Volley Requestでカスタムヘッダーを設定する方法


104

Volleyリクエストにカスタムヘッダーを設定するにはどうすればよいですか?現時点では、POSTリクエストの本文コンテンツを設定する方法があります。単純なGETリクエストを作成しましたが、カスタムヘッダーを一緒に渡す必要があります。JsonRequestクラスがそれをどのようにサポートするかわかりません。まったく可能ですか?


受け入れられた回答を変更してください。現在受け入れられている回答は正しくありません。
エステバン

回答:


118

public Map<String, String> getHeaders()定義されてRequestいるをオーバーライドして、目的のHTTPヘッダーを返すように見えます。


4
@JuanJoséMeleroGómezリンクが壊れています。404見つかりません
Milon

次に、別の例(ページの最後にあるスニペット)を示します:developer.android.com/training/volley/request-custom.html。クラスはGsonRequestメソッドgetHeaders()をオーバーライドして、コンストラクターで渡すヘッダーパラメーターでマップを返します。
ファンホセメレロゴメス

157

getParams()で受け入れられた回答はPOSTの本文データを設定するためのものですが、タイトルの質問では、User-AgentなどのHTTPヘッダーを設定する方法を尋ねられました。CommonsWareが言ったように、getHeaders()をオーバーライドします。以下は、User-Agentを「Nintendo Gameboy」に設定し、Accept-Languageを「fr」に設定するサンプルコードです。

public void requestWithSomeHttpHeaders() {
    RequestQueue queue = Volley.newRequestQueue(this);
    String url = "http://www.somewebsite.com";
    StringRequest getRequest = new StringRequest(Request.Method.GET, url, 
        new Response.Listener<String>() 
        {
            @Override
            public void onResponse(String response) {
                // response
                Log.d("Response", response);
            }
        }, 
        new Response.ErrorListener() 
        {
            @Override
            public void onErrorResponse(VolleyError error) {
                // TODO Auto-generated method stub
                Log.d("ERROR","error => "+error.toString());
            }
        }
    ) {     
        @Override
        public Map<String, String> getHeaders() throws AuthFailureError { 
                Map<String, String>  params = new HashMap<String, String>();  
                params.put("User-Agent", "Nintendo Gameboy");  
                params.put("Accept-Language", "fr");

                return params;  
        }
    };
    queue.add(getRequest);

}

この回答はJSONObjectRequestでも機能しますか?JSONObjectRequest postRequest = new JSONObjectRequest ......これを実行していて、getHeaders()が呼び出されていないため... ??? 匿名クラスを作成してメソッドをオーバーライドしているとのことですが、StringRequestの代わりにJSONObjectRequestのみを使用していて、getHeaders()が呼び出されていません。
JDOaktown

getHeaders()メソッドにも「Cookie」を追加できますか?投稿リクエストでも機能しますか?
Arnab Banerjee

残りのPOSTデータはどこに送信しますか?
Fernando Torres、

30

URLに情報を追加するのではなく、データを投稿する必要がある場合。

public Request post(String url, String username, String password, 
      Listener listener, ErrorListener errorListener) {
  JSONObject params = new JSONObject();
  params.put("user", username);
  params.put("pass", password);
  Request req = new Request(
     Method.POST,
     url,
     params.toString(),
     listener,
     errorListener
  );

  return req;
}

あなたがしたいことがリクエストのヘッダーを編集する場合、これはあなたがしたいことです:

// could be any class that implements Map
Map<String, String> mHeaders = new ArrayMap<String, String>();
mHeaders.put("user", USER);
mHeaders.put("pass", PASSWORD);
Request req = new Request(url, postBody, listener, errorListener) {
  public Map<String, String> getHeaders() {
    return mHeaders;
  }
}

44
これは質問の質問とはまったく違うので、私は反対票を投じました。これはPOSTコンテンツの設定用であり、User-AgentなどのカスタムHTTPヘッダーの設定用ではありません。ええ AtanasovとCommonsWareはgetHeaders正解です。
georgiecasey 2013年

4
これはユーザーが求めたものではないため、私はこの回答に反対しました。
Dharmendra Pratap Singh 2014

1
これは、ヘッダーではなくコンテンツパラメータを追加するためのものです。それは本当に受け入れられる答えであってはならない
ファン・コルテス

1
私の質問を見てください。これは、これに似ていますが、私はそれを右得ることができなかったstackoverflow.com/a/37948318
X09

18

あなたはこの解決策を見ることができます。Cookieを取得/設定する方法を示していますが、Cookieは要求/応答のヘッダーの1つにすぎません。Volleyの* Requestクラスの1つをオーバーライドし、必要なヘッダーをgetHeaders()


リンクされたソースは次のとおりです。

