EasyHttp - 使用详解

最新推荐文章于 2024-04-26 18:40:57 发布
最新推荐文章于 2024-04-26 18:40:57 发布
阅读量1.2k 收藏 3
点赞数 2
分类专栏： Android开发技术 文章标签： android EasyHttp http okhttp

官网

https://github.com/getActivity/EasyHttp/blob/master/HelpDoc.md

集成文档

配置权限
<!-- 联网权限 -->
<uses-permission android:name="android.permission.INTERNET" />

<!-- 访问网络状态 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
Http 明文请求
  • Android 9.0 限制了明文流量的网络请求，非加密的流量请求都会被系统禁止掉。
  • 如果当前应用的请求是 http 请求，而非 https，这样就会导系统禁止当前应用进行该请求，如果 WebView 的 url 用 http 协议，同样会出现加载失败，https 不受影响
  • 在 res 下新建一个 xml 目录，然后创建一个名为：network_security_config.xml 文件 ，该文件内容如下
<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
    <base-config cleartextTrafficPermitted="true" />
</network-security-config>
  • 然后在 AndroidManifest.xml application 标签内应用上面的 xml 配置
<application
    android:networkSecurityConfig="@xml/network_security_config" />
服务器配置
public class RequestServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.baidu.com/";
    }

    @NonNull
    @Override
    public BodyType getBodyType() {
        // 参数以 Json 格式提交（默认是表单）
        return BodyType.JSON;
    }
}
框架初始化
  • 需要配置请求结果处理，具体封装可以参考 RequestHandler
OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .build();

EasyConfig.with(okHttpClient)
        // 是否打印日志
        .setLogEnabled(BuildConfig.DEBUG)
        // 设置服务器配置（必须设置）
        .setServer(server)
        // 设置请求处理策略（必须设置）
        .setHandler(new RequestHandler())
        // 设置请求重试次数
        .setRetryCount(3)
        // 添加全局请求参数
        //.addParam("token", "6666666")
        // 添加全局请求头
        //.addHeader("time", "20191030")
        // 启用配置
        .into();
  • 上述是创建配置，更新配置可以使用
EasyConfig.getInstance()
        .addParam("token", data.getData().getToken());
混淆规则
# OkHttp3
-keepattributes Signature
-keepattributes *Annotation*
-keep class okhttp3.** { *; }
-keep interface okhttp3.** { *; }
-dontwarn okhttp3.**
-dontwarn okio.**

# 不混淆这个包下的类
-keep class com.xxx.xxx.xxx.xxx.** {
    <fields>;
}

使用文档

配置接口
public final class LoginApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "user/login";
    }

    /** 用户名 */
    private String userName;

    /** 登录密码 */
    private String password;

    public LoginApi setUserName(String userName) {
        this.userName = userName;
        return this;
    }

    public LoginApi setPassword(String password) {
        this.password = password;
        return this;
    }
}
  • 可为这个类的字段加上一些注解
    • @HttpHeader：标记这个字段是一个请求头参数
    • @HttpIgnore：标记这个字段不会被发送给后台
    • @HttpRename：重新定义这个字段发送给后台的参数或者请求头名称
  • 可在这个类实现一些接口
    • implements IRequestHost：实现这个接口之后可以重新指定这个请求的主机地址
    • implements IRequestType：实现这个接口之后可以重新指定这个请求的提交方式
    • implements IRequestCache：实现这个接口之后可以重新指定这个请求的缓存模式
    • implements IRequestClient：实现这个接口之后可以重新指定这个请求所用的 OkHttpClient 对象
  • 字段作为请求参数的衡量标准
    • 假设某个字段的属性值为空，那么这个字段将不会作为请求参数发送给后台
    • 假设果某个字段类型是 String，属性值是空字符串，那么这个字段就会作为请求参数，如果是空对象则不会
    • 假设某个字段类型是 int，因为基本数据类型没有空值，所以这个字段一定会作为请求参数，但是可以换成 Integer 对象来避免，因为 Integer 的默认值是 null
public final class XxxApi implements IRequestServer, IRequestApi {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.baidu.com/";
    }

    @NonNull
    @Override
    public String getApi() {
        return "user/getInfo";
    }
}
发起请求
  • 需要配置请求状态及生命周期处理，具体封装可以参考 BaseActivity
EasyHttp.post(this)
        .api(new LoginApi()
                .setUserName("Android 轮子哥")
                .setPassword("123456"))
        .request(new HttpCallbackProxy<HttpData<LoginBean>>(activity) {

            @Override
            public void onHttpSuccess(HttpData<LoginBean> data) {
                toast("登录成功");
            }
        });
  • 这里展示 post 用法，另外 EasyHttp 还支持 get、head、delete、put、patch 请求方式，这里不再过多演示
上传文件
public final class UpdateImageApi implements IRequestApi, IRequestType {

    @NonNull
    @Override
    public String getApi() {
        return "upload/";
    }

    @NonNull
    @Override
    public BodyType getBodyType() {
        // 上传文件需要使用表单的形式提交
        return BodyType.FORM;
    }

    /** 本地图片 */
    private File image;

    public UpdateImageApi(File image) {
        this.image = image;
    }

