OkHttp简易封装和使用

最新推荐文章于 2025-07-23 16:44:42 发布
最新推荐文章于 2025-07-23 16:44:42 发布
阅读量2.5k 收藏 11
点赞数 1
CC 4.0 BY-SA版权
分类专栏： Android 框架使用 文章标签： OkHttp
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/xingxtao/article/details/53835895
本文介绍了如何对OkHttp进行简易封装，以减少重复代码。封装后，调用者只需一行代码即可发送Post请求。内容包括Android端的封装类如CommonRequest、RequestParams、ResponseListener、ResultCallback和OkHttpUtil的详细说明，以及测试代码示例，涵盖GET、POST请求及文件上传等操作。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

常规情况下，OkHttp发送一个Post请求:

OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
        FormBody.Builder formBodyBuilder = new FormBody.Builder();
        formBodyBuilder.add("username", "star");
        formBodyBuilder.add("password", "123");
        FormBody formBody = formBodyBuilder.build();
        Request request = new Request.Builder().url("http://10.0.2.2:8080/Struts2/app_postForm").post(formBody).build();
        okHttpClient.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                Log.i("debug", "postRequest().... onFailure" + e.getMessage());
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                Log.i("debug", "postRequest().... onResponse");
                final String result = response.body().string();
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        textView.setText(result);
                    }
                });
            }
        });

由此可见，在没有封装的情况下，如果发送请求有多处，那么代码量还是蛮多的。

而封装之后的调用为：
OkHttpUtil.post(url,params,callback)

进入主题：

一：服务端
使用Struts2搭建,主要包括两个Action,AppAction和UploadAction.

public class AppAction extends ActionSupport {

    private String username;

    private String password;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String postForm() {
        System.out.println("postForm......................");
        System.out.println("Android: username=" + username + ",password="
                + password);
        return SUCCESS;
    }

    public String postJson() throws Exception {
        HttpServletRequest request = ServletActionContext.getRequest();
        InputStream is = request.getInputStream();
        int len = 0;
        StringBuilder sb = new StringBuilder();
        byte[] buffer = new byte[1024];
        while ((len = is.read(buffer)) != -1) {
            sb.append(new String(buffer, 0, len));
        }
        System.out.println("接收到的json= " + sb.toString());
        return SUCCESS;
    }

    public String get() throws IOException {
        System.out.println("Android: username=" + username);
        HttpServletResponse response = ServletActionContext.getResponse();
        response.getWriter().write("get success");
        return SUCCESS;
    }

    public String getParams() {
        System.out.println("username=" + username);
        return SUCCESS;
    }

}
public class UploadAction extends ActionSupport {

    private String username;

    private String password;

    private File file; // pic名称必须和文件表单项中的name属性值相同。

    private String fileFileName; // 文件名称必须为文件表单项中的name属性值为前缀，后缀必须是FileName

    private String fileContentType;// 文件名称必须为文件表单项中的name属性值为前缀，后缀必须是ContentType

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public File getFile() {
        return file;
    }

    public void setFile(File file) {
        this.file = file;
    }

    public String getFileFileName() {
        return fileFileName;
    }

    public void setFileFileName(String fileFileName) {
        this.fileFileName = fileFileName;
    }

    public String getFileContentType() {
        return fileContentType;
    }

    public void setFileContentType(String fileContentType) {
        this.fileContentType = fileContentType;
    }

    /**
     * 处理上传文件和表单
     * 
     * @return
     * @throws Exception
     */
    public String uploadFileForm() throws Exception {
        System.out.println("uploadFileForm()........");
        System.out.println("fileName = " + fileFileName);
        System.out.println("username = " + username + ",password=" + password);
        HttpServletRequest request = ServletActionContext.getRequest();
        String path = request.getRealPath("/file");
        InputStream is = new FileInputStream(file);
        OutputStream os = new FileOutputStream(new File(path, fileFileName));
        byte[] buffer = new byte[1024];
        int len = 0;
        while ((len = is.read(buffer)) != -1) {
            os.write(buffer, 0, len);
        }
        os.close();
        is.close();
        return SUCCESS;
    }

