okhttp3現(xiàn)在基本都在用的一個(gè)底層網(wǎng)絡(luò)框架。這篇博客主要的目的就是將OKHttp3這個(gè)框架在開(kāi)發(fā)中能用到的地方都記錄下來(lái)，也當(dāng)一個(gè)工具文檔為日后使用時(shí)查找方便。文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-840917.html
vOkHttpUtils
import com.google.gson.Gson; import lombok.extern.slf4j.Slf4j; import okhttp3.*; import javax.net.ssl.SSLContext; import javax.net.ssl.SSLSocketFactory; import javax.net.ssl.TrustManager; import javax.net.ssl.X509TrustManager; import java.io.IOException; import java.net.URLEncoder; import java.security.SecureRandom; import java.security.cert.X509Certificate; import java.util.LinkedHashMap; import java.util.Map; import java.util.concurrent.Semaphore; import java.util.concurrent.TimeUnit; /** * @Author * @Date 2024/3 * @Des */ @Slf4j public class OkHttpUtils { private static volatile OkHttpClient okHttpClient = null; private static volatile Semaphore semaphore = null; private Map<String, String> headerMap; private Map<String, String> paramMap; private String url; private Request.Builder request; /** * 初始化okHttpClient，并且允許https訪問(wèn) */ private OkHttpUtils() { if (okHttpClient == null) { synchronized (OkHttpUtils.class) { if (okHttpClient == null) { TrustManager[] trustManagers = buildTrustManagers(); okHttpClient = new OkHttpClient.Builder() .connectTimeout(15, TimeUnit.SECONDS) .writeTimeout(20, TimeUnit.SECONDS) .readTimeout(20, TimeUnit.SECONDS) .sslSocketFactory(createSSLSocketFactory(trustManagers), (X509TrustManager) trustManagers[0]) .hostnameVerifier((hostName, session) -> true) .retryOnConnectionFailure(true) .build(); addHeader("User-Agent", "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36"); } } } } /** * 用于異步請(qǐng)求時(shí)，控制訪問(wèn)線程數(shù)，返回結(jié)果 * * @return */ private static Semaphore getSemaphoreInstance() { //只能1個(gè)線程同時(shí)訪問(wèn) synchronized (OkHttpUtils.class) { if (semaphore == null) { semaphore = new Semaphore(0); } } return semaphore; } /** * 創(chuàng)建OkHttpUtils * * @return */ public static OkHttpUtils builder() { return new OkHttpUtils(); } /** * 添加url * * @param url * @return */ public OkHttpUtils url(String url) { this.url = url; return this; } /** * 添加參數(shù) * * @param key 參數(shù)名 * @param value 參數(shù)值 * @return */ public OkHttpUtils addParam(String key, String value) { if (paramMap == null) { paramMap = new LinkedHashMap<>(16); } paramMap.put(key, value); return this; } /** * 添加請(qǐng)求頭 * * @param key 參數(shù)名 * @param value 參數(shù)值 * @return */ public OkHttpUtils addHeader(String key, String value) { if (headerMap == null) { headerMap = new LinkedHashMap<>(16); } headerMap.put(key, value); return this; } /** * 初始化get方法 * * @return */ public OkHttpUtils get() { request = new Request.Builder().get(); StringBuilder urlBuilder = new StringBuilder(url); if (paramMap != null) { urlBuilder.append("?"); try { for (Map.Entry<String, String> entry : paramMap.entrySet()) { urlBuilder.append(URLEncoder.encode(entry.getKey(), "utf-8")). append("="). append(URLEncoder.encode(entry.getValue(), "utf-8")). append("&"); } } catch (Exception e) { e.printStackTrace(); } urlBuilder.deleteCharAt(urlBuilder.length() - 1); } request.url(urlBuilder.toString()); return this; } /** * 初始化post方法 * * @param isJsonPost true等于json的方式提交數(shù)據(jù)，類(lèi)似postman里post方法的raw * false等于普通的表單提交 * @return */ public OkHttpUtils post(boolean isJsonPost) { RequestBody requestBody; if (isJsonPost) { String json = ""; if (paramMap != null) { json = GsonUtils.toJSONString(paramMap); // 如果沒(méi)有GsonUtils工具類(lèi)就用下面這行代碼 // json = new Gson().toJson(value) } requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), json); } else { FormBody.Builder formBody = new FormBody.Builder(); if (paramMap != null) { paramMap.forEach(formBody::add); } requestBody = formBody.build(); } request = new Request.Builder().post(requestBody).url(url); return this; } /** * 同步請(qǐng)求 * * @return */ public String sync() { setHeader(request); try { Response response = okHttpClient.newCall(request.build()).execute(); assert response.body() != null; return response.body().string(); } catch (IOException e) { e.printStackTrace(); return "請(qǐng)求失?。? + e.getMessage(); } } /** * 異步請(qǐng)求，有返回值 */ public String async() { StringBuilder buffer = new StringBuilder(""); setHeader(request); okHttpClient.newCall(request.build()).enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { buffer.append("請(qǐng)求出錯(cuò)：").append(e.getMessage()); } @Override public void onResponse(Call call, Response response) throws IOException { assert response.body() != null; buffer.append(response.body().string()); getSemaphoreInstance().release(); } }); try { getSemaphoreInstance().acquire(); } catch (InterruptedException e) { e.printStackTrace(); } return buffer.toString(); } /** * 異步請(qǐng)求，帶有接口回調(diào) * * @param callBack */ public void async(ICallBack callBack) { setHeader(request); okHttpClient.newCall(request.build()).enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { callBack.onFailure(call, e.getMessage()); } @Override public void onResponse(Call call, Response response) throws IOException { assert response.body() != null; callBack.onSuccessful(call, response.body().string()); } }); } /** * 為request添加請(qǐng)求頭 * * @param request */ private void setHeader(Request.Builder request) { if (headerMap != null) { try { for (Map.Entry<String, String> entry : headerMap.entrySet()) { request.addHeader(entry.getKey(), entry.getValue()); } } catch (Exception e) { e.printStackTrace(); } } } /** * 生成安全套接字工廠，用于https請(qǐng)求的證書(shū)跳過(guò) * * @return */ private static SSLSocketFactory createSSLSocketFactory(TrustManager[] trustAllCerts) { SSLSocketFactory ssfFactory = null; try { SSLContext sc = SSLContext.getInstance("SSL"); sc.init(null, trustAllCerts, new SecureRandom()); ssfFactory = sc.getSocketFactory(); } catch (Exception e) { e.printStackTrace(); } return ssfFactory; } private static TrustManager[] buildTrustManagers() { return new TrustManager[]{ new X509TrustManager() { @Override public void checkClientTrusted(X509Certificate[] chain, String authType) { } @Override public void checkServerTrusted(X509Certificate[] chain, String authType) { } @Override public X509Certificate[] getAcceptedIssuers() { return new X509Certificate[]{}; } } }; } /** * 自定義一個(gè)接口回調(diào) */ public interface ICallBack { void onSuccessful(Call call, String data); void onFailure(Call call, String errorMsg); } }
v使用示例
public static void main(String[] args) { // get請(qǐng)求，方法順序按照這種方式，切記選擇post/get一定要放在倒數(shù)第二，同步或者異步倒數(shù)第一，才會(huì)正確執(zhí)行 OkHttpUtils.builder().url("請(qǐng)求地址，http/https都可以") // 有參數(shù)的話添加參數(shù)，可多個(gè) .addParam("參數(shù)名", "參數(shù)值") .addParam("參數(shù)名", "參數(shù)值") // 也可以添加多個(gè) .addHeader("Content-Type", "application/json; charset=utf-8") .get() // 可選擇是同步請(qǐng)求還是異步請(qǐng)求 //.async(); .sync(); // post請(qǐng)求，分為兩種，一種是普通表單提交，一種是json提交 OkHttpUtils.builder().url("請(qǐng)求地址，http/https都可以") // 有參數(shù)的話添加參數(shù)，可多個(gè) .addParam("參數(shù)名", "參數(shù)值") .addParam("參數(shù)名", "參數(shù)值") // 也可以添加多個(gè) .addHeader("Content-Type", "application/json; charset=utf-8") // 如果是true的話，會(huì)類(lèi)似于postman中post提交方式的raw，用json的方式提交，不是表單 // 如果是false的話傳統(tǒng)的表單提交 .post(true) .sync(); // 選擇異步有兩個(gè)方法，一個(gè)是帶回調(diào)接口，一個(gè)是直接返回結(jié)果 OkHttpUtils.builder().url("") .post(false) .async(); OkHttpUtils.builder().url("").post(false).async(new OkHttpUtils.ICallBack() { @Override public void onSuccessful(Call call, String data) { // 請(qǐng)求成功后的處理 } @Override public void onFailure(Call call, String errorMsg) { // 請(qǐng)求失敗后的處理 } }); }
v源碼地址
https://github.com/toutouge/javademosecond/tree/master/hellolearn文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-840917.html
到了這里，關(guān)于Java OkHttp3工具類(lèi)的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
