一個(gè)歷經(jīng)千錘百煉okhttp工具類

這是一個(gè)經(jīng)歷浴血后的OkHttpUtil,那就會(huì)有人問,浴血后發(fā)生了什么變化呢?下面我來介紹下。這個(gè)OkHttpUtil采用了鏈?zhǔn)骄幊?,使用更加的方便,靈活,并且擴(kuò)展性更好,并且在使用的過程中修復(fù)了數(shù)據(jù)類型不匹配的問題,以前的入?yún)?shù)據(jù)Map<String, String> paramMap 都是,都是字符串類型的,這樣就會(huì)在對(duì)接第三方發(fā)起Http請(qǐng)求的,會(huì)存在數(shù)據(jù)類型不匹配的問題,在實(shí)戰(zhàn)中發(fā)現(xiàn)了這個(gè)問題,并且修復(fù),新增了對(duì)圖片上傳和圖片批量處理的功能,特此分享給大家

使用說明,在maven中引入json序列化工具
<dependency>
  <groupId>com.alibaba.fastjson2</groupId>
  <artifactId>fastjson2</artifactId>
  <version>2.0.1</version>
</dependency>
<dependency>
  <groupId>com.squareup.okhttp3</groupId>
  <artifactId>okhttp</artifactId>
  <version>3.10.0</version>
</dependency>

不廢話,直接上代碼
package com.utils;

import com.alibaba.fastjson.JSON;
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.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.security.SecureRandom;
import java.security.cert.X509Certificate;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.Semaphore;
import java.util.concurrent.TimeUnit;

/**
 * 描述: 自定義鏈?zhǔn)阶兂蓪?shí)現(xiàn)OkHttpUtils </br>
 * 時(shí)間: 2020-09-28 11:10  </br>
 * 作者:老王
 */
public class OkHttpUtils {
    //OkHttp客戶端
    private static volatile OkHttpClient okHttpClient = null;
    //OkHttp請(qǐng)求信號(hào)量*/
    private static volatile Semaphore semaphore = null;
    //OkHttp的requestHeader參數(shù)map
    private Map<String, Object> headerMap;
    //OkHttp的request參數(shù)map
    private Map<String, Object> paramMap;
    //OkHttp的請(qǐng)求url
    private String url;
    //OkHttp的Request
    private Request.Builder request;

    /**
     * 初始化okHttpClient,并且允許https訪問
     */
    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í),控制訪問線程數(shù),返回結(jié)果
     *
     * @return
     */
    private static Semaphore getSemaphoreInstance() {
        //只能1個(gè)線程同時(shí)訪問
        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, Object> entry : paramMap.entrySet()) {
                    urlBuilder.append(URLEncoder.encode(entry.getKey(), "utf-8")).
                            append("=").
                            append(URLEncoder.encode(entry.getValue().toString(), "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ù),類似postman里post方法的raw
     *                   false等于普通的表單提交
     * @return
     */
    public OkHttpUtils post(boolean isJsonPost) {
        RequestBody requestBody;
        if (isJsonPost) {
            String json = "";
            if (paramMap != null) {
                json = JSON.toJSONString(paramMap);
            }
            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());
                for (String key : paramMap.keySet()) {
                    formBody.add(key, paramMap.get(key).toString());
                }
            }
            requestBody = formBody.build();
        }
        request = new Request.Builder().post(requestBody).url(url);
        return this;
    }

    /**
     * 上傳文件
     * @param file 文件對(duì)象
     * @param fileName 文件名
     * @return
     * @throws Exception
     */
    public OkHttpUtils uploadFile(File file, String fileName) throws Exception {
        RequestBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("file", fileName, RequestBody.create(MediaType.parse("multipart/form-data"), file))
                .build();
        request = new Request.Builder().post(requestBody).url(url);
        return this;

    }



    /**
     * 上傳文件
     * @param filePath 文件路徑
     * @param fileName 文件名
     * @return
     * @throws Exception
     */
    public OkHttpUtils uploadFile(String filePath, String fileName) throws Exception {
        return uploadFile(new File(filePath), fileName);

    }


    /**
     * 多文件上傳
     * @param filesMap 文件對(duì)象map
     * @return
     * @throws Exception
     */
    public OkHttpUtils uploadFiles(HashMap<String, File> filesMap) throws Exception {
        MultipartBody.Builder builder = new MultipartBody.Builder();
        for (String fileName : filesMap.keySet()) {
            builder.addFormDataPart("file", fileName, RequestBody.create(MediaType.parse("multipart/form-data"), filesMap.get(fileName)));
        }
        RequestBody requestBody = builder.setType(MultipartBody.FORM)
                .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, Object> entry : headerMap.entrySet()) {
                    request.addHeader(entry.getKey(), entry.getValue().toString());
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }


    /**
     * 生成安全套接字工廠,用于https請(qǐng)求的證書跳過
     *
     * @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);

    }
}
使用示例:
import com.utils.OkHttpUtils;
import okhttp3.Call;

/**
 * 描述: OkHttpUtilDemo </br>
 * 時(shí)間: 2021-05-26 11:52  </br>
 * 作者:老王
 */
public class OkHttpUtilDemo {

    public static void main(String[] args) {
        // get請(qǐng)求,方法順序按照這種方式,切記選擇post/get一定要放在倒數(shù)第二,同步或者異步倒數(shù)第一,才會(huì)正確執(zhí)行
        String getData = 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提交
        String postData = 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ì)類似于postman中post提交方式的raw,用json的方式提交,不是表單
                // 如果是false的話傳統(tǒng)的表單提交
                .post(true)
                .sync();

        // 選擇異步有兩個(gè)方法,一個(gè)是帶回調(diào)接口,一個(gè)是直接返回結(jié)果
        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)求失敗后的處理
                    }
                });

        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)求失敗后的處理
            }
        });
    }

}
文件上傳demo
import java.io.File;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * 描述: NFT通用接口封裝util </br>
 * 時(shí)間: 2022-05-09 14:15  </br>
 * 作者:老王
 */
@Component
public class FileUtil {

    private static void upLoadFile() throws Exception {
        File file = new File("D:\\test.json");
        File file1 = new File("D:\\test1.json");
        HashMap<String, File> fileMap = new HashMap<>();
        fileMap.put("test", file);
        fileMap.put("test1", file1);
    //對(duì)文件上傳
        String result = OkHttpUtils.builder().addParam("Authorization", "Client-ID " + UUID.randomUUID())
                .url("http://127.0.0.1:18000/file/uploadsMinio")
                .uploadFiles(fileMap)
                .sync();
        System.out.println(result);

    }

    public static void main(String[] args) throws Exception {
        upLoadFile();
    }

}
自己去試試吧










作者:老王

歡迎關(guān)注微信公眾號(hào) : IT學(xué)習(xí)道場