spring集成okhttp3的步驟詳解

2024-07-14 08:40:17

字體：大中小

來源：轉載

供稿：網友

前言

okhttp 介紹

HTTP is the way modern applications network. It's how we exchange data & media. >Doing HTTP efficiently makes your stuff load faster and saves bandwidth.

OkHttp is an HTTP client that's efficient by default:

HTTP/2 support allows all requests to the same host to share a socket.
Connection pooling reduces request latency (if HTTP/2 isn't available).
Transparent GZIP shrinks download sizes.
Response caching avoids the network completely for repeat requests.
OkHttp perseveres when the network is troublesome: it will silently recover from > >common connection problems. If your service has multiple IP addresses OkHttp will >attempt alternate addresses if the first connect fails. This is necessary for IPv4+IPv6 >and for services hosted in redundant data centers. OkHttp initiates new connections >with modern TLS features (SNI, ALPN), and falls back to TLS 1.0 if the handshake fails.

Using OkHttp is easy. Its request/response API is designed with fluent builders and immutability. It supports both synchronous blocking calls and async calls with callbacks.

OkHttp supports Android 2.3 and above. For Java, the minimum requirement is 1.7. —摘自 https://square.github.io/okhttp/

特點

1.支持http和https協議,api相同,易用;

2.http使用線程池,https使用多路復用;

3.okhttp支持同步和異步調用;

4.支持普通form和文件上傳form;

5.提供了攔截器,操作請求和響應(日志,請求頭,body等);

6.okhttp可以設置緩存;

準備工作

在pom.xml文件中增加以下依賴

<dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>3.6.0</version></dependency>

書寫配置類

用@Configuration注解該類，等價與XML中配置beans；用@Bean標注方法等價于XML中配置bean。

@Configurationpublic class OkHttpConfiguration { @Bean public X509TrustManager x509TrustManager() { return new X509TrustManager() {  @Override  public void checkClientTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException {  }  @Override  public void checkServerTrusted(X509Certificate[] x509Certificates, String s) throws CertificateException {  }  @Override  public X509Certificate[] getAcceptedIssuers() {  return new X509Certificate[0];  } }; } @Bean public SSLSocketFactory sslSocketFactory() { try {  //信任任何鏈接  SSLContext sslContext = SSLContext.getInstance("TLS");  sslContext.init(null, new TrustManager[]{x509TrustManager()}, new SecureRandom());  return sslContext.getSocketFactory(); } catch (NoSuchAlgorithmException e) {  e.printStackTrace(); } catch (KeyManagementException e) {  e.printStackTrace(); } return null; } /** * Create a new connection pool with tuning parameters appropriate for a single-user application. * The tuning parameters in this pool are subject to change in future OkHttp releases. Currently */ @Bean public ConnectionPool pool() { return new ConnectionPool(200, 5, TimeUnit.MINUTES); } @Bean public OkHttpClient okHttpClient() { return new OkHttpClient.Builder()  .sslSocketFactory(sslSocketFactory(), x509TrustManager())  .retryOnConnectionFailure(false)//是否開啟緩存  .connectionPool(pool())//連接池  .connectTimeout(10L, TimeUnit.SECONDS)  .readTimeout(10L, TimeUnit.SECONDS)  .build(); }}

工具類

自己寫的工具類，比較簡單，不是REST風格

@Componentpublic class OkHttpUtil { private static final Logger logger = LoggerFactory.getLogger(OkHttpUtil.class); @Resource private OkHttpClient okHttpClient; /** * get * * @param url 請求的url * @param queries 請求的參數，在瀏覽器？后面的數據，沒有可以傳null * @return */ public String get(String url, Map<String, String> queries) { String responseBody = ""; StringBuffer sb = new StringBuffer(url); if (queries != null && queries.keySet().size() > 0) {  boolean firstFlag = true;  Iterator iterator = queries.entrySet().iterator();  while (iterator.hasNext()) {  Map.Entry entry = (Map.Entry<String, String>) iterator.next();  if (firstFlag) {   sb.append("?" + entry.getKey() + "=" + entry.getValue());   firstFlag = false;  } else {   sb.append("&" + entry.getKey() + "=" + entry.getValue());  }  } } Request request = new Request  .Builder()  .url(sb.toString())  .build(); Response response = null; try {  response = okHttpClient.newCall(request).execute();  int status = response.code();  if (status == 200) {  return response.body().string();  } } catch (Exception e) {  logger.error("okhttp put error >> ex = {}", ExceptionUtils.getStackTrace(e)); } finally {  if (response != null) {  response.close();  } } return responseBody; } /** * post * * @param url 請求的url * @param params post form 提交的參數 * @return */ public String post(String url, Map<String, String> params) { String responseBody = ""; FormBody.Builder builder = new FormBody.Builder(); //添加參數 if (params != null && params.keySet().size() > 0) {  for (String key : params.keySet()) {  builder.add(key, params.get(key));  } } Request request = new Request  .Builder()  .url(url)  .post(builder.build())  .build(); Response response = null; try {  response = okHttpClient.newCall(request).execute();  int status = response.code();  if (status == 200) {  return response.body().string();  } } catch (Exception e) {  logger.error("okhttp post error >> ex = {}", ExceptionUtils.getStackTrace(e)); } finally {  if (response != null) {  response.close();  } } return responseBody; } /** * post 上傳文件 * * @param url * @param params * @param fileType * @return */ public String postFile(String url, Map<String, Object> params, String fileType) { String responseBody = ""; MultipartBody.Builder builder = new MultipartBody.Builder(); //添加參數 if (params != null && params.keySet().size() > 0) {  for (String key : params.keySet()) {  if (params.get(key) instanceof File) {   File file = (File) params.get(key);   builder.addFormDataPart(key, file.getName(), RequestBody.create(MediaType.parse(fileType), file));   continue;  }  builder.addFormDataPart(key, params.get(key).toString());  } } Request request = new Request  .Builder()  .url(url)  .post(builder.build())  .build(); Response response = null; try {  response = okHttpClient.newCall(request).execute();  int status = response.code();  if (status == 200) {  return response.body().string();  } } catch (Exception e) {  logger.error("okhttp postFile error >> ex = {}", ExceptionUtils.getStackTrace(e)); } finally {  if (response != null) {  response.close();  } } return responseBody; }}

使用方法