热门标签 | HotTags
当前位置:  开发笔记 > 前端 > 正文

深入了解OkHttp3之Interceptors

这篇文章主要介绍了深入了解OkHttp3之Interceptors,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

OKHttp官网上面介绍:拦截器是一种强大的机制,可以监视,重写和重试调用。这里我们主要对拦截器的网络请求头和数据请求的封装。

网络请求头拦截器

在Android应用中,我们通常需要获取用户手机的IMEI值和其他一些常用的参数,如果把他们封装到请求头里面的话会非常的方便。

既然是自定义拦截器,我们首先肯定要继承OKHttp的拦截器,把这个自定义类设置成 final 类型的防止其他类继承。

这里需要在父类的intercept(Chain chain)方法中进行操作。在方法里面得Request.Builder对象然后添加请求头。

创建一个BaseParam 对象,对请求头的参数进行封装。

public final class HeaderInterceptorTest implements Interceptor {

  /**
   * 请求头参数基础参数
   */
  private static final String HEADER_BASE_PARAM = "baseParam";
  private static String BASE_PARAM;

  @Override
  public Response intercept(Chain chain) throws IOException {

    Request.Builder builder = chain.request().newBuilder();

    builder.addHeader(HEADER_BASE_PARAM, BASE_PARAM);
    return chain.proceed(builder.build());
  }

  public static void initBaseParam(Context context) {
    BaseParam baseParam = new BaseParam();
    String imei;
    String imsi;
    try {
      imei = DeviceInfoUtil.getIMEI(context);
    } catch (Exception e) {
      imei = null;
    }
    if (null == imei || imei.equals("")) {
      imei = DeviceInfoUtil.getDeviceID(context);
      imsi = DeviceInfoUtil.getDeviceID(context);
    } else {
      imei = DeviceInfoUtil.getIMEI(context);
      imsi = DeviceInfoUtil.getIMSI(context);
    }
    baseParam.setImei(imei);
    baseParam.setImsi(imsi);
    baseParam.setMac(DeviceInfoUtil.getWifiMAC(context));
    baseParam.setVersion(DeviceInfoUtil.getVersion(context));
    baseParam.setModel(DeviceInfoUtil.getModel());
    baseParam.setBrand(DeviceInfoUtil.getBrand());
    BASE_PARAM = new Gson().toJson(baseParam).toString();
  }

  private static class BaseParam {
    /**
     * imei :
     * imsi :
     * mac :
     * version :
     * model :
     * brand :
     * city :
     */
    private String imei;
    private String imsi;
    private String mac;
    private String version;
    private String model;
    private String brand;
    private String city;

    public String getImei() {
      return imei;
    }

    public void setImei(String imei) {
      this.imei = imei;
    }

    public String getImsi() {
      return imsi;
    }

    public void setImsi(String imsi) {
      this.imsi = imsi;
    }

    public String getMac() {
      return mac;
    }

    public void setMac(String mac) {
      this.mac = mac;
    }

    public String getVersion() {
      return version;
    }

    public void setVersion(String version) {
      this.version = version;
    }

    public String getModel() {
      return model;
    }

    public void setModel(String model) {
      this.model = model;
    }

    public String getBrand() {
      return brand;
    }

    public void setBrand(String brand) {
      this.brand = brand;
    }

    public String getCity() {
      return city;
    }

    public void setCity(String city) {
      this.city = city;
    }
  }
}

数据请求拦截器

在进行数据请求的时候,一般都会定义一种固定的请求格式。在这里我们直接通过拦截器,将这个固定的格式定义好,这样使用起来可以统一管理。具体的使用方法其实和上面一样。

主要注意的是先得到,请求时设置的请求体,然后让请求的数据封装到和后端设置的请求格式里面。

public class HttpDataPackInterceptorTest implements Interceptor {

  @Override
  public Response intercept(Chain chain) throws IOException {
    Request request = chain.request();

    Request.Builder requestBuilder = chain.request().newBuilder();
    //请求数据处理
    if (request.url().toString().contains("uploads")) {
      //特殊接口的参数不需要处理的
    } else {
      //需要处理请求参数的
      if (request.body() instanceof FormBody) {
        FormBody.Builder newFormBody = new FormBody.Builder();
        //得到请求时设置的请求体
        FormBody oldFormBody = (FormBody) request.body();
        Buffer buffer = new Buffer();
        oldFormBody.writeTo(buffer);
        String postParams = JsonUtils.getJsonStrFromPostParams(buffer.readString(Charset.forName("UTF-8")));
        String data = URLDecoder.decode(postParams, "UTF-8");
        if (TextUtils.isEmpty(data)) {
          newFormBody.add("data", "");
        } else {
          //将请求的数据封装
          newFormBody.add("data", data);
        }
        requestBuilder.method(request.method(), newFormBody.build());
      }
    }
    return chain.proceed(requestBuilder.build());
  }
}

代码中调用

在创建OkHttpClient 对象的时候,调用 addInterceptor()方法 添加俩个拦截器。

