OkHttp学习及简单工具类封装

心已赠人 2023-07-18 12:40 14阅读 0赞

[OkHtt官网][OkHtt]  
[OkHttp github][]

工作中需要调用三方接口，请求参数一般为json，返回结果也为json  
使用版本

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

官方最新版： 4.4.0  
utils用到的其他依赖

<dependency>
                <groupId>com.google.guava</groupId>
                <artifactId>guava</artifactId>
                <version>20.0</version>
            </dependency>
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.46</version>
            </dependency>

HttpUtils

package com.xk.pre.agent.utils;
    
    import com.alibaba.fastjson.JSONObject;
    import com.google.gson.JsonObject;
    import okhttp3.*;
    
    import java.io.IOException;
    import java.security.SecureRandom;
    import java.security.cert.CertificateException;
    import java.security.cert.X509Certificate;
    import java.util.*;
    import java.util.concurrent.TimeUnit;
    
    import javax.net.ssl.HostnameVerifier;
    import javax.net.ssl.SSLContext;
    import javax.net.ssl.SSLSession;
    import javax.net.ssl.SSLSocketFactory;
    import javax.net.ssl.TrustManager;
    import javax.net.ssl.X509TrustManager;
    
    import okhttp3.Call;
    import okhttp3.OkHttpClient;
    import okhttp3.Request;
    import okhttp3.RequestBody;
    import okhttp3.Response;
    import org.junit.Test;
    
    
    /** * @author : wh * @date : 2020/3/259:42 * @Description : */
    public class HttpUtils { 
    
        private static final byte[] LOCKER = new byte[0];
        private static HttpUtils1 httputils;
        private OkHttpClient client;
    
        private  HttpUtils() { 
            okhttp3.OkHttpClient.Builder ClientBuilder=new okhttp3.OkHttpClient.Builder();
            ClientBuilder.readTimeout(20, TimeUnit.SECONDS);//读取超时
            ClientBuilder.connectTimeout(6, TimeUnit.SECONDS);//连接超时
            ClientBuilder.writeTimeout(60, TimeUnit.SECONDS);//写入超时
            //支持HTTPS请求，跳过证书验证
            ClientBuilder.sslSocketFactory(createSSLSocketFactory());
            ClientBuilder.hostnameVerifier(new HostnameVerifier() { 
                @Override
                public boolean verify(String hostname, SSLSession session) { 
                    return true;
                }
            });
            client=ClientBuilder.build();
        }
    
        /** * 单例获取HttpClient * @return */
        public static HttpUtils getInstance() { 
            if (httputils == null) { 
                synchronized (LOCKER) { 
                    if (httputils == null) { 
                        httputils = new HttpUtils();
                    }
                }
            }
            return httputils;
        }
    
        /** * post请求 * @param apiName 接口名称 * @param url 请求地址 * @param bodys 请求参数 json * @param message 返回状态标识 * @param code 成功状态码 * @return */
        public Object post(String apiName, String url, JSONObject bodys, String message, String code) { 
            // 1.RequestBody
            RequestBody requestBody = RequestBody.create(MediaType.parse("application/json"), bodys.toJSONString());
            // 2.构造Request
            Request request = new Request.Builder()
                    .url(url)
                    .header("content-type", "application/json")
                    .post(requestBody)
                    .build();
            // 3.执行Call
            Call call = client.newCall(request);
            //4.得到response
            Response response = null;
            try { 
                response = call.execute();
                // 5. 返回请求参数
                return httputils.getresult(response, apiName, url, bodys, message, code);
            } catch (IOException e) { 
                LogUtils.error("{}接口调用失败,请求url:{},方式:{},参数:{}",apiName,url,"POST",bodys);
            } finally { 
                response.close();
            }
            return Collections.emptyList();
    
    
        }
    
    
        /** * GET请求 * @param apiName 接口名称 * @param url 请求地址 * @param map 请求参数 map * @param message 返回状态标识 * @param code 成功状态码 * @return json字符串 */
        public Object get(String apiName, String url, Map map, String message, String code) { 
            // 1.拼接URL
            if ( map != null){ 
                url = httputils.getUrl(url, map);
            }
            // 2.构建Request
            Request request = new Request.Builder()
                    .url(url)
                    .get()
                    .build();
            // 3.执行Call
            Call call = client.newCall(request);
            //4.得到response
            try(Response response = call.execute()) { 
                // 5. 获取返回body
                return httputils.getresult(response, apiName, url, null, message, code);
            } catch (IOException e) { 
                LogUtils.error("{}接口调用失败,请求url:{},方式:{},参数:{}",apiName,url,"GET");
            }
            return Collections.emptyList();
        }
    
    
        /** * 返回请求参数处理 * @param response * @param apiName * @param url * @param bodys * @param message * @param code * @return json字符串 */
        public  JSONObject getresult(Response response, String apiName, String url, JSONObject bodys ,String message, String code) { 
            try { 
            if (response.isSuccessful()) { 
                JSONObject result = null;
                result = JSONObject.parseObject(response.body().string());
                if (!result.getString(message).equals(code)) { 
                    LogUtils.error("{}接口调用失败,请求url:{},方式:{},参数:{}",apiName,url,"POST",bodys);
                    return null;
                }
                return result;
            }} catch (IOException e) { 
            e.printStackTrace();
            LogUtils.error("{}接口调用失败,请求url:{},方式:{},参数:{}",apiName,url,"POST",bodys.toJSONString());
        }
            return null;
    
        }
    
    
    
    
        /** * 生成安全套接字工厂，用于https请求的证书跳过 * @return */
        public SSLSocketFactory createSSLSocketFactory() { 
            SSLSocketFactory ssfFactory = null;
            try { 
                SSLContext sc = SSLContext.getInstance("TLS");
                sc.init(null, new TrustManager[]{ new TrustAllCerts()}, new SecureRandom());
                ssfFactory = sc.getSocketFactory();
            } catch (Exception e) { 
            }
            return ssfFactory;
        }
    
        /** * 获取拼接参数后的URL * @param url 接口url * @param params 参数map * @return String */
        public  String getUrl(String url, Map<String, Object> params) { 
            StringBuffer sb = new StringBuffer(url + "?");
    
            params.forEach((k,v) -> { 
                if (v != null) { 
                    sb.append("&");
                    sb.append(k);
                    sb.append("=");
                    sb.append(v);
                }
            });
             url = sb.toString().replaceFirst("&", "");
            return url;
        }
    
    
        }
    
    }
    
    
    
    /** * 用于信任所有证书 */
    class TrustAllCerts implements 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];
        }
    }

