Android Retrofit使用map上传文件 android retrofit2

之前Retrofit2.0出来没多久，搜集了一些Retrofit 2.x版本与之前版本的一些区别，这篇文字发出了Retrofit最新版已经到了2.1.0(http://square.github.io/retrofit/)。

因为其简单与出色的性能，Retrofit 是安卓上最流行的HTTP Client库之一。

不过它的缺点是在Retrofit 1.x中没有直接取消正在进行中任务的方法。如果你想做这件事必须手动杀死，而这并不好实现。

Square几年前曾许诺这个功能将在Retrofit 2.0实现，但是几年过去了仍然没有在这个问题上有所更新。直到Retrofit 2.0 公开给所有人。不得不说新的模式和新的功能有，许多改进，本文将讨论它们。让我们开始吧！

一、新的Service定义方式，不再有同步和异步之分

关于在Retrofit 1.9中service 接口的定义，如果你想定义一个同步的函数，你应该这样定义：

/* Synchronous in Retrofit 1.9 */
public interface APIService {
    @POST("/list")
    Repo loadRepo();
}

而定义一个异步的则是这样：

/* Asynchronous in Retrofit 1.9 */
public interface APIService {
    @POST("/list")
    void loadRepo(Callback<Repo> cb);     
}

但是在Retrofit 2.0上，只能定义一个模式，因此要简单得多。

import retrofit.Call;
/* Retrofit 2.0 */
public interface APIService { 

    @POST("/list")

        Call<Repo> loadRepo();

 }

而创建service 的方法也变得和OkHttp的模式一模一样。如果要调用同步请求，只需调用enqueue，或者调用enqueue来发起一个异步请求。

二、同步请求与异步请求

同步请求

// Synchronous Call in Retrofit 2.0
Call<Repo> call = service.loadRepo();
Repo repo = call.execute();

以上的代码会阻塞线程，因此你不能在安卓的主线程中调用，不然会面临NetworkOnMainThreadException。如果你想调用execute方法，请在后台线程执行。
异步请求

// Synchronous Call in Retrofit 2.0  
Call<Repo> call = service.loadRepo();
call.enqueue(new Callback<Repo>() {
    @Override
    public void onResponse(Response<Repo> response) {
            // Get result Repo from response.body()
    }     

    @Override
    public void onFailure(Throwable t) {

    }
});

以上代码发起了一个在后台线程的请求并从response 的response.body()方法中获取一个结果对象。注意这里的onResponse和onFailure方法是在主线程中调用的。
我建议你使用enqueue，它最符合 Android OS的习惯。

三、取消正在进行中的业务

service 的模式变成Call的形式的原因是为了让正在进行的事务可以被取消。要做到这点，你只需调用call.cancel()。

call.cancel();

事务将会在之后立即被取消。好简单嘿嘿！

四、Converter现在从Retrofit中删除

在Retrofit 1.9中，GsonConverter 包含在了package 中而且自动在RestAdapter创建的时候被初始化。这样来自服务器的son结果会自动解析成定义好了的Data Access Object（DAO）
但是在Retrofit 2.0中，Converter 不再包含在package 中了。你需要自己插入一个Converter 不然的话Retrofit 只能接收字符串结果。同样的，Retrofit 2.0也不再依赖于Gson 。
如果你想接收json 结果并解析成DAO，你必须把Gson Converter 作为一个独立的依赖添加进来。
然后使用addConverterFactory把它添加进来。注意RestAdapter的别名仍然为Retrofit。

Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://api.nuuneoi.com/base/")
.addConverterFactory(GsonConverterFactory.create())
.build();
APIService service = retrofit.create(APIService.class);

这里是Square提供的官方Converter modules列表。选择一个最满足你需求的。

• Gson: com.squareup.retrofit2:converter-gson
• Jackson: com.squareup.retrofit2:converter-jackson
• Moshi: com.squareup.retrofit2:converter-moshi
• Protobuf: com.squareup.retrofit2:converter-protobuf
• Wire: com.squareup.retrofit2:converter-wire
• Simple XML: com.squareup.retrofit2:converter-simplexml
• Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

五、自定义Gson对象

为了以防你需要调整json里面的一些格式，比如，Date Format。你可以创建一个Gson 对象并把它传递给GsonConverterFactory.create()。

Gson gson = new GsonBuilder()
    .setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ")
    .create();

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://api.nuuneoi.com/base/")
    .addConverterFactory(GsonConverterFactory.create(gson))
    .build();
APIService service = retrofit.create(APIService.class);

完成。

六、新的URL定义方式

Retrofit 2.0使用了新的URL定义方式。Base URL与@Url 不是简单的组合在一起而是和< a href=”…” >的处理方式一致。用下面的几个例子阐明。

对于 Retrofit 2.0中新的URL定义方式，这里是我的建议：

- Base URL: 总是以 /结尾

- @Url: 不要以 / 开头

七、现在需要OkHttp的支持

OkHttp 在Retrofit 1.9里是可选的。如果你想让Retrofit 使用OkHttp 作为HTTP 连接接口，你需要手动包含okhttp 依赖。
但是在Retrofit 2.0中，OkHttp 是必须的，并且自动设置为了依赖。下面的代码是从Retrofit 2.0的pom文件中抓取的。你不需要再做任何事情了。

<dependencies>
    <dependency>
        <groupId>com.squareup.okhttp</groupId>
        <artifactId>okhttp</artifactId>
    </dependency>
      ...
</dependencies>

为了让OkHttp 的Call模式成为可能，在Retrofit 2.0中OkHttp 自动被用作HTTP 接口。

八、Use an Interceptor from OkHttp

在Retrofit 1.9中，你可以使用RequestInterceptor来拦截一个请求，但是它已经从Retrofit 2.0 移除了，因为HTTP连接层已经转为OkHttp。
结果就是，现在我们必须转而实用OkHttp里面的Interceptor。首先你需要实用Interceptor创建一个OkHttpClient对象，如下：

OkHttpClient client = new OkHttpClient();

client.interceptors().add(new Interceptor() {

    @Override
    public Response intercept(Chain chain) throws IOException {
        Response response = chain.proceed(chain.request());
        // Do anything with response here
        return response;
    }
});

然后传递创建的client到Retrofit的Builder链中。

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("http://api.nuuneoi.com/base/")
    .addConverterFactory(GsonConverterFactory.create())
    .client(client)
    .build();

学习关于OkHttp Interceptor的知识，请到OkHttp Interceptors。

九、即使response存在问题onResponse依然被调用

在Retrofit 1.9中，如果获取的 response 不能背解析成定义好的对象，则会调用failure。但是在Retrofit 2.0中，不管 response 是否能被解析。onResponse总是会被调用。但是在结果不能背解析的情况下，response.body()会返回null。别忘了处理这种情况。
如果response存在什么问题，比如404什么的，onResponse也会被调用。你可以从response.errorBody().string()中获取错误信息的主体。

十、RxJava Integration with CallAdapter

除了使用Call模式来定义接口，我们也可以定义自己的type，比如MyCall。。我们把Retrofit 2.0的这个机制称为CallAdapter。
Retrofit团队有已经准备好了的CallAdapter module。其中最著名的module可能是为RxJava准备的CallAdapter，它将作为Observable返回。要使用它，你的项目依赖中必须包含两个modules。
adapter-rxjava:2.0.0-beta1
rxandroid:1.0.1
在Retrofit Builder链表中如下调用addCallAdapterFactory：

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://api.nuuneoi.com/base/")
        .addConverterFactory(GsonConverterFactory.create())
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
        .build();

你的Service接口现在可以作为Observable返回了！

ApiService service = retrofit.create(ApiService.class);
Observable<Gps> observable = service.getUser();

你可以完全像RxJava那样使用它，如果你想让subscribe部分的代码在主线程被调用，需要把observeOn(AndroidSchedulers.mainThread())添加到链表中。

observable.subscribe(new Subscriber<Gps>() {
     @Override
     public void onCompleted() {
         System.out.println("completed!");
     }

     @Override
     public void onError(Throwable throwable) {

     }

     @Override
     public void onNext(Gps gps) {
         System.out.println(gps.getResult());
         System.out.println(gps.getItem().getLat());
     }
 })

Retrofit原理

Retrofit使用了Java的动态代理模式。
进入Retrofit的create方法看一下：

/** Create an implementation of the API defined by the {@code service} interface. */
@SuppressWarnings("unchecked") // Single-interface proxy creation guarded by parameter safety.
public <T> T create(final Class<T> service) {
        Utils.validateServiceInterface(service);
        if(this.validateEagerly) {
            this.eagerlyValidateMethods(service);
        }

        return Proxy.newProxyInstance(service.getClassLoader(), new Class[]{service}, new InvocationHandler() {
            private final Platform platform = Platform.get();

            public Object invoke(Object proxy, Method method, Object... args) throws Throwable {
                return method.getDeclaringClass() == Object.class?method.invoke(this, args):(this.platform.isDefaultMethod(method)?this.platform.invokeDefaultMethod(method, service, proxy, args):Retrofit.this.loadMethodHandler(method).invoke(args));
            }
        });
    }

这里就是使用Java动态代理模式，create方法返回了一个动态代理对象。Retrofit把ApiService接口翻译成一个HTTP请求，也就是Retrofit中的MethodHandler对象。然后调用service.loadDessertListRx();方法时执行的是下面的代码：
MethodHandler中的invoke()方法

Object invoke(Object... args) {
  return callAdapter.adapt(new OkHttpCall<>(client, requestFactory, responseConverter, args));
}

这个也就是github.contributors(“square”, “retrofit”);返回的Call对象
最后你调用Call对象的execute()或enqueue(Callback callback)方法，就能发送一个Http请求了