原博主地址:
http://blog.csdn.net/zzz_zzz_z
Retrofit开源项目地址:
https://github.com/square/retrofit
Retrofit项目官网:
https://square.github.io/retrofit
了解RESTful Api
看下面设计的三个删除评论的api:
http://test.net/?method=comment.del&id=x ①
http://test.net/comment/del/id/x ②
而RESTful Api则是:
[DELETE] http://test.net/comments/1 ③
我们对比可以发现 ① 和 ② URL 中,都有 del 的动作指示。
SOAP Web API采用RPC风格,它采用面向功能的架构,所以我们在设计**SOAP Web API **的时候首相考虑的是应高提供怎样的功能(或者操作)。
而 RESTful Api 是面向资源的架构。是查询、新增、修改、删除,都与该资源无关。
RESTful Api是以 HTTP 协议为强烈依托的,将类似于①和②这种以功能为主导的 URL 风格舍弃,还原 URL 的本质,它的宗旨就是一个 URL 就应该是一个资源,不能包含任何动作,如下所示:
[POST] http://test.net/users //新增
[GET] http://test.net/users/1 //查询
[PATCH] http://test.net/users/1 //更新
[PUT] http://test.net/users/1 //覆盖,全更新
[DELETE] http://test.net/users/1 //删除
URL的简单构成
URL一般是这样构成的:
[scheme:][//authority][path][?query]
看下面一个url:
http://www.java2s.com:8080/yourpath/fileName.htm?stove=10&path=32&id=4
- scheme: http
- authority: www.java2s.com:8080
- path: /yourpath/fileName.htm
- query: stove=10&path=32&id=4
authority可以进一步划分为host:port形式,其中host:port用冒号分隔,冒号前是host,冒号后是port,所以:
- host: www.java2s.com
- port: 8080
这是url中的参数,除了url中的参数还有两个http协议常用的参数是:
header(请求头) 和body (常用于post请求中的请求体,有多中封装方法,不暴露在url中)
可以看出整个网络请求参数主要可以分成:scheme,authority,path,query,header,body这六块,下面看Retrofit怎么配置这六块参数。
参数配置
- scheme和authority
在Retrofit中将这两者合体为baseurl ,接口用法如下:
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.build();
- header
静态header
单个键值对注解:
@Header("Cache-Control:max-age=640000")
@GET("widget/list")
Call> widgetList();
多个键值对注解:
@Header({
"Accept: application/vnd.github.v3.full+json",
"User-Agent:Retrofit-Sample-App"})
@GET("users/{username}")
Call getUser(@Path("username") String username);
动态header
局部动态header:(又分为单个键值对和多个键值对)
单个键值对局部动态Header:
@GET("user")
Call getUser (@Header("Authorization") String authorization);
多个键值对局部动态Header:
@GET("user")
Call getUser(@HeaderMap Map headerMap);
全局动态Header(适用于项目中的Header规则一致的情况):
这里用的是OkHttp中interceptor:
Request interRequest = chain.request().newBuilder()
.headers(Headers.of(Map yourHeader))
.build();
- path
不带参数:
@GET("widget/list")
Call> widgetList();
带参数:
@GET("user/{user}/repos")
Call> listRepos(@Path("user") String uesr);
- query
单个键值对:
@GET("top250")
Call getTop250(@Query("start") int start, @Query("count") int count);
多个键值对:
@GET("top250")
Call getTop250(@QueryMap Map options);
- body
大多用于POST请求中:
@POST("users/new")
Call createUser(@Body User user);
Retrofit简单封装
先配置第三方库(Retrofit库,json库,log的截断器库)
compile 'com.squareup.retrofit2:retrofit:2.2.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.okhttp3:logging-interceptor:3.4.0-RC1'
RetrofitManager:
public class RetrofitManager {
private static OkHttpClient mOkHttpClient;
private static Retrofit mRetrofit;
private static final String BASE_URL = "https://api.douban.com/v2/movie/";
private static final int DEFAULT_TIME_OUT = 5;
private static final int DEFAULT_READ_TIME_OUT = 10;
private static void initHttpClient() {
OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder();
if (httpClientBuilder.interceptors() != null) {
httpClientBuilder.interceptors().clear();
}
httpClientBuilder.addInterceptor(new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
String path = request.url().encodedPath();
Log.e("baizhou", path + ">>>path");
String query = request.url().query();
if (BuildConfig.DEBUG) {
Log.e("baizhou", query + ">>>query");
}
Map queryParam = null;
if (query != null) {
queryParam = new HashMap();
String queryEntries[] = query.split("&");
for (int i = 0; i < queryEntries.length; i++) {
queryParam.put(queryEntries[i].split("=")[0], queryEntries[i].split("=")[1]);
}
}
if (BuildConfig.DEBUG) {
Log.e("baizhou", "queryParam:" + queryParam + ">>>queryParam");
}
Request interRequest = chain.request().newBuilder()
//加入请求头
// .headers(Headers.of)
.build();
return chain.proceed(interRequest);
}
})
.connectTimeout(DEFAULT_TIME_OUT, TimeUnit.SECONDS)
.readTimeout(DEFAULT_READ_TIME_OUT, TimeUnit.SECONDS);
if (BuildConfig.DEBUG) {
HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
httpClientBuilder.addInterceptor(loggingInterceptor);
}
mOkHttpClient = httpClientBuilder.build();
}
private RetrofitManager() {
initHttpClient();
mRetrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.client(mOkHttpClient)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.build();
}
private static class SingletonHolder {
private static final RetrofitManager INSTANCE = new RetrofitManager();
}
public static RetrofitManager getInstance() {
return SingletonHolder.INSTANCE;
}
public T create(Class service) {
return mRetrofit.create(service);
}
}