通用封装系列——OkHttp

为了帮助自己记忆,以及方便自己以后使用,将一些常用、通用的功能整理出来,如果能帮到大家,那就更好了。

该系列文章并不是技术解析贴,不会讲详细原理,属于工具类,直接拿走即可使用。


okHttp,这个几乎每个Android开发都知道的强大的开源工具,我在多个我个人或者公司的项目中都有使用,将其中一些通用的方法封装在一个工具类,以便复用。

首先先上github地址:https://github.com/square/okhttp

废话不多说了,直接上代码:

public class OkHttpHelper {

    private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
    private static final MediaType STREAM = MediaType.parse("application/octet-stream; charset=utf-8");
    private static OkHttpClient okHttpClient;
    private static OkHttpHelper okHttpHelper;

    private OkHttpHelper(){
        okHttpClient= new OkHttpClient().newBuilder().connectTimeout(30, TimeUnit.SECONDS)
                .readTimeout(10, TimeUnit.SECONDS)//设置读取超时时间
                .writeTimeout(10, TimeUnit.SECONDS)//设置写入超时时间
                .build();;
    }

    //单例模式构造okhttp实例
    public static OkHttpHelper getInstance(){
        if (okHttpHelper == null) {
            synchronized (OkHttpHelper.class) {
                if (okHttpHelper == null) {
                    okHttpHelper = new OkHttpHelper();
                }
            }
        }
        return okHttpHelper;
    }

    //同步方式发起网络请求
    public static Response execute(Request request) throws IOException{
        return okHttpClient.newCall(request).execute();
    }
    //异步方式发起网络请求
    public static void enqueue(Request request, Callback responseCallback){
        okHttpClient.newCall(request).enqueue(responseCallback);
    }

    /**
     * get请求
     * @param url 请求URL
     * @return  服务器返回内容
     */
    public static String okHttpGet(String url){

        Request request = new Request.Builder().url(url).build();
        try {
            Response response = execute(request);
            if (response.isSuccessful()) {
                String responseUrl = response.body().string();
                return responseUrl;
            } else {
                return null;
            }
        }catch (IOException e){
            return null;
        }
    }

    /**
     * post请求
     *
     * @param url 请求URL
     * @param json json入参
     * @return 服务器返回内容
     */
    public static String okHttpPost(String url, String json){
        try {
            RequestBody body = RequestBody.create(JSON, json);
            Request request = new Request.Builder()
                    .url(url)
                    .post(body)
                    .build();
            Response response = execute(request);
            if (response.isSuccessful()) {
                return response.body().string();
            }
        } catch (IOException e){
            e.printStackTrace();
        }
        return null;
    }

