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

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

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

最近在学习使用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,bytes.length);  sink.write(bytes,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));

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

您可能感兴趣的文章:详解Retrofit 动态参数(非固定参数、非必须参数)(Get、Post请求)Retrofit2.0 实现图文(参数+图片)上传方法总结Retrofit2.0 公共参数(固定参数) 总结

以上是内存溢出为你收集整理的为Retrofit统一添加post请求的默认参数的方法全部内容,希望文章能够帮你解决为Retrofit统一添加post请求的默认参数的方法所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。

欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/web/1142860.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2022-05-31
下一篇2022-05-31

发表评论

登录后才能评论

评论列表(0条)

    保存