OkHttp框架入门笔记

    xiaoxiao2025-03-13  71

    OkHttp框架入门笔记

    框架概述版本需求依赖简单应用例子对OkHttp框架进行简单的封装参考资料

    本篇文章是我在学习 @慕课网【Android网络框架-OkHttp使用】课程时所做的笔记,方便写代码时进行参考。

    框架概述

    采用Http协议进行通信是当下Android APP中非常普遍的一个需求,而OkHttp则是目前比较流行的一款基于Java的Http网络通信框架。根据官方介绍,其具有以下特性:

    HTTP/2允许对同一主机的所有请求共享套接字。连接池减少了请求延迟(在HTTP/2不可用的情况下)。透明GZIP减少了下载流量。响应缓存可以完全避免重复的网络请求。

    简而言之,OkHttp充当一个高效的HTTP客户端,它能像浏览器一样方便的发送HTTP请求、处理HTTP响应。并且,OkHttp具有一系列设计优良的API,具有简单易用的特点。

    版本需求

    OkHttp支持Android 5.0+ (API级别21+)和Java 8+。

    依赖

    笔者所采用的安卓测试环境:

    compileSdkVersion 28

    应用的OkHttp依赖如下(在build.gradle中编辑):

    implementation 'com.squareup.okhttp3:okhttp:4.0.0-alpha01' implementation 'com.squareup.okio:okio:2.2.2'

    PS. 注意,不要遗漏okio包,否则在运行过程中将抛出“xx包找不到”的异常。

    简单应用例子

    效果图如下(点击按钮发起一个Get请求): 此段代码应用OkHttp框架发起了一个异步的Get请求,并最终将响应体中的字符串更新到UI上,篇幅限制仅给出局部代码:

    // 1 OkHttpClient okHttpClient = new OkHttpClient(); // 2 Request.Builder builder = new Request.Builder(); Request request = builder.get().url("http://***.**.**.**:8090/api/v1/cards?targetId=1000&offset=0&limit=5").build(); // 3 Call call = okHttpClient.newCall(request); // 4 call.enqueue(new Callback() { @Override public void onFailure(@NotNull Call call, @NotNull IOException e) { } @Override public void onResponse(@NotNull Call call, @NotNull Response response) throws IOException { final String result = response.body().string(); runOnUiThread(new Runnable() { @Override public void run() { Toast.makeText(getApplicationContext(), result, Toast.LENGTH_LONG).show(); } }); } });

    该段代码具有极为清晰的4步,发送其它类型请求皆可以依葫芦画瓢的采用如下4个步骤:

    拿到okHttpClient对象构造Request将Request封装为Call执行Call(可选择同步或者异步)

    我们可以通过okHttpClient进行一些全局性的配置,通过Request.Builder对每个Request进行配置。 这里值得注意的是,不能在回调函数中直接操控UI组件,必须在UI线程中才可以,所以需要调用runOnUiThread方法。

    对OkHttp框架进行简单的封装

    每次都执行如上4步有时候显得非常不便,实际过程中,我们通常要对OkHttp框架进行一些封装,下面是一个极为简单的封装示例:

    import java.io.IOException; import okhttp3.Call; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; /** * 对okHttp进行简单封装 */ public class MyHttpUtil { private static final OkHttpClient mOK_HTTP_CLIENT = new OkHttpClient(); public static Response doGet(String url) throws IOException { Request.Builder builder = new Request.Builder(); Request request = builder.get().url(url).build(); Call call = mOK_HTTP_CLIENT.newCall(request); return call.execute(); } }

    在官方文档中建议对OkHttpClient进行重用,并实现单例模式。这是因为每个OkHttpClient都有自己的线程池、连接池,复用一个OkHttpClient可以为我们的APP节省内存、减少延迟。

    参考资料

    OkHttp - Square Open SourceAndroid网络框架-OkHttp使用
    最新回复(0)