springboot笔记示例一：okhttp正确姿势

pom.xml添加依赖

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

OkHttpConfiguration.java

package cn.cuiot.municipal.gather.utils;

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;

import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSocketFactory;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import okhttp3.ConnectionPool;
import okhttp3.OkHttpClient;

/**
 * @Title: OkHttpConfiguration.java
 * @Package: cn.cuiot.municipal.gather.utils
 * @Description: okhttp配置类
 * @author: 逆天-逍遥哥哥
 * @date: 2022年12月26日 下午1:22:04
 * @version: V1.0
 * @Copyright: nit逆天开源版权
 */
@Slf4j
@Component
@ConfigurationProperties(prefix = "okhttp") // 使用前缀标明具体的属性
@Data
public class OkHttpConfiguration {

	@Value("${connect-timeout:30}")
	private Integer connectTimeout;

	@Value("${read-timeout:30}")
	private Integer readTimeout;

	@Value("${write-timeout:30}")
	private Integer writeTimeout;

	@Value("${max-idle-connections:200}")
	private Integer maxIdleConnections;

	@Value("${keep-alive-duration:300}")
	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", 6666)))
				// 拦截器
//                .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);
	}
}

yml配置

#如果不配置则走默认值
okhttp:
  connect-timeout: 30
  read-timeout: 30
  write-timeout: 30
# 连接池中整体的空闲连接的最大数量
  max-idle-connections: 200
# 连接空闲时间最多为 300 秒
  keep-alive-duration: 300

OkHttpHelper.java编写

package cn.cuiot.municipal.gather.utils;

import java.io.IOException;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import com.alibaba.nacos.common.utils.Objects;

import lombok.extern.slf4j.Slf4j;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.FormBody;
import okhttp3.Headers;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
import okhttp3.ResponseBody;
/**
 * 
 * @Title: OkHttpHelper.java
 * @Package: cn.cuiot.municipal.gather.utils
 * @Description: OkHttp工具类
 * @author: 逆天-逍遥哥哥
 * @date: 2022年12月26日 下午1:21:17
 * @version: V1.0
 * @Copyright: 版权
 */
@Slf4j
@Component
public class OkHttpHelper {
	private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
	private static final MediaType XML = MediaType.parse("application/xml; charset=utf-8");

	@Autowired
	private OkHttpClient okHttpClient;

	/**
	 * get 请求
	 * 
	 * @param url 请求url地址
	 * @return string
	 */
	public String doGet(String url) {
		return doGet(url, null, null);
	}

	/**
	 * get 请求
	 * 
	 * @param url    请求url地址
	 * @param params 请求参数 map
	 * @return string
	 */
	public String doGet(String url, Map<String, String> params) {
		return doGet(url, params, null);
	}

	/**
	 * get 请求
	 * 
	 * @param url     请求url地址
	 * @param headers 请求头字段 {k1, v1 k2, v2, ...}
	 * @return string
	 */
	public String doGet(String url, Headers headers) {
		return doGet(url, null, headers);
	}

	/**
	 * get 请求
	 * 
	 * @param url     请求url地址
	 * @param params  请求参数 map
	 * @param headers 请求头字段 {k1, v1 k2, v2, ...}
	 * @return string
	 */
	public String doGet(String url, Map<String, String> params, Headers 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();
		Request request = builder.url(sb.toString()).build();

		if (Objects.nonNull(headers)) {
			builder.headers(headers);
		}
		log.info("do get request and url[{}]", sb.toString());
		return execute(request);
	}

	/**
	 * post 请求
	 * 
	 * @param url    请求url地址
	 * @param params 请求参数 map
	 * @return string
	 */
	public String doPost(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[{}] and params = {}", url, params);

		return execute(request);
	}

	/**
	 * post 请求, 请求数据为 json 的字符串
	 * 
	 * @param url  请求url地址
	 * @param json 请求数据, json 字符串
	 * @return string
	 */
	public String doPostJson(String url, String json) {
		log.info("do post request and url[{}]and json[{json}]", url);
		return exectePost(url, json, JSON);
	}

	/**
	 * post 请求, 请求数据为 xml 的字符串
	 * 
	 * @param url 请求url地址
	 * @param xml 请求数据, xml 字符串
	 * @return string
	 */
	public String doPostXml(String url, String xml) {
		log.info("do post request and url[{}]", url);
		return exectePost(url, xml, XML);
	}

	private String exectePost(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 String execute(Request request) {
		Response response = null;
		try {
			response = okHttpClient.newCall(request).execute();
			ResponseBody result = response.body();
			String resutlStr = result.string();
			log.info("okhttp.result=={}", resutlStr);
			return resutlStr;
		} catch (Exception e) {
			e.printStackTrace();
		} finally {
			if (response != null) {
				response.close();
			}
		}
		return "";
	}

	/**
	 * 开启异步线程访问
	 * @param request
	 * @param responseCallback
	 */
	public void enqueue(Request request, Callback responseCallback) {
		okHttpClient.newCall(request).enqueue(responseCallback);
	}

	/**
	 * 开启异步线程访问网络, 且不在意返回结果（实现空callback）
	 * @param request
	 */
	private void enqueue(Request request) {
		okHttpClient.newCall(request).enqueue(new Callback() {
			@Override
			public void onFailure(Call call, IOException e) {
				log.error("", e);
			}
			@Override
			public void onResponse(Call call, Response response) throws IOException {
				if (response.isSuccessful()) {
					log.info("Successful data acquisition . . . ");
					log.info("response.code()==" + response.code());
					log.info("response.body().string()==" + response.body().string());
				}
			}
		});
	}
}

引用示例

	@Autowired
	private OkHttpHelper okHttpHelper;

    String url = "http://www.baidu.com";
    String res = okHttpHelper.doGet(hccUrl + url);
    JSONObject jb = JSONObject.parseObject(res);
	// header 示例
	private String get(String url, Map<String, Object> params) {
		Headers.Builder headersbuilder = new Headers.Builder();
		headersbuilder.add("Authorization", this.getToken());
		Headers headers = headersbuilder.build();
		return okHttpHelper.doGet(hccUrl + url, params, headers);
	}