Retrofit全攻略——基础篇

Posted 2020-09-30 cxchanpin

实际开发过程中一般都会选择一些网络框架提升开发效率。随着Google对HttpClient 摒弃和Volley框架的逐渐没落。OkHttp開始异军突起。而Retrofit则对OkHttp进行了强制依赖，能够简单理解Retroifit在OKHttp基础上进一步完好。

Retrofit是由Square公司出品的针对于android和Java的类型安全的Httpclient，眼下推出了2.0+的版本号。

Retrofit框架项目地址：https://github.com/square/retrofit。

Retrofit官方文档地址: http://square.github.io/retrofit/

使用Retrofit

接下来我们来学习下怎样使用Retrofit。

首先须要在app/build.gradle加入依赖。

dependencies {
    //...
    //retrofit
    compile ‘com.squareup.retrofit2:retrofit:2.1.0‘
    //假设用到gson解析 须要加入以下的依赖
    compile ‘com.squareup.retrofit2:converter-gson:2.1.0‘
}

我们以查号码归属地接口为例 https://www.juhe.cn/docs/api/id/11

Retrofit不能直接使用，须要进行初始化，在这里创建NetWork.java

public class NetWork {
    private static Retrofit retrofit;

    /**返回Retrofit*/
    public static Retrofit getRetrofit(){
        if(retrofit==null){
            Retrofit.Builder builder = new Retrofit.Builder();//创建Retrfit构建器
            retrofit = builder.baseUrl("http://apis.juhe.cn/") //指定网络请求的baseUrl
                    .addConverterFactory(GsonConverterFactory.create())//返回的数据通过Gson解析
                    .build();
        }
        return retrofit;
    }
}

Retrofit须要之地baseUrl。往往一个项目中有很多接口。接口都使用同样的server地址，这时候能够把接口地址同样的部分抽取到baseUrl中。Retrofit扩展性极好。能够指定返回的数据通过Gson解析，前提你须要保证项目中有Gson框架和com.squareup.retrofit2:converter-gson:2.1.0的依赖。

除了通过Gson解析还能够使用其他的方式解析，须要的依赖也不同。有例如以下几种：

• Gson: com.squareup.retrofit:converter-gson
• Jackson: com.squareup.retrofit:converter-jackson
• Moshi: com.squareup.retrofit:converter-moshi
• Protobuf: com.squareup.retrofit:converter-protobuf
• Wire: com.squareup.retrofit:converter-wire
• Simple XML: com.squareup.retrofit:converter-simplexml

Retrofit须要把Http的请求接口封装到一个接口文件里。

public interface NetInterface {
    //获取号码归属地，返回来类型是Bean, 须要两个參数分别为phone何key
    @GET("mobile/get")
    Call<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
}

当中Bean是依据请求的结果创建的对象.

方法前加入@GET注解表示当前请求是Get方式请求，链接的地址是baseUrl+”mobile/get”。baseUrl在初始化Retrofit的时候指定了，拼到一起就是 http://apis.juhe.cn/mobile/get。
对于 Retrofit 2.0中新的URL定义方式，这里是我的建议：

• baseUrl: 总是以 /结尾
• url: 不要以 / 开头

由于假设不是这样的方式，拼装后的结果和你期望的是不一样的，详情參考官方文档。

除了Get请求还有以下几种请求方式

• @POST 表明这是post请求
• @PUT 表明这是put请求
• @DELETE 表明这是delete请求
• @PATCH 表明这是一个patch请求。该请求是对put请求的补充。用于更新局部资源
• @HEAD 表明这是一个head请求
• @OPTIONS 表明这是一个option请求
• @HTTP 通用注解,能够替换以上全部的注解。其拥有三个属性：method。path，hasBody

最后的HTTP通用注解写法比較特殊。请求能够取代之前的请求。以下的写法和之前的@GET效果是一样的。

/**
 * method 表示请的方法，不区分大写和小写
 * path表示路径
 * hasBody表示是否有请求体
 */
@HTTP(method = "get",path = "mobile/get",hasBody = false)
Call<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);

@Quert表示查询參数。用于GET查询，注解里的字符串是參数的key值，參数会自己主动拼装到Url后面。
除了上面的注解。再给大家介绍几种不同的注解。

经常使用的注解

@Url：使用全路径复写baseUrl，适用于非统一baseUrl的场景。演示样例代码：

@GET Call<ResponseBody> XXX(@Url String url);

@Streaming:用于下载大文件。演示样例代码：

@Streaming @GET Call<ResponseBody> downloadFileWithDynamicUrlAsync(@Url String fileUrl);


