簡(jiǎn)介
簡(jiǎn)單示例
1. 定義Model
public interface WebModel {
// 此字符串會(huì)拼接在baseUrl后面胀莹，其中{id}是占位符携丁，可以用@Path后接的參數(shù)替換熔掺。
@GET("something/{id}/")
Call<ResponseBody> getWeb(@Path("id") int id);
@POST("form")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);
}
2. 創(chuàng)建OkHttpClient
OkHttpClient okHttpClient = new OkHttpClient().newBuilder()
.readTimeout(10, TimeUnit.SECONDS)
.connectTimeout(9, TimeUnit.SECONDS)
.build();
3. 創(chuàng)建Retrofit
Retrofit retrofit = new Retrofit.Builder()
.client(okHttpClient)
.baseUrl("https://www.baidu.com/")
.build();
4. 創(chuàng)建Model
WebModel service = retrofit.create(WebModel.class);
5. 創(chuàng)建Call
Call<ResponseBody> call = service.getWeb(2);
6. 執(zhí)行Call
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
try {
// UI線程
Log.d("MyTag", response.body().string());
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
t.printStackTrace();
}
});
Model注解
1. HTTP請(qǐng)求方法
@HTTP注解
public interface WebModel {
@HTTP(method = "get", path = "blog/{id}", hasBody = false)
Call<ResponseBody> getWeb(@Path("id") int id);
}
2. 標(biāo)記類及其示例
標(biāo)記類注解
1. 定義Model
0. 外殼
public interface BlogService {
// ...
}
1. 演示@FormUrlEncoded和@Field
@POST("form")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded1(@Field("username") String name, @Field("age") int age);
2. 演示@FormUrlEncoded和@FieldMap
-
@FieldMap和@Field并非互斥，可以混合使用。
@POST("form")
@FormUrlEncoded
Call<ResponseBody> testFormUrlEncoded2(@FieldMap Map<String, Object> map);
3. 演示@Multipart和@Part
-
@Part支持三種類型：RequestBody、okhttp3.MultipartBody.Part、任意類型财骨。
- 除
okhttp3.MultipartBody.Part以外，其它類型都必須帶上表單字段（okhttp3.MultipartBody.Part中已經(jīng)包含了表單字段的信息）藏姐。
@POST("form")
@Multipart
Call<ResponseBody> testFileUpload1(@Part("name") RequestBody name, @Part("age") RequestBody age, @Part MultipartBody.Part file);
4. 演示@Multipart和@PartMap
-
@PartMap注解支持一個(gè)Map作為參數(shù)隆箩，僅支持RequestBody類型，如果有其它的類型羔杨，會(huì)被retrofit2.Converter轉(zhuǎn)換捌臊。
- 對(duì)于文件上傳，雖然不能用
RequestBody類型封裝兜材，但是可以通過@PartMap和@Part混合使用來實(shí)現(xiàn)理澎。
@POST("form")
@Multipart
Call<ResponseBody> testFileUpload3(@PartMap Map<String, RequestBody> args);
2. 創(chuàng)建Call
1. 演示@FormUrlEncoded和@Field
Call<ResponseBody> call1 = service.testFormUrlEncoded1("name", 24);
2. 演示@FormUrlEncoded和@FieldMap
Map<String, Object> map = new HashMap<>();
map.put("username", "name");
map.put("age", 24);
Call<ResponseBody> call2 = service.testFormUrlEncoded2(map);
3. 演示@Multipart和@Part
RequestBody name = RequestBody.create(MediaType.parse("text/plain"), "怪盜kidou");
RequestBody age = RequestBody.create(MediaType.parse("text/plain"), "24");
RequestBody file = RequestBody.create(MediaType.parse("application/octet-stream"), "這里是模擬文件的內(nèi)容");
MultipartBody.Part filePart = MultipartBody.Part.createFormData("file", "test.txt", file);
Call<ResponseBody> call3 = service.testFileUpload1(name, age, filePart);
4. 演示@Multipart和@PartMap
// 實(shí)現(xiàn)和@Multipart和@Part同樣的效果，但是文件要單獨(dú)處理曙寡，因?yàn)槲募怯涉I糠爬、文件名(包含在Content-Disposition請(qǐng)求頭中)、文件內(nèi)容組成的举庶，不是普通的鍵值對(duì)执隧。
Map<String, RequestBody> fileUpload2Args = new HashMap<>();
fileUpload2Args.put("name", name);
fileUpload2Args.put("age", age);
Call<ResponseBody> call4 = service.testFileUpload2(fileUpload2Args, filePart);
3. 參數(shù)類
1. 定義Model
0. 外殼
public interface BlogService {
// ...
}
1. 演示@Headers與@Header
@GET("/headers?showAll=true")
@Headers({"CustomHeader1: customHeaderValue1", "CustomHeader2: customHeaderValue2"})
Call<ResponseBody> testHeader(@Header("CustomHeader3") String customHeaderValue3);
2. 演示@Query
// 效果：ids[]=ids1&ids[]=ids2
Call<ResponseBody> foo(@Query("ids[]") boolean ids1, @Query("ids[]") boolean ids2);
// 效果：ids[]=0&ids[]=1&ids[]=2
Call<ResponseBody> foo(@Query("ids[]") List<Integer> ids);
3. 演示@QueryMap【Todo】
4. 演示@Url
- 當(dāng)
@GET、@POST户侥、@HTTP等方法中沒有設(shè)置Url時(shí)镀琉，則必須在參數(shù)中使用@Url提供
-
@Url支持的類型有okhttp3.HttpUrl，String蕊唐，java.net.URI屋摔，android.net.Uri。
@GET
Call<ResponseBody> testUrlAndQuery(@Url String url, @Query("showAll") boolean showAll);
注意事項(xiàng)
-
{占位符}和PATH盡量只用在URL的path部分刃泌。
-
Query凡壤、Field和Part這三者都支持?jǐn)?shù)組和實(shí)現(xiàn)了Iterable接口的類型，如List耙替，Set等，方便向后臺(tái)傳遞數(shù)組曹体。