    public UpdateImageApi setImage(File image) {
        this.image = image;
        return this;
    }
}
EasyHttp.post(this)
        .api(new UpdateImageApi(file))
        .request(new OnUpdateListener<Void>() {

            @Override
            public void onUpdateStart(Call call) {
                mProgressBar.setVisibility(View.VISIBLE);
            }

            @Override
            public void onUpdateProgressChange(int progress) {
                mProgressBar.setProgress(progress);
            }

            @Override
            public void onUpdateSuccess(Void result) {
                toast("上传成功");
            }

            @Override
            public void onUpdateFail(Exception e) {
                toast("上传失败");
            }

            @Override
            public void onUpdateEnd(Call call) {
                mProgressBar.setVisibility(View.GONE);
            }
        });
  • 需要注意的是：如果上传的文件过多或者过大，可能会导致请求超时，可以重新设置本次请求超时时间，超时时间建议根据文件大小而定，具体设置超时方式文档有介绍，可以在本页面直接搜索。
  • 当然除了可以使用 File 类型的对象进行上传，还可以使用 FileContentResolver、InputStream、RequestBody、MultipartBody.Part 类型的对象进行上传，如果你需要批量上传，请使用 List<File>、List<FileContentResolver>、List<InputStream>、List<RequestBody>、List<MultipartBody.Part>、 类型的对象来做批量上传。
下载文件
  • 下载缓存策略：在指定下载文件 md5 或者后台有返回 md5 的情况下，下载框架默认开启下载缓存模式，如果这个文件已经存在手机中，并且经过 md5 校验文件完整，框架就不会重复下载，而是直接回调下载监听。减轻服务器压力，减少用户等待时间。
EasyHttp.download(this)
        .method(HttpMethod.GET)
        .file(new File(Environment.getExternalStorageDirectory(), "微信.apk"))
        //.url("https://qd.myapp.com/myapp/qqteam/AndroidQQ/mobileqq_android.apk")
        .url("http://dldir1.qq.com/weixin/android/weixin708android1540.apk")
        .md5("2E8BDD7686474A7BC4A51ADC3667CABF")
        .listener(new OnDownloadListener() {

            @Override
            public void onDownloadStart(File file) {
                mProgressBar.setVisibility(View.VISIBLE);
            }

            @Override
            public void onDownloadProgressChange(File file, int progress) {
                mProgressBar.setProgress(progress);
            }

            @Override
            public void onDownloadSuccess(File file) {
                toast("下载完成：" + file.getPath());
                installApk(XxxActivity.this, file);
            }

            @Override
            public void onDownloadFail(File file, Exception e) {
                toast("下载出错：" + e.getMessage());
            }

            @Override
            public void onDownloadEnd(File file) {
                mProgressBar.setVisibility(View.GONE);
            }

        }).start();
分区存储适配
  • 在 Android 10 之前，我们在读写外部存储的时候，可以直接使用 File 对象来上传或者下载文件，但是在 Android 10 之后，如果你的项目需要 Android 10 分区存储的特性，那么在读写外部存储文件的时候，就不能直接使用 File 对象，因为 ContentResolver.insert 返回是一个 Uri 对象，这个时候就需要使用到框架提供的 FileContentResolver 对象了（这个对象是 File 的子类），具体使用案例如下：
File outputFile;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
    ContentValues values = new ContentValues();
    .........
    // 生成一个新的 uri 路径
    Uri outputUri = getContentResolver().insert(MediaStore.Xxx.Media.EXTERNAL_CONTENT_URI, values);
    // 适配 Android 10 分区存储特性
    outputFile = new FileContentResolver(context, outputUri);
} else {
    outputFile = new File(xxxx);
}

EasyHttp.post(this)
        .api(new XxxApi()
                .setImage(outputFile))
        .request(new HttpCallbackProxy<Xxx <Xxx>>(this) {

            @Override
            public void onHttpSuccess(Xxx<Xxx> data) {

            }
        });
  • 这是上传的案例，下载也同理，这里不再赘述。
发起同步请求
  • 需要注意的是：同步请求是耗时操作，不能在主线程中执行，请务必保证此操作在子线程中执行
PostRequest postRequest = EasyHttp.post(MainActivity.this);
try {
    HttpData<SearchBean> data = postRequest
            .api(new SearchBlogsApi()
                    .setKeyword("搬砖不再有"))
            .execute(new ResponseClass<HttpData<SearchBean>>() {});
    toast("请求成功，请看日志");
} catch (Exception e) {
    toast(e.getMessage());
}
设置请求缓存
  • 需要先实现读取和写入缓存的接口，如果已配置则可以跳过，这里以 MMKV 为例
public final class RequestHandler implements IRequestHandler {

    private final Application mApplication;
    private final MMKV mMmkv;

    public RequestHandler(Application application) {
        mApplication = application;
        mMmkv = MMKV.mmkvWithID("http_cache_id");
    }

    ..................

    @Nullable
    @Override
    public Object readCache(@NonNull HttpRequest<?> httpRequest, @NonNull Type type, long cacheTime) {
        String cacheKey = HttpCacheManager.generateCacheKey(httpRequest);
        String cacheValue = HttpCacheManager.getMmkv().getString(cacheKey, null);
        if (cacheValue == null || "".equals(cacheValue) || "{}".equals(cacheValue)) {
            return null;
        }
        EasyLog.printLog(httpRequest, "----- readCache cacheKey -----");
        EasyLog.printJson(httpRequest, cacheKey);
        EasyLog.printLog(httpRequest, "----- readCache cacheValue -----");
        EasyLog.printJson(httpRequest, cacheValue);
        return GsonFactory.getSingletonGson().fromJson(cacheValue, type);
    }

    @Override
    public boolean writeCache(@NonNull HttpRequest<?> httpRequest, @NonNull Response response, @NonNull Object result) {
        String cacheKey = HttpCacheManager.generateCacheKey(httpRequest);
        String cacheValue = GsonFactory.getSingletonGson().toJson(result);
        if (cacheValue == null || "".equals(cacheValue) || "{}".equals(cacheValue)) {
            return false;
        }
        EasyLog.printLog(httpRequest, "----- writeCache cacheKey -----");
        EasyLog.printJson(httpRequest, cacheKey);
        EasyLog.printLog(httpRequest, "----- writeCache cacheValue -----");
        EasyLog.printJson(httpRequest, cacheValue);
        return HttpCacheManager.getMmkv().putString(cacheKey, cacheValue).commit();
    }

