Java-OkHttpUtil扩展工具类

先把基于OkHttp的使用进行工具化,形成公共类

配置引入

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

扩展工具

import lombok.extern.slf4j.Slf4j;
import okhttp3.*;
import org.apache.commons.codec.binary.Base64;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * OkHttpUtil
 */
@Slf4j
public class TyOkHttpUtil {
    private static final OkHttpClient client =
            new OkHttpClient.Builder()
                    .readTimeout(5, TimeUnit.SECONDS)       // 设置超时时间
                    .build();


    public static final MediaType MEDIA_TYPE_JSON = MediaType.get("application/json; charset=utf-8");


    /**
     * 发起Get请求
     *
     * @param url    url
     * @param params 参数
     * @return 响应结果
     */
    public static String doGet(String url, Map<String, Object> params) {
        Call call = createGetCall(url, params);
        return execute(call);
    }

    /**
     * 发起Get请求,返回请求流,用于文件下载
     *
     * @param url    url
     * @param params 参数
     * @return 响应结果
     */
    public static InputStream doGetFileStream(String url, Map<String, Object> params) {
        Call call = createGetCall(url, params);
        return executeAndReturnStream(call);
    }

    /**
     * 发起 Post请求, 使用form表单参数
     *
     * @param url    url
     * @param params 参数
     * @return 响应结果
     */
    public static String doPost(String url, Map<String, Object> params) {
        Call call = createPostCall(url, params);
        return execute(call);
    }

    /**
     * 发起 post请求, 使用json参数
     *
     * @param url  url
     * @param json json参数
     * @return resp
     */
    public static String doPost(String url, String json) {
        Call call = createPostJsonCall(url, json);
        return execute(call);
    }


    /**
     * [异步] 发起Get请求
     *
     * @param url      url
     * @param params   参数
     * @param callback 回调方法
     */
    public static void doGetAsync(String url, Map<String, Object> params, Callback callback) {
        Call call = createGetCall(url, params);
        call.enqueue(callback);
    }

    /**
     * [异步] 发起 Post请求
     *
     * @param url    url
     * @param params 参数
     */
    public static void doPostAsync(String url, Map<String, Object> params, Callback callback) {
        Call call = createPostCall(url, params);
        call.enqueue(callback);
    }

    /**
     * [异步] 发起 post请求, 使用json参数
     *
     * @param url  url
     * @param json json参数
     */
    public static void doPostAsync(String url, String json, Callback callback) {
        Call call = createPostJsonCall(url, json);
        call.enqueue(callback);
    }


    /**
     * Get请求, 构造 Call对象
     *
     * @param url    请求url
     * @param params 请求参数
     * @return Call
     */
    private static Call createGetCall(String url, Map<String, Object> params) {

        Request.Builder builder = new Request.Builder();
        Request request = builder.url(url).build();
        // 设置参数
        HttpUrl httpUrl = createHttpUrl(request, params);
        builder.url(httpUrl).build();

        return client.newCall(builder.build());
    }

    /**
     * Post请求, 构造 Call对象
     *
     * @param url    请求url
     * @param params 请求参数
     * @return Call
     */
    private static Call createPostCall(String url, Map<String, Object> params) {
        Request request = new Request.Builder()
                .post(createFormBody(params))
                .url(url)
                .build();
        return client.newCall(request);
    }

    /**
     * Post请求, 构造 Call对象
     *
     * @param url  请求url
     * @param json 请求参数
     * @return Call
     */
    private static Call createPostJsonCall(String url, String json) {
        Request request = new Request.Builder()
                .post(RequestBody.create(MEDIA_TYPE_JSON, json))
                .url(url)
                .build();
        return client.newCall(request);
    }


