@GET("users?sortby={sortby}")Call<List<User>> getUsersBySort(@Path("sortby") String sort);

看上去没有问题，哈，实际上运行是不支持的~估计是@ Path的定位就是用于url的路径而不是参数，对于参数还是选择通过@Query来设置。

2  @Body

POST请求体的方式向服务器传入json字符串，

大家都清楚，我们app很多时候跟服务器通信，会选择直接使用POST方式将json字符串作为请求体发送到服务器，那么我们看看这个需求使用retrofit该如何实现。

再次添加一个方法：

    @POST("add")Call<User> addUser(@Body User user);

调用post提交的代码基本都是一致的：

        //省略前面构建retrofit的代码GitHubUserInfo userInfo = retrofit.create(GitHubUserInfo.class);Call <User> addUser = userInfo.addUser(new User(123,"nick"));//省略后面Call执行的代码

ok，可以看到其实就是使用@Body这个注解标识我们的参数对象即可，那么这里需要考虑一个问题，retrofit是如何将user对象转化为字符串呢？下文将详细解释~

3  @FormUrlEncoded

表单的方式传递键值对

这里我们模拟一个登录的方法，添加一个方法：

    @POST("login")@FormUrlEncodedCall<User> login(@Field("username") String username, @Field("password") String password);

提交的代码：

        //省略前面构建retrofit的代码GitHubUserInfo userInfo = retrofit.create(GitHubUserInfo.class);Call <User> loginUser = userInfo.login("nick","123456");//省略后面Call执行的代码

ok，看起来也很简单，通过@POST指明url，添加FormUrlEncoded，然后通过@Field添加参数即可。

4  @Multipart

单文件上传

下面看一下单文件上传，依然是再次添加个方法：

    @Multipart@POST("register")Call<User> registerUser(@Part MultipartBody.Part photo, @Part("username") RequestBody username, @Part("password") RequestBody password);

这里@MultiPart的意思就是允许多个@Part了，我们这里使用了3个@Part，第一个我们准备上传个文件，使用了MultipartBody.Part类型，其余两个均为简单的键值对。 下面是调用：

   //省略前面构建retrofit的代码GitHubUserInfo userInfo = retrofit.create(GitHubUserInfo.class);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<User> call = userInfo.registerUser(photo, RequestBody.create(null, "abc"), RequestBody.create(null, "123"));//省略后面Call执行的代码

ok，这里感觉略为麻烦。不过还是蛮好理解~~多个@Part，每个Part对应一个RequestBody。

5  @PartMap

多文件上传，再添加一个方法~~~

   @Multipart @POST("register") Call<User> registerUser(@PartMap Map<String, RequestBody> params);

这里使用了一个新的注解@PartMap，这个注解用于标识一个Map，Map的key为String类型，代表上传的键值对的key(与服务器接受的key对应),value即为RequestBody，有点类似@Part的封装版本。

执行的代码：

 //省略前面构建retrofit的代码GitHubUserInfo userInfo = retrofit.create(GitHubUserInfo.class);File file = new File(Environment.getExternalStorageDirectory(), "icon.png");RequestBody photoRequestBody = RequestBody.create(MediaType.parse("image/png"), file);Map<String,RequestBody> photos = new HashMap<>();photos.put("photos\"; filename=\"icon.png", photoRequestBody);photos.put("username",  RequestBody.create(null, "abc"));photos.put("password",  RequestBody.create(null, "123"));Call<User> call = userInfo.registerUser(photos);//省略后面Call执行的代码

可以看到，可以在Map中put进一个或多个文件，键值对等，当然你也可以分开，单独的键值对也可以使用@Part，这里又看到设置文件的时候，相对应的key很奇怪，例如上例"photos\"; filename=\"icon.png",前面的photos就是与服务器对应的key，后面filename是服务器得到的文件名，ok，参数虽然奇怪，但是也可以动态的设置文件名，不太影响使用~~

6 @Header

请求头的设置可以通过 @Header 注解添加，又有两种添加方式：

设置静态的请求头。

    @Headers({ "Accept: application/vnd.github.v3.full+json", "User-Agent: Retrofit-Sample-App" })@GET("users/{user}")Call<User> getUserInfo(@Path("user") String user);