    @Override
    public void clearCache() {
        HttpCacheManager.getMmkv().clearMemoryCache();
        HttpCacheManager.getMmkv().clearAll();
    }
}
public class HttpCacheManager {

   private volatile static MMKV sMmkv;

   /**
    * 获取单例的 MMKV 实例
    */
   public static MMKV getMmkv() {
      if(sMmkv == null) {
         synchronized (RequestHandler.class) {
            if (sMmkv == null) {
               sMmkv = MMKV.mmkvWithID("http_cache_id");
            }
         }
      }
      return sMmkv;
   }

   /**
    * 生成缓存的 key
    */
   public static String generateCacheKey(@NonNull HttpRequest<?> httpRequest) {
      IRequestApi requestApi = httpRequest.getRequestApi();
      return "用户 id" + "\n" + requestApi.getApi() + "\n" + GsonFactory.getSingletonGson().toJson(requestApi);
   }
}
  • 首先请求缓存模式有四种方式，都在 CacheMode 这个枚举类中
public enum CacheMode {

    /**
     * 默认（按照 Http 协议来缓存）
     */
    DEFAULT,

    /**
     * 不使用缓存（禁用 Http 协议缓存）
     */
    NO_CACHE,

    /**
     * 只使用缓存
     *
     * 已有缓存的情况下：读取缓存 -> 回调成功
     * 没有缓存的情况下：请求网络 -> 写入缓存 -> 回调成功
     */
    USE_CACHE_ONLY,

    /**
     * 优先使用缓存
     *
     * 已有缓存的情况下：先读缓存 —> 回调成功 —> 请求网络 —> 刷新缓存
     * 没有缓存的情况下：请求网络 -> 写入缓存 -> 回调成功
     */
    USE_CACHE_FIRST,

    /**
     * 只在网络请求失败才去读缓存
     */
    USE_CACHE_AFTER_FAILURE
}
  • 为某个接口设置缓存模式
public final class XxxApi implements IRequestApi, IRequestCache {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/";
    }

    @NonNull
    @Override
    public CacheMode getCacheMode() {
        // 设置优先使用缓存
        return CacheMode.USE_CACHE_FIRST;
    }
}
  • 全局设置缓存模式
public class XxxServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.xxxxxxx.com/";
    }

    @NonNull
    @Override
    public CacheMode getCacheMode() {
        // 只在请求失败才去读缓存
        return CacheMode.USE_CACHE_AFTER_FAILURE;
    }
}
搭配协程使用
  • 可以使用同步请求搭配协程做处理，使用代码如下：
lifecycleScope.launch(Dispatchers.IO) {
    try {
        val bean = EasyHttp.post(this@XxxActivity)
            .api(XxxApi().apply {
                setXxx(xxx)
                setXxxx(xxxx)
            })
            .execute(object : ResponseClass<HttpData<XxxBean?>>() {})
        withContext(Dispatchers.Main) {
            // 在这里进行 UI 刷新
        }
    } catch (e: Exception) {
        toast(e.message)
    }
}
  • 如果你对协程的使用不太熟悉，推荐你看一下这篇文章
如何设置 Cookie
  • EasyHttp 是基于 OkHttp 封装的，而 OkHttp 本身就是支持设置 Cookie，所以用法和 OkHttp 是一样的
OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .cookieJar(new XxxCookieJar())
        .build();

EasyConfig.with(okHttpClient)
        .setXxx()
        .into();
如何添加或者删除全局参数
  • 添加全局请求参数
EasyConfig.getInstance().addParam("key", "value");
  • 移除全局请求参数
EasyConfig.getInstance().removeParam("key");
  • 添加全局请求头
EasyConfig.getInstance().addHeader("key", "value");
  • 移除全局请求头
EasyConfig.getInstance().removeHeader("key");
如何定义全局的动态参数
EasyConfig.getInstance().setInterceptor(new IRequestInterceptor() {

    @Override
    public void interceptArguments(@NonNull HttpRequest<?> httpRequest, @NonNull HttpParams params, @NonNull HttpHeaders headers) {
        headers.put("key", "value");
        params.put("key", "value");
    }
});
如何在请求中忽略某个全局参数
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    @HttpIgnore
    private String token;
}
如何获取服务器配置
  • 先定义一个服务器配置
public class XxxServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.xxxxxxx.com/";
    }
}
  • 再将它应用到全局配置中
EasyConfig.getInstance().setServer(new XxxServer());
  • 如果只是针对某个接口可以这样配置
public final class XxxApi extends XxxServer implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }
}
  • 如果不想单独定义一个类，也可以这样写
public final class XxxApi implements IRequestServer, IRequestApi {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.xxxxxxx.com/";
    }

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }
}
如何配置多域名
  • 先定义一个普通接口的测试服和正式服的配置
public class TestServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.test.xxxxxxx.com/";
    }
}
public class ReleaseServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.xxxxxxx.com/";
    }
}
  • 再将它应用到全局配置中
IRequestServer server;
if (BuildConfig.DEBUG) {
    server = new TestServer();
} else {
    server = new ReleaseServer();
}
EasyConfig.getInstance().setServer(server);
  • 假设要为 H5 业务模块设定特定服务器配置，可以这样做
public class H5Server implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        IRequestServer server = EasyConfig.getInstance().getServer();
        if (server instanceof TestServer) {
            return "https://www.test.h5.xxxxxxx.com/";
        }
        return "https://www.h5.xxxxxxx.com/";
    }
}
  • 在配置接口的时候继承 H5Server 就可以了，其他 H5 模块的配置也是雷同
public final class UserAgreementApi extends H5Server implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "user/agreement";
    }
}
如何修改参数的提交方式
  • 以表单的形式提交参数（默认）