    /**
     * 为 get请求设置参数
     *
     * @param request request对象
     * @param params 请求参数
     * @return 设置了参数的 HttpUrl对象
     */
    private static HttpUrl createHttpUrl(Request request, Map<String, Object> params) {
        HttpUrl.Builder urlBuilder = request.url().newBuilder();
        if (params != null && params.size() > 0) {
            for (Map.Entry<String, Object> entry : params.entrySet()) {
                urlBuilder.addQueryParameter(entry.getKey(), String.valueOf(entry.getValue()));
            }
        }
        return urlBuilder.build();
    }


    /**
     * 为 post请求设置参数
     *
     * @param params 请求参数
     * @return FormBody
     */
    private static FormBody createFormBody(Map<String, Object> params) {
        FormBody.Builder builder = new FormBody.Builder();
        if (params != null && params.size() > 0) {
            for (Map.Entry<String, Object> entry : params.entrySet()) {
                builder.add(entry.getKey(), String.valueOf(entry.getValue()));
            }
        }
        return builder.build();
    }


    /**
     * 同步执行 http请求
     *
     * @param call call对象
     * @return 响应结果
     */
    public static String execute(Call call) {
        String respStr = "";
        try {
            ResponseBody body = call.execute().body();
            if (body != null) {
                respStr = body.string();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return respStr;
    }

    /**
     * 同步执行 http请求
     *
     * @param call call对象
     * @return 响应结果
     */
    public static InputStream executeAndReturnStream(Call call) {
        InputStream respStr =  null;
        try {
            ResponseBody body = call.execute().body();
            if (body != null) {
                return body.byteStream();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        return respStr;
    }


    /**
     * 将inputstream转为Base64
     *
     * @param is
     * @return
     * @throws Exception
     */
    public static String inputStreamToBase64(InputStream is) throws Exception {
        byte[] data = null;
        try {
            ByteArrayOutputStream swapStream = new ByteArrayOutputStream();
            byte[] buff = new byte[100];
            int rc = 0;
            while ((rc = is.read(buff, 0, 100)) > 0) {
                swapStream.write(buff, 0, rc);
            }
            data = swapStream.toByteArray();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (is != null) {
                try {
                    is.close();
                } catch (IOException e) {
                    throw new Exception("输入流关闭异常");
                }
            }
        }

        return Base64.encodeBase64String(data);
    }
}

  

使用示例

        //拼接参数
        String tgFullUrl="http://xxx.com/abc";
        String objRet="";
        String xbUserToken="test";
String xbAppToken="test"; Map
<String, Object> listKv=new HashMap<>();
try { listKv.put("xbUserToken",xbUserToken); listKv.put("xbAppToken",XbAppToken); listKv.put("current","1"); listKv.put("limit","10"); listKv.put("pageSize","10"); listKv.put("filters","leiXing eq xw"); listKv.put("orderBy","update_time desc"); queryData=TyOkHttpUtil.doGet(tgFullUrl,listKv); if(StringUtils.isEmpty(queryData)){ return objRet; } } catch (Exception ex){ log.error(ex.getMessage(),ex); return objRet; }

 

文件下载测试

            try {
                //基础路径
                String tgFullUrl=tgRootUrl+URL_NEWS_IMAGE_PATH+picId;
                inputStream=TyOkHttpUtil.doGetFileStream(tgFullUrl,listKv);
                if(ObjectUtil.isEmpty(inputStream)) {
                    objRet.setMsg("二期新闻图片接口获取失败.");
                    return  objRet;
                }
            }
            catch (Exception ex){
                log.error(ex.getMessage(),ex);
                objRet.setMsg("二期新闻图片接口获取失败.");
                return  objRet;
            }
            try {
                String fileBase64=TyOkHttpUtil.inputStreamToBase64(inputStream);
                objRet.setSuccess(true);
                objRet.setData(fileBase64);
                objRet.setMsg("文件下载完成");
            }
            catch (Exception ex){
                log.error(ex.getMessage(),ex);
                objRet.setSuccess(false);
                objRet.setMsg("文件下载失败");
            }
        return objRet;

测试Ok

 

posted @ 2024-03-14 15:38  李文学  阅读(826)  评论(0编辑  收藏  举报