一入偷、搭建聯(lián)網(wǎng)框架
使用Retrofit2搭建項(xiàng)目的網(wǎng)絡(luò)請求框架之前呵晚,我們需要先導(dǎo)入相關(guān)的三方庫
compile 'com.squareup.retrofit2:retrofit:2.2.0'
compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.2.0'
compile 'io.reactivex:rxandroid:1.2.1'
compile 'io.reactivex:rxjava:1.2.1'
1矾芙、發(fā)起請求
Retrofit2向web服務(wù)器發(fā)起請求的方式有兩種----Call 和rxjava
- Call
Call是Retrofit2庫里發(fā)起請求的方法假抄,使用這種方式我們可以使用execute來進(jìn)行同步請求隧出,enqueue來進(jìn)行異步請求踏志,cancel來取消請求。實(shí)際的使用過程:
Retrofit 初始化
public static final String baseUrl = "http://192.168.100.214:8090/peakBusiness/"; //內(nèi)網(wǎng)
//--接口請求
private static NetworkService api;
public static NetworkService api() {
if (api == null) {
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build();
api = retrofit.create(NetworkService.class);
}
return api;
}
定義接口請求的方法
@GET("front/user.htm")
Call<ReceiveData.BaseResponse > login(@QueryMap Map<String, String> options);
返回?cái)?shù)據(jù)解析
//登錄
public static class BaseResponse {
public int code;
public String msg;
}
接口調(diào)用
private void login(String loginName,String password) {
Map<String, String> options = new HashMap<>();
options.put("method", "login");
options.put("token", "123121");
options.put("loginName", loginName);
options.put("password", password);
RestClient.api().login(options).enqueue(new Callback<ReceiveData.loginResponse>() {
@Override
public void onResponse(Call<ReceiveData.loginResponse> call, Response<ReceiveData.loginResponse> response) {
if (response.body() == null) {
ToastUtil.showLong(LoginActivity.this,"登錄異常", Gravity.CENTER);
return;
}
if (response.body().code == 0) {
ToastUtil.showLong(LoginActivity.this,"登錄成功", Gravity.CENTER);
Gson gson = new Gson();
MyApplication.getInstance().setUserInfo(gson.toJson(response.body().obj));
finish();
}else {
ToastUtil.showLong(LoginActivity.this,response.body().msg, Gravity.CENTER);
}
}
@Override
public void onFailure(Call<ReceiveData.loginResponse> call, Throwable t) {
dialog.dismiss();
ToastUtil.showLong(LoginActivity.this,"登錄失敗",Gravity.CENTER);
}
});
}
- rxjava
RxJava響應(yīng)式編程框架胀瞪,基于觀察者模式针余。使用這種方式進(jìn)行請求我們主要使用到了ObServable(被觀察者)和Subscribe(觀察者),關(guān)于RxJava和Observable的講解可以查看這篇文章RxJava—Observable
實(shí)際的使用過程:
Retrofit 初始化(HttpMethods.java)
public static final String BASE_URL = "http://192.168.100.132:8080/cnbsExamInterface/";
private static final int DEFAULT_TIMEOUT = 15;
private NetworkService networkService;
public static final int SuccessCode = 0;
//構(gòu)造方法私有
private HttpMethods() {
OkHttpClient httpClient = new OkHttpClient.Builder()
.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
.readTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
.build();
networkService = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.client(httpClient)
.build()
.create(NetworkService.class);
}
//在訪問HttpMethods時(shí)創(chuàng)建單例
private static class SingletonHolder {
private static final HttpMethods INSTANCE = new HttpMethods();
}
//獲取單例
public static HttpMethods getInstance() {
return SingletonHolder.INSTANCE;
}
private void toSubscribe(Observable o, Subscriber s) {
o.subscribeOn(Schedulers.io()) // 指定 subscribe() 發(fā)生在 IO 線程
.observeOn(AndroidSchedulers.mainThread()) // 指定 Subscriber 的回調(diào)發(fā)生在主線程
.subscribe(s);
}
//----------請求方法------------
//登錄
public void login(Subscriber<HttpResult.LoginResponse> subscriber, Map<String, String> options) {
Observable observable = networkService.login(options);
toSubscribe(observable, subscriber);
}
定義接口請求的方法(NetworkService.java)
//登錄
@GET("front/logAct/log.html")
Observable<HttpResult.LoginResponse> login(@QueryMap Map<String, String> options);
返回?cái)?shù)據(jù)解析(HttpResult.java)
public static class BaseResponse {
public String code;
public String msg;
}
接口調(diào)用
private void login(String user,String psw) {
Map<String, String> map = new HashMap<>();
map.put("loginName", user);
map.put("passWord", psw);
HttpMethods.getInstance().login(new Subscriber<HttpResult.LoginResponse>() {
@Override
public void onCompleted() {
}
@Override
public void onError(Throwable e) {
new CenterHintToast(LoginActivity.this,"登錄失敗凄诞,稍后重試圆雁!");
}
@Override
public void onNext(HttpResult.LoginResponse response) {
if ("0".equals(response.code)) {
UserBean bean = response.user;
MyApplication instance = MyApplication.getInstance();
instance.setUserInfo(bean);
Intent intent = new Intent(LoginActivity.this, MainActivity.class);
startActivity(intent);
} else {
new CenterHintToast(LoginActivity.this, response.msg);
}
}
}, map);
}
二、Retrofit2.0 注解的使用
- 下面是常用的注解
1帆谍、Get請求
使用@GET注解伪朽,@Query 或 @QueryMap參數(shù)注解,示例:
@GET("apisiness/inspectTasks/inspectTask")
Observable<HttpResult.TaskDownResponse> downTask(@QueryMap Map<String, String> options);
2汛蝙、Post請求
使用@POST注解烈涮,@Field 或 @FieldMap參數(shù)注解,示例:
@POST("apisiness/inspectTasks/uploadTask")
Observable<HttpResult.TaskUploadResponse> uploadTask(@FieldMap Map<String, String> options);
@Multipart
@POST("apisiness/uploadAct/uploadImgs")
Observable<HttpResult.TaskUploadResponse> uploadAdjunct(@FieldMap <String, String> options, @Part() List<MultipartBody.Part> parts);
Post請求還有以下常用的注解:
@Field和FieldMap -- 參數(shù)注解窖剑,用于發(fā)送一個(gè)表單請求坚洽。
@FormUrlEncoded -- 用于修飾Field注解和FieldMap注解,使用該注解,表示請求正文將使用表單網(wǎng)址編碼西土。
@Multipart -- 表示請求體是多部分的讶舰。 每一部分作為一個(gè)參數(shù),且用Part注解聲明。
@Part -- 參數(shù)注解需了,用于定義Multipart請求的每個(gè)part绘雁,參數(shù)值可以為空,為空時(shí),則忽略。
使用該注解定義的參數(shù)類型有以下3種方式可選:
- 如果類型是okhttp3.MultipartBody.Part援所,內(nèi)容將被直接使用。 省略part中的名稱,即 @Part MultipartBody.Part part 欣除;
- 如果類型是RequestBody住拭,那么該值將直接與其內(nèi)容類型一起使用。 在注釋中提供part名稱(例如历帚,@Part(“img”)RequestBody img);
- 其他對象類型將通過使用轉(zhuǎn)換器轉(zhuǎn)換為適當(dāng)?shù)母袷剑ㄈ鐚?shí)體Bean對象的上傳)滔岳。 在注釋中提供part名稱(例如,@Part(“Image ”)Image photo)挽牢。
三谱煤、RxJava處理嵌套請求
這里就要用到RxJava的操作符flatMap了。以下代碼實(shí)現(xiàn)了上傳圖片和設(shè)置用戶頭像的兩個(gè)接口的嵌套使用禽拔,Demo代碼如下:
Map<String, String> options = new HashMap<>();
options.put("type", "userHeadImg");
Map<String, RequestBody> obj = new HashMap<>();
RequestBody photo = RequestBody.create(MediaType.parse("image/png"), os.toByteArray());
obj.put("Imgs\"; filename=\"icon.png", photo);
RestClient.oapi().oUploadPic(options,obj)
.flatMap(new Func1<ReceiveData.OUpPhotoResponse, Observable<ReceiveData.OBaseResponse>>() {
@Override
public Observable<ReceiveData.OBaseResponse> call(ReceiveData.OUpPhotoResponse oUpPhotoResponse) {
thumPath = oUpPhotoResponse.piclist.get(0).getImg_path();
Map<String, String> options = new HashMap<>();
options.put("method", "updateImg");
options.put("userId", 5+"");
options.put("headImg",thumPath);
return RestClient.omapi().oResetUserImg(options);
}
})
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Action1<ReceiveData.OBaseResponse>() {
@Override
public void call(ReceiveData.OBaseResponse oBaseResponse) {
if (oBaseResponse.code == 0){
showInfo.setText("嵌套請求成功A趵搿室叉!");
userimg.setImageURI(RestClient.imgUrl+thumPath);
}
}
});
四、攔截器&Basic認(rèn)證
有兩種添加方式硫惕,一種是在每一個(gè)接口中加茧痕;第二種是在攔截器中加。
1恼除、認(rèn)證加密信息
private String username = "$";
private String password = "$";
// basic認(rèn)證信息
String credentials = username + ":" + password;
final String basic = "Basic " + Base64.encodeToString(credentials.getBytes(), Base64.NO_WRAP);
2踪旷、在接口中添加認(rèn)證信息
接口傳參時(shí),將上面的加密信息傳遞給接口豁辉,再進(jìn)行調(diào)用即可令野。
@GET("loginAct/loginByVerifyCode.html")
Observable<HttpResult.BaseResponse> base(@Header("Authorization") String auth,@QueryMap Map<String, String> options);
3、在攔截器中添加認(rèn)證信息
public class InterceptorUtils{
//給請求添加一個(gè)頭
public static Interceptor HeaderInterceptor(final String basic) {
return new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Request.Builder builder = request.newBuilder();
builder.addHeader("authorization", basic);
return chain.proceed(builder.build());
}
};
}
}
4徽级、實(shí)際使用
public class HttpMethods {
private static final int DEFAULT_TIMEOUT = 15;
public NetworkService networkService;
private String username = "$";
private String password = "$";
// basic認(rèn)證信息
String credentials = username + ":" + password;
final String basic = "Basic " + Base64.encodeToString(credentials.getBytes(), Base64.NO_WRAP);
private static HttpMethods httpMethodsods;
//構(gòu)造方法私有
private HttpMethods() {
OkHttpClient httpClient = new OkHttpClient.Builder()
.addInterceptor(InterceptorUtils.HeaderInterceptor(basic))
.connectTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
.readTimeout(DEFAULT_TIMEOUT, TimeUnit.SECONDS)
.build();
//防止修改的url不合理
try {
networkService = new Retrofit.Builder()
.baseUrl(MyApplication.getInstance().getBaseURL())
.addConverterFactory(GsonConverterFactory.create())
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
.client(httpClient)
.build()
.create(NetworkService.class);
}catch (Exception e){
e.printStackTrace();
}
}
...
五气破、錯(cuò)誤解決
1、post請求返回400
現(xiàn)象:retrofit2.0 post提交一直返回400,用httpurlconnection就可以
原因:我使用的post方式有問題灰追,雖然我使用了@post標(biāo)識這個(gè)請求堵幽,但是我傳參的地方用錯(cuò)標(biāo)簽了,@QueryMap是用于get請求的傳參標(biāo)簽弹澎,把他換成post的傳參標(biāo)簽@FieldMap就好了朴下。
- 錯(cuò)誤的使用
@POST("front/questionnaireResultsAct/resultSave.html")
Observable<HttpResult.UploadResponse> uploadData(@QueryMap <String, String> options);
- 正確的使用
@FormUrlEncoded
@POST("front/questionnaireResultsAct/resultSave.html")
Observable<HttpResult.UploadResponse> uploadData(@FieldMap Map<String, String> options);