수색…


소개

발리 (Volley)는 네트워킹 호출을 훨씬 간단하게 만들기 위해 Google에서 소개 한 Android HTTP 라이브러리입니다. 기본적으로 모든 Volley 네트워크 호출은 백그라운드 스레드의 모든 것을 처리하고 콜백을 사용하여 포 그라운드에서 결과를 반환하여 비동기 적으로 이루어집니다. 네트워크를 통해 데이터를 가져 오는 것은 모든 앱에서 수행되는 가장 일반적인 작업 중 하나이기 때문에 Volley 라이브러리는 Android 앱 개발을 용이하게하기 위해 만들어졌습니다.

통사론

  • RequestQueue queue = Volley.newRequestQueue (컨텍스트); // 대기열 설정
  • 요청 요청 = 새로운 SomeKindOfRequestClass (Request.Method, String url, Response.Listener, Response.ErrorListener); // 어떤 종류의 요청을 설정하면 각 요청 유형마다 정확한 유형과 인수가 변경됩니다.
  • queue.add (request); // 요청을 대기열에 추가합니다. 요청이 완료되면 (또는 이유에 상관없이) 적절한 응답 수신기가 호출됩니다.

비고

설치

공식 Google 소스 코드 에서 Volley를 만들 수 있습니다. 잠시 동안, 그것은 유일한 선택이었습니다. 또는 타사 사전 제작 버전 중 하나를 사용하십시오. 그러나 Google은 마침내 jcenter에 대한 공식 maven 패키지를 릴리스했습니다.

응용 프로그램 수준 build.gradle 파일에서 종속성 목록에 다음을 추가하십시오.

dependencies {
    ...
    compile 'com.android.volley:volley:1.0.0'
}

앱의 매니페스트에 INTERNET 권한이 설정되어 있는지 확인합니다.

<uses-permission android:name="android.permission.INTERNET"/>

공식 문서

Google은이 라이브러리에 대한 매우 광범위한 문서를 제공하지 않았으며 몇 년 동안 언급하지 않았습니다. 그러나 사용할 수있는 것은 다음에서 찾을 수 있습니다 :

https://developer.android.com/training/volley/index.html

GitHub에서 호스팅되는 비공식 문서가 있지만 앞으로는 호스팅하는 것이 더 좋습니다.

https://pablobaxter.github.io/volley-docs/

GET 메소드를 사용한 기본 StringRequest

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);

요청 취소

// 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);

NetworkImageView에 사용자 정의 디자인 시간 속성 추가

Volley NetworkImageView 가 표준 ImageView 추가하는 몇 가지 추가 속성이 있습니다. 그러나 이러한 특성은 코드에서만 설정할 수 있습니다. 다음은 XML 레이아웃 파일에서 속성을 선택하여 NetworkImageView 인스턴스에 적용 할 확장 클래스를 만드는 방법의 예입니다.

~/res/xml 디렉토리에 attrx.xml 파일을 추가하십시오.

<resources>
    <declare-styleable name="MoreNetworkImageView">
        <attr name="defaultImageResId" format="reference"/>
        <attr name="errorImageResId" format="reference"/>
    </declare-styleable>
</resources>

새 클래스 파일을 프로젝트에 추가하십시오.

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);
        }
    }
}

맞춤 속성 사용을 보여주는 레이아웃 파일 예제 :

<?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>

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);

요청에 사용자 정의 헤더 추가 [예 : 기본 인증]

발리 요청에 사용자 지정 헤더를 추가해야하는 경우 머리글이 개인 변수에 저장되기 때문에 초기화 후에이를 수행 할 수 없습니다.

대신 Request.classgetHeaders() 메서드를 다음과 같이 재정의해야합니다.

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;
    }
};

