上一篇简要总结了一下Retrofit的最基本用法,异步GET请求。
先来个小插曲:有很多网上的资料上来一段代码是这样的:
public class ServiceGenerator {
public static final String API_BASE_URL = "your-base-url";
private static RestAdapter.Builder builder = new RestAdapter.Builder()
.setEndpoint(API_BASE_URL)
.setClient(new OkClient(new OkHttpClient()));
public static <S> S createService(Class<S> serviceClass) {
RestAdapter adapter = builder.build();
return adapter.create(serviceClass);
}
}
这里解释一下,因为我在初次使用的时候就发现怎么也找不到RestAdapter这个类,就更不用说里面的静态构造器类Builder了。
其实是这样,网上写的这些都是用的Retrofit1.9这个版本。有的可能在资料里没说清楚。
如果你导入的是下面这个,那么是可以按上面这种方式来做的:
dependencies {
// ...
compile 'com.squareup.retrofit:retrofit:1.9.0'
compile 'com.squareup.okhttp:okhttp:2.7.2'
}
下面来一大波干货。(下面都是按照Retrofit2.0来做的,使用1.9的童鞋自行绕道:http://blog.36dr.net/2015/10/31/Retrofit1.9%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8/)
一、续上篇。做个小封装吧
public class ServiceGenerator {
// URL基本部分
private static String BASE_URL = "your-base-url";
// 初始化一个OkHttpClient对象
private static OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
// 初始化一个Retrofit构造器对象
private static Retrofit.Builder builder = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create());
/**
* 此方法的目的是为了创建你需要的Service
* 注意:这个Service并不是真正的继承了android.app.Service的服务
* 只是一般将请求都放到一个叫做Service的类中,你可以自己取名字~~
* 这里的<S> S也没啥讲究,就是表示泛型
* @params serviceClass 表示的是你写了具体的请求的那个类,里面可以写了@GET...
*/
public static <S> S createService(Class<S> serviceClass) {
Retrofit retrofit = builder.client(httpClient.build()).build();
return retrofit.create(serviceClass);
}
}
然后你需要根据业务需求写你的Service接口,比如
public interface HttpService {
@GET("/part/index.php")
Call<JavaBean> getJavaBean();
}
二、几个重要的注解的使用
(一) GET请求中的常用注解
1.@Path - 替换参数注解
// 如果你的接口有多个,并且不同的接口只是其中的某个或者若干个参数不同
@GET("/part/index.php/{id}/users")
// 注意:@Path的写法,用字符串标记出要替换的部分,指定形式参数与之对应。
List<User> getList(@Path("id") int id);
2.@Query - 添加查询参数
@GET("/part/index.php/{id}/users")
// 此时针对的是这样的URL: .../part/index.php/123/users?sort=desc
List<User> getList(@Path("id") int id, @Query("sort") String sort);
3.@QueryMap - 查询一个集合
@GET("/part/index.php/{id}/users")
// 理解了第2点,第3点就很好理解了。就是查的时候有很多个参数呗
List<User> getList(@Path("id") int id, @QueryMap Map<String, String> options);
// 这时候就传键值对就好了
// 最后URL可能的形式是 .../users?sort=desc&group=A&time=456&page=1
(二)、POST请求中常用的注解
1.@Body - 请求体注解
参数会被指定的转换器转换成字符串或者字节流提交给服务器。如果没有指定转换器,会使用默认的请求体。
@POST("/users/new")
void createUser(@Body User user, CallBack<User> callBack);
2.@FormUrlEncoded - 提交表单数据给服务器
@FormUrlEncoded
@POST("users/edit")
User updateUser(@Field("nickName") String nickName, @Field(email) String email);
3.@Mutipart - 多种不同类型的参数上传
@Multipart
@PUT("/users/logo")
User updateUser(@Part("logo") TypedFile photo, @Part("individualSign") TypedString sign);
注意:@Multipart 中的@Part在未指定转换器时使用默认转换器来转换,也可自定义转换方式(需要 implement TypedOutput,具体百度)
这个例子是用在用户修改或者设置账户头像时,这是一个很普通的操作。
另外,网上有提到@Multipart经常用在上传文件的场景下。在这里了解一下:
//创建接口
interface HttpService {
@Multipart
@POST("/images")
void upload(@Part("file") TypedFile file, Callback<File> callback);
}
//使用
httpService.upload(new TypedFile("image/jpg",yourFile),
new Callback<File>() {
@Override
public void success(File file, Response response) {
}
@Override
public void failure(RetrofitError error) {
}
});
4.@Header - 指定请求头
@POST("...")
XX getXXX(@Header("Authorization") String authorization);
@Headers("Authorization: authorization") //这里authorization就是上面方法里传进来变量的值
@POST("widget/list")
Call<User> getUser()
三、基本使用
// 在需要的时候进行初始化
HttpService mSevice = ServiceGenerator.createService(HttpService.class);
// 根据需求调用在HttpService中的请求回调方法
mService.getXXX(arg0, arg1...);
————————————-不怎么华丽的分割线——————————————-