RESTFUL网路请求框架Retrofit

Retrofit是一个高质量高效率的HTTP请求库，和OkHttp同样出自Square公司。Retrofit内部依赖于OkHttp，它将OKHttp底层的代码和细节都封装了起来，功能上做了更多的扩展,比如返回结果的自动解析，网络引擎的切换，拦截器......

有了Retrofit之后对于一些请求我们就只需要一行代码或者一个注解、大大简化了网络请求的代码量。

注解

retrofit注解驱动型上层网络请求框架，使用注解来简化请求，大体分为以下几类：

• 用于标注网络请求方式的注解
• 标记网络请求参数的注解
• 用于标记网络请求和响应格式的注解

使用示例：

interface ApiService{
    @GET("user/query")
    Call<User> queryUser(@Query("userId") String userId);
}

val mApi = retrofit.create(ApiService.class);
val response = mApi.queryUser("100086").execute()

请求方法注解

请求头注解

请求参数注解

请求和响应格式注解

请求方法定义

public interface ApiService {

    @GET("user/query")
    Call<User> queryUser(@Query("userId") String userId);

    //使用@Headers添加多个请求头
    @Headers({"User-Agent:android", "apikey:123456789", })
    @GET("user/query")
    Call<User> queryUser(@Query("userId") String userId);

    // 多个参数的情况下可以使用@QueryMap，但只能用在GET请求上
    @GET("user/query"")
    Call<User> queryUser(@QueryMap Map<String, String> params);

    /**
     * 很多情况下，我们需要上传json格式的数据。当我们注册新用户的时候，因为用户注册时的数据相对较多
     * 并可能以后会变化，这时候，服务端可能要求我们上传json格式的数据。此时就要@Body注解来实现。
     * 直接传入实体,它会自行转化成Json, @Body只能用在POST请求上
     *
     * 字符串提交
     */
    @POST("user/update")
    Call<User> update(@Body News post);

    /**
    * 表单提交（键值对提交）
    */
    @POST()
    @FormUrlEncoded  
    Call<User> executePost(@FieldMap Map<String, Object> maps);

    /**
     * 表单上传文件（键值对提交、同时上传文件）
     */
    @Multipart
    @POST("upload/upload")
    Call<> register(@Filed String openId, @PartMap Map<String, MultipartBody.Part> map);

}

开始使用

添加依赖

在Android Studio中使用，先添加依赖：

compile 'com.squareup.retrofit2:retrofit:2.3.0'
compile 'com.squareup.retrofit2:converter-gson:2.3.0' //json转换

初始化

 val retrofit = new Retrofit.Builder()
                .client(okhttpClient)
                .baseUrl("http://123.56.232.18:8080/serverdemo/")
                .addConverterFactory(GSONConverterFactory.create())
                .build();

val mApi = retrofit.create(ApiService.class);