public class StringRequest extends com.android.volley.toolbox.StringRequest {

private final Map<String, String> _params;

/**
 * @param method
 * @param url
 * @param params
 *            A {@link HashMap} to post with the request. Null is allowed
 *            and indicates no parameters will be posted along with request.
 * @param listener
 * @param errorListener
 */
public StringRequest(int method, String url, Map<String, String> params, Listener<String> listener,
        ErrorListener errorListener) {
    super(method, url, listener, errorListener);

    _params = params;
}

@Override
protected Map<String, String> getParams() {
    return _params;
}

/* (non-Javadoc)
 * @see com.android.volley.toolbox.StringRequest#parseNetworkResponse(com.android.volley.NetworkResponse)
 */
@Override
protected Response<String> parseNetworkResponse(NetworkResponse response) {
    // since we don't know which of the two underlying network vehicles
    // will Volley use, we have to handle and store session cookies manually
    MyApp.get().checkSessionCookie(response.headers);

    return super.parseNetworkResponse(response);
}

/* (non-Javadoc)
 * @see com.android.volley.Request#getHeaders()
 */
@Override
public Map<String, String> getHeaders() throws AuthFailureError {
    Map<String, String> headers = super.getHeaders();

    if (headers == null
            || headers.equals(Collections.emptyMap())) {
        headers = new HashMap<String, String>();
    }

    MyApp.get().addSessionCookie(headers);

    return headers;
}

}

そして、MyAppクラス:

public class MyApp extends Application {
    private static final String SET_COOKIE_KEY = "Set-Cookie";
    private static final String COOKIE_KEY = "Cookie";
    private static final String SESSION_COOKIE = "sessionid";

    private static MyApp _instance;
    private RequestQueue _requestQueue;
    private SharedPreferences _preferences;

    public static MyApp get() {
        return _instance;
    }

    @Override
    public void onCreate() {
        super.onCreate();
        _instance = this;
            _preferences = PreferenceManager.getDefaultSharedPreferences(this);
        _requestQueue = Volley.newRequestQueue(this);
    }

    public RequestQueue getRequestQueue() {
        return _requestQueue;
    }


    /**
     * Checks the response headers for session cookie and saves it
     * if it finds it.
     * @param headers Response Headers.
     */
    public final void checkSessionCookie(Map<String, String> headers) {
        if (headers.containsKey(SET_COOKIE_KEY)
                && headers.get(SET_COOKIE_KEY).startsWith(SESSION_COOKIE)) {
                String cookie = headers.get(SET_COOKIE_KEY);
                if (cookie.length() > 0) {
                    String[] splitCookie = cookie.split(";");
                    String[] splitSessionId = splitCookie[0].split("=");
                    cookie = splitSessionId[1];
                    Editor prefEditor = _preferences.edit();
                    prefEditor.putString(SESSION_COOKIE, cookie);
                    prefEditor.commit();
                }
            }
    }

    /**
     * Adds session cookie to headers if exists.
     * @param headers
     */
    public final void addSessionCookie(Map<String, String> headers) {
        String sessionId = _preferences.getString(SESSION_COOKIE, "");
        if (sessionId.length() > 0) {
            StringBuilder builder = new StringBuilder();
            builder.append(SESSION_COOKIE);
            builder.append("=");
            builder.append(sessionId);
            if (headers.containsKey(COOKIE_KEY)) {
                builder.append("; ");
                builder.append(headers.get(COOKIE_KEY));
            }
            headers.put(COOKIE_KEY, builder.toString());
        }
    }

}

7

コトリンでは

次のようにgetHeaders()メソッドをオーバーライドする必要があります。

val volleyEnrollRequest = object : JsonObjectRequest(GET_POST_PARAM, TARGET_URL, PAYLOAD_BODY_IF_YOU_WISH,
            Response.Listener {
                // Success Part  
            },

            Response.ErrorListener {
                // Failure Part
            }
        ) {
            // Providing Request Headers

            override fun getHeaders(): Map<String, String> {
               // Create HashMap of your Headers as the example provided below

                val headers = HashMap<String, String>()
                headers["Content-Type"] = "application/json"
                headers["app_id"] = APP_ID
                headers["app_key"] = API_KEY

                return headers
            }
        }

1
これは、Kotlinでヘッダーをオーバーライドするために見つけることができる唯一のリソースです。ありがとうございました!
Mathew Sonke

@MathewSonke私はあなたが仲間だと感じます。ところで、AndroidのネットワーキングにはRetrofitを試してください。
devDeejay

6

この問題の解決策も探しています。ここで何かを参照してください:http : //developer.android.com/training/volley/request.html

ImageLoaderの代わりにImageRequestを直接使用することは良い考えですか?とにかくImageLoaderは内部的にそれを使用しているようです。ImageLoaderのキャッシュサポート以外に重要なものはありませんか?

ImageView mImageView;
String url = "http://i.imgur.com/7spzG.png";
mImageView = (ImageView) findViewById(R.id.myImage);
...

