web-dev-qa-db-de.com

Wie füge ich allen HttpClient-Anforderungsmethoden Parameter hinzu?

Ich schreibe einen Java-Code, der Apache HttpClient version 4.2.2 verwendet, um auf eine RESTful-API eines Drittanbieters zuzugreifen. Diese API verfügt über Methoden, die HTTP GET, POST, PUT und DELETE verwenden. Es ist wichtig zu beachten, dass ich eine 4.x.x-Version und keine 3.x.x-Version verwende, da sich die API stark von 3 auf 4 geändert hat. Alle relevanten Beispiele, die ich gefunden habe, betrafen eine 3.x.x-Version.

Für alle API-Aufrufe muss der api_key als Parameter angegeben werden (unabhängig davon, welche Methode Sie verwenden). Dies bedeutet, dass unabhängig davon, ob ich ein GET, POST oder ein anderes mache, ich diesen api_key angeben muss, damit der Aufruf serverseitig authentifiziert werden kann.

// Have to figure out a way to get this into my HttpClient call,
// regardless of whether I'm using: HttpGet, HttpPost, HttpPut
// or HttpDelete...
String api_key = "blah-whatever-my-unique-api-key";

Ich versuche also herauszufinden, wie ich HttpClient mit dem api_key versorgen kann, unabhängig von meiner Anforderungsmethode (was wiederum davon abhängt, welche RESTful-API-Methode ich zu treffen versuche). Es sieht so aus, als ob HttpGet nicht einmal support die Vorstellung von Parametern unterstützt, und HttpPost verwendet etwas, das als HttpParams bezeichnet wird; Aber auch diese HttpParams scheint nur in der 3.x.x-Version von HttpClient zu existieren.

Also frage ich: Was ist die richtige v4.2.2-Methode, um meinen api_key-String an alle vier anzuhängen/hinzuzufügen :

  • HttpGet
  • HttpPost
  • HttpPut
  • HttpDelete

Danke im Voraus.

10
user1768830

Sie können URIBuilder class verwenden, um den Anforderungs-URI für alle HTTP-Methoden zu erstellen. Der URI-Builder bietet die Methode setParameter zum Festlegen des Parameters.

URIBuilder builder = new URIBuilder();
builder.setScheme("http").setHost("www.google.com").setPath("/search")
    .setParameter("q", "httpclient")
    .setParameter("btnG", "Google Search")
    .setParameter("aq", "f")
    .setParameter("oq", "");
URI uri = builder.build();
HttpGet httpget = new HttpGet(uri);
System.out.println(httpget.getURI());

Die Ausgabe sollte sein

http://www.google.com/search?q=httpclient&btnG=Google+Search&aq=f&oq= 
18

Sie können diesen Ansatz auch verwenden, wenn Sie einige http-Parameter übergeben und eine Json-Anfrage senden möchten:

(Hinweis: Ich habe in einigen zusätzlichen Code nur hinzugefügt, wenn es anderen zukünftigen Lesern hilft und Importe von org.Apache.http Client-Bibliotheken sind.)

public void postJsonWithHttpParams() throws URISyntaxException, UnsupportedEncodingException, IOException {

    //add the http parameters you wish to pass
    List<NameValuePair> postParameters = new ArrayList<>();
    postParameters.add(new BasicNameValuePair("param1", "param1_value"));
    postParameters.add(new BasicNameValuePair("param2", "param2_value"));

    //Build the server URI together with the parameters you wish to pass
    URIBuilder uriBuilder = new URIBuilder("http://google.ug");
    uriBuilder.addParameters(postParameters);

    HttpPost postRequest = new HttpPost(uriBuilder.build());
    postRequest.setHeader("Content-Type", "application/json");

    //this is your JSON string you are sending as a request
    String yourJsonString = "{\"str1\":\"a value\",\"str2\":\"another value\"} ";

    //pass the json string request in the entity
    HttpEntity entity = new ByteArrayEntity(yourJsonString.getBytes("UTF-8"));
    postRequest.setEntity(entity);

    //create a socketfactory in order to use an http connection manager
    PlainConnectionSocketFactory plainSocketFactory = PlainConnectionSocketFactory.getSocketFactory();
    Registry<ConnectionSocketFactory> connSocketFactoryRegistry = RegistryBuilder.<ConnectionSocketFactory>create()
            .register("http", plainSocketFactory)
            .build();

    PoolingHttpClientConnectionManager connManager = new PoolingHttpClientConnectionManager(connSocketFactoryRegistry);

    connManager.setMaxTotal(20);
    connManager.setDefaultMaxPerRoute(20);

    RequestConfig defaultRequestConfig = RequestConfig.custom()
            .setSocketTimeout(HttpClientPool.connTimeout)
            .setConnectTimeout(HttpClientPool.connTimeout)
            .setConnectionRequestTimeout(HttpClientPool.readTimeout)
            .build();

    // Build the http client.
    CloseableHttpClient httpclient = HttpClients.custom()
            .setConnectionManager(connManager)
            .setDefaultRequestConfig(defaultRequestConfig)
            .build();

    CloseableHttpResponse response = httpclient.execute(postRequest);

    //Read the response
    String responseString = "";

    int statusCode = response.getStatusLine().getStatusCode();
    String message = response.getStatusLine().getReasonPhrase();

    HttpEntity responseHttpEntity = response.getEntity();

    InputStream content = responseHttpEntity.getContent();

    BufferedReader buffer = new BufferedReader(new InputStreamReader(content));
    String line;

    while ((line = buffer.readLine()) != null) {
        responseString += line;
    }

    //release all resources held by the responseHttpEntity
    EntityUtils.consume(responseHttpEntity);

    //close the stream
    response.close();

    // Close the connection manager.
    connManager.close();
}
2
Arthur

