专栏首页恩蓝脚本为Retrofit统一添加post请求的默认参数的方法

为Retrofit统一添加post请求的默认参数的方法

最近在学习使用Retrofit,并尝试将之引入到现有的项目中来。大家都知道,在Http请求中我们使用 Content-Type 来指定不同格式的请求信息:

APP_FORM_URLENCODED("application/x-www-form-urlencoded"),
 APP_JSON("application/json"),
 APP_OCTET_STREAM("application/octet-stream"),
 MULTIPART_FORM_DATA("multipart/form-data"),
 TEXT_HTML("text/html"),
 TEXT_PLAIN("text/plain"),

实际项目中通常最后的请求参数都包含默认的一些参数(Token,Api版本、App版本等)和普通的请求参数。网上有很多关于第一种 Content-Type 添加默认参数的方法。而在我现有项目上,除文件上传外绝大多数请求都走了 post + application/json 的方式。这里暂不讨论两者的优缺点,而是谈下 Content-Type 为 application/json 时,如何添加默认参数。

传统方式:

我们先来回忆下两种方式

public interface Apis {
 
 @POST("user/login")
 Observable<Entity<User   login(@Body RequestBody body);//构造一个RequestBody对象
 
 @POST("user/login")
 Observable<Entity<User   login(@Body LoginInfo loginInfo);//构造一个实体对象
 
 }

第二种方法,你需要为每一个请求的对象创建一个不同的Model,太麻烦了,这里选择第一种直接构造RequestBody对象:

Retrofit mRetrofit = new Retrofit.Builder()
    .baseUrl(HttpConfig.BASE_URL)
    .addConverterFactory(GsonConverterFactory.create())//添加gson转换器
    .addCallAdapterFactory(RxJava2CallAdapterFactory.create())//添加rxjava转换器
    .client(new OkHttpClient.Builder().build())
    .build();
Apis mAPIFunction = mRetrofit.create(Apis.class);
Map<String, Object  params = new LinkedHashMap< ();
 params.put("name", "吴彦祖");
 params.put("request", "123456");
RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), JsonHelper.toJSONString(params));
mAPIFunction.login(RequestBody.create(requestBody))

执行后通过抓包查看,请求体如下:

而我希望的结果是这样的:

当然我们可以每次构造 RequestBody,在传入的参数中加入默认参数:

public static RequestBody getRequestBody(HashMap<String, Object  hashMap) {
  Map<String, Object  params = new LinkedHashMap< ();
  params.put("auth", getBaseParams());
  params.put("request", hashMap);
  return RequestBody.create(MediaType.parse("application/json; charset=utf-8"), JsonHelper.toJSONString(params));
 }

这样完全没问题,但不够优雅,所以接下来我们来讨论我所想到的一种方式

拦截器方式:

哈哈,相信熟悉OkHttp的同学已经想到这种方式了,是的很多网上关于第一种 Content-Type 添加默认参数也是这么做的(原文链接):