    /**
     * post请求
     * @param context 上下文
     * @param url 请求URL
     * @param map 键值类型入参
     * @return 服务器返回内容
     */
    public static String okHttpPost(Context context, String url, Map<String, Object> map){
        
	try {
            FormBody.Builder body = new FormBody.Builder();
            if (map != null) {
                // map 里面是请求中所需要的 key 和 value
                for (Map.Entry entry : map.entrySet()) {
                    body.add(entry.getKey().toString(), entry.getValue().toString());
                }
            }
            Request request = new Request.Builder().url(url).post(body.build()).tag(context).build();
            Response response = execute(request);
            if (response.isSuccessful()) {
                return response.body().string();
            }
        }catch (IOException e){
            e.printStackTrace();
        }

return null; } /** * 上次文件 * @param context 上下文 * @param map 键值类型入参 * @param file 要上传的文件 * @param url 请求URL */ public static void okHttpPostFile(Context context, Map<String, Object> map, File file, UploadCall uploadCall, String url) { // form 表单形式上传 MultipartBody.Builder requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM); if(file != null){ RequestBody body = RequestBody.create(STREAM, file); // 参数分别为, 请求key ,文件名称 , RequestBody requestBody.addFormDataPart("media", file.getName(), body); } if (map != null) { for (Map.Entry entry : map.entrySet()) { requestBody.addFormDataPart(entry.getKey().toString(), entry.getValue().toString()); } } Request request = new Request.Builder().url(url).post(requestBody.build()).tag(context).build(); enqueue(request,uploadCall); } /** * 下载文件 * @param url 请求URL * @param outPath 文件要保存的完整目录(包括文件名) * @return */ public static String okHttpLoadFile(String url, String outPath){// String outPath = Params.CACHE_FILE_LOCATION + picname; //获取请求对象 Request request = new Request.Builder().url(url).build(); //获取响应体 ResponseBody body = null; try { body = okHttpClient.newCall(request).execute().body(); } catch (IOException e) { e.printStackTrace(); } //获取流 InputStream in = body.byteStream(); //转化为bitmap Bitmap bitmap = BitmapFactory.decodeStream(in); try { saveBitmap(bitmap,outPath); } catch (FileNotFoundException e) { outPath = ""; } catch (IOException e){ outPath = ""; } return outPath; } abstract static class UploadCall implements Callback{ private final int SUCCESS = 1; private final int FAIL = 0; private int position; private Handler updateSendTypeHandler; private String json; public UploadCall(int position, Handler updateSendTypeHandler,String json){ this.position = position; this.updateSendTypeHandler = updateSendTypeHandler; this.json = json; } public UploadCall(){ } public void onGetResult(int state,Response response){} @Override public void onFailure(Call call, IOException e) { onGetResult(FAIL,null); } @Override public void onResponse(Call call, Response response) throws IOException { if (response.isSuccessful()) { onGetResult(SUCCESS,response); } else { onGetResult(FAIL,null); } } } public static void saveBitmap(Bitmap bitmap, String filePath) throws FileNotFoundException,IOException{ FileOutputStream fos = null; fos = new FileOutputStream(filePath); if (fos != null) { bitmap.compress(Bitmap.CompressFormat.JPEG, 90, fos); fos.close(); } }}


该工具类封装了普通的get请求,不同入参的post请求,以及文件上传和下载。

网上关于okhttp的封装有很多,我也是参考了很多前辈和大神的方式,总结出更适合自己用的用法,如有不同意见,欢迎指正。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
OkHttp是一个开源的HTTP客户端库,它封装了平台之间的差异性,为我们提供了方便的接口来发送HTTP请求和处理响应。当我们使用OkHttp时,可以使用封装类来简化使用过程。 OkHttp封装类主要包括以下几个方面: 1. 初始化OkHttpClient:首先,我们需要创建一个OkHttpClient对象,用于发送HTTP请求。在封装类中,可以在构造方法中进行OkHttpClient的初始化设置,比如设置超时时间、添加拦截器等。 2. 发送GET请求:通过封装类,我们可以定义一个方法来发送GET请求。该方法接收一个URL作为参数,使用OkHttpClient来创建一个Request对象,并通过该对象发送异步的GET请求。在回调中处理服务器响应结果,并返回给调用者。 3. 发送POST请求:类似于GET请求,我们可以封装一个方法来发送POST请求。该方法接收一个URL和需要发送的数据作为参数,使用OkHttpClient创建一个RequestBody对象,并通过该对象发送异步的POST请求。同样,在回调中处理响应结果,并返回给调用者。 4. 添加请求头:在某些情况下,我们可能需要添加请求头来发送自定义的信息。封装类可以提供一个方法,接收一个字符串类型的键值对参数,用于添加自定义的请求头。 5. 异步请求:OkHttp的请求是异步执行的,默认情况下在子线程中发送请求并在主线程中处理结果。封装类可以将异步请求的结果通过回调的方式返回给调用者,方便处理响应结果。 通过封装类,我们可以将OkHttp的使用变得更简单、更便捷。可以将一些通用的处理逻辑提取出来,在封装类中进行统一处理,并对外提供更友好的接口。这样可以减少代码的重复性,提高开发效率。同时,封装类还可以对请求进行统一的异常处理、日志打印等操作,方便排查问题和调试。总之,OkHttp封装类可以让我们更好地利用OkHttp的强大功能,提升开发效率和代码可维护性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值