HTTP客户端链接，选择HttpClient仍是OkHttp？

时间 2020-01-09

标签 http 客户端链接选择 httpclient 仍是 okhttp 栏目 HTTP/TCP 繁體版

原文原文链接

写在前面

为何会写这篇文章，原由于和朋友的聊天 java

这又触及到个人知识盲区了，首先来一波面向百度学习，直接根据关键字httpclient和okhttp的区别、性能比较进行搜索，没有找到想要的答案，因而就去overstackflow上看看是否是有人问过这个问题，果真不会让你失望的

因此从使用、性能、超时配置方面进行比较

使用

HttpClient和OkHttp通常用于调用其它服务，通常服务暴露出来的接口都为http，http经常使用请求类型就为GET、PUT、POST和DELETE，所以主要介绍这些请求类型的调用git

HttpClient使用介绍

使用HttpClient发送请求主要分为一下几步骤：github

建立 CloseableHttpClient对象或CloseableHttpAsyncClient对象，前者同步，后者为异步
建立Http请求对象
调用execute方法执行请求，若是是异步请求在执行以前需调用start方法

建立链接：docker

CloseableHttpClient httpClient = HttpClientBuilder.create().build();
复制代码

该链接为同步链接apache

GET请求：json

@Test
public void testGet() throws IOException {
    String api = "/api/files/1";
    String url = String.format("%s%s", BASE_URL, api);
    HttpGet httpGet = new HttpGet(url);
    CloseableHttpResponse response = httpClient.execute(httpGet);
    System.out.println(EntityUtils.toString(response.getEntity()));
}
复制代码

使用HttpGet表示该链接为GET请求，HttpClient调用execute方法发送GET请求windows

PUT请求：api

@Test
public void testPut() throws IOException {
    String api = "/api/user";
    String url = String.format("%s%s", BASE_URL, api);
    HttpPut httpPut = new HttpPut(url);
    UserVO userVO = UserVO.builder().name("h2t").id(16L).build();
    httpPut.setHeader("Content-Type", "application/json;charset=utf8");
    httpPut.setEntity(new StringEntity(JSONObject.toJSONString(userVO), "UTF-8"));
    CloseableHttpResponse response = httpClient.execute(httpPut);
    System.out.println(EntityUtils.toString(response.getEntity()));
}
复制代码

POST请求：bash

添加对象

@Test
public void testPost() throws IOException {
    String api = "/api/user";
    String url = String.format("%s%s", BASE_URL, api);
    HttpPost httpPost = new HttpPost(url);
    UserVO userVO = UserVO.builder().name("h2t2").build();
    httpPost.setHeader("Content-Type", "application/json;charset=utf8");
    httpPost.setEntity(new StringEntity(JSONObject.toJSONString(userVO), "UTF-8"));
    CloseableHttpResponse response = httpClient.execute(httpPost);
    System.out.println(EntityUtils.toString(response.getEntity()));
}
复制代码

该请求是一个建立对象的请求，须要传入一个json字符串

上传文件

@Test
public void testUpload1() throws IOException {
    String api = "/api/files/1";
    String url = String.format("%s%s", BASE_URL, api);
    HttpPost httpPost = new HttpPost(url);
    File file = new File("C:/Users/hetiantian/Desktop/学习/docker_practice.pdf");
    FileBody fileBody = new FileBody(file);
    MultipartEntityBuilder builder = MultipartEntityBuilder.create();
    builder.setMode(HttpMultipartMode.BROWSER_COMPATIBLE);
    builder.addPart("file", fileBody);  //addPart上传文件
    HttpEntity entity = builder.build();
    httpPost.setEntity(entity);
    CloseableHttpResponse response = httpClient.execute(httpPost);
    System.out.println(EntityUtils.toString(response.getEntity()));
}
复制代码

经过addPart上传文件

DELETE请求：app

@Test
public void testDelete() throws IOException {
    String api = "/api/user/12";
    String url = String.format("%s%s", BASE_URL, api);
    HttpDelete httpDelete = new HttpDelete(url);
    CloseableHttpResponse response = httpClient.execute(httpDelete);
    System.out.println(EntityUtils.toString(response.getEntity()));
}
复制代码

请求的取消：

@Test
public void testCancel() throws IOException {
    String api = "/api/files/1";
    String url = String.format("%s%s", BASE_URL, api);
    HttpGet httpGet = new HttpGet(url);
    httpGet.setConfig(requestConfig);  //设置超时时间
    //测试链接的取消

    long begin = System.currentTimeMillis();
    CloseableHttpResponse response = httpClient.execute(httpGet);
    while (true) {
        if (System.currentTimeMillis() - begin > 1000) {
          httpGet.abort();
          System.out.println("task canceled");
          break;
      }
    }

    System.out.println(EntityUtils.toString(response.getEntity()));
}
复制代码

调用abort方法取消请求执行结果：

task canceled
cost 8098 msc
Disconnected from the target VM, address: '127.0.0.1:60549', transport: 'socket'

java.net.SocketException: socket closed...【省略】
复制代码

OkHttp使用

使用OkHttp发送请求主要分为一下几步骤：

建立OkHttpClient对象
建立Request对象
将Request 对象封装为Call
经过Call 来执行同步或异步请求，调用execute方法同步执行，调用enqueue方法异步执行

建立链接：

private OkHttpClient client = new OkHttpClient();
复制代码

GET请求：

@Test
public void testGet() throws IOException {
    String api = "/api/files/1";
    String url = String.format("%s%s", BASE_URL, api);
    Request request = new Request.Builder()
            .url(url)
            .get() 
            .build();
    final Call call = client.newCall(request);
    Response response = call.execute();
    System.out.println(response.body().string());
}
复制代码

