Retrofit使用

2017-01-10

上篇我们介绍了OkHttp的使用，OkHttp虽说是网络请求，但和velley、nohttp等不大相同，它属于底层的东西，是没有经过封装的。今天我们讨论的retrofit就是对okhttp进行了封装，是一个非常棒的网络请求框架。
retrofit是主要是通过注解的形式来写请求接口，并且支持Rx，配合使用有奇效。

如何使用

首先当然是依赖

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
//compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
//compile 'io.reactivex:rxandroid:1.2.1'
//compile 'io.reactivex:rxjava:1.2.3'

*注释部分是配合rx使用。
然后java部分
我们先写个接口类用于网络请求

public interface ApiService {
	/**
     * 每日一Gank
     **/
	@GET("day/{year}/{month}/{day}")
	Call/*Observable*/<GankData> getDayData(@Path("year") int year,@Path("month") int month, @Path("day") int day);
	/**
	* 获取IP信息
	**/
	@FormUrlEncoded
	@POST("service/getIpInfo.php")
    Call/*Observable*/<IpInfo> getIpInfo(@Field("ip") String ip);
    /**
    * 上传头像
    **/
    @Multipart
    @POST("uptUserHeadImg")
    Call/*Observable*/<UserBean> uploadHead(@Part MultipartBody.Part photo, @Part("uid") RequestBody userId);
      /**
     * 下载图片
     */
    @GET
    Call/*Observable*/<ResponseBody> downloadPicFromNet(@Url String fileUrl);
}

*注释部分是配合Rx使用
这里我们介绍一下retrofit的注解

get请求
- @GET 申明get请求方式，括号里面是请求路径。
- @Query 请求参数对应的键值，括号内为key，参数为value。
- @QueryMap 如果Query参数比较多，那么可以通过@QueryMap方式将所有的参数集成在一个Map。
- @Path 会把参数填充到路径上，如上面的@Path("year") @Path("month") @Path("day") 会填充@GET("day/{year}/{month}/{day}") 中的year、month、day。@Path可用于任何请求方式。
- @Url 不使用baseUrl。
post请求
- @POST 申明post请求方式，括号里面是请求路径。
- @FormUrlEncoded 自动将请求参数的类型调整为application/x-www-form-urlencoded，FormUrlEncoded不能用于Get请求。
- @Field 请求参数对应的键值。
- @FieldMap 如果Field参数比较多，那么可以通过@FieldMap 方式将所有的参数集成在一个Map。
- @Body 请求参数有多个，那么统一封装到类中应该会更好，这样维护起来会非常方便。
上传文件
- @Multipart 申明为上传文件方式。
- @Part 参数列表 MultipartBody.Part 为文件类型，RequestBody 为一般参数。
- @PartMap 如果Part参数比较多，那么可以通过@PartMap 方式将所有的参数集成在一个Map。@PartMap Map<String, RequestBody> params 可以是多个文件，也可是文件与参数混合。

接口类写好后，我们要写个单例模式的网络请求类

public class Api {
    public static final String BASE_URL = "http://gank.io/api/";
    public final static MediaType TYPE_IMAGE = MediaType.parse("image/*");
    public static final int DEFAULT_TIMEOUT = 30;
    public Retrofit retrofit;
    public ApiService service;
    //构造方法私有
    private Api() {
        OkHttpClient okHttpClient = new OkHttpClient.Builder()
                .readTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
                .connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
                .build();
        Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").serializeNulls().create();
        retrofit = new Retrofit.Builder()
				.client(okHttpClient)
			    .addConverterFactory(GsonConverterFactory.create(gson))
		        //.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .baseUrl(BASE_URL)
                .build();
        service = retrofit.create(ApiService.class);
    }
    //在访问HttpMethods时创建单例
    private static class SingletonHolder {
        private static final Api INSTANCE = new Api();
    }
    //获取单例
    public static Api getInstance() {
        return SingletonHolder.INSTANCE;
    }

到这里基本上完成一大半，下面我们开始在Activity、fragment等中调用。

Calendar calender = Calendar.getInstance();
calender.setTime(date);   
//Rx使用方式
Api.getInstance().service.getDayData(calender.get(Calendar.YEAR), calender.get(Calendar.MONTH) + 1, calender.get(Calendar.DAY_OF_MONTH))
               .subscribeOn(Schedulers.io())
               .map(new Func1<GankData, GankData.ResultsBean>() {
                   @Override
                   public GankData.ResultsBean call(GankData gankData) {
                       return gankData.getResults();
                   }
               })
               .observeOn(AndroidSchedulers.mainThread())
               .subscribe(new Subscriber<GankData.ResultsBean>() {
                   @Override
                   public void onCompleted() {
                       Log.v("success:", "onCompleted");
                   }
                   @Override
                   public void onError(Throwable e) {
                       Log.v("failure:", "onError");
                   }
                   @Override
                   public void onNext(GankData.ResultsBean resultsBean) {
                     
                   }
               });
         
//call使用方式
Api.getInstance().service.getDayData(calender.get(Calendar.YEAR), calender.get(Calendar.MONTH) + 1, calender.get(Calendar.DAY_OF_MONTH))
			.enqueue(new Callback<GankData>() {
				@Override
				public void onResponse(Call<GankData> call,Response<GankData> response) {
		
				}
				@Override
				public void onFailure(Call<GankData> call, Throwable t) {
				}
});

其他的接口也是类似的操作。

总结

retrofit使用起来还是蛮方便的，其他还有header、日志、拦截器等的内容没有介绍，考虑到一般情况下是不需要对这些进行操作的。使用retrofit后台必须遵循restful原则，具体概念可上网了解。例子中使用到了Rx等相关的知识，了解java后端的应该对链式操作有所了解，需要学习的小伙伴可参考抛物线的给 Android 开发者的 RxJava 详解，这篇文章对Rx进行了详细的解读。目前Rx 2.0的版本也已发布，相对1.0有些许改动。