매개 변수 설명 :

  • REQUEST_METHOD - Request.Method.* 상수 중 하나입니다.
  • REQUEST_URL - 요청을 보낼 전체 URL입니다.
  • REQUEST_BODY - 보낼 POST-Body를 포함하는 JSONObject (또는 null)입니다.
  • RESP_LISTENER - Response.Listener<?> 객체로, 성공적으로 완료되면 onResponse(T data) 메서드가 호출됩니다.
  • ERR_LISTENER - 실패한 요청에 대해 onErrorResponse(VolleyError e) 메소드가 호출되는 Response.ErrorListener 객체입니다.

사용자 정의 요청을 작성하려면 헤더도 추가 할 수 있습니다.

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;
    }
    ...
}

발리 오류 처리를위한 도우미 클래스

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);
        }

POST 메서드를 통해 StringRequest를 사용하여 원격 서버 인증

이 예제에서는 Android 앱에서 POST 요청을 처리 할 서버가 있다고 가정합니다.

// 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();
}

HTTP 요청에 Volley 사용

앱 수준 build.gradle에 gradle 종속성을 추가합니다.

compile 'com.android.volley:volley:1.0.0'

또한 앱의 매니페스트에 android.permission.INTERNET 권한을 추가하십시오.

** 응용 프로그램에서 발리 RequestQueue 인스턴스 싱글 톤 만들기 **

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;
}
}

이제 getInstance () 메소드를 사용하여 발리 인스턴스를 사용하고 InitApplication.getInstance().addToQueue(request); 사용하여 큐에 새 요청을 추가 할 수 있습니다 InitApplication.getInstance().addToQueue(request);

서버에서 JsonObject를 요청하는 간단한 예는 다음과 같습니다.

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));

발리 타임 아웃을 처리하려면 RetryPolicy 를 사용해야합니다. 재시도 정책은 네트워크 장애 또는 다른 경우로 인해 요청을 완료 할 수없는 경우에 사용됩니다.

Volley는 요청에 대한 RetryPolicy 를 손쉽게 구현할 수있는 방법을 제공합니다. 기본적으로 Volley는 모든 요청에 ​​대해 모든 소켓 및 연결 시간 초과를 5 초로 설정합니다. RetryPolicy 는 시간 초과가 발생할 때 특정 요청을 재 시도하려는 논리를 구현해야하는 인터페이스입니다.

생성자는 다음 세 가지 매개 변수를 사용합니다.

  • initialTimeoutMs - 재시도 시도마다 소켓 시간 초과를 밀리 초 단위로 지정합니다.
  • maxNumRetries - 재 시도가 시도 된 횟수입니다.
  • backoffMultiplier - 재시도 시도마다 소켓에 설정된 지수 시간을 결정하는 데 사용되는 승수입니다.

발리에서 json 요청이있는 서버의 부울 변수 응답

당신은 하나의 사용자 정의 클래스 수 있습니다.

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;
        }
    }
}

당신의 활동에 이것을 사용하십시오.

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();
    }

요청 본문으로 JSONArray 사용

발리에서 통합 된 기본 요청은 POST 요청에서 요청 본문으로 JSONArray 를 전달할 수 없습니다. 대신 JSON 객체 만 매개 변수로 전달할 수 있습니다.

그러나 JSON 객체를 요청 생성자에 매개 변수로 전달하는 대신 Request.classgetBody() 메소드를 재정의해야합니다. 세 번째 매개 변수로 null 을 전달해야합니다.

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;
        }
    }
};

매개 변수 설명 :

  • REQUEST_URL - 요청을 보낼 전체 URL입니다.
  • RESP_LISTENER - Response.Listener<?> 객체로, 성공적으로 완료되면 onResponse(T data) 메서드가 호출됩니다.
  • ERR_LISTENER - 실패한 요청에 대해 onErrorResponse(VolleyError e) 메소드가 호출되는 Response.ErrorListener 객체입니다.


Modified text is an extract of the original Stack Overflow Documentation
아래 라이선스 CC BY-SA 3.0
와 제휴하지 않음 Stack Overflow