这篇文章主要为大家展示了“如何为Retrofit统一添加post请求的默认参数”,内容简而易懂,条理清晰,希望能够帮助大家解决疑惑,下面让小编带领大家一起研究并学习一下“如何为Retrofit统一添加post请求的默认参数”这篇文章吧。
10年积累的网站设计、网站建设经验,可以快速应对客户对网站的新想法和需求。提供各种问题对应的解决方案。让选择我们的客户得到更好、更有力的网络服务。我虽然不认识你,你也不认识我。但先网站设计制作后付款的网站建设流程,更有南海免费网站建设让你可以放心的选择与我们合作。在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> login(@Body RequestBody body);//构造一个RequestBody对象 @POST("user/login") Observable > 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); Mapparams = 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(HashMaphashMap) { Map 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(); HashMaphashMap = 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统一添加post请求的默认参数”这篇文章的所有内容,感谢各位的阅读!相信大家都有了一定的了解,希望分享的内容对大家有所帮助,如果还想学习更多知识,欢迎关注创新互联行业资讯频道!
当前名称:如何为Retrofit统一添加post请求的默认参数-创新互联
网站路径:http://lswzjz.com/article/dgdgdo.html