//获取数据的代码
ResponseBody body = response.body();
long fileSize = body.contentLength();
InputStream inputStream = body.byteStream();

@Path：URL占位符，用于替换和动态更新,相应的參数必须使用同样的字符串被@Path进行凝视

//实际请求地址会给句groupId的值发生变化--> http://baseurl/group/groupId/users
@GET("group/{id}/users") Call<List<User>> groupList(@Path("id") int groupId);

@QueryMap:查询參数，和@Query相似。差别就是后面须要Map集合參数。演示样例代码：

Call<List<News>> getNews((@QueryMap(encoded=true) Map<String, String> options);

@Body:用于POST请求体。将实例对象依据转换方式转换为相应的json字符串參数。这个转化方式是GsonConverterFactory定义的。 演示样例代码：

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

@Field，@FieldMap:Post方式传递简单的键值对，须要加入@FormUrlEncoded表示表单提交

@FormUrlEncoded @POST("user/edit") Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

@Part，@PartMap：用于POST文件上传，当中@Part MultipartBody.Part代表文件，@Part(“key”) RequestBody代表參数，须要加入@Multipart表示支持文件上传的表单。

@Multipart
   @POST("upload")
   Call<ResponseBody> upload(@Part("description") RequestBody description,
                             @Part MultipartBody.Part file);

完毕请求实例

了解了Retrofit，我们用Retrofit请求完毕请求。Retrofit使用起来比較省事，核心代码例如以下所看到的：

//初始化Retrofit,载入接口
NetInterface netInterface = NetWork.getRetrofit().create(NetInterface.class);
//请求接口
netInterface.getAddress(editText.getText().toString(),"你的app key")
        .enqueue(new Callback<Bean>() {
            @Override
            public void onResponse(Call<Bean> call, Response<Bean> response) {
                //请求成功
                Bean bean = response.body();
                //...
            }

            @Override
            public void onFailure(Call<Bean> call, Throwable t) {
                //请求失败
            }
        });

Retrofit会自己主动在子线程中进行网络请求。请求结束切换到主线程中。并且内部使用了线程池。对网络请求的缓存控制的也很到位，网络响应速度也是很快的，使用起来很的爽!

RxJava和Retrofit结合

RxJava很强大。就连Retrofit都要抱下他的大腿，Retrofit也能够用RxJava方式进行网络请求。仅仅须要对上面的代码进行改造就可以。

首先加入框架依赖。

dependencies {
  //...

    compile ‘io.reactivex:rxandroid:1.2.1‘
    compile ‘io.reactivex:rxjava:1.1.6‘

    compile ‘com.google.code.gson:gson:2.8.0‘

    compile ‘com.squareup.retrofit2:retrofit:2.1.0‘
    //假设用到gson解析 须要加入以下的依赖
    compile ‘com.squareup.retrofit2:converter-gson:2.1.0‘
    //Retrofit使用RxJava须要的依赖
    compile ‘com.squareup.retrofit2:adapter-rxjava:2.1.0‘

}

改动Retrofit初始化的代码:

public class NetWork {
    private static Retrofit retrofit;

    /**返回Retrofit*/
    public static Retrofit getRetrofit(){
        if(retrofit==null){
            //创建Retrfit构建器
            Retrofit.Builder builder = new Retrofit.Builder();
            //指定网络请求的baseUrl
            retrofit = builder.baseUrl("http://apis.juhe.cn/")
                    //返回的数据通过Gson解析
                    .addConverterFactory(GsonConverterFactory.create())
                    //使用RxJava模式
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

上面代码我们通过，加入代码addCallAdapterFactory(RxJavaCallAdapterFactory.create())就变成了使用RxJava模式。

接口也须要改动,把方法的返回值类型由Call改成了RxJava中的Observable。

public interface NetInterface {
    //获取号码归属地，返回来类型是Bean, 须要两个參数分别为phone何key
    @GET("mobile/get")
    Observable<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
}

接下来改动终于网络请求的代码，能够改成RxJava方式了。

  NetInterface netInterface = NetWork.getRetrofit().create(NetInterface.class);
    //RxJava方式
    netInterface.getAddress(editText.getText().toString(),"你的app key")
            .subscribeOn(Schedulers.io())//设置网络请求在子线程中
            .observeOn(AndroidSchedulers.mainThread())// 回调在主线程中
            .subscribe(new Action1<Bean>() {
                @Override
                public void call(Bean bean) {
                    //请求成功
                }
            }, new Action1<Throwable>() {
                @Override
                public void call(Throwable throwable) {
                    //请求失败
                }
            });

总结

这是Retrofit基础篇， 后面有时间再继续深入研究

---

很多其他精彩请关注微信公众账号likeDev