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

2401_84149743

于 2024-04-11 08:59:42 发布

阅读量1k

点赞数 7

分类专栏：程序员文章标签： retrofit

本文链接：https://blog.csdn.net/2401_84149743/article/details/137623704

版权

程序员专栏收录该内容

274 篇文章 0 订阅

订阅专栏

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

传统方式：

我们先来回忆下post-json的两种方式

public interface Apis {

@POST(“user/login”)
Observable<Entity> login(@Body RequestBody body);//构造一个RequestBody对象

@POST(“user/login”)
Observable<Entity> 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());
}

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

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。