// Retrieves an image specified by the URL, displays it in the UI.
mRequestQueue = Volley.newRequestQueue(context);;
ImageRequest request = new ImageRequest(url,
  new Response.Listener() {
      @Override
      public void onResponse(Bitmap bitmap) {
          mImageView.setImageBitmap(bitmap);
      }
  }, 0, 0, null,
  new Response.ErrorListener() {
      public void onErrorResponse(VolleyError error) {
          mImageView.setImageResource(R.drawable.image_load_error);
      }
  })   {
    @Override
    public Map<String, String> getHeaders() throws AuthFailureError {
        Map<String, String> params = new Map<String, String>();
        params.put("User-Agent", "one");
        params.put("header22", "two");

        return params;
    };
mRequestQueue.add(request);

単に「-1」を与えるのではなく、質問が間違っている、または解決策に問題があると思う理由を指摘できれば、非常にありがたく、より役立つでしょう。
lannyf 2014

1
地図は抽象的です。HashMapでなければなりません
superuserdo

4

これを試して

{
    @Override
       public Map<String, String> getHeaders() throws AuthFailureError {
           String bearer = "Bearer ".concat(token);
            Map<String, String> headersSys = super.getHeaders();
            Map<String, String> headers = new HashMap<String, String>();
            headersSys.remove("Authorization");
            headers.put("Authorization", bearer);
            headers.putAll(headersSys);
            return headers;
       }
};

4

次のように、StringRequestを拡張するカスタムRequestクラスを作成し、その内部のgetHeaders()メソッドをオーバーライドできます。

public class CustomVolleyRequest extends StringRequest {

    public CustomVolleyRequest(int method, String url,
                           Response.Listener<String> listener,
                           Response.ErrorListener errorListener) {
        super(method, url, listener, errorListener);
    }

    @Override
    public Map<String, String> getHeaders() throws AuthFailureError {
        Map<String, String> headers = new HashMap<>();
        headers.put("key1","value1");
        headers.put("key2","value2");
        return headers;
    }
}

1
public class CustomJsonObjectRequest  extends JsonObjectRequest
{
    public CustomJsonObjectRequest(int method, String url, JSONObject jsonRequest,Response.Listener listener, Response.ErrorListener errorListener)
    {
        super(method, url, jsonRequest, listener, errorListener);
    }


@Override
public Map getHeaders() throws AuthFailureError {
    Map headers = new HashMap();
    headers.put("AppId", "xyz");

    return headers;
}

}

1

さらにとして、私は共有に私が見つけに関して何か希望Content-Typeの上には:

@Override
public Map<String, String> getHeaders() throws AuthFailureError {
Map<String, String> params = new HashMap<String, String>();
.
.
.
return params;
}

追加する必要がありました:

@Override
public String getBodyContentType() {
return /*(for exmaple)*/ "application/json";
}

理由を聞かないでくださいContent-Type。セットを正しく設定できない他の人の役に立つかもしれないと思いました。


0

githubサンプルからヘッダーを設定します。

StringRequest myReq = new StringRequest(Method.POST,
                       "http://ave.bolyartech.com/params.php",
                        createMyReqSuccessListener(),
                        createMyReqErrorListener()) {

 protected Map<String, String> getParams() throws 
         com.android.volley.AuthFailureError {
                        Map<String, String> params = new HashMap<String, String>();
                        params.put("param1", num1);
                        params.put("param2", num2);
                        return params;
                    };
                };
                queue.add(myReq);

0

これを試して

 public void VolleyPostReqWithResponseListenerwithHeaders(String URL,final Map<String, String> params,final Map<String, String> headers,Response.Listener<String> responseListener) {


    String url = URL;

    Log.i("url:", ":" + url);
    StringRequest mStringRequest = new StringRequest(Request.Method.POST,
            url, responseListener, new Response.ErrorListener() {
        @Override
        public void onErrorResponse(VolleyError error) {
            // error


            //Log.d("Error.Response", error.getLocalizedMessage());
        }
    }){
        @Override
        protected Map<String, String> getParams() {
            return params;
        }

        @Override
        public Map<String, String> getHeaders() throws AuthFailureError {
            return headers;
        }
    };



    mStringRequest.setRetryPolicy(new DefaultRetryPolicy(
            60000,
            DefaultRetryPolicy.DEFAULT_MAX_RETRIES,
            DefaultRetryPolicy.DEFAULT_BACKOFF_MULT));

    mStringRequest.setShouldCache(true);



    //  dialog.show();
    SingletonRequestQueue.getInstance(context).addToRequestQueue(mStringRequest);
}

@Override public Map <String、String> getHeaders()はAuthFailureError {return headers; }};
オサマイブラヒム

ヘッダーはどこですか?
オサマイブラヒム

signutareでは、Map <String、String>ヘッダーで呼び出すときに設定できます
Yigit Yuksel

0

それは私のコードです、忘れないでください=オブジェクト:入れない場合は機能しません

val queue = Volley.newRequestQueue(this)
        val url = "http://35.237.133.137:8080/lamarrullaWS/rest/lamarrullaAPI"
        // Request a string response from the provided URL.
        val jsonObjectRequest = object: JsonObjectRequest(Request.Method.GET, url, null,
                Response.Listener { response ->
                    txtPrueba.text = "Response: %s".format(response.toString())
                },
                Response.ErrorListener { txtPrueba.text = "That didn't work!" }
        )
        {
            @Throws(AuthFailureError::class)
            override fun getHeaders(): Map<String, String> {
                val headers = HashMap<String, String>()
                headers.put("Content-Type", "application/json")
                return headers
            }
        }
        queue.add(jsonObjectRequest)
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.