private OkHttpClient client;
  @Override
  protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_okhttp);
    HeaderInterceptorTest.initBaseParam(this);
    client= new OkHttpClient()
        .newBuilder()
        .addInterceptor(new HeaderInterceptorTest())
        .addInterceptor(new HttpDataPackInterceptorTest())
        .connectTimeout(60, TimeUnit.SECONDS)
        .writeTimeout(60, TimeUnit.SECONDS)
        .readTimeout(60, TimeUnit.SECONDS).build();
    okhttpAsyncPost();
  }

  private void okhttpAsyncPost(){
    RequestBody formBody = new FormBody.Builder()
        .add("page", "1")
        .add("count", "2")
        .add("type","video")
        .build();
    Request request = new Request.Builder()
        .url("https://api.apiopen.top/getJoke")
        .post(formBody)
        .build();

    client.newCall(request).enqueue(new Callback() {
      @Override
      public void onFailure(Call call, IOException e) {

      }

      @Override
      public void onResponse(Call call, Response response) throws IOException {
        Log.e("error","结果"+response.body().string());
        Log.e("error","方法"+response.request().toString());
        Log.e("error","请求头"+response.request().headers().toString());
      }
    });
  }

打印的日志

结果{"status":200,"msg":"OK","data":"{\"count\":\"2\",\"page\":\"1\",\"type\":\"video\"}"}
方法Request{method=POST, url=https://www.26uuun.com/list, tags={}}
请求头baseParam: {"brand":"Xiaomi","city":"\u4e1c\u4eac","imei":"9fc70b16bf169075f556e6d67be9ef1a","imsi":"9fc70b16bf169075f556e6d67be9ef1a","mac":"02:00:00:00:00:00","model":"Mi Note 2","version":"1.0"}

OK,OKHttp3中Interceptors配置完成,小伙伴们,可以设置自己不同需求的其他的拦截器添加到请求中。

最近我会写很多关于Android常用控件的使用,里面都是一些很有用的知识,如果你感觉有用,请给我一个star,谢谢。 代码实例

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


推荐阅读
  • SvpplyTable: 实现可扩展和可折叠的菜单动画
    SvpplyTable 是一个示例项目,旨在实现类似 Svpply 应用程序中的可扩展和可折叠的菜单动画效果。该项目托管在 GitHub 上,地址为 https://github.com/liuminqian/SvpplyTable。 ... [详细]
  • ABP框架是ASP.NET Boilerplate的简称,它不仅是一个开源且文档丰富的应用程序框架,还提供了一套基于领域驱动设计(DDD)的最佳实践架构模型。本文将详细介绍ABP框架的特点、项目结构及其在Web API优先架构中的应用。 ... [详细]
  • 申请地址:https://developer.apple.com/appstore/contact/?topic=expedite 常见申请理由:1. 我们即将发布新产品,这是一个媒体活动,我们无法承担任何风险,因此在多个方面努力提升应用质量。 ... [详细]
  • 本文介绍了 LaiFengcode 在 GitHub 上的两个主要开源项目:SopCastComponent 和 iOS 相关组件。 ... [详细]
  • 近期遇到了一个系统中在线文本编辑器上传本地图片时报服务器异常的问题。经过初步调试和排查,最终找到了解决方案。 ... [详细]
  • 本文介绍了如何使用Postman构建和发送HTTP请求,包括四个主要部分:方法(Method)、URL、头部(Headers)和主体(Body)。特别强调了Body部分的重要性,并详细说明了不同类型的请求体。 ... [详细]
  • 如何解决TS1219:实验性装饰器功能可能在未来版本中更改的问题
    本文介绍了两种方法来解决TS1219错误:通过VSCode设置启用实验性装饰器,或在项目根目录下创建配置文件(jsconfig.json或tsconfig.json)。 ... [详细]
  • MongoDB核心概念详解
    本文介绍了NoSQL数据库的概念及其应用场景,重点解析了MongoDB的基本特性、数据结构以及常用操作。MongoDB是一个高性能、高可用且易于扩展的文档数据库系统。 ... [详细]
  • 小程序的授权和登陆
    小程序的授权和登陆 ... [详细]
  • 本文介绍了 Go 语言中的高性能、可扩展、轻量级 Web 框架 Echo。Echo 框架简单易用,仅需几行代码即可启动一个高性能 HTTP 服务。 ... [详细]
  • PowerQuery中处理空值(null)运算的有效方法
    在数据处理过程中,空值(null)的处理是一个常见的问题。本文将探讨在PowerQuery中如何有效地处理空值运算,确保数据的准确性和完整性。 ... [详细]
  • PostgreSQL 12 版本预览:分离 max_wal_senders 和 max_connections 的连接槽处理
    本文介绍了 PostgreSQL 12 中的一项重要改进,即 max_wal_senders 参数不再计入 max_connections,从而解决了流复制连接槽不足的问题。 ... [详细]
  • 说明Python教程正在编写中,欢迎大家加微信sinbam提供意见、建议、纠错、催更。drymail是一个邮件发送库,封装了Python的smtplib ... [详细]
  • 深入理解Java多线程与并发机制
    本文探讨了Java多线程和并发机制的核心概念,包括多线程类的分类、执行器框架、并发容器及控制工具。通过详细解析这些组件,帮助开发者更好地理解和应用多线程技术。 ... [详细]
  • Spring 中策略模式的应用:Resource 接口详解
    本文探讨了在 Spring 框架中如何利用 Resource 接口实现资源访问策略。Resource 接口作为资源访问策略的抽象,通过多种实现类支持不同类型的资源访问。 ... [详细]
author-avatar
勇敢的柯柯_j
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有