Eine wichtige Sache hier ist, explizit die Apache-Pakete anzugeben, die Sie verwenden müssen, da es verschiedene Möglichkeiten gibt, eine Get-Anfrage zu implementieren. 

Sie können beispielsweise Apache Commons oder HttpComponents verwenden. In diesem Beispiel verwende ich HttpComponents (org.Apache.http.*)

Klasse anfordern:

package request;

import Java.io.IOException;
import Java.net.URI;
import Java.net.URISyntaxException;

import org.Apache.http.client.methods.CloseableHttpResponse;
import org.Apache.http.client.methods.HttpGet;
import org.Apache.http.client.utils.URIBuilder;
import org.Apache.http.impl.client.CloseableHttpClient;
import org.Apache.http.impl.client.HttpClients;

import Task;

public void sendRequest(Task task) throws URISyntaxException {

    URIBuilder uriBuilder = new URIBuilder();
    uriBuilder.setScheme("http")
            .setHost("localhost")
            .setPort(8080)
            .setPath("/TesteHttpRequest/TesteDoLucas")
            .addParameter("className", task.getClassName())
            .addParameter("dateExecutionBegin", task.getDateExecutionBegin())
            .addParameter("dateExecutionEnd", task.getDateExecutionEnd())
            .addParameter("lastDateExecution", task.getDateLastExecution())
            .addParameter("numberExecutions", Integer.toString(task.getNumberExecutions()))
            .addParameter("idTask", Integer.toString(task.getIdTask()))
            .addParameter("numberExecutions" , Integer.toString(task.getNumberExecutions()));
    URI uri = uriBuilder.build();

    HttpGet getMethod = new HttpGet(uri);

    CloseableHttpClient httpclient = HttpClients.createDefault();

    CloseableHttpResponse response = null;

    try {
        response = httpclient.execute(getMethod);
    } catch (IOException e) {
        //handle this IOException properly in the future
    } catch (Exception e) {
        //handle this IOException properly in the future
    }
}

Ich verwende Tomcat v7.0 Server. Die Klasse oben empfängt eine Aufgabe und sendet sie an ein bestimmtes Servlet im Link http: // localhost: 8080/TesteHttpRequest/TesteDoLucas

Mein Dynamic Web-Projekt hat den Namen TesteHttpRequest und mein Servlet nimmt an der URL / TesteDoLucas teil.

Aufgabenklasse:

package bean;

public class Task {

    private int idTask;
    private String taskDescription;
    private String dateExecutionBegin;
    private String dateExecutionEnd;
    private String dateLastExecution;
    private int numberExecutions;
    private String className;

    public int getIdTask() {
        return idTask;
    }

    public void setIdTask(int idTask) {
        this.idTask = idTask;
    }

    public String getTaskDescription() {
        return taskDescription;
    }

    public void setTaskDescription(String taskDescription) {
        this.taskDescription = taskDescription;
    }

    public String getDateExecutionBegin() {
        return dateExecutionBegin;
    }

    public void setDateExecutionBegin(String dateExecutionBegin) {
        this.dateExecutionBegin = dateExecutionBegin;
    }

    public String getDateExecutionEnd() {
        return dateExecutionEnd;
    }

    public void setDateExecutionEnd(String dateExecutionEnd) {
        this.dateExecutionEnd = dateExecutionEnd;
    }

    public String getDateLastExecution() {
        return dateLastExecution;
    }

    public void setDateLastExecution(String dateLastExecution) {
        this.dateLastExecution = dateLastExecution;
    }

    public int getNumberExecutions() {
        return numberExecutions;
    }

    public void setNumberExecutions(int numberExecutions) {
        this.numberExecutions = numberExecutions;
    }

    public String getClassName() {
        return className;
    }

    public void setClassName(String className) {
        this.className = className;
    }
}

Servlet-Klasse:

package servlet;

import Java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@WebServlet("/TesteDoLucas")
public class TesteHttpRequestServlet extends HttpServlet {
     private static final long serialVersionUID = 1L;

     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        String query = request.getQueryString();
        System.out.println(query);
     }

     protected void doPost(HttpServletRequest request, HttpServletResponse   response) throws ServletException, IOException {
        doGet(request, response);
        }
    }

Die gesendeten Abfrageparameter werden an der Konsole angezeigt.

klassenname = Java.Autil.Objekte% 3B & DatumExecutionBegin = 2016% 2F04% 2F07 + 22% 3A22% 3A22 & DatumExecutionEnd = 2016% 2F04% 2F07 + 06% 3A06% 3A06 & LastDateExecution = 2016% 2F04% 2F07 + 10% 10

Um die Kodierung zu korrigieren, können Sie hier nachsehen: HttpServletRequest UTF-8-Kodierung

0