public class XxxServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.xxxxxxx.com/";
    }

    @NonNull
    @Override
    public BodyType getBodyType() {
        return BodyType.FORM;
    }
  • 以 Json 的形式提交参数
public class XxxServer implements IRequestServer {

    @NonNull
    @Override
    public String getHost() {
        return "https://www.xxxxxxx.com/";
    }

    @NonNull
    @Override
    public BodyType getBodyType() {
        return BodyType.JSON;
    }
  • 当然也支持对某个接口进行单独配置
public final class XxxApi implements IRequestApi, IRequestType {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    @NonNull
    @Override
    public BodyType getBodyType() {
        return BodyType.JSON;
    }
}
  • 表单和 Json 方式提交的优缺点对比

场景

表单方式

Json 方式

多级参数

不支持

支持

文件上传

支持

不支持

如何对接口进行加密或者解密
  • 关于这个问题，其实可以利用框架中提供的 IRequestInterceptor 接口来实现，通过重写接口中的对应方法进行拦截，修改对象的内容从而达到加密的效果。
public interface IRequestInterceptor {

    /**
     * 拦截参数
     *
     * @param httpRequest   接口对象
     * @param params        请求参数
     * @param headers       请求头参数
     */
    default void interceptArguments(@NonNull HttpRequest<?> httpRequest, @NonNull HttpParams params, @NonNull HttpHeaders headers) {}

    /**
     * 拦截请求头
     *
     * @param httpRequest   接口对象
     * @param request       请求头对象
     * @return              返回新的请求头
     */
    @NonNull
    default Request interceptRequest(@NonNull HttpRequest<?> httpRequest, @NonNull Request request) {
        return request;
    }

    /**
     * 拦截器响应头
     *
     * @param httpRequest   接口对象
     * @param response      响应头对象
     * @return              返回新的响应头
     */
    @NonNull
    default Response interceptResponse(@NonNull HttpRequest<?> httpRequest, @NonNull Response response) {
        return response;
    }
}
// 在框架初始化的时候设置拦截器
EasyConfig.with(okHttpClient)
        // 设置请求参数拦截器
        .setInterceptor(new XxxInterceptor())
        .into();
  • 如果你只想对某个接口进行加解密，可以让 Api 类单独实现 IRequestInterceptor 接口，这样它就不会走全局的配置。
如何忽略某个参数
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    @HttpIgnore
    private String address;
如何传入请求头
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    @HttpHeader
    private String time;
}
如何重命名参数或者请求头的名称
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    @HttpRename("k")
    private String keyword;
}
如何上传文件
  • 使用 File 对象上传
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    private File file;
}
  • 使用 InputStream 对象上传
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    private InputStream inputStream;
}
  • 使用 RequestBody 对象上传
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    private RequestBody requestBody;
如何上传文件列表
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxxx";
    }

    private List<File> files;
}
如何设置超时重试
// 设置请求重试次数
EasyConfig.getInstance().setRetryCount(3);
// 设置请求重试时间
EasyConfig.getInstance().setRetryTime(1000);
如何设置请求超时时间
  • 全局配置（针对所有接口都生效）
OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.readTimeout(5000, TimeUnit.MILLISECONDS);
builder.writeTimeout(5000, TimeUnit.MILLISECONDS);
builder.connectTimeout(5000, TimeUnit.MILLISECONDS);

EasyConfig.with(builder.build())
        .into();
  • 局部配置（只在某个接口上生效）
public final class XxxApi implements IRequestApi, IRequestClient {

    @NonNull
    @Override
    public String getApi() {
        return "xxxx/";
    }

    @NonNull
    @Override
    public OkHttpClient getOkHttpClient() {
        OkHttpClient.Builder builder = EasyConfig.getInstance().getOkHttpClient().newBuilder();
        builder.readTimeout(5000, TimeUnit.MILLISECONDS);
        builder.writeTimeout(5000, TimeUnit.MILLISECONDS);
        builder.connectTimeout(5000, TimeUnit.MILLISECONDS);
        return builder.build();
    }
}
如何设置不打印日志
EasyConfig.getInstance().setLogEnabled(false);
如何修改日志打印策略
  • 可以先定义一个类实现 IRequestLogStrategy 接口，然后在框架初始化的时候传入即可
EasyConfig.with(okHttpClient)
        .......
        // 设置自定义的日志打印策略
        .setLogStrategy(new XxxStrategy())
        .into();
  • 需要修改日志打印策略的场景
    • 需要将请求的日志写入到本地
    • 需要修改打印的请求日志格式
如何取消已发起的请求
// 取消和这个 LifecycleOwner 关联的请求
EasyHttp.cancel(LifecycleOwner lifecycleOwner);
// 取消指定 Tag 标记的请求
EasyHttp.cancel(Object tag);
// 取消所有请求
EasyHttp.cancel();
如何延迟发起一个请求
EasyHttp.post(MainActivity.this)
        .api(new XxxApi())
        // 延迟 5 秒后请求
        .delay(5000)
        .request(new HttpCallbackProxy<HttpData<XxxBean>>(MainActivity.this) {

            @Override
            public void onHttpSuccess(HttpData<XxxBean> result) {

            }
        });
如何对接口路径进行动态化拼接
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "article/query/" + pageNumber + "/json";
    }

    @HttpIgnore
    private int pageNumber;

    public XxxApi setPageNumber(int pageNumber) {
        this.pageNumber = pageNumber;
        return this;
    }
}
如何动态化整个请求的 url
EasyHttp.post(this)
        .api(new RequestUrl("https://xxxx.com/aaaa"))
        .request(new HttpCallbackProxy<Xxx>(this) {

            @Override
            public void onHttpSuccess(Xxx result) {

            }
        });
Https 如何配置信任所有证书
  • 在初始化 OkHttp 的时候这样设置
