Android
salvo
Zoeken…
Invoering
Volley is een Android HTTP-bibliotheek die werd geïntroduceerd door Google om netwerkoproepen veel eenvoudiger te maken. Standaard worden alle Volley-netwerkoproepen asynchroon uitgevoerd, waarbij alles in een achtergrondthread wordt afgehandeld en de resultaten op de voorgrond worden geretourneerd met behulp van callbacks. Omdat het ophalen van gegevens via een netwerk een van de meest voorkomende taken is die in elke app wordt uitgevoerd, is de Volley-bibliotheek gemaakt om de ontwikkeling van Android-apps te vergemakkelijken.
Syntaxis
- RequestQueue queue = Volley.newRequestQueue (context); // de wachtrij instellen
- Request request = new SomeKindOfRequestClass (Request.Method, String url, Response.Listener, Response.ErrorListener); // stel een soort verzoek in, het exacte type en de argumenten veranderen voor elk verzoektype
- queue.add (verzoek); // voeg het verzoek toe aan de wachtrij; de juiste antwoordluisteraar wordt gebeld zodra het verzoek is voltooid (of om welke reden dan ook beëindigd)
Opmerkingen
Installatie
U kunt Volley bouwen met de officiële Google-broncode . Een tijdje was dat de enige optie. Of gebruik een van de vooraf gebouwde versies van derden. Google heeft echter eindelijk een officieel maven-pakket op jcenter uitgebracht.
Voeg dit in uw build.gradle
bestand op toepassingsniveau toe aan uw lijst met afhankelijkheden:
dependencies {
...
compile 'com.android.volley:volley:1.0.0'
}
Zorg ervoor dat de INTERNET
machtiging is ingesteld in het manifest van uw app:
<uses-permission android:name="android.permission.INTERNET"/>
Officiële documentatie
Google heeft geen zeer uitgebreide documentatie over deze bibliotheek verstrekt en ze hebben deze al jaren niet meer aangeraakt. Maar wat beschikbaar is, is te vinden op:
https://developer.android.com/training/volley/index.html
Er is niet-officiële documentatie gehost op GitHub, hoewel er een betere locatie zou moeten zijn om dit in de toekomst te hosten:
Basic StringRequest met behulp van de GET-methode
final TextView mTextView = (TextView) findViewById(R.id.text);
...
// Instantiate the RequestQueue.
RequestQueue queue = Volley.newRequestQueue(this);
String url ="http://www.google.com";
// Request a string response from the provided URL.
StringRequest stringRequest = new StringRequest(Request.Method.GET, url,
new Response.Listener<String>() {
@Override
public void onResponse(String response) {
// Display the first 500 characters of the response string.
mTextView.setText("Response is: "+ response.substring(0,500));
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
mTextView.setText("That didn't work!");
}
});
// Add the request to the RequestQueue.
queue.add(stringRequest);
Annuleer een verzoek
// assume a Request and RequestQueue have already been initialized somewhere above
public static final String TAG = "SomeTag";
// Set the tag on the request.
request.setTag(TAG);
// Add the request to the RequestQueue.
mRequestQueue.add(request);
// To cancel this specific request
request.cancel();
// ... then, in some future life cycle event, for example in onStop()
// To cancel all requests with the specified tag in RequestQueue
mRequestQueue.cancelAll(TAG);
Aangepaste ontwerptijdattributen toevoegen aan NetworkImageView
Er zijn verschillende aanvullende kenmerken die de Volley NetworkImageView
toevoegt aan de standaard ImageView
. Deze attributen kunnen echter alleen in code worden ingesteld. Het volgende is een voorbeeld van het maken van een uitbreidingsklasse die de attributen uit uw XML-lay- NetworkImageView
en voor u op de NetworkImageView
instantie toepast.
Voeg in uw map ~/res/xml
een bestand met de naam attrx.xml
:
<resources>
<declare-styleable name="MoreNetworkImageView">
<attr name="defaultImageResId" format="reference"/>
<attr name="errorImageResId" format="reference"/>
</declare-styleable>
</resources>
Voeg een nieuw klassenbestand toe aan uw project:
package my.namespace;
import android.content.Context;
import android.content.res.TypedArray;
import android.support.annotation.NonNull;
import android.util.AttributeSet;
import com.android.volley.toolbox.NetworkImageView;
public class MoreNetworkImageView extends NetworkImageView {
public MoreNetworkImageView(@NonNull final Context context) {
super(context);
}
public MoreNetworkImageView(@NonNull final Context context, @NonNull final AttributeSet attrs) {
this(context, attrs, 0);
}
public MoreNetworkImageView(@NonNull final Context context, @NonNull final AttributeSet attrs, final int defStyle) {
super(context, attrs, defStyle);
final TypedArray attributes = context.obtainStyledAttributes(attrs, R.styleable.MoreNetworkImageView, defStyle, 0);
// load defaultImageResId from XML
int defaultImageResId = attributes.getResourceId(R.styleable.MoreNetworkImageView_defaultImageResId, 0);
if (defaultImageResId > 0) {
setDefaultImageResId(defaultImageResId);
}
// load errorImageResId from XML
int errorImageResId = attributes.getResourceId(R.styleable.MoreNetworkImageView_errorImageResId, 0);
if (errorImageResId > 0) {
setErrorImageResId(errorImageResId);
}
}
}
Een voorbeeld van een lay-outbestand met het gebruik van de aangepaste kenmerken:
<?xml version="1.0" encoding="utf-8"?>
<android.support.v7.widget.CardView
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="wrap_content"
android:layout_height="fill_parent">
<my.namespace.MoreNetworkImageView
android:layout_width="64dp"
android:layout_height="64dp"
app:errorImageResId="@drawable/error_img"
app:defaultImageResId="@drawable/default_img"
tools:defaultImageResId="@drawable/editor_only_default_img"/>
<!--
Note: The "tools:" prefix does NOT work for custom attributes in Android Studio 2.1 and
older at least, so in this example the defaultImageResId would show "default_img" in the
editor, not the "editor_only_default_img" drawable even though it should if it was
supported as an editor-only override correctly like standard Android properties.
-->
</android.support.v7.widget.CardView>
Verzoek JSON
final TextView mTxtDisplay = (TextView) findViewById(R.id.txtDisplay);
ImageView mImageView;
String url = "http://ip.jsontest.com/";
final JsonObjectRequest jsObjRequest = new JsonObjectRequest
(Request.Method.GET, url, null, new Response.Listener<JSONObject>() {
@Override
public void onResponse(JSONObject response) {
mTxtDisplay.setText("Response: " + response.toString());
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
// ...
}
});
requestQueue.add(jsObjRequest);
Aangepaste kopteksten toevoegen aan uw verzoeken [bijvoorbeeld voor basisverificatie]
Als u aangepaste kopteksten aan uw volleyverzoeken moet toevoegen, kunt u dit niet doen na initialisatie, omdat de kopteksten worden opgeslagen in een privévariabele.
In plaats daarvan moet u de methode getHeaders()
van Request.class
als zodanig overschrijven:
new JsonObjectRequest(REQUEST_METHOD, REQUEST_URL, REQUEST_BODY, RESP_LISTENER, ERR_LISTENER) {
@Override
public Map<String, String> getHeaders() throws AuthFailureError {
HashMap<String, String> customHeaders = new Hashmap<>();
customHeaders.put("KEY_0", "VALUE_0");
...
customHeaders.put("KEY_N", "VALUE_N");
return customHeaders;
}
};
Verklaring van de parameters:
-
REQUEST_METHOD
- Een van deRequest.Method.*
. -
REQUEST_URL
- De volledige URL waarnaar uw verzoek moet worden verzonden. -
REQUEST_BODY
- EenJSONObject
dat de te verzenden POST-body bevat (of null). -
RESP_LISTENER
- Een objectResponse.Listener<?>
,onResponse(T data)
methodeonResponse(T data)
wordt aangeroepen na succesvolle voltooiing. -
ERR_LISTENER
- EenResponse.ErrorListener
object, waarvan deonErrorResponse(VolleyError e)
op een mislukt verzoek wordt aangeroepen.
Als u een aangepast verzoek wilt maken, kunt u hier ook de kopteksten aan toevoegen:
public class MyCustomRequest extends Request {
...
@Override
public Map<String, String> getHeaders() throws AuthFailureError {
HashMap<String, String> customHeaders = new Hashmap<>();
customHeaders.put("KEY_0", "VALUE_0");
...
customHeaders.put("KEY_N", "VALUE_N");
return customHeaders;
}
...
}
Hulpklasse voor het omgaan met volleyfouten
public class VolleyErrorHelper {
/**
* Returns appropriate message which is to be displayed to the user
* against the specified error object.
*
* @param error
* @param context
* @return
*/
public static String getMessage (Object error , Context context){
if(error instanceof TimeoutError){
return context.getResources().getString(R.string.timeout);
}else if (isServerProblem(error)){
return handleServerError(error ,context);
}else if(isNetworkProblem(error)){
return context.getResources().getString(R.string.nointernet);
}
return context.getResources().getString(R.string.generic_error);
}
private static String handleServerError(Object error, Context context) {
VolleyError er = (VolleyError)error;
NetworkResponse response = er.networkResponse;
if(response != null){
switch (response.statusCode){
case 404:
case 422:
case 401:
try {
// server might return error like this { "error": "Some error occured" }
// Use "Gson" to parse the result
HashMap<String, String> result = new Gson().fromJson(new String(response.data),
new TypeToken<Map<String, String>>() {
}.getType());
if (result != null && result.containsKey("error")) {
return result.get("error");
}
} catch (Exception e) {
e.printStackTrace();
}
// invalid request
return ((VolleyError) error).getMessage();
default:
return context.getResources().getString(R.string.timeout);
}
}
return context.getResources().getString(R.string.generic_error);
}
private static boolean isServerProblem(Object error) {
return (error instanceof ServerError || error instanceof AuthFailureError);
}
private static boolean isNetworkProblem (Object error){
return (error instanceof NetworkError || error instanceof NoConnectionError);
}
Serververificatie op afstand met behulp van StringRequest via POST-methode
Laten we voor dit voorbeeld aannemen dat we een server hebben voor het verwerken van de POST-aanvragen die we via onze Android-app zullen doen:
// User input data.
String email = "[email protected]";
String password = "123";
// Our server URL for handling POST requests.
String URL = "http://my.server.com/login.php";
// When we create a StringRequest (or a JSONRequest) for sending
// data with Volley, we specify the Request Method as POST, and
// the URL that will be receiving our data.
StringRequest stringRequest =
new StringRequest(Request.Method.POST, URL,
new Response.Listener<String>() {
@Override
public void onResponse(String response) {
// At this point, Volley has sent the data to your URL
// and has a response back from it. I'm going to assume
// that the server sends an "OK" string.
if (response.equals("OK")) {
// Do login stuff.
} else {
// So the server didn't return an "OK" response.
// Depending on what you did to handle errors on your
// server, you can decide what action to take here.
}
}
},
new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
// This is when errors related to Volley happen.
// It's up to you what to do if that should happen, but
// it's usually not a good idea to be too clear as to
// what happened here to your users.
}
}) {
@Override
protected Map<String, String> getParams() throws AuthFailureError {
// Here is where we tell Volley what it should send in
// our POST request. For this example, we want to send
// both the email and the password.
// We will need key ids for our data, so our server can know
// what is what.
String key_email = "email";
String key_password = "password";
Map<String, String> map = new HashMap<String, String>();
// map.put(key, value);
map.put(key_email, email);
map.put(key_password, password);
return map;
}
};
// This is a policy that we need to specify to tell Volley, what
// to do if it gets a timeout, how many times to retry, etc.
stringRequest.setRetryPolicy(new RetryPolicy() {
@Override
public int getCurrentTimeout() {
// Here goes the timeout.
// The number is in milliseconds, 5000 is usually enough,
// but you can up or low that number to fit your needs.
return 50000;
}
@Override
public int getCurrentRetryCount() {
// The maximum number of attempts.
// Again, the number can be anything you need.
return 50000;
}
@Override
public void retry(VolleyError error) throws VolleyError {
// Here you could check if the retry count has gotten
// to the maximum number, and if so, send a VolleyError
// message or similar. For the sake of the example, I'll
// show a Toast.
Toast.makeText(getContext(), error.toString(), Toast.LENGTH_LONG).show();
}
});
// And finally, we create a Volley Queue. For this example, I'm using
// getContext(), because I was working with a Fragment. But context could
// be "this", "getContext()", etc.
RequestQueue requestQueue = Volley.newRequestQueue(getContext());
requestQueue.add(stringRequest);
} else {
// If, for example, the user inputs an email that is not currently
// on your remote DB, here's where we can inform the user.
Toast.makeText(getContext(), "Wrong email", Toast.LENGTH_LONG).show();
}
Volley gebruiken voor HTTP-aanvragen
Voeg de gradle-afhankelijkheid toe op build.gradle op app-niveau
compile 'com.android.volley:volley:1.0.0'
Voeg ook de machtiging android.permission.INTERNET toe aan het manifest van uw app.
** Maak een Volley RequestQueue-instantie singleton in uw toepassing **
public class InitApplication extends Application {
private RequestQueue queue;
private static InitApplication sInstance;
private static final String TAG = InitApplication.class.getSimpleName();
@Override
public void onCreate() {
super.onCreate();
sInstance = this;
Stetho.initializeWithDefaults(this);
}
public static synchronized InitApplication getInstance() {
return sInstance;
}
public <T> void addToQueue(Request<T> req, String tag) {
req.setTag(TextUtils.isEmpty(tag) ? TAG : tag);
getQueue().add(req);
}
public <T> void addToQueue(Request<T> req) {
req.setTag(TAG);
getQueue().add(req);
}
public void cancelPendingRequests(Object tag) {
if (queue != null) {
queue.cancelAll(tag);
}
}
public RequestQueue getQueue() {
if (queue == null) {
queue = Volley.newRequestQueue(getApplicationContext());
return queue;
}
return queue;
}
}
Nu kunt u de volleyinstantie gebruiken met de methode getInstance () en een nieuw verzoek in de wachtrij toevoegen met InitApplication.getInstance().addToQueue(request);
Een eenvoudig voorbeeld om JsonObject van de server aan te vragen is
JsonObjectRequest myRequest = new JsonObjectRequest(Method.GET,
url, null,
new Response.Listener<JSONObject>() {
@Override
public void onResponse(JSONObject response) {
Log.d(TAG, response.toString());
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
Log.d(TAG, "Error: " + error.getMessage());
}
});
myRequest.setRetryPolicy(new DefaultRetryPolicy(
MY_SOCKET_TIMEOUT_MS,
DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));
Om Volley-time-outs te verwerken, moet u een RetryPolicy
. Een opnieuw proberen beleid wordt gebruikt in het geval een verzoek niet kan worden voltooid als gevolg van netwerkstoring of enkele andere gevallen.
Volley biedt een eenvoudige manier om uw RetryPolicy
te implementeren voor uw verzoeken. Standaard stelt Volley alle socket- en verbindingtime-outs in op 5 seconden voor alle aanvragen. RetryPolicy
is een interface waar u uw logica moet implementeren van hoe u een bepaald verzoek opnieuw wilt proberen wanneer er een time-out optreedt.
De constructor neemt de volgende drie parameters:
-
initialTimeoutMs
- Specificeert de socket-time-out in milliseconden voor elke nieuwe poging. -
maxNumRetries
- Het aantal keren dat opnieuw is geprobeerd. -
backoffMultiplier
- Een multiplier die wordt gebruikt om de exponentiële tijd te bepalen die is ingesteld op socket voor elke nieuwe poging.
Booleaanse variabele respons van server met json-verzoek in volley
u kunt aangepaste klasse hieronder een
private final String PROTOCOL_CONTENT_TYPE = String.format("application/json; charset=%s", PROTOCOL_CHARSET);
public BooleanRequest(int method, String url, String requestBody, Response.Listener<Boolean> listener, Response.ErrorListener errorListener) {
super(method, url, errorListener);
this.mListener = listener;
this.mErrorListener = errorListener;
this.mRequestBody = requestBody;
}
@Override
protected Response<Boolean> parseNetworkResponse(NetworkResponse response) {
Boolean parsed;
try {
parsed = Boolean.valueOf(new String(response.data, HttpHeaderParser.parseCharset(response.headers)));
} catch (UnsupportedEncodingException e) {
parsed = Boolean.valueOf(new String(response.data));
}
return Response.success(parsed, HttpHeaderParser.parseCacheHeaders(response));
}
@Override
protected VolleyError parseNetworkError(VolleyError volleyError) {
return super.parseNetworkError(volleyError);
}
@Override
protected void deliverResponse(Boolean response) {
mListener.onResponse(response);
}
@Override
public void deliverError(VolleyError error) {
mErrorListener.onErrorResponse(error);
}
@Override
public String getBodyContentType() {
return PROTOCOL_CONTENT_TYPE;
}
@Override
public byte[] getBody() throws AuthFailureError {
try {
return mRequestBody == null ? null : mRequestBody.getBytes(PROTOCOL_CHARSET);
} catch (UnsupportedEncodingException uee) {
VolleyLog.wtf("Unsupported Encoding while trying to get the bytes of %s using %s",
mRequestBody, PROTOCOL_CHARSET);
return null;
}
}
}
gebruik dit bij uw activiteit
try {
JSONObject jsonBody;
jsonBody = new JSONObject();
jsonBody.put("Title", "Android Demo");
jsonBody.put("Author", "BNK");
jsonBody.put("Date", "2015/08/28");
String requestBody = jsonBody.toString();
BooleanRequest booleanRequest = new BooleanRequest(0, url, requestBody, new Response.Listener<Boolean>() {
@Override
public void onResponse(Boolean response) {
Toast.makeText(mContext, String.valueOf(response), Toast.LENGTH_SHORT).show();
}
}, new Response.ErrorListener() {
@Override
public void onErrorResponse(VolleyError error) {
Toast.makeText(mContext, error.toString(), Toast.LENGTH_SHORT).show();
}
});
// Add the request to the RequestQueue.
queue.add(booleanRequest);
} catch (JSONException e) {
e.printStackTrace();
}
Gebruik JSONArray als body
De standaardverzoeken die in volley zijn geïntegreerd, staan niet toe dat een JSONArray
als aanvraaginstantie wordt JSONArray
in een POST
aanvraag. In plaats daarvan kunt u een JSON
object alleen als parameter doorgeven.
In plaats van een JSON
object als parameter door te geven aan de constructor van het verzoek, moet u echter de methode getBody()
van de Request.class
. U moet ook null
doorgeven als derde parameter:
JSONArray requestBody = new JSONArray();
new JsonObjectRequest(Request.Method.POST, REQUEST_URL, null, RESP_LISTENER, ERR_LISTENER) {
@Override
public byte[] getBody() {
try {
return requestBody.toString().getBytes(PROTOCOL_CHARSET);
} catch (UnsupportedEncodingException uee) {
// error handling
return null;
}
}
};
Verklaring van de parameters:
-
REQUEST_URL
- De volledige URL waarnaar uw verzoek moet worden verzonden. -
RESP_LISTENER
- Een objectResponse.Listener<?>
,onResponse(T data)
methodeonResponse(T data)
wordt aangeroepen na succesvolle voltooiing. -
ERR_LISTENER
- EenResponse.ErrorListener
object, waarvan deonErrorResponse(VolleyError e)
op een mislukt verzoek wordt aangeroepen.