以前项目搭建框架主要用到retrofit，rxJava，然后是mvp模式，大多时候只能用，没有深入了解，现在来系统的学习一下。
先从Retrofit开始,以下内容都是以Retrofit 2.0为主
项目里面导入
dependencies {
compile 'com.squareup.retrofit2:retrofit:2.1.0'
// 需要添加一个转化器给Retrofit对象，在继承Gson作为默认的Json转换器
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
}
1 Retrofit的使用
1.1 创建Retrofit实例
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://192.168.0.1:9001/")
.build();
注意
a.Retrofit2 的baseUlr 必须以 /（斜线） 结束，不然会抛出一个IllegalArgumentExceptiond 的异常
b.http://192.168.0.1:9001?id=value 这样做为baseUrl亦可以，？id=value会在请求时被丢掉
1.2 接口形式
public interface TestAps {
@POST(Urls.SEND_LOG_MESSAGE)
Call<ResponseBody> sendLogMessage(@Path("id") int id);
}
创建接口对象
TestAps api=retrofit.create(TestAps.class);
这里可以创建一个Api的工具类，避免创建对象都要写重复代码
public class ApiFactory{
public static final String API_BASE_URL = "http://your.api-base.url";
private static OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
private static Retrofit.Builder builder =
new Retrofit.Builder()
.baseUrl(API_BASE_URL)
.addConverterFactory(GsonConverterFactory.create());
public static <S> S createService(Class<S> serviceClass) {
Retrofit retrofit = builder.client(httpClient.build()).build();
return retrofit.create(serviceClass);
}
}
可以在这里做一些操作例如使用自签证书的https地址时设置证书，或者设置http的请求头信息
httpClient.addInterceptor(new Interceptor() {
@Override
public Response intercept(Interceptor.Chain chain) throws IOException {
Request original = chain.request();
Request.Builder requestBuilder = original.newBuilder()
.header("Authorization", basic)
.header("Accept", "application/json")
.method(original.method(), original.body());
Request request = requestBuilder.build();
return chain.proceed(request);
}
});
}
OkHttpClient client = httpClient.build();
Retrofit retrofit = builder.client(client).build();
1.3接口请求实例
Call<ResponseBody> call=api.sendLogMessage(0);
同步操作
try {
ResponseBody response= call.execute().body();
} catch (IOException e) {
// handle errors
}
一般不会用到同步的方式，因为会引起ui线程的阻塞，有特殊情况时可以考虑
异步操作
//retrofit中系统回到方法执行在主线程
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
try {
System.out.println(response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
t.printStackTrace();
}
});
2 Retrofit的注解
2.1 请求类
也就是接口类里面的@POST
主要用到三个 @GET get请求 @POST post请求
@Http
//method 表示请求的方法 path 接口地址 hasBody表示是否有请求体
@HTTP(method = "GET", path = "blog/{id}", hasBody = false)
@Headers添加固定的请求头
添加单个请求头
public interface TestAps {
@Headers("Cache-Control: max-age=640000")
@POST(Urls.SEND_LOG_MESSAGE)
Call<ResponseBody> sendLogMessage(@Path("id") int id);
}
添加多个请求头
public interface TestAps {
@Headers({
"Accept: application/vnd.yourapi.v1.full+json",
"User-Agent: Your-App-Name"
})
@POST(Urls.SEND_LOG_MESSAGE)
Call<ResponseBody> sendLogMessage(@Path("id") int id);
}
@Header动态添加请求头
public interface TestAps {
@POST(Urls.SEND_LOG_MESSAGE)
Call<ResponseBody> sendLogMessage(@Path("id") int id，@Header("Content-Range") String contentRange);
}
header的作用等同于上面在ApiFactory中使用http拦截器
2.2 标记类
@FormUrlEncode
请求体form表单形式 Content-Type:application/x-www-form-urlencoded
使用这个时参数只能用@Field或者@FieldMap
@POST(Urls.SEND_LOG_MESSAGE)
@FormUrlEncode
Call<ResponseBody> sendLogMessage(@Field("id") int id);
@POST(Urls.SEND_LOG_MESSAGE)
@FormUrlEncode
Call<ResponseBody> sendLogMessage(@FieldMap Map<String, Object> map);
@Multipart
请求体支持文件上传
Content-Type:multipart/form-data
@POST("/form")
@Multipart
Call<ResponseBody> sendLogMessage(@Part("id") RequestBody id, @Part("age") RequestBody age, @Part MultipartBody.Part file);
@POST("/form")
@Multipart
Call<ResponseBody> test(@PartMap Map<String, RequestBody> args, @Part MultipartBody.Part file);
2.3 参数类
非表单请求体
@Body
表单请求体
@Field @FieldMap与FormUrlEncoded注解配合使用
@Part @PartMap与Multipart注解配合
用于拼接URL
@Path @Query @QueryMap
@Url
@GET //当有URL注解时，这里的URL就省略了
Call<ResponseBody> test(@Url String url);
注意多个Query参数使用同一个名字
https://api.example.com/tasks?id=123
public interface TestApi {
@GET("/tasks")
Call<Task> getTask(@Query("id") long taskId);
}
https://api.example.com/tasks?id=123&id=124&id=125
public interface TestApi{
@GET("/tasks")
Call<List<Task>> getTask(@Query("id") List<Long> taskIds);
}
3 使用引入的Gson 实现返回响应体类型的转换
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
public interface TestApi{
@POST("/blog")
Call<Basedata<Blog>> getBlog(@Path("id") int id);
}