测试类  
Test

@Test
     	// 测试 get请求
        public void test() { 
            HttpUtils client = HttpUtils1.getInstance();
            String url = "http://wechat.hfjtdyf.com:5648/hfjtdyf/api/GetOrder";
            JSONObject jsonobj = new JSONObject().fluentPut("2019-01-10 12:00:00","2019-01-10 12:01:00");
    
            Object object = client.post("apiname", url,jsonobj , "code", "1");
            System.out.println(object);
    
        }
        // 测试 post请求
        HttpUtils1 client = HttpUtils1.getInstance();
            String url = "http://wechat.hfjtdyf.com:4825/hfjtdyf/api/GetOrder";
            JSONObject o = new JSONObject()
                    .fluentPut("startTime","2019-01-10 12:00:00")
                    .fluentPut("endTime","2019-01-10 12:01:00");
            Object object = client.post("apiname", url,o, "code", "1");
            List list = object.getJSONObject("data").getObject("cardNo",List.class);

更多例子可以参考官方文档，官方以给出详细例子  
![在这里插入图片描述][20200327103603797.png]

[OkHtt]: https://square.github.io/okhttp
[OkHttp github]: https://github.com/square/okhttp
[20200327103603797.png]: /images/20230528/b738a9b534734b11ad7ee184a09bb602.png