HttpSslConfig sslConfig = HttpSslFactory.generateSslConfig();
OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .sslSocketFactory(sslConfig.getsSLSocketFactory(), sslConfig.getTrustManager())
        .hostnameVerifier(HttpSslFactory.generateUnSafeHostnameVerifier())
        .build();
  • 但是不推荐这样做，因为这样是不安全的，意味着每个请求都不会用 Https 去校验
  • 当然框架中也提供了一些生成的证书的 API，具体请参见 com.hjq.http.ssl 包下的类
我不想一个接口写一个类怎么办
  • 先定义一个 URL 管理类，将 URL 配置到这个类中
public final class HttpUrls {

    /** 获取用户信息 */
    public static final String GET_USER_INFO =  "user/getUserInfo";
}
  • 然后在 EasyHttp 引入接口路径
EasyHttp.post(this)
        .api(HttpUrls.GET_USER_INFO)
        .request(new HttpCallbackProxy<HttpData<XxxBean>>(this) {

            @Override
            public void onHttpSuccess(HttpData<XxxBean> result) {

            }
        });
  • 不过这种方式只能应用于没有参数的接口，有参数的接口还是需要写一个类，因为框架只会在 Api 类中去解析参数。
  • 虽然 EasyHttp 开放了这种写法，但是身为作者的我并不推荐你这样写，因为这样写会导致扩展性很差，比如后续加参数，还要再改回来，并且无法对接口进行动态化配置。
框架只能传入 LifecycleOwner 该怎么办
  • 其中 androidx.appcompat.app.AppCompatActivity 和 androidx.fragment.app.Fragment 都是 LifecycleOwner 子类的，这个是毋庸置疑的，可以直接当做 LifecycleOwner 传给框架
  • 但是你如果传入的是 android.app.Activity 对象，并非 androidx.appcompat.app.AppCompatActivity 对象，那么你可以这样写
EasyHttp.post(new ActivityLifecycle(this))
        .api(new XxxApi())
        .request(new HttpCallbackProxy<HttpData<XxxBean>>(this) {

            @Override
            public void onHttpSuccess(HttpData<XxxBean> result) {

            }
        });
  • 如果你传入的是 android.app.Fragment 对象，并非 androidx.fragment.app.Fragment 对象，请将 Fragment 直接继承框架中的 LifecycleAppFragment 类，又或者在项目中封装一个带有 Lifecycle 特性的 Fragment 基类
  • 你如果想在 android.app.Service 中使用 EasyHttp，请将 Service 直接继承框架中的 LifecycleService 类，又或者在项目中封装一个带有 Lifecycle 特性的 Service 基类
  • 如果以上条件都不满足，但是你就是想在某个地方请求网络，那么你可以这样写
EasyHttp.post(ApplicationLifecycle.getInstance())
        .api(new XxxApi())
        .tag("abc")
        .request(new OnHttpListener<HttpData<XxxBean>>() {

            @Override
            public void onHttpSuccess(HttpData<XxxBean> result) {

            }

            @Override
            public void onHttpFail(Exception e) {

            }
        });
  • 需要注意的是，传入 ApplicationLifecycle 将意味着框架无法自动把控请求的生命周期，如果在 Application 中这样写是完全可以的，但是不能在 Activity 或者 Service 中这样写，因为这样可能会导致内存泄漏。
  • 除了 Application，如果你在 Activity 或者 Service 中采用了 ApplicationLifecycle 的写法，那么为了避免内存泄漏或者崩溃的事情发生，需要你在请求的时候设置对应的 Tag，然后在恰当的时机手动取消请求（一般在 Activity 或者 Service 销毁或者退出的时候取消请求）。
如何在 ViewModel 中使用 EasyHttp 请求网络
  • 第一步：封装一个 BaseViewModel，并将 LifecycleOwner 特性植入进去
public class BaseViewModel extends ViewModel implements LifecycleOwner {

    private final LifecycleRegistry mLifecycle = new LifecycleRegistry(this);

    public BaseViewModel() {
        mLifecycle.handleLifecycleEvent(Lifecycle.Event.ON_CREATE);
        mLifecycle.handleLifecycleEvent(Lifecycle.Event.ON_RESUME);
    }

    @Override
    protected void onCleared() {
        super.onCleared();
        mLifecycle.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY);
    }

    @NonNull
    @Override
    public Lifecycle getLifecycle() {
        return mLifecycle;
    }
}
  • 第二步：让业务 ViewModel 类继承至 BaseViewModel，具体案例如下
public class XxxViewModel extends BaseViewModel {

    public void xxxx() {
        EasyHttp.post(this)
                .api(new XxxApi())
                .request(new OnHttpListener<HttpData<Xxx>>() {

                    @Override
                    public void onHttpSuccess(HttpData<Xxx> result) {

                    }

                    @Override
                    public void onHttpFail(Exception e) {

                    }
                });
    }
}
我想取消请求时显示的加载对话框该怎么办
  • 首先这个加载对话框不是框架自带的，是可以修改或者取消的，主要有两种方式可供选择
  • 第一种方式：重写 HttpCallbackProxy 类回调方法
EasyHttp.post(this)
        .api(new XxxApi())
        .request(new HttpCallbackProxy<Xxx>(this) {

            @Override
            public void onHttpStart(Call call) {
                // 重写方法并注释父类调用
                //super.onHttpStart(call);
            }

            @Override
            public void onHttpEnd(Call call) {
                // 重写方法并注释父类调用
                //super.onHttpEnd(call);
            }
        });
  • 第二种方式：直接实现 OnHttpListener 接口

EasyHttp.post(this)
        .api(new XxxApi())
        .request(new OnHttpListener<Xxx>() {

            @Override
            public void onHttpSuccess(Xxx result) {

            }

            @Override
            public void onHttpFail(Exception e) {

            }
        });
我想用 Json 数组作为参数进行上传该怎么办
  • 由于 Api 类最终会转换成一个 JsonObject 类型的字符串，如果你需要上传 JsonArray 类型的字符串，请使用以下方式实现
