引言
最近的一個項目里使用到了現(xiàn)在很火的 Retrofit ，剛接觸時就是簡單的使用。在需要請求接口的地方定義一個方法，方法體里面寫 Retrofit 相關代碼，所以基本上每一個需要請求接口的地方都要這樣做一次。這樣做的后果就是后期再回頭看這些代碼的時候，就覺得類很亂，代碼冗余，難于維護。所以我做了一個簡單的封裝，經(jīng)一位大神指點過后（這位大神說我這個封裝有點MVP的味道，內心還有點小竊喜），現(xiàn)將整理后的代碼貼在這兒，分享給大家。如有覺得不足之處，請大家多多指點，在評論區(qū)積極留言，以做討論。我這也是一個拋磚引玉之舉，如果哪位大神還有什么好的使用方法，歡迎在此分享給大家，一起學習，一起進步，謝謝！
一般來說我們使用 Retrofit 必不可少的就是定義一個 interface ，里面定義獲取 Call 的方法。之前都是隨用隨建，幾乎每個類里面都有一個。現(xiàn)在我把它拿了出來，作為一個公共的 interface ，在里面寫各個接口需要的獲取 Call 的方法。
public interface Parser {
/**
* 添加游客身份
*
* @param mParams
* @return
*/
@FormUrlEncoded
@POST("surfers")
Call<SurferEntry> doParserSurferEntry(@FieldMap Map<String, String> mParams);
/**
* 獲取文章列表
*
* @param params
* @return
*/
@GET("articles")
Call<RecommendEntry> doGetArticles(@QueryMap Map<String, String> params);
}
這步做完之后，我們就該去創(chuàng)建 Retrofit 了，用它來請求接口，獲取數(shù)據(jù)。這里我也是把這個操作放在了一個公共類里，這樣我們就只需要創(chuàng)建一次就可以了，不需要在每個地方都去創(chuàng)建一次了。
public class EntryDataParser {
private Context mContext;
private Parser mParser;
private Map<String, String> mParams;
private int DATA_TYPE;
private EntryDataListener mListener;
public EntryDataParser(Context mContext, EntryDataListener mListener) {
this.mContext = mContext;
this.mListener = mListener;
}
/**
* 請求接口，接收返回數(shù)據(jù)
*
* @param DATA_TYPE 接口類型
* @param mParams 接口參數(shù)
*/
public void doParser(int DATA_TYPE, Map<String, String> mParams) {
this.DATA_TYPE = DATA_TYPE;
this.mParams = mParams;
Retrofit retrofit = new Retrofit.Builder().baseUrl(ConstantUtil.BASE_URL)
.addConverterFactory(GsonConverterFactory.create()).build();
mParser = retrofit.create(Parser.class);
switch (DATA_TYPE) {
case ParserEntry.SURFER_TYPE://添加游客身份
doCreateSurfer();
break;
case ParserEntry.ARTICLE_TYPE://獲取文章列表
doGetArticles();
break;
}
}
/**
* 添加游客身份
*/
private void doCreateSurfer() {
Call<SurferEntry> call = mParser.doCreateSurfer(mParams);
call.enqueue(new Callback<SurferEntry>() {
@Override
public void onResponse(Call<SurferEntry> call, Response<SurferEntry> response) {
if (response.isSuccessful()) {
if (response.body().code == 200) {
mListener.doEntryData(DATA_TYPE, response.body());
} else {
PrintUtil.toast(mContext, response.body().msg);
}
} else {
PrintUtil.i("添加游客身份失敗: response is unsuccessful");
}
}
@Override
public void onFailure(Call<SurferEntry> call, Throwable t) {
PrintUtil.i("添加游客身份失敗: " + t.getMessage());
}
});
}
/**
* CommonTestActivity.java
* 獲取文章列表
*/
private void doGetArticles() {
Call<RecommendEntry> call = mParser.doGetArticles(mParams);
call.enqueue(new Callback<RecommendEntry>() {
@Override
public void onResponse(Call<RecommendEntry> call, Response<RecommendEntry> response) {
if (response.isSuccessful()) {
if (response.body().code == 200) {
mListener.doEntryData(DATA_TYPE, response.body());
} else {
PrintUtil.toast(mContext, response.body().msg);
}
} else {
PrintUtil.i("獲取文章列表失敗: response is unsuccessful");
}
}
@Override
public void onFailure(Call<RecommendEntry> call, Throwable t) {
PrintUtil.i("獲取文章列表失敗: " + t.getMessage());
}
});
}
}
解釋一下各個變量：
Context mContext; 就是上下文，不多解釋；
Parser mParser; 就是上面定義的公共 interface ，用來獲取 Call ；
Map<String, String> mParams; 就是請求接口所需要的參數(shù)；
int DATA_TYPE; 這個參數(shù)是用來區(qū)分你是要做哪個操作的，比如說添加游客身份和獲取文章列表，要傳入一個用以區(qū)分的 tag 。
EntryDataListener mListener; 這個參數(shù)是用來回調接口返回的數(shù)據(jù)通過 Gson 解析后的實體類的，后面會給出定義。
public class ParserEntry {
//添加游客身份
public static final int SURFER_TYPE = 0;
//獲取文章列表
public static final int ARTICLE_TYPE = 1;
}
ParserEntry 類，這個類里定義了上面 EntryDataParser 類里 doParser() 方法里面的 switch() 里對應的 DATA_TYPE ，用以區(qū)分你要做什么操作。
public class ParserData {
private Context mContext;
private EntryDataParser parser;
public ParserData(Context mContext, EntryDataListener mListener) {
this.mContext = mContext;
this.parser = new EntryDataParser(mContext, mListener);
}
/**
* 添加游客身份
*/
public void doCreateSurfer() {
Map<String, String> params = new HashMap<>();
params.put("deviceId", DeviceUtil.doGetIMEI(mContext));
parser.doParser(ParserEntry.SURFER_TYPE, params);
}
/**
* 獲取文章列表
*/
public void doGetArticles() {
Map<String, String> params = new HashMap<>();
params.put("user", "surfer");
params.put("fromUid", ShareSaveUtil.doGetSurferId(mContext));
params.put("flag", "index2");
params.put("page", String.valueOf(1));
params.put("limit", ConstantUtil.COMMON_LIMIT);
parser.doParser(ParserEntry.ARTICLE_TYPE, params);
}
}
ParserData 類，用來實現(xiàn)具體接口的請求操作，里面添加需要的參數(shù)。
最后，在 Activity 里面調用，實現(xiàn)接口數(shù)據(jù)的獲取，然后填充界面。
public class CommonTestActivity extends Activity implements EntryDataListener {
private TextView show;
private ParserData data;
private SurferEntry surferEntry;
private RecommendEntry recommendEntry;
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_common_test);
init();
showView();
}
/**
* 初始化
*/
private void init() {
show = findViewById(R.id.text_show);
data = new ParserData(this, this);
surferEntry = new SurferEntry();
recommendEntry = new RecommendEntry();
}
/**
* 顯示UI
*/
private void showView() {
data.doCreateSurfer();//添加游客身份
}
/**
* 接收回調實體類
*
* @param DATA_TYPE 實體類類型
*/
@Override
public void doEntryData(int DATA_TYPE, Object mObject) {
switch (DATA_TYPE) {
case ParserEntry.SURFER_TYPE:
surferEntry = (SurferEntry) mObject;
data.doGetArticles();//獲取文章列表
break;
case ParserEntry.ARTICLE_TYPE:
recommendEntry = (RecommendEntry) mObject;
show.setText(surferEntry.toString() + "\n\n" + recommendEntry.toString());
break;
}
}
}
其中 SurferEntry 和 RecommendEntry 都是接口數(shù)據(jù)的實體類，大家看情況自行定義。到此，封裝使用完畢。
結束語
這個東西做出來之后自己內心還是有點小欣喜的，因為覺得耦合度降低了很多，Activity 層看上去也簡潔了很多。但是一開始用了靜態(tài)方法和靜態(tài)變量，經(jīng)大神指點后，知道了這樣做會很容易導致內存泄漏。所以改成了現(xiàn)在這樣，這應該是我寫代碼以來做的一件非常非常有成就感覺的事兒了，哈哈哈，自喜一下。
這里分享出來給大家，一是想方便大家使用 Retrofit ，二來也是希望大家看到之后，如果覺得哪兒還可以改進，能在評論區(qū)積極留言，多多指點，因為我也期待著進步嘛，嘿嘿。謝謝大家！
