Retrofit2.0使用

Retrofit项目Github主页:点击打开链接 

Retrofit项目官方文档   :点击打开链接


1.设置

(1)权限:首先确保在AndroidManifest.xml中请求了网络权限 :

(2)Studio用户,在app/build.gradle文件中添加如下代码:

dependencies {

compile 'com.squareup.retrofit:retrofit:2.0.0-beta2'

compile 'com.squareup.okhttp:okhttp:2.5.0'

compile 'com.squareup.okio:okio:1.6.0'

}

Eclipse的用户,可以下载最新的jar:我将整理的jar包已上传:点击打开链接

注意:1.Retrofit必须使用okhttp请求了,如果项目中没有okhttp的依赖的话,肯定会出错 。

2.okhttp内部依赖okio所以也要添加。

2.使用

(1)创建Retrofit实例

public static final String BASE_URL = "http://api.myservice.com";

Retrofit retrofit = new Retrofit.Builder()

.baseUrl(BASE_URL)

.build();

如果你想接收json 结果并解析成DAO,你必须把Gson Converter 作为一个独立的依赖添加进来。

compile 'com.google.code.gson:gson:2.4'

compile 'com.squareup.retrofit:converter-gson:2.0.0-beta2'

这里是Square提供的官方Converter modules列表。选择一个最满足你需求的。

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

你也可以通过实现Converter.Factoty接口来创建一个自定义的converter。

然后使用addConverterFactory把它添加进来:

public static final String BASE_URL = "http://api.myservice.com";

Retrofit retrofit = new Retrofit.Builder()

.baseUrl(BASE_URL)

.addConverterFactory(GsonConverterFactory.create())

.build();

(2)定义Endpoints,实现了转换HTTP API为Java接口

Retrofit提供了5种内置的注解:GET、POST、PUT、DELETE和HEAD,在注解中指定的资源的相对URL

@GET("users/list")

也可以在URL中指定查询参数

@GET("users/list?sort=desc")

请求的URL可以在函数中使用替换块和参数进行动态更新,替换块是{ and }包围的字母数字组成的字符串,相应的参数必须使用相同的字符串被@Path进行注释

@GET("group/{id}/users")

Call> groupList(@Path("id") int groupId);

也可以添加查询参数

@GET("group/{id}/users")

Call> groupList(@Path("id") int groupId, @Query("sort") String sort);

复杂的查询参数可以使用Map进行组合

@GET("group/{id}/users")

Call> groupList(@Path("id") int groupId, @QueryMap Map options);

可以通过@Body注解指定一个对象作为Http请求的请求体

@POST("users/new")

Call createUser(@Body User user);

使用@FormUrlEncoded发送表单数据,使用@Field注解和参数来指定每个表单项的Key,Value为参数的值。

@FormUrlEncoded

@POST("user/edit")

Call getUser(@Field("name") String name, @Field("password") String password);

使用@FormUrlEncoded发送表单数据时,表单项过多时可以使用Map进行组合

@FormUrlEncoded

@POST("user/edit")

Call getUser(@FieldMap Map map);

使用@Multipart可以进行文件上传,使用@Part指定文件路径及类型

@Multipart

@POST("/user/edit")

Call upload(@Part("image\"; filename=\"文件名.jpg") RequestBody file);

使用@MapPart可以方便批量上传

@Multipart

@POST("/user/edit")

Call upload(@PartMap Map params);

RequestBody fileBody = RequestBody.create(MediaType.parse("image/png"), imgFile);

map.put("image\"; filename=\""+imgFile.getName()+"", fileBody);

(3)Accessing the API

public interface MyApiEndpointInterface {

// Request method and URL specified in the annotation

// Callback for the parsed response is the last parameter

@GET("/users/{username}")

Call getUser(@Path("username") String username);

}

MyApiEndpointInterface apiService = retrofit.create(MyApiEndpointInterface.class);

异步请求这个API

String username = "sarahjean";

Call call = apiService.getUser(username);

call.enqueue(new Callback() {

@Override

public void onResponse(Response response) {

int statusCode = response.code();

User user = response.body();

}

@Override

public void onFailure(Throwable t) {

// Log error here since request failed

}

});

同步请求

String username = "sarahjean";

Call call = apiService.getUser(username);

User user = call.execute();

3.注意

(1)我们在同步方法使用时可以直接调用execute方法,但是这个方法只能调用一次。解决办法:需要用clone方法生成一个新的之后在调用execute方法:

Call> call = gitHubService.repoContributors("square", "retrofit");

response = call.execute();

// This will throw IllegalStateException:

response = call.execute();

Call> call2 = call.clone();

// This will not throw:

response = call2.execute();

(2)当我们执行的同步或异步加入队列后,可以随时使用cancel方法取消请求:

Call> call = gitHubService.repoContributors("square", "retrofit");

call.enqueue(...);

// or...

call.execute();

// later...

call.cancel();


推荐阅读更多精彩内容