List<Xxx> parameter = new ArrayList<>();
list.add(xxx);
list.add(xxx);
String json = gson.toJson(parameter);

EasyHttp.post(this)
        .api(new XxxApi())
        .body(new JsonBody(json))
        .request(new HttpCallbackProxy<HttpData<Xxx>>(this) {

            @Override
            public void onHttpSuccess(HttpData<Xxx> result) {

            }
        });
  • 但是我个人不推荐将 JsonArray 作为参数的根部类型，因为这样的接口后续的扩展性极差。
接口参数的 Key 值是动态变化的该怎么办
  • 框架是通过反射解析 Api 类中的字段来作为参数的，字段名作为参数的 Key 值，字段值作为参数的 Value 值，由于 Java 无法动态更改类的字段名，所以无法通过正常的手段进行修改，你如果有这种需求，请通过以下方式进行实现
HashMap<String, Object> parameter = new HashMap<>();

// 添加全局参数
HashMap<String, Object> globalParams = EasyConfig.getInstance().getParams();
Set<String> keySet = globalParams.keySet();
for (String key : keySet) {
    parameter.put(key, globalParams.get(key));
}

// 添加自定义参数
parameter.put("key1", value1);
parameter.put("key2", value2);

String json = gson.toJson(parameter);
JsonBody jsonBody = new JsonBody(json)

EasyHttp.post(this)
        .api(new XxxApi())
        .body(jsonBody)
        .request(new HttpCallbackProxy<HttpData<Xxx>>(this) {

            @Override
            public void onHttpSuccess(HttpData<Xxx> result) {

            }
        });
如何设置自定义的 UA 标识
  • 首先 UA 是 User Agent 的简称，当我们没有设置自定义 UA 标识的时候，那么 OkHttp 会在 BridgeInterceptor 拦截器添加一个默认的 UA 标识，那么如何在 EasyHttp 设置自定义 UA 标识呢？其实很简单，UA 标识本质上其实就是一个请求头，在 EasyHttp 中添加一个请求头为 User-Agent 的参数即可，至于怎么添加请求头，前面的文档已经有介绍了，这里不再赘述。
我想修改请求回调所在的线程该怎么办
EasyHttp.post(this)
        .api(new XxxApi())
        // 表示回调是在子线程中进行
        .schedulers(ThreadSchedulers.IOThread)
        .request(new HttpCallbackProxy<HttpData<Xxx>>(this) {

            @Override
            public void onHttpSuccess(HttpData<Xxx> result) {

            }
        });
我想自定义一个 RequestBody 进行请求该怎么办
  • 在一些极端的情况下，框架无法满足使用的前提下，这个时候需要自定义 RequestBody 来实现，那么怎么使用自定义 RequestBody 呢？框架其实有开放方法，具体使用示例如下：
EasyHttp.post(this)
        .api(new XxxApi())
        .body(RequestBody body)
        .request(new HttpCallbackProxy<HttpData<Xxx>>(this) {

            @Override
            public void onHttpSuccess(HttpData<Xxx> result) {

            }
        });
  • 需要注意的是：由于 Post 请求是将参数放置到 RequestBody 上面，而一个请求只能设置一个 RequestBody，如果你设置了自定义 body(RequestBody body)，那么框架将不会去将 XxxApi 类中的字段解析成参数。另外除了 Post 请求，Put 请求和 Patch 请求也可以使用这种方式进行设置，这里不再赘述。
我想自定义请求头中的 ContentType 该怎么做
  • 具体的写法示例如下：
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "xxx/xxx";
    }

    @HttpHeader
    @HttpRename("Content-Type")
    private String contentType = "application/x-www-form-urlencoded;charset=utf-8";
}
  • 需要注意的是：此功能仅是在框架 11.5 版本的时候加上的，之前的版本没有这一功能
我想自定义 Get 请求参数中的 key 和 value 该怎么做
  • 先自定义一个 Api 类，然后通过 getApi 方法将参数动态拼接上去
public final class CustomParameterApi implements IRequestApi {

   @HttpIgnore
   @NonNull
   private final Map<String, String> parameters;

   public CustomParameterApi() {
      this(new HashMap<>());
   }

   public CustomParameterApi(@NonNull Map<String, String> parameters) {
      this.parameters = parameters;
   }

   @NonNull
   @Override
   public String getApi() {
      Set<String> keys = parameters.keySet();

      StringBuilder builder = new StringBuilder();
      int index = 0;
      for (String key : keys) {
         String value = parameters.get(key);

         if (index == 0) {
            builder.append("?");
         }
         builder.append(key)
                 .append("=")
                 .append(value);
         if (index < keys.size() - 1) {
            builder.append("&");
         }
         index++;
      }

      return "xxx/xxx" + builder;
   }

   public CustomParameterApi putParameter(String key, String value) {
      parameters.put(key, value);
      return this;
   }

   public CustomParameterApi removeParameter(String key) {
      parameters.remove(key);
      return this;
   }
}
  • 外层可以通过以下方式进行调用
CustomParameterApi api = new CustomParameterApi();
api.putParameter("key1", "value1");
api.putParameter("key2", "value2");

EasyHttp.get(this)
        .api(api)
        .request(new HttpCallbackProxy<Xxx>(this) {

            @Override
            public void onHttpSuccess(Xxx result) {

            }
        });
  • 需要注意的是：这种实现方式仅适用于在框架设计无法满足需求的情况下，其他情况下作者并不提倡用这种方式，因为这样不方便管理请求参数的 key，还是推荐大家使用在类上面定义字段的方式来实现。
我想在 Post 请求中定义类似 Get 请求参数该怎么做
  • 直接拼接请求的参数到 url 上面，并且忽略某个字段的值（避免被解析成 Post 参数）