    /**
     * 处理上传文件
     * 
     * @return
     * @throws Exception
     */
    public String uploadFile() throws Exception {
        System.out.println("upload file......");
        HttpServletRequest request = ServletActionContext.getRequest();
        ServletInputStream is = request.getInputStream();
        String path = request.getRealPath("/file");
        File file = new File(path, "Android.png");
        OutputStream os = new FileOutputStream(file);
        byte[] buffer = new byte[1024];
        int len = 0;
        while ((len = is.read(buffer)) != -1) {
            os.write(buffer, 0, len);
        }
        os.close();
        is.close();
        return NONE;
    }

}

二：Android端
封装的类有：

  • CommonRequest：负责创建Request对象
  • RequestParams：封装请求参数，key为参数名，value为参数值
  • ResponseListener：回调接口
  • ResultCallback：实现OkHttp中Callback接口
  • OkHttpUtil：OkHttp工具类，供外界调用其方法

1. RequestParams 

public class RequestParams {

    public String key;

    public String value;

    public RequestParams() {
    }

    public RequestParams(String key, String value) {
        this.key = key;
        this.value = value;
    }

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }


    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    @Override
    public String toString() {
        return "RequestParams{" +
                "key='" + key + '\'' +
                ", value='" + value + '\'' +
                '}';
    }
}

2.回调接口

public interface ResponseListener {

    void onSuccess(Object obj);

    void onFailure(Object error);

}

3. 通过Handler将请求结果回调到主线程中

public class ResultCallback implements Callback {

    private Handler mHandler = null;

    private ResponseListener listener;

    public ResultCallback(ResponseListener listener) {
        this.listener = listener;
        mHandler = new Handler(Looper.getMainLooper());
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        String result = response.body().string();
        sendSuccessCallback(call, result);
    }


    @Override
    public void onFailure(Call call, IOException e) {
        sendFailureCallback(call, e);
    }


    private void sendFailureCallback(Call call, final IOException e) {
        //Handler post到主线程中
        mHandler.post(new Runnable() {
            @Override
            public void run() {
                listener.onFailure(e.getMessage());
            }
        });
    }


    private void sendSuccessCallback(Call call, final String result) {
        mHandler.post(new Runnable() {
            @Override
            public void run() {
                listener.onSuccess(result);
            }
        });
    }

}

4 . CommonRequest封装创建Request对象

public class CommonRequest {

    private static final MediaType TYPE_JSON = MediaType.parse("application/json; charset=utf-8");

    private static final MediaType TYPE_STREAM = MediaType.parse("application/octet-stream");

    /**
     * 创建 Get 请求，将参数拼装成Url
     *
     * @return
     */
    public static Request createGetRequest(String url, List<RequestParams> paramsList) {
        String realUrl = url;
        Request.Builder requestBuilder = new Request.Builder();
        StringBuffer sb = new StringBuffer(url);
        if (paramsList != null) {
            sb.append("?");
            for (RequestParams params : paramsList) {
                sb.append(params.key).append("=").append(params.value).append("&");
            }
            realUrl = sb.substring(0, sb.length() - 1);
        }
        Request request = requestBuilder.url(realUrl).get().build();
        return request;
    }

    /**
     * 创建 Post 请求，填充Form表单
     *
     * @param url
     * @param paramsList
     * @return
     */
    public static Request createPostRequest(String url, List<RequestParams> paramsList) {
        Request.Builder requestBuilder = new Request.Builder();
        FormBody.Builder formBodyBuilder = new FormBody.Builder();
        if (paramsList != null) {
            for (RequestParams params : paramsList) {
                formBodyBuilder.add(params.key, params.value);
            }
        }
        RequestBody requestBody = formBodyBuilder.build();
        Request request = requestBuilder.url(url).post(requestBody).build();
        return request;
    }

    /**
     * 创建 Post json 请求，
     *
     * @param url
     * @param jsonStr
     * @return
     */
    public static Request createPostJsonRequest(String url, String jsonStr) {
        Request.Builder requestBuilder = new Request.Builder();
        RequestBody requestBody = RequestBody.create(TYPE_JSON, jsonStr);
        Request request = requestBuilder.url(url).post(requestBody).build();
        return request;
    }

    /**
     * post 上传文件
     *
     * @param url
     * @param file
     * @return
     */
    public static Request createPostFileRequest(String url, File file) {
        Request.Builder requestBuilder = new Request.Builder();
        RequestBody requestBody = RequestBody.create(TYPE_STREAM, file);
        Request request = requestBuilder.url(url).post(requestBody).build();
        return request;
    }