@Override
 public Response intercept(Chain chain) throws IOException {
  Request request = chain.request();
  if (request.method().equals("POST")) {
  if (request.body() instanceof FormBody) {
   FormBody.Builder bodyBuilder = new FormBody.Builder();
   FormBody formBody = (FormBody) request.body();
   //把原来的参数添加到新的构造器,(因为没找到直接添加,所以就new新的)
   for (int i = 0; i < formBody.size(); i++) {
    bodyBuilder.addEncoded(formBody.encodedName(i), formBody.encodedValue(i));
   }
   formBody = bodyBuilder
     .addEncoded("clienttype", "1")
     .addEncoded("imei", "imei")
     .addEncoded("version", "VersionName")
     .addEncoded("timestamp", String.valueOf(System.currentTimeMillis()))
     .build();

   request = request.newBuilder().post(formBody).build();
  }
   return chain.proceed(request);
  }

在上面,我们拿到了request对象,然后拿到了requestBody对象,然后 判断是不是FormBody类型,如果是的话,将里面的键值对取出,并添加默认参数的键值对并构造出一个新的formBody对象,最后将原来用request对象构造出新的一个request对象,将新的formBody对象穿进去,拦截器返回。formBody对象是 Content-Type 为 application/x-www-form-urlencoded 时,Retrofit为我们生成的对象,它是RequestBody的子类;而 Content-Type 为 application/json 时,生成的就是 RequestBody (准确的说是匿名子类)。所以我们只要继承重写 RequestBody ,记录请求内容,再将它在拦截器里取出加入并处理就行了。

public class PostJsonBody extends RequestBody {

 private static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
 private static final Charset charset = Util.UTF_8;

 private String content;

 public PostJsonBody(@NonNull String content) {
  this.content = content;
 }

 public String getContent() {
  return content;
 }

 @Nullable
 @Override
 public MediaType contentType() {
  return JSON;
 }

 @Override
 public void writeTo(@NonNull BufferedSink sink) throws IOException {
  byte[] bytes = content.getBytes(charset);
  if (bytes == null) throw new NullPointerException("content == null");
  Util.checkOffsetAndCount(bytes.length, 0, bytes.length);
  sink.write(bytes, 0, bytes.length);
 }

 public static RequestBody create(@NonNull String content) {
  return new PostJsonBody(content);
 }
}

拦截器里面取出原始json数据,并添加新的默认参数:

@Override
 public Response intercept(@NonNull Chain chain) throws IOException {
  Request originalRequest = chain.request();
  Request.Builder builder = originalRequest.newBuilder();
  if (originalRequest.method().equals("POST")) {
   RequestBody requestBody = originalRequest.body();
   if (requestBody instanceof PostJsonBody) {
    String content = ((PostJsonBody) requestBody).getContent();
    HashMap<String, Object  hashMap = JsonHelper.fromJson(content, HashMap.class);
    builder.post(RequestBodyFactory.getRequestBody(hashMap));
   }
  }
  return chain.proceed(builder.build());
 }

这样在外面我们只要改动一行代码就可以实现全局添加默认参数:

RequestBody requestBody =
 RequestBody.create(MediaType.parse("application/json;charset=utf-8"),JsonHelper.toJSONString(params));

替换为:

复制代码 代码如下:

RequestBody requestBody = PostJsonBody.create( JsonHelper.toJSONString(params));

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • Android开发实现的内存管理工具类

    本文实例讲述了Android开发实现的内存管理工具类。分享给大家供大家参考,具体如下:

    砸漏
  • python模拟实现分发扑克牌

    砸漏
  • Laravel框架控制器的request与response用法示例

    本文实例讲述了Laravel框架控制器的request与response用法。分享给大家供大家参考,具体如下:

    砸漏
  • Paxos——分布式一致性算法

    Paxos算法问世已经有将近30年的历史了,是目前公认最有效的解决分布式场景下一致性问题的算法之一,但是缺点是比较难懂,工程化比较难。本文希望能够辅以图例和通俗...

    用户5546570
  • html中的<!DOCTYPE html>起到什么作用?前端面试经常考到

    相信很多小伙伴都写过html代码,即使是一些刚接触零基础网页编程的小伙伴也是,但是很多人在学习到html较多以后,却不知,在一个网页创建的时候,很多编辑器都会自...

    刘金玉编程
  • 【学习】Vlookup、Lookup都靠边,Mlookup函数来了

    Vlookup是最常用到的查找函数,但它有很大的局限性。比如:只能查找第一个符合条件的值,无法任意位置查找和多条件查找等。于是,兰色用VBA编写了一个功能强大的...

    小莹莹
  • webpack打包原理入门探究(四)插件探究(上)

    效果如下,在 dist 目录生成 index.html,同事也引入了 a.js, main.js

    公众号---人生代码
  • P1522 牛的旅行 Cow Tours(floyd)

    题目描述 农民 John的农场里有很多牧区。有的路径连接一些特定的牧区。一片所有连通的牧区称为一个牧场。但是就目前而言,你能看到至少有两个牧区通过任何路径都不...

    风骨散人Chiam
  • P1522 牛的旅行 Cow Tours(floyd)

    题目描述 农民 John的农场里有很多牧区。有的路径连接一些特定的牧区。一片所有连通的牧区称为一个牧场。但是就目前而言,你能看到至少有两个牧区通过任何路径都不...

    风骨散人Chiam
  • node服务端渲染(完整demo)

    项目源码 git clone https://gitee.com/wjj0720/nod...

    random_wang

扫码关注云+社区

领取腾讯云代金券