public final class XxxApi implements IRequestApi {

    @NonNull
    @Override
    public String getApi() {
        return "article/query?pageNumber=" + pageNumber;
    }

    @HttpIgnore
    private int pageNumber;

    public XxxApi setPageNumber(int pageNumber) {
        this.pageNumber = pageNumber;
        return this;
    }
}
  • Ps：一般情况下我是不建议这样写的，这样的请求看起来不伦不类，即长得像一个 Get 请求，但是实际上却是一个 Post 请求。

搭配 RxJava

准备工作
  • 添加远程依赖
dependencies {
    // RxJava：https://github.com/ReactiveX/RxJava
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
    implementation 'io.reactivex.rxjava2:rxjava:2.2.12'
}
  • 请注意 RxJava 需要自行处理生命周期，以免发生内存泄漏
多个请求串行
Observable.create(new ObservableOnSubscribe<HttpData<SearchBean>>() {

    @Override
    public void subscribe(ObservableEmitter<HttpData<SearchBean>> emitter) throws Exception {

        HttpData<SearchBean> data1;
        try {
            data1 = EasyHttp.post(MainActivity.this)
                    .api(new SearchBlogsApi()
                            .setKeyword("搬砖不再有"))
                    .execute(new ResponseClass<HttpData<SearchBean>>() {});
        } catch (Exception e) {
            throw e;
        }

        HttpData<SearchBean> data2;
        try {
            data2 = EasyHttp.post(MainActivity.this)
                    .api(new SearchBlogsApi()
                            .setKeyword(data1.getMessage()))
                    .execute(new ResponseClass<HttpData<SearchBean>>() {});
        } catch (Exception e) {
            throw e;
        }

        emitter.onNext(data2);
        emitter.onComplete();
    }
})
// 让被观察者执行在IO线程
.subscribeOn(Schedulers.io())
// 让观察者执行在主线程
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<HttpData<SearchBean>>() {

    @Override
    public void accept(HttpData<SearchBean> data) throws Exception {
        Log.i("EasyHttp", "最终结果为：" + data.getMessage());
    }

}, new Consumer<Throwable>() {

    @Override
    public void accept(Throwable throwable) throws Exception {
        toast(throwable.getMessage());
    }
});
发起轮询请求
  • 如果轮询的次数是有限，可以考虑使用 Http 请求来实现，但是如果轮询的次数是无限的，那么不推荐使用 Http 请求来实现，应当使用 WebSocket 来做，又或者其他长链接协议来做。
// 发起轮询请求，共发起三次请求，第一次请求在 5 秒后触发，剩下两次在 1 秒 和 2 秒后触发
Observable.intervalRange(1, 3, 5000, 1000, TimeUnit.MILLISECONDS)
        // 让被观察者执行在 IO 线程
        .subscribeOn(Schedulers.io())
        // 让观察者执行在主线程
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(new Consumer<Long>() {
            @Override
            public void accept(Long aLong) throws Exception {
                EasyHttp.post(MainActivity.this)
                        .api(new SearchBlogsApi()
                                .setKeyword("搬砖不再有"))
                        .request(new HttpCallbackProxy<HttpData<SearchBean>>(MainActivity.this) {

                            @Override
                            public void onHttpSuccess(HttpData<SearchBean> result) {

                            }
                        });
            }
        });