    /**
     * post上传文件并提交表单
     *
     * @param url        服务端处理请求的url
     * @param fileKey    表单中上传文件域的名字，服务端定义的File变量，名称要和这个相同。
     * @param file       要上传的文件
     * @param paramsList 要提交的表单数据
     * @return
     */
    public static Request createMultiPostRequest(String url, String fileKey, File file, List<RequestParams> paramsList) {
        MultipartBody.Builder multipartBodyBuilder = new MultipartBody.Builder();
        for (RequestParams params : paramsList) {
            multipartBodyBuilder.addFormDataPart(params.key, params.value);
        }
        //文件上传enctype必须设置为 multipart/form-data
        MultipartBody multipartBody = multipartBodyBuilder.setType(MultipartBody.FORM)
                .addFormDataPart(fileKey, file.getName(), RequestBody.create(TYPE_STREAM, file))
                .build();
        Request request = new Request.Builder().url(url).post(multipartBody).build();
        return request;
    }
}

5 . OkHttp工具类，外界通过调用公共方法实现HTTP请求。

/**
 * OkHttp封装的工具类，应用层通过该类调用get,post静态方法完成相应的请求
 */

public class OkHttpUtil {

    private static final int TIME = 30;

    private static OkHttpClient okHttpClient;

    static {
        OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();
        okHttpClientBuilder.connectTimeout(TIME, TimeUnit.SECONDS);  //设置连接超时时间
        okHttpClientBuilder.readTimeout(TIME, TimeUnit.SECONDS);    //设置读取超时时间
        okHttpClientBuilder.writeTimeout(TIME, TimeUnit.SECONDS);  //设置写入超时时间
        okHttpClient = okHttpClientBuilder.build();
    }

    /*-------------对外提供的接口--------------*/

    /**
     * 不带参数的get请求
     *
     * @param url
     * @param callback
     */
    public static void get(String url, ResultCallback callback) {
        get(url, null, callback);
    }

    /**
     * GET 请求，带参数
     *
     * @param url
     * @param paramsList
     * @param callback
     */
    public static void get(String url, List<RequestParams> paramsList, ResultCallback callback) {
        Call call = okHttpClient.newCall(CommonRequest.createGetRequest(url, paramsList));
        call.enqueue(callback);
    }

    /**
     * POST 请求，完成表单的提交
     *
     * @param url
     * @param paramsList
     * @param callback
     */
    public static void post(String url, List<RequestParams> paramsList, ResultCallback callback) {
        Call call = okHttpClient.newCall(CommonRequest.createPostRequest(url, paramsList));
        call.enqueue(callback);
    }


    /* POST 提交json字符串给服务端*/
    public static void postJson(String url, String jsonStr, ResultCallback callback) {
        Call call = okHttpClient.newCall(CommonRequest.createPostJsonRequest(url, jsonStr));
        call.enqueue(callback);
    }


    /* POST 上传文件 */
    public static void postFile(String url, File file, ResultCallback callback) {
        Call call = okHttpClient.newCall(CommonRequest.createPostFileRequest(url, file));
        call.enqueue(callback);
    }

    /**
     * 上传文件，并提交表单
     */
    public static void postFileAndForm(String url, String fileKey, File file, List<RequestParams> paramsList, ResultCallback callback) {
        Call call = okHttpClient.newCall(CommonRequest.createMultiPostRequest(url, fileKey, file, paramsList));
        call.enqueue(callback);
    }
}

6 测试代码：

(1) 发送一个GET请求

private void get() {
        OkHttpUtil.get("http://10.0.2.2:8080/Struts2/app_get", new ResultCallback(new ResponseListener() {
            @Override
            public void onSuccess(Object obj) {
                textView.setText(obj.toString());
            }

            @Override
            public void onFailure(Object error) {

            }
        }));
    }

这里写图片描述

(2) 发送一个post请求

private void post() {
        // post request
        List<RequestParams> paramsList = new ArrayList<>();
        paramsList.add(new RequestParams("username", "star123"));
        paramsList.add(new RequestParams("password", "111"));
        OkHttpUtil.post("http://10.0.2.2:8080/Struts2/app_postForm", paramsList, new ResultCallback(new ResponseListener() {
            @Override
            public void onSuccess(Object obj) {
                Log.i("debug", obj.toString());
                Toast.makeText(MainActivity.this, "success", Toast.LENGTH_LONG).show();
            }

            @Override
            public void onFailure(Object error) {
                Log.i("debug", "onFailure" + error.toString());
            }
        }));
    }