动态的设置请求头。

    @GET("user") Call getUser(@Header("Authorization") String authorization);

注意，同一个请求的同一个请求头在不同地方的设置不会被覆盖，而是会被全部添加进请求头中。

如果要给每个请求都添加同样的Header时，可以使用okHttp的 Interceptor 。

5 配置OkHttpClient

由于Retrofit 2.0 底层强制依赖okHttp，所以可以使用okHttp的拦截器Interceptors 来对所有请求进行再处理。目前使用中，一般用来设置UA、设置缓存策略 、打印Log 等。这里介绍下配置OkHttpClient和设置UserAgent的Interceptor：

public class OkHttpFactory {private OkHttpClient client;private static final int TIMEOUT_READ = 25;private static final int TIMEOUT_CONNECTION = 25;Cache cache = new Cache(MyApplication.mContext.getCacheDir(), 10 * 1024 * 1024);//缓存目录private OkHttpFactory(){client = new OkHttpClient.Builder().cache(cache).addInterceptor(new LoggingInterceptor()) //打印log.addInterceptor(new UserAgentInterceptor()) //UserAgent设置.retryOnConnectionFailure(true) //失败重连.readTimeout(TIMEOUT_READ, TimeUnit.SECONDS).connectTimeout(TIMEOUT_CONNECTION, TimeUnit.SECONDS).build();}public static OkHttpClient getOkHttpClient(){return Holder.INSTANCE.client;}private static class Holder{final public static OkHttpFactory INSTANCE = new OkHttpFactory();}
}

这里用单例实现了OkHttpClient,并且添加了缓存和超时设置，下面看看UserAgentInterceptor拦截器代码：

public class UserAgentInterceptor implements Interceptor {private static final String USER_AGENT_HEADER_NAME = "User-Agent";private final String userAgentHeaderValue;public UserAgentInterceptor(String userAgentHeaderValue) {this.userAgentHeaderValue = userAgentHeaderValue;}@Override public Response intercept(Chain chain) throws IOException {Request originalRequest = chain.request();Request requestWithUserAgent = originalRequest.newBuilder().removeHeader(USER_AGENT_HEADER_NAME)   //移除先前默认的User-Agent.addHeader(USER_AGENT_HEADER_NAME, userAgentHeaderValue)  //设置新的User-Agent.build();return chain.proceed(requestWithUserAgent);}
}

下面将上面的OkHttpClient设置进Retrofit里：

public enum  RetrofitClient {INSTANCE;private final Retrofit retrofit;RetrofitClient() {retrofit = new Retrofit.Builder()//设置OKHttpClient.client(OkHttpFactory.getOkHttpClient())//baseUrl.baseUrl(ApiContants.GITHUB_BASEURL)//gson转化器.addConverterFactory(GsonConverterFactory.create())//创建.build();}public Retrofit getRetrofit() {return retrofit;}
}

这里使用了枚举单例实现了Retorfit的一个Client，后续就可以轻松使用它了。如下面使用：

public interface GitHubAPI {@GET("user")Call<List<User>> getUser();@GET("users/{user}")Call<User> getUserInfo(@Path("user") String user);
}
public enum  ApiFactory {INSTANCE;private static GitHubAPI gitHubAPI;ApiFactory() {}public static GitHubAPI gitHubAPI() {if (gitHubAPI == null) {gitHubAPI = RetrofitClient.INSTANCE.getRetrofit().create(GitHubAPI.class);}return gitHubAPI;}
}

最后使用创建ApiFactory类管理所有的API interface，对外提供方法获取他们，这样调用时会方便很多，而且也便于修改。调用如下：

        Call<User>  userCall = ApiFactory.gitHubAPI().getUserInfo("nickyangjun");userCall.enqueue(new Callback<User>() {@Overridepublic void onResponse(Call<User> call, Response<User> response) {Log.i(TAG, "name:  " + response.body().login + " id: " + response.body().id);mTextView.setText("name:  " + response.body().login + " id: " + response.body().id);}@Overridepublic void onFailure(Call<User> call, Throwable t) {}});

代码github 地址：https://github.com/nickyangjun/RetrofitTest

未完待续，下节将会从源码角度分析Retrofit。