詳情查看 https://github.com/square/retrofit
介紹
Square公司為Android開源的類型安全的Http客戶端
底層基于OkHttp妆毕,使用OkHttp進(jìn)行請(qǐng)求
將java API的定義轉(zhuǎn)換為interface形式
使用annotation描述http請(qǐng)求
支持配置json解析器
添加依賴
compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.0.2'
創(chuàng)建Retrofit實(shí)例對(duì)象
//創(chuàng)建
RetrofitRetrofit retrofit = new Retrofit.Builder()
//注意顽素,服務(wù)器主機(jī)應(yīng)該以/結(jié)束礁竞,
.baseUrl("http://192.168.2.103:8080/apitest/")
//設(shè)置服務(wù)器主機(jī)
.addConverterFactory(GsonConverterFactory.create())
//配置Gson作為json的解析器
.build();
定義業(yè)務(wù)邏輯接口
public interface HeiMaApi { /** * 定義了一個(gè)業(yè)務(wù)方法庵寞,獲取訂單枉证, */
@GET("test") //指定該方法要請(qǐng)求的url以躯,注意方法的路徑不要以/開頭,如/test湖饱,是錯(cuò)誤的
Call<Stu> getOrder();
}
創(chuàng)建接口實(shí)例對(duì)象
HeiMaApi heiMaApi = retrofit.create(HeiMaApi.class);
獲取業(yè)務(wù)方法的調(diào)用對(duì)象掖蛤,并進(jìn)行請(qǐng)
//調(diào)用業(yè)務(wù)方法,得到要執(zhí)行的業(yè)務(wù)請(qǐng)求對(duì)象
Call<Stu> order = heiMaApi.getOrder();
//執(zhí)行請(qǐng)求對(duì)象//1.同步執(zhí)行井厌,得到響應(yīng)對(duì)象,會(huì)阻塞UI,不推薦//
Response<Stu> response = order.execute();
//Stu stu = response.body();
//2.異步執(zhí)行業(yè)務(wù)方法
order.enqueue(new Callback<Stu>() {
@Override public void onResponse(Call<Stu> call, Response<Stu> response) {
Stu stu = response.body();
text.setText(stu.toString());
}
@Override public void onFailure(Call<Stu> call, Throwable t) {
}
});
Retrofit的url注解處理
使用@Path注解來處理url路徑不固定的需求蚓庭,如:
@GET("test/{order}")
//獲取訂單的某段路徑不固定,
Call<Stu> getOrder(@Path("order")String order);
使用@Query注解來替換url后面跟的參數(shù)仅仆,如:
//url為:
test?id=333
//使用
@Query來替換查詢參數(shù)
@GET("test")Call<Stu> getOrderById(@Query("id") String id);
使用@QueryMap來替換多個(gè)查詢參數(shù)器赞,如
//假設(shè)url為:
login?username=heima&password=111
//使用@QueryMay來替換多個(gè)查詢參數(shù)
@GET("login")Call<Stu> login(@QueryMap Map<String,String> map);
使用@Post注解進(jìn)行post請(qǐng)求,提交key-value數(shù)據(jù)墓拜,如
@FormUrlEncoded
//配置對(duì)請(qǐng)求體參數(shù)進(jìn)行url編碼
@POST("login")Call<Login> postLogin(
@Field("username")String username,
@Field("password")String password
);
使用@Post注解進(jìn)行post請(qǐng)求拳魁,提交json數(shù)據(jù),如
//使用@Body設(shè)置請(qǐng)求體參數(shù)
//注意撮弧,@Body不需要配置@FormUrlEncoded或者@Multipart
@POST("login")Call<Login> postJson(@Body JsonObject jsonObject);
使用@Headers定義請(qǐng)求頭潘懊,如
//定義請(qǐng)求頭
@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
使用ResponseBody來接收流的數(shù)據(jù),比如下載文件
//下載文件
@GET("image")Call<ResponseBody> getImage();
使用@Muptipart和@Part或者@PartMao封裝多塊請(qǐng)求體
//上傳文件和其他參數(shù)@Multipart
//將請(qǐng)求體進(jìn)行Multipart拼接@POST("uploadMulti")
//RequestBody表示數(shù)據(jù)和數(shù)據(jù)類型的封裝體
//Call<UploadResult> upload(@Part("file") RequestBody file,
@Part("params1") RequestBody params1);
//或者使用
@PartMapCall<UploadResult> upload(@PartMap Map<String, RequestBody> map);
需要注意的是贿衍,構(gòu)建RequestBody的時(shí)候要注意拼接:
File file = new
File(Environment.getExternalStorageDirectory(),"a.jpg");
File file2 = new File(Environment.getExternalStorageDirectory(),"dog.jpg");
RequestBody fileBody = RequestBody.create(MediaType.parse("image/jpeg"),file);
RequestBody fileBody2 = RequestBody.create(MediaType.parse("image/jpeg"),file2);
HashMap<String,RequestBody> map = new HashMap<>();
map.put("file\";
filename=\""+file.getName(),fileBody);
map.put("file\";
filename=\""+file2.getName(),fileBody2);
Call<UploadResult> uploadResultCall = HeiMaClient.create().heiMaApi.upload(map);
uploadResultCall.enqueue(new Callback<UploadResult>() {
@Override public void onResponse(Call<UploadResult> call, Response<UploadResult> response) {
text.setText(response.body().toString());
}
@Override public void onFailure(Call<UploadResult> call, Throwable t) { }});