Como definir o cabeçalho personalizado na solicitação Volley

104

Como os cabeçalhos personalizados podem ser definidos para uma solicitação do Volley? No momento, há uma maneira de definir o conteúdo do corpo para uma solicitação POST. Tenho uma solicitação GET simples, mas preciso passar os cabeçalhos personalizados junto com ela. Não vejo como a classe JsonRequest o suporta. É possível de alguma forma?

Bianca
fonte
altere a resposta aceita, a resposta aceita atualmente está incorreta.
Esteban,

Respostas:

119

Parece que você substitui public Map<String, String> getHeaders(), definido emRequest , para retornar seus cabeçalhos HTTP desejados.

CommonsWare
fonte
4
@ JuanJoséMeleroGómez o link está quebrado. 404 Não encontrado
Milon de
Aqui está outro exemplo (o snippet no final da página): developer.android.com/training/volley/request-custom.html . A classe GsonRequestsubstitui o método getHeaders()para retornar um Mapa com os parâmetros do cabeçalho que você passa no construtor.
Juan José Melero Gómez
157

A resposta aceita com getParams () é para configurar os dados do corpo do POST, mas a pergunta no título perguntava como configurar cabeçalhos HTTP como User-Agent. Como CommonsWare disse, você sobrescreve getHeaders (). Aqui está um exemplo de código que define o User-Agent como 'Nintendo Gameboy' e o Accept-Language como '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);

}
georgiecasey
fonte
Essa resposta funcionará para JSONObjectRequest também? JSONObjectRequest postRequest = new JSONObjectRequest ...... porque estou fazendo isso e meu getHeaders () não está sendo chamado ... ??? Eu entendo que você está criando uma classe anônima e substituindo os métodos. Estou fazendo exatamente isso com JSONObjectRequest em vez de StringRequest e meu getHeaders () não é chamado.
JDOaktown
Podemos adicionar "Cookie" no método getHeaders () também? Funcionará para solicitações de postagem também?
Arnab Banerjee
Para onde vou enviar o resto dos dados POST?
Fernando Torres
30

Se o que você precisa é postar dados em vez de adicionar as informações na 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;
}

Se o que você deseja fazer é editar os cabeçalhos na solicitação, isto é o que você deseja fazer:

// 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;
  }
}
thepoosh
fonte
44
Eu votei negativamente, pois não era exatamente isso que a pergunta fazia. Isso é para definir o conteúdo POST, não para definir cabeçalhos HTTP personalizados como o User-Agent. Zh. Atanasov e CommonsWare estão corretos com suas getHeadersrespostas.
georgiecasey
4
Eu votei contra esta resposta porque não é isso que o usuário perguntou.
Dharmendra Pratap Singh
1
Isso é para adicionar parâmetros de conteúdo, não cabeçalhos, desculpe também rejeitaram. Realmente não deveria ser a resposta aceita
Juan Cortés,
1
Por favor, você pode dar uma olhada na minha pergunta? É semelhante a isso, mas não consegui acertar stackoverflow.com/a/37948318
X09
18

Você pode ver esta solução. Ele mostra como obter / definir cookies, mas os cookies são apenas um dos cabeçalhos em uma solicitação / resposta. Você deve substituir uma das classes * Request do Volley e definir os cabeçalhos necessários emgetHeaders()


Aqui está a fonte vinculada:

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

}

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

}
Zh. Atanasov
fonte
7

Em Kotlin,

Você deve substituir o método getHeaders () como:

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
            }
        }
devDeejay
fonte
1
Este é o único recurso que encontrei para substituir cabeçalhos em Kotlin. Obrigado!
Mathew Sonke,
@MathewSonke Eu sinto você mano. A propósito, tente Retrofit para redes no Android.
devDeejay
6

Procurando solução para este problema também. veja algo aqui: http://developer.android.com/training/volley/request.html

é uma boa ideia usar diretamente ImageRequest em vez de ImageLoader? Parece que ImageLoader o usa internamente de qualquer maneira. Perde algo importante além do suporte de cache do 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);
lannyf
fonte
Seria muito apreciado e mais útil se você pudesse apontar por que acha que a pergunta está errada ou a solução pedida tem problema, em vez de simplesmente dar um '-1'.
lannyf
1
O mapa é abstrato. Deve ser HashMap
superusuário do
4

tente isso

{
    @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;
       }
};
AntuJorge
fonte
4

Você pode criar uma classe Request personalizada que estenda StringRequest e substituir o método getHeaders () dentro dela, assim:

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;
    }
}
Khashayar Motarjemi
fonte
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;
}

}
Navneet Boghani
fonte
1

Além disso, gostaria de compartilhar algo que descobri sobre Content-Type:

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

Eu tive que adicionar:

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

Não me pergunte por quê, eu apenas pensei que poderia ajudar alguns outros que não conseguem Content-Typeacertar o set.

Jack
fonte
0

Aqui está a configuração de cabeçalhos de amostra do 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);
M.Kouchi
fonte
0

tente isso

 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);
}
Yigit Yuksel
fonte
@Override public Map <String, String> getHeaders () lança AuthFailureError {return headers; }};
Osama Ibrahim
onde está o cabeçalho ??
Osama Ibrahim
No signutare, você pode configurá-lo ao chamar com os cabeçalhos Map <String, String>
Yigit Yuksel
0

Esse é o meu código, não se esqueça de = objeto: se não colocar não funciona

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)
Dave Rincon
fonte