这里写图片描述
-
(3) 仅仅上传文件

private void postFile() {
        File file = new File("/mnt/sdcard", "logo1.png");
        if (!file.exists()) {
            Log.i("debug", "picture not exists");
            return;
        }
        OkHttpUtil.postFile("http://10.0.2.2:8080/Struts2/action_uploadFile", file, new ResultCallback(new ResponseListener() {
            @Override
            public void onSuccess(Object obj) {
                Log.i("debug", "post file success");
            }

            @Override
            public void onFailure(Object error) {
                Log.i("debug", "post file failed");
            }
        }));
    }

这里写图片描述

(4) 上传文件，并提交表单数据

private void postFileAndForm() {
        File file = new File("/mnt/sdcard", "logo1.png");
        if (!file.exists()) {
            Log.i("debug", "file not exists");
            return;
        }
        List<RequestParams> paramsList = new ArrayList<>();
        paramsList.add(new RequestParams("username", "xiaohei"));
        paramsList.add(new RequestParams("password", "hei@xiao"));
        OkHttpUtil.postFileAndForm("http://10.0.2.2:8080/Struts2/action_uploadFileForm", "file", file, paramsList, new ResultCallback(new ResponseListener() {
            @Override
            public void onSuccess(Object obj) {
                Log.i("debug", "post file-form success");
            }

            @Override
            public void onFailure(Object error) {
                Log.i("debug", "post file-form failed");
            }
        }));
    }

这里写图片描述