对返回的数据进行包装
Observable.create(new ObservableOnSubscribe<HttpData<SearchBean>>() {

    @Override
    public void subscribe(ObservableEmitter<HttpData<SearchBean>> emitter) throws Exception {
        EasyHttp.post(MainActivity.this)
                .api(new SearchBlogsApi()
                        .setKeyword("搬砖不再有"))
                .request(new HttpCallbackProxy<HttpData<SearchBean>>(MainActivity.this) {

                    @Override
                    public void onHttpSuccess(HttpData<SearchBean> result) {
                        emitter.onNext(result);
                        emitter.onComplete();
                    }

                    @Override
                    public void onHttpFail(Exception e) {
                        super.onHttpFail(e);
                        emitter.onError(e);
                    }
                });
    }
})
.map(new Function<HttpData<SearchBean>, String>() {

    @Override
    public String apply(HttpData<SearchBean> data) throws Exception {
        int curPage = data.getData().getCurPage();
        int pageCount = data.getData().getPageCount();
        return curPage + "/" + pageCount;
    }
})
// 让被观察者执行在 IO 线程
.subscribeOn(Schedulers.io())
// 让观察者执行在主线程
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<String>() {

    @Override
    public void accept(String s) throws Exception {
        Log.i("EasyHttp", ""当前页码位置" + s);
    }

}, new Consumer<Throwable>() {

    @Override
    public void accept(Throwable throwable) throws Exception {
        toast(throwable.getMessage());
    }
});
KarenChia
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
EasyHttp 基于OkHttp的网络请求框架
暮醉南山的博客
07-13 1万+
EasyHttp 一个可扩展的Http框架一、 引入项目compile ‘com.liwy.easyhttp:easyhttp:1.0.6’二、 初始化在Application里初始化,主要初始化内容为统一解析回调和IHttpService实现类传入，具体如下： // 默认已实现两种解析方式GSON和xml // 也可以自定义解析方式，比如解析html类型的数据
EasyHttp基本使用
HeerKirov的博客
05-10 5417
由于在用C#请求DRF的API时遇到了认证问题，只好用个第三方的包来解决这个问题。 同时了解到了HttpLib和EasyHttp，然后决定使用EasyHttp。 项目的地址：https://github.com/EasyHttp/EasyHttp。在VS上可以直接用NuGet安装。 主要使用的内容在EasyHttp.Http中。
RxEasyHttp网络库请求数据（三）
zhou-you
06-22 3497
github源码地址：https://github.com/zhou-you/RxEasyHttp请求数据网络请求，采用链式调用，支持一点到底。入口方法 /** * get请求 */ public static GetRequest get(String url); /** * post请求和文件上传 */ public static
css-sprite使用详解
09-25
主要介绍了css-sprite的使用详解,css-sprite是一个经常被用来合并前端图片的工具.需要的朋友可以参考下
Android-EasyHttp是一个基于OkHttp封装的KotlinDSL网络请求框架
08-13
EasyHttp是一个基于OkHttp封装的Kotlin DSL网络请求框架
EasyHttp_OkHttp网络请求框架_EasyHttp_
09-30
EasyHttp 基于OkHttp的网络请求框架
easyproxy:适用于android应用的Easy Http Proxy。 在那些只希望为您的应用程序代理的日子里。 支持不同的URL代理
05-25
适用于Android和Java的简易代理 适用于android和java应用程序的Easy Proxy。 在那些只希望为您的应用程序代理的日子里。 为不同的URL支持不同的代理。 我们都知道这是多么痛苦： 进入wifi->长按wifi->修改网络->输入IP和端口 后来忘记了您已经进行了此设置，并思考了为什么我的互联网无法正常工作。 上帝啊，这到底是为什么？？？ 特征 为所有网址设置单个代理。 为除某些排除规则外的所有URL设置单个代理。 为所有网址设置单个代理，但对于某些网址格式，除了某些排除规则和一些单独的代理规则外。 不可知的图书馆。 您可以使用任何需要Volley，OkHttp，Ion或任何其他http库的库。 用法示例 在您的应用程序类中初始化EasyProxy，如下所示。 package com.vijayrawatsan.easyproxy.demo ; imp
EasyHttp:Android 网络请求框架，简单易用，so easy
05-12
简单易用的网络框架 码云地址： 博客地址： 另外对 OkHttp 原理感兴趣的同学推荐你看以下源码分析文章 集成步骤 在项目根目录下的 build.gradle 文件中加入 buildscript { ...... } allprojects { repositories { // JitPack 远程仓库：https://jitpack.io maven { url 'https://jitpack.io' } } } 在项目 app 模块下的 build.gradle 文件中加入 android { // 支持 JDK 1.8 compileOptions { targetCompatibility JavaVersion.VERSION_1_8 sourceCompatibilit
【Android -- 开源库】网络请求 EasyHttp 的基本使用
Kevin Learn Android
05-18 4586
Android 网络请求框架，简单易用
EasyHttp框架的使用
xxdw1992的博客
11-06 375
网络请求，如斯优雅 - 简书GitHub - getActivity/EasyHttp: Android 网络请求框架，简单易用，so easy。
Easy Http Proxy
01-29
Easy Http Proxy Server
easyhttpproxy
01-28
httpproxy
PermissionsDispatcher-master使用详解.zip
06-02
PermissionsDispatcher-master使用详解.zip 权限的详解， 权限使用详解。 可以参考一下， 可以拿来借鉴开发。
IAR-使用详解.docx
08-15
IAR-使用详解.docx， 官方中文使用详细介绍文档
基于Jexus-5.6.3使用详解
10-18
下面小编就为大家分享一篇基于Jexus-5.6.3使用详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
background-size使用详解
09-25
主要介绍了background-size使用详解,需要的朋友可以参考下
Android --- 英文单引号用&apos；替换报错：does not contain a valid string resource
梁同学与Android
04-23 249
Android --- 英文单引号用&apos;替换报错：does not contain a valid string resource
Android 14 transtion 动画流程
u012627628的博客
04-24 1026
implements Transitions.TransitionHandler 的对象都会调用到startAnimation。根据上步计算出来的sortedTargets计算要做的动画TransitionInfo。此列表在开始做动画时候会判断里面的key，value是否满足做动画的条件。将符合条件的changeInfo添加到targets 返回。计算所有的到mChanges。
关于MySQL Command Line Client 运行闪退问题解决，my.ini文件内容
最新发布
m0_67403773的博客
04-26 303
解决 Command Line Client 缺少my.ini文件内容，导致运行闪退问题问题
undetected-chromedriver使用详解
06-06
undetected-chromedriver是一个Python库，它是基于Selenium WebDriver和ChromeDriver的封装，旨在提供更好的自动化测试和爬虫体验。 使用undetected-chromedriver可以解决ChromeDriver被检测到的问题，因为它会自动在ChromeDriver启动的时候模拟人类操作，从而避免被网站检测到。 下面是使用undetected-chromedriver的详细步骤： 1. 安装undetected-chromedriver库： ``` pip install undetected-chromedriver ``` 2. 导入库并创建ChromeDriver实例： ```python from undetected_chromedriver import Chrome, ChromeOptions options = ChromeOptions() # 配置ChromeOptions options.add_argument("--headless") # 无头模式 options.add_argument("--no-sandbox") # 禁用沙箱模式 options.add_argument("--disable-dev-shm-usage") # 禁用/dev/shm使用 options.add_argument("--disable-gpu") # 禁用GPU加速 options.add_argument("--disable-setuid-sandbox") # 禁用setuid沙箱 options.add_argument("--disable-blink-features=AutomationControlled") # 禁用自动化控制特性 with Chrome(options=options) as driver: # 使用ChromeDriver实例进行自动化测试或爬虫 ``` 在创建ChromeDriver实例的时候，需要配置ChromeOptions，可以根据自己的需要添加或修改参数。 3. 在ChromeDriver实例中执行自动化测试或爬虫： ```python with Chrome(options=options) as driver: driver.get("https://www.baidu.com") # 执行自动化测试或爬虫操作 ``` 在ChromeDriver实例中，可以使用WebDriver提供的各种方法执行自动化测试或爬虫操作，例如get方法打开网页，find_element方法查找元素等等。 这就是undetected-chromedriver的使用详解，希望对你有帮助！

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值