PUT请求：

@Test
public void testPut() throws IOException {
    String api = "/api/user";
    String url = String.format("%s%s", BASE_URL, api);
    //请求参数
    UserVO userVO = UserVO.builder().name("h2t").id(11L).build();
    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"),
    JSONObject.toJSONString(userVO));
    Request request = new Request.Builder()
            .url(url)
            .put(requestBody)
            .build();
    final Call call = client.newCall(request);
    Response response = call.execute();
    System.out.println(response.body().string());
}
复制代码

POST请求：

添加对象

@Test
public void testPost() throws IOException {
    String api = "/api/user";
    String url = String.format("%s%s", BASE_URL, api);
    //请求参数
    JSONObject json = new JSONObject();
    json.put("name", "hetiantian");
    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"),     String.valueOf(json));
    Request request = new Request.Builder()
            .url(url)
            .post(requestBody) //post请求
           .build();
    final Call call = client.newCall(request);
    Response response = call.execute();
    System.out.println(response.body().string());
}
复制代码

上传文件

@Test
public void testUpload() throws IOException {
    String api = "/api/files/1";
    String url = String.format("%s%s", BASE_URL, api);
    RequestBody requestBody = new MultipartBody.Builder()
            .setType(MultipartBody.FORM)
            .addFormDataPart("file", "docker_practice.pdf",
                    RequestBody.create(MediaType.parse("multipart/form-data"),
                            new File("C:/Users/hetiantian/Desktop/学习/docker_practice.pdf")))
            .build();
    Request request = new Request.Builder()
            .url(url)
            .post(requestBody)  //默认为GET请求，能够不写
            .build();
    final Call call = client.newCall(request);
    Response response = call.execute();
    System.out.println(response.body().string());
}
复制代码

经过addFormDataPart方法模拟表单方式上传文件

DELETE请求：

@Test
public void testDelete() throws IOException {
  String url = String.format("%s%s", BASE_URL, api);
  //请求参数
  Request request = new Request.Builder()
          .url(url)
          .delete()
          .build();
  final Call call = client.newCall(request);
  Response response = call.execute();
  System.out.println(response.body().string());
}
复制代码

请求的取消：

@Test
public void testCancelSysnc() throws IOException {
    String api = "/api/files/1";
    String url = String.format("%s%s", BASE_URL, api);
    Request request = new Request.Builder()
            .url(url)
            .get()  
            .build();
    final Call call = client.newCall(request);
    Response response = call.execute();
    long start = System.currentTimeMillis();
    //测试链接的取消
    while (true) {
         //1分钟获取不到结果就取消请求
        if (System.currentTimeMillis() - start > 1000) {
            call.cancel();
            System.out.println("task canceled");
            break;
        }
    }

    System.out.println(response.body().string());
}
复制代码

调用cancel方法进行取消测试结果：

task canceled
cost 9110 msc

java.net.SocketException: socket closed...【省略】
复制代码

小结

OkHttp使用build模式建立对象来的更简洁一些，而且使用.post/.delete/.put/.get方法表示请求类型，不须要像HttpClient建立HttpGet、HttpPost等这些方法来建立请求类型

依赖包上，若是HttpClient须要发送异步请求、实现文件上传，须要额外的引入异步请求依赖

<!---文件上传-->
 <dependency>
     <groupId>org.apache.httpcomponents</groupId>
     <artifactId>httpmime</artifactId>
     <version>4.5.3</version>
 </dependency>
 <!--异步请求-->
 <dependency>
     <groupId>org.apache.httpcomponents</groupId>
     <artifactId>httpasyncclient</artifactId>
     <version>4.5.3</version>
 </dependency>
复制代码

请求的取消，HttpClient使用abort方法，OkHttp使用cancel方法，都挺简单的，若是使用的是异步client，则在抛出异常时调用取消请求的方法便可

超时设置

HttpClient超时设置：
在HttpClient4.3+版本以上，超时设置经过RequestConfig进行设置

private CloseableHttpClient httpClient = HttpClientBuilder.create().build();
private RequestConfig requestConfig =  RequestConfig.custom()
        .setSocketTimeout(60 * 1000)
        .setConnectTimeout(60 * 1000).build();
String api = "/api/files/1";
String url = String.format("%s%s", BASE_URL, api);
HttpGet httpGet = new HttpGet(url);
httpGet.setConfig(requestConfig);  //设置超时时间
复制代码

超时时间是设置在请求类型HttpGet上，而不是HttpClient上

OkHttp超时设置：
直接在OkHttp上进行设置

private OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(60, TimeUnit.SECONDS)//设置链接超时时间
        .readTimeout(60, TimeUnit.SECONDS)//设置读取超时时间
        .build();
复制代码

小结：
若是client是单例模式，HttpClient在设置超时方面来的更灵活，针对不一样请求类型设置不一样的超时时间，OkHttp一旦设置了超时时间，全部请求类型的超时时间也就肯定

HttpClient和OkHttp性能比较

测试环境：

CPU 六核
内存 8G
windows10

每种测试用例都测试五次，排除偶然性

client链接为单例：

client链接不为单例：

单例模式下，HttpClient的响应速度要更快一些，单位为毫秒，性能差别相差不大非单例模式下，OkHttp的性能更好，HttpClient建立链接比较耗时，由于多数状况下这些资源都会写成单例模式，所以图一的测试结果更具备参考价值

总结

OkHttp和HttpClient在性能和使用上不分伯仲，根据实际业务选择便可
最后附：示例代码，欢迎fork与star*
很久没有对外输出文章了

主要是写的前两篇没有人看，受打击了，急需网友的确定【 点赞呀】