Spring boot 整合 Okhttp3 并封裝請求工具實例 詳解
一、 為什么要使用okHttp
OkHttp是一個高效、靈活、易于使用的HTTP客戶端庫,優(yōu)勢如下:
- 性能更高:OkHttp在網(wǎng)絡請求處理上采用了異步模型,并將連接池、壓縮、網(wǎng)絡協(xié)議等多種技術應用到其中,從而提高了網(wǎng)絡請求的效率和處理速度。
- 功能更強大:OkHttp支持HTTP/2協(xié)議,可以進行數(shù)據(jù)流復用以及服務器推送。同時,OkHttp還支持GZIP壓縮、連接超時設置、緩存、重試等功能,提供了非常豐富的API接口,方便開發(fā)者進行擴展和個性化定制。
- 使用更簡單:OkHttp具有良好的API設計,可以輕松地實現(xiàn)網(wǎng)絡請求的發(fā)送和響應處理。其內置了許多預定義的請求類型,如Get, Post, Head, Put, Delete等,使得開發(fā)者可以快速地進行開發(fā)。
- 兼容性更好:OkHttp的代碼精簡,運行效率高,并且兼容Android平臺和Java平臺,可以在各種場景下進行使用。
OkHttp作為一款成熟、穩(wěn)定、易用的HTTP客戶端庫,擁有較高的性能和多樣化的功能,已被廣泛應用于移動應用開發(fā)、Web服務端開發(fā)等領域。
二、 導入依賴
<!-- okhttp3 依賴 --> <dependency> <groupId>com.squareup.okhttp3</groupId> <artifactId>okhttp</artifactId> <version>4.9.3</version> </dependency>
三、 配置
- 使用okhttp3 是很簡單的,但是需要配置連接池,緩存代理等
- 項目配置,application.yml 文件配置
ok:
http:
connect-timeout: 60
read-timeout: 60
write-timeout: 60
# 連接池中整體的空閑連接的最大數(shù)量
max-idle-connections: 200
# 連接空閑時間最多為 300 秒
keep-alive-duration: 3003.添加 配置應用,連接池,緩存,代理等開啟
import okhttp3.ConnectionPool;
import okhttp3.OkHttpClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
import java.security.KeyManagementException;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.security.cert.CertificateException;
import java.security.cert.X509Certificate;
import java.util.concurrent.TimeUnit;
/**
* @author luoqifeng
*/
@Configuration
public class OkHttpConfiguration {
@Value("${ok.http.connect-timeout}")
private Integer connectTimeout;
@Value("${ok.http.read-timeout}")
private Integer readTimeout;
@Value("${ok.http.write-timeout}")
private Integer writeTimeout;
@Value("${ok.http.max-idle-connections}")
private Integer maxIdleConnections;
@Value("${ok.http.keep-alive-duration}")
private Long keepAliveDuration;
@Bean
public OkHttpClient okHttpClient() {
return new OkHttpClient.Builder()
.sslSocketFactory(sslSocketFactory(), x509TrustManager())
// 是否開啟緩存
.retryOnConnectionFailure(false)
.connectionPool(pool())
.connectTimeout(connectTimeout, TimeUnit.SECONDS)
.readTimeout(readTimeout, TimeUnit.SECONDS)
.writeTimeout(writeTimeout,TimeUnit.SECONDS)
.hostnameVerifier((hostname, session) -> true)
// 設置代理
// .proxy(new Proxy(Proxy.Type.HTTP, new InetSocketAddress("127.0.0.1", 8888)))
// 攔截器
// .addInterceptor()
.build();
}
@Bean
public X509TrustManager x509TrustManager() {
return new X509TrustManager() {
@Override
public void checkClientTrusted(X509Certificate[] chain, String authType)
throws CertificateException {
}
@Override
public void checkServerTrusted(X509Certificate[] chain, String authType)
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 | KeyManagementException e) {
e.printStackTrace();
}
return null;
}
@Bean
public ConnectionPool pool() {
return new ConnectionPool(maxIdleConnections, keepAliveDuration, TimeUnit.SECONDS);
}
}4.配置創(chuàng)建工具類
package cn.wjj.wjjUtils.util;
import jakarta.annotation.PostConstruct;
import lombok.extern.slf4j.Slf4j;
import okhttp3.*;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.Map;
/**
* @author luoqifeng
*/
@Slf4j
@Component
public class OkHttpClientUtil {
private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
private static final MediaType XML = MediaType.parse("application/xml; charset=utf-8");
private static OkHttpClient okHttpClient;
// 為使用靜態(tài)調用異步注入
@Autowired
private OkHttpClient getOkHttpClient;
@PostConstruct
public void init() {
okHttpClient = getOkHttpClient;
}
/**
* get 請求
* @param url 請求url地址
* @return string
* */
public static String doGet(String url) {
return doGet(url, null, null);
}
public static byte[] doGetByte(String url) {
return doGetByte(url, null, null);
}
public static String doPost(String url) {
return doPost(url, null, null);
}
/**
* get 請求
* @param url 請求url地址
* @param params 請求參數(shù) map
* @return string
* */
public static String doGetToParams(String url, Map<String, String> params) {
return doGet(url, params, null);
}
/**
* get 請求
* @param url 請求url地址
* @param headers 請求頭字段 {k1, v1 k2, v2, ...}
* @return string
* */
public static String doGetToHeaders(String url, Map<String, String> headers) {
return doGet(url, null, headers);
}
/**
* get 請求
* @param url 請求url地址
* @param params 請求參數(shù) map
* @param headers 請求頭字段 {k1, v1 k2, v2, ...}
* @return string
* */
public static String doGet(String url, Map<String, String> params, Map<String, String> headers) {
StringBuilder sb = new StringBuilder(url);
if (params != null && params.keySet().size() > 0) {
boolean firstFlag = true;
for (String key : params.keySet()) {
if (firstFlag) {
sb.append("?").append(key).append("=").append(params.get(key));
firstFlag = false;
} else {
sb.append("&").append(key).append("=").append(params.get(key));
}
}
}
Request.Builder builder = new Request.Builder();
if (headers != null && !headers.isEmpty()) {
for (String header:headers.keySet()){
builder.addHeader(header, headers.get(header));
}
}
Request request = builder.url(sb.toString()).build();
log.info("do get request and url[{}]", sb.toString());
return executeBody(request);
}
public static byte[] doGetByte(String url, Map<String, String> params, Map<String, String> headers) {
StringBuilder sb = new StringBuilder(url);
if (params != null && params.keySet().size() > 0) {
boolean firstFlag = true;
for (String key : params.keySet()) {
if (firstFlag) {
sb.append("?").append(key).append("=").append(params.get(key));
firstFlag = false;
} else {
sb.append("&").append(key).append("=").append(params.get(key));
}
}
}
Request.Builder builder = new Request.Builder();
if (headers != null && !headers.isEmpty()) {
for (String header:headers.keySet()){
builder.addHeader(header, headers.get(header));
}
}
Request request = builder.url(sb.toString()).build();
log.info("do get request and url[{}]", sb.toString());
return executeByte(request);
}
/**
* post 請求
* @param url 請求url地址
* @param params 請求參數(shù) map
* @return string
*/
public static String doPostForm(String url, Map<String, String> params) {
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();
log.info("do post request and url[{}]", url);
return execute(request);
}
/**
* post 請求
* @param url 請求url地址
* @param params 請求參數(shù) map
* @param headers 請求頭字段 {k1:v1, k2: v2, ...}
* @return string
*/
public static String doPost(String url, Map<String, String> params, Map<String, String> headers) {
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.Builder requestBuilder = new Request.Builder();
if (headers != null && !headers.isEmpty()) {
for (String header:headers.keySet()){
requestBuilder.addHeader(header, headers.get(header));
}
}
Request request = requestBuilder.url(url).post(builder.build()).build();
log.info("do post request and url[{}]", url);
return execute(request);
}
/**
* post 請求, 請求數(shù)據(jù)為 json 的字符串
* @param url 請求url地址
* @param json 請求數(shù)據(jù), json 字符串
* @return string
*/
public static String doPostJson(String url, String json) {
log.info("do post request and url[{}]", url);
return executePost(url, json, JSON);
}
/**
* post 請求, 請求數(shù)據(jù)為 json 的字符串
* @param url 請求url地址
* @param json 請求數(shù)據(jù), json 字符串
* @param headers 請求頭字段 {k1, v1 k2, v2, ...}
* @return string
*/
public static String doPostJson(String url, String json, Map<String, String> headers) {
log.info("do post request and url[{}]", url);
RequestBody requestBody = RequestBody.create(json, JSON);
Request.Builder builder = new Request.Builder();
if (headers != null && !headers.isEmpty()) {
for (String header:headers.keySet()){
builder.addHeader(header, headers.get(header));
}
}
Request request = builder.url(url).post(requestBody).build();
return execute(request);
}
/**
* post 請求, 請求數(shù)據(jù)為 xml 的字符串
* @param url 請求url地址
* @param xml 請求數(shù)據(jù), xml 字符串
* @return string
*/
public static String doPostXml(String url, String xml) {
log.info("do post request and url[{}]", url);
return executePost(url, xml, XML);
}
private static String executePost(String url, String data, MediaType contentType) {
RequestBody requestBody = RequestBody.create(data ,contentType);
Request request = new Request.Builder().url(url).post(requestBody).build();
return execute(request);
}
private static String execute(Request request) {
Response response = null;
try {
response = okHttpClient.newCall(request).execute();
if (response.isSuccessful()) {
return response.body().string();
}
} catch (Exception e) {
log.error(ExceptionUtils.getStackTrace(e));
} finally {
if (response != null) {
response.close();
}
}
return "";
}
private static String executeBody(Request request) {
Response response = null;
try {
response = okHttpClient.newCall(request).execute();
if (response.body() != null) {
return response.body().string();
}
} catch (Exception e) {
log.error(ExceptionUtils.getStackTrace(e));
} finally {
if (response != null) {
response.close();
}
}
return "";
}
private static byte[] executeByte(Request request) {
Response response = null;
try {
response = okHttpClient.newCall(request).execute();
if (response.isSuccessful()) {
return response.body().bytes();
}
} catch (Exception e) {
log.error(ExceptionUtils.getStackTrace(e));
} finally {
if (response != null) {
response.close();
}
}
return null;
}
}四、 測試
/**
* @author luoqifeng
*/
@RestController
@RequestMapping("test")
public class testController {
@GetMapping("testOkhttp")
public String testOkhttp(){
String s = OkHttpClientUtil.doGet("https://www.baidu.com");
return s;
}
}響應結果:

至此已經(jīng)完成基本的Spring Boot整合 okhttp3 的示例。并使用okhttp3來發(fā)送HTTP請求,然后返回HTTP響應。
到此這篇關于Spring boot 整合 Okhttp3 并封裝請求工具的文章就介紹到這了,更多相關Spring boot 整合 Okhttp3內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
java8 Stream list to Map key 重復 value合并到Collectio的操作
這篇文章主要介紹了java8 Stream list to Map key 重復 value合并到Collectio的操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06
Java如何獲取JSONObject內指定字段key的value值
這篇文章主要介紹了Java如何獲取JSONObject內指定字段key的value值問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-12-12

