//用于访问zhy的信息
http://192.168.1.102:8080/springmvc_users/user/zhy
//用于访问lmj的信息
http://192.168.1.102:8080/springmvc_users/user/lmj
即通过不同的username访问不同用户的信息,返回数据为json字符串。
那么可以通过retrofit提供的@PATH
注解非常方便的完成上述需求。
我们再定义一个方法:
public interface IUserBiz
{
@GET("{username}")
Call getUser(@Path("username") String username);
}
可以看到我们定义了一个getUser方法,方法接收一个username参数,并且我们的@GET
注解中使用{username}
声明了访问路径,这里你可以把{username}
当做占位符,而实际运行中会通过@PATH("username")
所标注的参数进行替换。
那么访问的代码很类似:
//省略了retrofit的构建代码
Call call = userBiz.getUser("zhy");
//Call call = userBiz.getUser("lmj");
call.enqueue(new Callback()
{
@Override
public void onResponse(Call call, Response response)
{
Log.e(TAG, "getUsePath:" + response.body());
}
@Override
public void onFailure(Call call, Throwable t)
{
}
});
(3)查询参数的设置@Query
看下面的url
http://baseurl/users?sortby=username
http://baseurl/users?sortby=id
即一般的传参,我们可以通过@Query
注解方便的完成,我们再次在接口中添加一个方法:
public interface IUserBiz
{
@GET("users")
Call<List> getUsersBySort(@Query("sortby") String sort);
}
访问的代码,其实没什么写的:
//省略retrofit的构建代码
Call<List> call = userBiz.getUsersBySort("username");
//Call<List> call = userBiz.getUsersBySort("id");
//省略call执行相关代码
ok,这样我们就完成了参数的指定,当然相同的方式也适用于POST,只需要把注解修改为@POST
即可。
对了,我能刚才学了@PATH
,那么会不会有这样尝试的冲动,对于刚才的需求,我们这么写:
@GET("users?sortby={sortby}")
Call<List> getUsersBySort(@Path("sortby") String sort);
乍一看别说好像有点感觉,哈,实际上运行是不支持的~估计是@ Path
的定位就是用于url的路径而不是参数,对于参数还是选择通过@Query
来设置。
(4)POST请求体的方式向服务器传入json字符串@Body
大家都清楚,我们app很多时候跟服务器通信,会选择直接使用POST方式将json字符串作为请求体发送到服务器,那么我们看看这个需求使用retrofit
该如何实现。
再次添加一个方法:
public interface IUserBiz
{
@POST("add")
Call<List> addUser(@Body User user);
}
提交的代码其实基本都是一致的:
//省略retrofit的构建代码
Call<List> call = userBiz.addUser(new User(1001, "jj", "123,", "jj123", "jj@qq.com"));
//省略call执行相关代码
ok,可以看到其实就是使用@Body
这个注解标识我们的参数对象即可,那么这里需要考虑一个问题,retrofit是如何将user对象转化为字符串呢?下文将详细解释~
下面对应okhttp,还有两种requestBody,一个是FormBody
,一个是MultipartBody
,前者以表单的方式传递简单的键值对,后者以POST表单的方式上传文件可以携带参数,retrofit
也二者也有对应的注解,下面继续~
(5)表单的方式传递键值对@FormUrlEncoded
这里我们模拟一个登录的方法,添加一个方法:
public interface IUserBiz
{
@POST("login")
@FormUrlEncoded
Call login(@Field("username") String username, @Field("password") String password);
}
访问的代码:
//省略retrofit的构建代码
Call call = userBiz.login("zhy", "123");
//省略call执行相关代码
ok,看起来也很简单,通过@POST
指明url,添加FormUrlEncoded
,然后通过@Field
添加参数即可。
(6)单文件上传@Multipart
下面看一下单文件上传,依然是再次添加个方法:
public interface IUserBiz
{
@Multipart
@POST("register")
Call registerUser(@Part MultipartBody.Part photo, @Part("username") RequestBody username, @Part("password") RequestBody password);
}
这里@MultiPart
的意思就是允许多个@Part
了,我们这里使用了3个@Part
,第一个我们准备上传个文件,使用了MultipartBody.Part
类型,其余两个均为简单的键值对。
使用:
File file = new File(Environment.getExternalStorageDirectory(), "icon.png");
RequestBody photoRequestBody = RequestBody.create(MediaType.parse("image/png"), file);
MultipartBody.Part photo = MultipartBody.Part.createFormData("photos", "icon.png", photoRequestBody);
Call call = userBiz.registerUser(photo, RequestBody.create(null, "abc"), RequestBody.create(null, "123"));
ok,这里感觉略为麻烦。不过还是蛮好理解~~多个@Part
,每个Part对应一个RequestBody。
这里插个实验过程,其实我最初对于文件,也是尝试的@Part RequestBody
,因为@Part("key")
,然后传入一个代表文件的RequestBody
,我觉得更加容易理解,后来发现试验无法成功,而且查了下issue,给出了一个很奇怪的解决方案,这里可以参考:retrofit#1063。
给出了一个类似如下的方案:
public interface ApiInterface {
@Multipart
@POST ("/api/Accounts/editaccount")
Call editUser (@Header("Authorization") String authorization, @Part("file"; filename="pp.png") RequestBody file , @Part("FirstName") RequestBody fname, @Part("Id") RequestBody id);
}
可以看到对于文件的那个@Part
value竟然写了这么多奇怪的东西,而且filename竟然硬编码了~~这个不好吧,我上传的文件名竟然不能动态指定。
为了文件名不会被写死,所以给出了最上面的上传单文件的方法,ps:上面这个方案经测试也是可以上传成功的。
恩,这个奇怪方案,为什么这么做可行,下文会给出非常详细的解释。
最后看下多文件上传~
(7)多文件上传@PartMap
再添加一个方法~~~
public interface IUserBiz
{
@Multipart
@POST("register")
Call registerUser(@PartMap Map<String, RequestBody> params, @Part("password") RequestBody password);
}
这里使用了一个新的注解@PartMap
,这个注解用于标识一个Map,Map的key为String类型,代表上传的键值对的key(与服务器接受的key对应),value即为RequestBody,有点类似@Part
的封装版本。
执行的代码:
File file = new File(Environment.getExternalStorageDirectory(), "messenger_01.png");
RequestBody photo = RequestBody.create(MediaType.parse("image/png", file);
Map<String,RequestBody> photos = new HashMap<>();
photos.put("photos"; filename="icon.png", photo);
photos.put("username", RequestBody.create(null, "abc"));
Call call = userBiz.registerUser(photos, RequestBody.create(null, "123"));
可以看到,可以在Map中put进一个或多个文件,键值对等,当然你也可以分开,单独的键值对也可以使用@Part
,这里又看到设置文件的时候,相对应的key很奇怪,例如上例"photos\"; filename=\"icon.png"
,前面的photos就是与服务器对应的key,后面filename是服务器得到的文件名,ok,参数虽然奇怪,但是也可以动态的设置文件名,不太影响使用~~
(8)下载文件
这个其实我觉得直接使用okhttp就好了,使用retrofit去做这个事情真的有点瞎用的感觉~~
增加一个方法:
@GET("download")
Call downloadTest();
调用:
Call call = userBiz.downloadTest();
call.enqueue(new Callback()
{
@Override
public void onResponse(Call call, Response response)
{
InputStream is = response.body().byteStream();
//save file
}
@Override
public void onFailure(Call call, Throwable t)
{
}
});
可以看到可以返回ResponseBody
,那么很多事都能干了~~
but,也看出这种方式下载感觉非常鸡肋,并且onReponse回调虽然在UI线程,但是你还是要处理io操作,也就是说你在这里还要另外开线程操作,或者你可以考虑同步的方式下载。
最后还是建议使用okhttp去下载,例如使用okhttputils.
有人可能会问,使用okhttp,和使用retrofit会不会造成新建多个OkHttpClient
对象呢,其实是可设置的,参考下文。
ok,上面就是一些常用的方法,当然还涉及到一些没有介绍的注解,但是通过上面这么多方法的介绍,再多一二个注解的使用方式,相信大家能够解决。
三、配置OkHttpClient
这个需要简单提一下,很多时候,比如你使用retrofit需要统一的log管理,给每个请求添加统一的header等,这些都应该通过okhttpclient去操作,比如addInterceptor
例如:
OkHttpClient client = new OkHttpClient.Builder().addInterceptor(new Interceptor()//log,统一的header等
{
@Override
public okhttp3.Response intercept(Chain chain) throws IOException
{
return null;
}
}).build();
或许你需要更多的配置,你可以单独写一个OkhttpClient的单例生成类,在这个里面完成你所需的所有的配置,然后将OkhttpClient
实例通过方法公布出来,设置给retrofit。
设置方式:
Retrofit retrofit = new Retrofit.Builder()
.callFactory(OkHttpUtils.getClient())
.build();
callFactory
方法接受一个okhttp3.Call.Factory
对象,OkHttpClient
即为一个实现类。
四、retrofit 源码解析
ok,接下来我们队retrofit的源码做简单的分析,首先我们看retrofit如何为我们的接口实现实例;然后看整体的执行流程;最后再看详细的细节;
(1)retrofit如何为我们的接口实现实例
通过上文的学习,我们发现使用retrofit需要去定义一个接口,然后可以通过调用retrofit.create(IUserBiz.class);
方法,得到一个接口的实例,最后通过该实例执行我们的操作,那么retrofit如何实现我们指定接口的实例呢?
其实原理是:动态代理。但是不要被动态代理这几个词吓唬到,Java中已经提供了非常简单的API帮助我们来实现动态代理。
看源码前先看一个例子:
public interface ITest
{
@GET("/heiheihei")
public void add(int a, int b);
}
public static void main(String[] args)
{
ITest iTest = (ITest) Proxy.newProxyInstance(ITest.class.getClassLoader(), new Class<?>[]{ITest.class}, new InvocationHandler()
{
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
{
Integer a = (Integer) args[0];
Integer b = (Integer) args[1];
System.out.println("方法名:" + method.getName());
System.out.println("参数:" + a + " , " + b);
GET get = method.getAnnotation(GET.class);
System.out.println("注解:" + get.value());
return null;
}
});
iTest.add(3, 5);
}
输出结果为:
方法名:add
参数:3 , 5
注解:/heiheihei
可以看到我们通过Proxy.newProxyInstance
产生的代理类,当调用接口的任何方法时,都会调用InvocationHandler#invoke
方法,在这个方法中可以拿到传入的参数,注解等。
试想,retrofit也可以通过同样的方式,在invoke方法里面,拿到所有的参数,注解信息然后就可以去构造RequestBody
,再去构建Request
,得到Call
对象封装后返回。
ok,下面看retrofit#create
的源码:
public T create(final Class service) {
return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object... args) throws Throwable {
});
}
哈,和上面对应。到这里,你应该明白retrofit为我们接口生成实例对象并不神奇,仅仅是使用了Proxy
这个类的API而已,然后在invoke
方法里面拿到足够的信息去构建最终返回的Call而已。
哈,其实真正的动态代理一般是有具体的实现类的,只是在这个类调用某个方法的前后去执行一些别的操作,比如开事务,打log等等。当然,本博文并不需要涉及这些详细的内容,如果你希望详细去了解,可以搜索关键字:Proxy InvocationHandler
。
(2)retrofit整体实现流程
4.2.1 Retrofit的构建
这里依然是通过构造者模式进行构建retrofit对象,好在其内部的成员变量比较少,我们直接看build()方法。
public Builder() {
this(Platform.get());
}
public Retrofit build() {
if (baseUrl == null) {
throw new IllegalStateException("Base URL required.");
}
okhttp3.Call.Factory callFactory = this.callFactory;
if (callFactory == null) {
callFactory = new OkHttpClient();
}
Executor callbackExecutor = this.callbackExecutor;
if (callbackExecutor == null) {
callbackExecutor = platform.defaultCallbackExecutor();
}
// Make a defensive copy of the adapters and add the default Call adapter.
List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
// Make a defensive copy of the converters.
List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);
return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
callbackExecutor, validateEagerly);
}
-
baseUrl必须指定,这个是理所当然的;
-
然后可以看到如果不着急设置callFactory,则默认直接
new OkHttpClient()
,可见如果你需要对okhttpclient进行详细的设置,需要构建OkHttpClient
对象,然后传入; -
接下来是callbackExecutor,这个想一想大概是用来将回调传递到UI线程了,当然这里设计的比较巧妙,利用platform对象,对平台进行判断,判断主要是利用
Class.forName("")
进行查找,具体代码已经被放到文末,如果是Android平台,会自定义一个Executor
对象,并且利用Looper.getMainLooper()
实例化一个handler对象,在Executor
内部通过handler.post(runnable)
,ok,整理凭大脑应该能构思出来,暂不贴代码了。 -
接下来是adapterFactories,这个对象主要用于对Call进行转化,基本上不需要我们自己去自定义。
-
最后是converterFactories,该对象用于转化数据,例如将返回的
responseBody
转化为对象等;当然不仅仅是针对返回的数据,还能用于一般备注解的参数的转化例如@Body
标识的对象做一些操作,后面遇到源码详细再描述。
ok,总体就这几个对象去构造retrofit,还算比较少的~~
4.2.2 具体Call构建流程
我们构造完成retrofit,就可以利用retrofit.create方法去构建接口的实例了,上面我们已经分析了这个环节利用了动态代理,而且我们也分析了具体的Call的构建流程在invoke方法中,下面看代码:
public T create(final Class service) {
Utils.validateServiceInterface(service);
//...
return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
new InvocationHandler() {
@Override
public Object invoke(Object proxy, Method method, Object... args){
//...
ServiceMethod serviceMethod = loadServiceMethod(method);
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
return serviceMethod.callAdapter.adapt(okHttpCall);
}
});
}
主要也就三行代码,第一行是根据我们的method将其包装成ServiceMethod,第二行是通过ServiceMethod和方法的参数构造retrofit2.OkHttpCall
对象,第三行是通过serviceMethod.callAdapter.adapt()
方法,将OkHttpCall
进行代理包装;
下面一个一个介绍:
- ServiceMethod应该是最复杂的一个类了,包含了将一个method转化为Call的所有的信息。
#Retrofit class
ServiceMethod loadServiceMethod(Method method) {
ServiceMethod result;
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
if (result == null) {
result = new ServiceMethod.Builder(this, method).build();
serviceMethodCache.put(method, result);
}
}
return result;
}
#ServiceMethod
public ServiceMethod build() {
callAdapter = createCallAdapter();
responseType = callAdapter.responseType();
if (responseType == Response.class || responseType == okhttp3.Response.class) {
throw methodError("'"
-
Utils.getRawType(responseType).getName()
-
"' is not a valid response body type. Did you mean ResponseBody?");
}
responseConverter = createResponseConverter();
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
int parameterCount = parameterAnnotationsArray.length;
parameterHandlers = new ParameterHandler<?>[parameterCount];
for (int p = 0; p < parameterCount; p++) {
Type parameterType = parameterTypes[p];
if (Utils.hasUnresolvableType(parameterType)) {
throw parameterError(p, "Parameter type must not include a type variable or wildcard: %s",
parameterType);
}
Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
if (parameterAnnotations == null) {
throw parameterError(p, "No Retrofit annotation found.");
}
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
}
return new ServiceMethod<>(this);
}
直接看build方法,首先拿到这个callAdapter最终拿到的是我们在构建retrofit里面时adapterFactories时添加的,即为:new ExecutorCallbackCall<>(callbackExecutor, call)
,该ExecutorCallbackCall
唯一做的事情就是将原本call的回调转发至UI线程。
接下来通过callAdapter.responseType()
返回的是我们方法的实际类型,例如:Call<User>
,则返回User
类型,然后对该类型进行判断。
接下来是createResponseConverter
拿到responseConverter对象,其当然也是根据我们构建retrofit时,addConverterFactory
添加的ConverterFactory对象来寻找一个合适的返回,寻找的依据主要看该converter能否处理你编写方法的返回值类型,默认实现为BuiltInConverters
,仅仅支持返回值的实际类型为ResponseBody
和Void
,也就说明了默认情况下,是不支持Call<User>
这类类型的。
接下来就是对注解进行解析了,主要是对方法上的注解进行解析,那么可以拿到httpMethod以及初步的url(包含占位符)。
后面是对方法中参数中的注解进行解析,这一步会拿到很多的ParameterHandler
对象,该对象在toRequest()
构造Request的时候调用其apply方法。
ok,这里我们并没有去一行一行查看代码,其实意义也不太大,只要知道ServiceMethod主要用于将我们接口中的方法
转化为一个Request对象
,于是根据我们的接口返回值确定了responseConverter,解析我们方法上的注解拿到初步的url,解析我们参数上的注解拿到构建RequestBody所需的各种信息,最终调用toRequest的方法完成Request的构建。
- 接下来看OkHttpCall的构建,构造函数仅仅是简单的赋值
OkHttpCall(ServiceMethod serviceMethod, Object[] args) {
this.serviceMethod = serviceMethod;
this.args = args;
}
- 最后一步是
serviceMethod.callAdapter.adapt(okHttpCall)
我们已经确定这个callAdapter是ExecutorCallAdapterFactory.get()
对应代码为:
final class ExecutorCallAdapterFactory extends CallAdapter.Factory {
final Executor callbackExecutor;
ExecutorCallAdapterFactory(Executor callbackExecutor) {
this.callbackExecutor = callbackExecutor;
}
@Override
public CallAdapter<Call<?>> get(Type returnType, Annotation[] annotations, Retrofit retrofit) {
if (getRawType(returnType) != Call.class) {
return null;
}
final Type responseType = Utils.getCallResponseType(returnType);
return new CallAdapter<Call<?>>() {
@Override public Type responseType() {
return responseType;
}
@Override public Call adapt(Call call) {
return new ExecutorCallbackCall<>(callbackExecutor, call);
}
};
}
可以看到adapt
返回的是ExecutorCallbackCall
对象,继续往下看:
static final class ExecutorCallbackCall implements Call {
final Executor callbackExecutor;
final Call delegate;
ExecutorCallbackCall(Executor callbackExecutor, Call delegate) {
this.callbackExecutor = callbackExecutor;
this.delegate = delegate;
}
@Override public void enqueue(final Callback callback) {
if (callback == null) throw new NullPointerException("callback == null");
delegate.enqueue(new Callback() {
@Override public void onResponse(Call call, final Response response) {
callbackExecutor.execute(new Runnable() {
@Override public void run() {
if (delegate.isCanceled()) {
// Emulate OkHttp's behavior of throwing/delivering an IOException on cancellation.
callback.onFailure(ExecutorCallbackCall.this, new IOException("Canceled"));
} else {
callback.onResponse(ExecutorCallbackCall.this, response);
}
}
});
}
@Override public void onFailure(Call call, final Throwable t) {
callbackExecutor.execute(new Runnable() {
@Override public void run() {
callback.onFailure(ExecutorCallbackCall.this, t);
}
});
}
});
}
@Override public Response execute() throws IOException {
return delegate.execute();
}
}
可以看出ExecutorCallbackCall仅仅是对Call对象进行封装,类似装饰者模式,只不过将其执行时的回调通过callbackExecutor进行回调到UI线程中去了。
4.2.3 执行Call
在4.2.2我们已经拿到了经过封装的ExecutorCallbackCall
类型的call对象,实际上就是我们实际在写代码时拿到的call对象,那么我们一般会执行enqueue
方法,看看源码是怎么做的
首先是ExecutorCallbackCall.enqueue
方法,代码在4.2.2,可以看到除了将onResponse和onFailure回调到UI线程,主要的操作还是delegate完成的,这个delegate实际上就是OkHttpCall对象,我们看它的enqueue方法
@Override
public void enqueue(final Callback callback)
{
okhttp3.Call call;
Throwable failure;
synchronized (this)
{
if (executed) throw new IllegalStateException("Already executed.");
executed = true;
try
{
call = rawCall = createRawCall();
} catch (Throwable t)
{
failure = creationFailure = t;
}
}
if (failure != null)
{
callback.onFailure(this, failure);
return;
}
if (canceled)
{
call.cancel();
}
call.enqueue(new okhttp3.Callback()
{
@Override
public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse)
throws IOException
{
Response response;
try
{
response = parseResponse(rawResponse);
} catch (Throwable e)
{
callFailure(e);
return;
}
callSuccess(response);
}
@Override
public void onFailure(okhttp3.Call call, IOException e)
{
try
{
callback.onFailure(OkHttpCall.this, e);
} catch (Throwable t)
{
t.printStackTrace();
}
}
private void callFailure(Throwable e)
{
try
{
callback.onFailure(OkHttpCall.this, e);
} catch (Throwable t)
{
t.printStackTrace();
}
}
private void callSuccess(Response response)
{
try
{
callback.onResponse(OkHttpCall.this, response);
} catch (Throwable t)
{
t.printStackTrace();
}
}
});
}
没有任何神奇的地方,内部实际上就是okhttp的Call对象,也是调用okhttp3.Call.enqueue
方法。
中间对于okhttp3.Call
的创建代码为:
private okhttp3.Call createRawCall() throws IOException
{
Request request = serviceMethod.toRequest(args);
okhttp3.Call call = serviceMethod.callFactory.newCall(request);
if (call == null)
{
throw new NullPointerException("Call.Factory returned null.");
}
return call;
}
可以看到,通过serviceMethod.toRequest
完成对request的构建,通过request去构造call对象,然后返回.
中间还涉及一个parseResponse
方法,如果顺利的话,执行的代码如下:
Response parseResponse(okhttp3.Response rawResponse) throws IOException
{
ResponseBody rawBody = rawResponse.body();
ExceptionCatchingRequestBody catchingBody = new ExceptionCatchingRequestBody(rawBody);
T body = serviceMethod.toResponse(catchingBody);
return Response.success(body, rawResponse);
通过serviceMethod对ResponseBody进行转化,然后返回,转化实际上就是通过responseConverter
的convert方法。
#ServiceMethod
T toResponse(ResponseBody body) throws IOException {
return responseConverter.convert(body);
}
ok,关于responseConverter
后面还会细说,不用担心。
到这里,我们整个源码的流程分析就差不多了,目的就掌握一个大体的原理和执行流程,了解下几个核心的类。
那么总结一下:
-
首先构造retrofit,几个核心的参数呢,主要就是baseurl,callFactory(默认okhttpclient),converterFactories,adapterFactories,excallbackExecutor。
-
然后通过create方法拿到接口的实现类,这里利用Java的
Proxy
类完成动态代理的相关代理 -
在invoke方法内部,拿到我们所声明的注解以及实参等,构造ServiceMethod,ServiceMethod中解析了大量的信息,最痛可以通过
toRequest
构造出okhttp3.Request
对象。有了okhttp3.Request
对象就可以很自然的构建出okhttp3.call
,最后calladapter对Call进行装饰返回。 -
拿到Call就可以执行enqueue或者execute方法了
ok,了解这么多足以。
下面呢,有几个地方需要注意,一方面是一些特殊的细节;另一方面就是Converter
。
五、retrofit中的各类细节
(1)上传文件中使用的奇怪value值
第一个问题涉及到文件上传,还记得我们在单文件上传那里所说的吗?有种类似于hack的写法,上传文件是这么做的?
public interface ApiInterface {
@Multipart
@POST ("/api/Accounts/editaccount")
Call editUser (@Part("file_key"; filename="pp.png"),@Part("username") String username);
}
首先我们一点明确,因为这里使用了@ Multipart
,那么我们认为@Part
应当支持普通的key-value,以及文件。
对于普通的key-value是没问题的,只需要这样@Part("username") String username
。
那么对于文件,为什么需要这样呢?@Part("file_key\"; filename=\"pp.png")
这个value设置的值不用看就会觉得特别奇怪,然而却可以正常执行,原因是什么呢?
原因是这样的:
当上传key-value的时候,实际上对应这样的代码:
builder.addPart(Headers.of("Content-Disposition", "form-data; name="" + key + """),
RequestBody.create(null, params.get(key)));
也就是说,我们的@Part
转化为了
Headers.of("Content-Disposition", "form-data; name="" + key + """)
这么一看,很随意,只要把key放进去就可以了。
但是,retrofit2并没有对文件做特殊处理,文件的对应的字符串应该是这样的
Headers.of("Content-Disposition", "form-data; name="filekey";filename="filename.png");
与键值对对应的字符串相比,多了个;filename="filename.png
,就因为retrofit没有做特殊处理,所以你现在看这些hack的做法
@Part("file_key"; filename="pp.png")
拼接:==>
Content-Disposition", "form-data; name="" + key + ""
结果:==>
Content-Disposition", "form-data; name=file_key"; filename="pp.png"
ok,到这里我相信你已经理解了,为什么要这么做,而且为什么这么做可以成功!
恩,值得一提的事,因为这种方式文件名写死了,我们上文使用的的是@Part MultipartBody.Part file
,可以满足文件名动态设置,这个方式貌似也是2.0.1的时候支持的。
上述相关的源码:
#ServiceMethod
if (annotation instanceof Part) {
if (!isMultipart) {
throw parameterError(p, "@Part parameters can only be used with multipart encoding.");
}
Part part = (Part) annotation;
gotPart = true;
String partName = part.value();
Headers headers =
Headers.of("Content-Disposition", "form-data; name="" + partName + """,
"Content-Transfer-Encoding", part.encoding());
}
可以看到呢,并没有对文件做特殊处理,估计下个版本说不定@Part
会多个isFile=true|false
属性,甚至修改对应形参,然后在这里做简单的处理。
ok,最后来到关键的ConverterFactory
了~
六、自定义Converter.Factory
(1)responseBodyConverter
关于Converter.Factory
,肯定是通过addConverterFactory
设置的
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())
.build();
该方法接受的是一个Converter.Factory factory
对象
该对象呢,是一个抽象类,内部包含3个方法:
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)
最后
在这里我和身边一些朋友特意整理了一份快速进阶为Android高级工程师的系统且全面的学习资料。涵盖了Android初级------Android高级架构师进阶必备的一些学习技能。
附上:我们之前因为秋招收集的二十套一二线互联网公司Android面试真题(含BAT、小米、华为、美团、滴滴)和我自己整理Android复习笔记(包含Android基础知识点、Android扩展知识点、Android源码解析、设计模式汇总、Gradle知识点、常见算法题汇总。)
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门即可获取!
" + partName + """,
"Content-Transfer-Encoding", part.encoding());
}
可以看到呢,并没有对文件做特殊处理,估计下个版本说不定@Part
会多个isFile=true|false
属性,甚至修改对应形参,然后在这里做简单的处理。
ok,最后来到关键的ConverterFactory
了~
六、自定义Converter.Factory
(1)responseBodyConverter
关于Converter.Factory
,肯定是通过addConverterFactory
设置的
Retrofit retrofit = new Retrofit.Builder()
.addConverterFactory(GsonConverterFactory.create())
.build();
该方法接受的是一个Converter.Factory factory
对象
该对象呢,是一个抽象类,内部包含3个方法:
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长或者是报班学习,但对于培训机构动则近万的学费,着实压力不小。自己不成体系的自学效果低效又漫长,而且极易碰到天花板技术停滞不前!
因此收集整理了一份《2024年Android移动开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
[外链图片转存中...(img-ts1qbInt-1712296462983)]
[外链图片转存中...(img-DF3XRDNw-1712296462984)]
[外链图片转存中...(img-XzzBHT1n-1712296462984)]
[外链图片转存中...(img-Ac457E2a-1712296462984)]
[外链图片转存中...(img-uuS35eFz-1712296462985)]
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点,真正体系化!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
如果你觉得这些内容对你有帮助,可以扫码获取!!(备注:Android)
最后
在这里我和身边一些朋友特意整理了一份快速进阶为Android高级工程师的系统且全面的学习资料。涵盖了Android初级------Android高级架构师进阶必备的一些学习技能。
附上:我们之前因为秋招收集的二十套一二线互联网公司Android面试真题(含BAT、小米、华为、美团、滴滴)和我自己整理Android复习笔记(包含Android基础知识点、Android扩展知识点、Android源码解析、设计模式汇总、Gradle知识点、常见算法题汇总。)
[外链图片转存中...(img-liXjrSQw-1712296462985)]