使用OkHttp进行网络请求和简单封装（Android）
CodeGu的博客
10-16 421
本文将介绍如何使用OkHttp进行网络请求，并展示如何进行简单的封装，以便在整个应用程序中重复使用。发送请求并处理响应的过程通常是在后台线程中进行的，以避免阻塞应用程序的主线程。通过OkHttp的强大功能和简单的API，我们可以轻松地进行网络通信，并在应用程序中实现网络请求的复用。通过这种封装方式，我们可以在应用程序的任何地方使用OkHttpManager类的sendRequest()方法发送网络请求，并在回调中处理响应数据。为了在整个应用程序中重复使用网络请求的代码，我们可以进行简单的封装。
OKHTTP封装及调用
技术小白
05-29 405
package com.example.ok02; import android.os.Handler; import java.io.IOException; import java.util.concurrent.TimeUnit; import okhttp3.Call; import okhttp3.Callback; import okhttp3.OkHttpClient; imp...
OKHttp网络请求封装
10-25
在开发过程中有时候一个项目可能会用两三个网络请求框架，使用自己的规范来封装三方库。我这是封装OKHttp实现该接口，当然你也可以使用别的三方库来实现在接口。
Okhttp实用封装
findhappy117的博客
02-23 283
对okhttp的get，put,delete，post请求简单封装，减少了不必要的冗余代码
Android网络编程：OkHttp封装实践
最新发布
weixin_42509888的博客
07-23 643
OkHttp是Square公司开发的一个高效的HTTP客户端，支持同步和异步请求。它已被广泛应用于Android和Java应用程序中，用于处理网络通信。OkHttp对网络协议进行了优化，使用连接池来减少请求延迟，并且能够通过透明GZIP压缩来减少响应大小。其灵活性和性能优越，是很多开发者处理HTTP请求的首选库。我们将从OkHttp的基本使用和封装开始，逐步深入探讨如何利用OkHttp来实现复杂网络请求和数据处理。在HttpHelper类中，我们定义了私有成员。
okhttp 封装
无问西东的博客
08-29 2818
okhttp get/post基本用法 okhttp upload/download 上传和下载 对应的项目下载地址：NetFramework 全部单例模式创建方式：单例模式例子中用到了静态内部类创建单例，对此不了解的可以参考这篇 前两篇文章实践了使用okhttp3.0进行简单的网络交互、获取网络资源等操作，但是可以预料代码会有冗余的情况，我们可以写的更加优雅一点，例子中只是个别的网络请...
okhttp封装
AI_LWT的博客
10-13 217
#okhttpcontenuitls … /** 原则：代码复用性+只有一个Client对象 */ public class OkhttpUtils { private OkHttpClient okHttpClient;//在构造方法里面创建 //单例模式：构造私有化 private OkhttpUtils(){//只会创建一次 //log拦截器 HttpLoggingInterceptor httpLoggingInterceptor=new HttpLoggingInterceptor()
封装OKHttp
kakayang2012的博客
06-26 1276
如果不封装OKHttp，则每发出一个请求，都要写很多重复代码，是无用且繁琐的，所以必须要封装，并且若能够结合GSON，将返回的json数据直接解析为Bean对象，就可以大大简化网络请求过程；更进一步，若能在每个请求都加上进度对话框的功能，就大大美化了网络请求过程。下面开始封装： ①构建OKHttpHelper类 ->OKHttpHelper应该是单例的 private  static  Ok
OkHttp简易封装实现Android网络请求及Bean转换
OkHttp库的封装通常是为了解耦和提高代码复用性，使得网络请求相关的代码更容易管理和维护。在本资源中，封装的目标是为了简化OkHttp的使用，以实现简单的网络post请求，并且能够将服务器返回的数据利用Gson库进行...
Android-简易封装OkHttp
08-13
总结起来，简易封装OkHttp主要是为了简化HTTP请求的调用流程，统一网络请求的配置，以及提供更好的请求管理和错误处理。通过创建一个工具类并定义不同类型的请求方法，我们可以使代码更加模块化，易于维护。同时，...
OkHttp简易使用示例与代码封装技术
OkHttp的版本更新很快，而且非常注重性能和网络优化。本文档展示了如何在Java项目中通过简单代码使用OkHttp进行网络请求。 1. 引入依赖包 首先，要在项目的build.gradle文件中的dependencies块中加载OkHttp的依赖包...
OkHttp3简易封装教程与实践
以下是对简单封装使用OkHttp3的知识点的详细解释： ### OkHttp3 的核心组件 - **OkHttpClient**: 用于发起请求的客户端类，一个OkHttpClient实例可以用来配置请求的默认选项（如超时时间、缓存等）。 - **Request*...
OKHttp的封装
weixin_43860442的博客
12-31 156
1.导依赖 implementation 'com.squareup.okhttp3:okhttp:3.12.1' 2.在MVP的model层写代码 public class LoginModel implements ILoginContract.ILoginModel { @Override //M层接受数据的方法 public void containLoginResponData(S...
学习笔记之-----OkHttp之使用与简单封装
小样
03-09 739
一.OKHttp的简单使用： 1.简意：OKHttp是一个高效的Http库 2.优点： （1）支持SPDY，共享同一个Socket来处理同一个服务器的所有请求 （2）如果SPDY不可用，则通过连接池来减少请求延时 （3）无缝的支持GZIP来减少数据流量 （4）缓存响应数据来减少重复的网络请求 3.支持情况： （1）一般的get请求 （2）一般的post请求 （3）基于Http的
okhttp3的封装
tiger_Angle
07-10 2989
https://github.com/hongyangAndroid/okhttputils 此处借鉴鸿洋大神分享的框架：https://github.com/hongyangAndroid/okhttputils 还有鸿洋大神的博客：https://blog.csdn.net/lmj623565791/article/details/47911083 使用前导入： implementation 'com.zhy:okhttputils:2.6.2' ​​​​​​Okhttp3封装_Snow_I.
OkHttp的封装
indeedes的博客
09-12 2839
通过前面的操作，发现使用HttpURLConnection的写法 还是比较复杂的，那么使用OkHttp会变得简单吗？ 一、重写HttpUtil类 public class HttpUtil{ public static void sendOkHttpRequest(String address,okhttp3.Callback callback){ OkHttpClient client = new OkHttpClient(); Req...
OKHttp封装
peixiaopao的博客
09-13 450
下面是出自本人之手的一个OKHttp的封装： （简单易懂，注释详尽） /** * Created by peiyan on 2017/9/6. * okhttp的中级封装，实现两个功能： * 1.从服务端下载数据； * 2.从客户端提交数据； * 1.节约内存，使所有的网络请求都用一个okhttpclient和handler对象 * 2.解决okhttp,网络请求成功，代码在子线程
okHttp封装
小婕儿的优快云
10-30 286
okHttp的封装，get和post请求
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值