編輯：關於Android編程
項目搭建
根據架構篇所講的，將項目分為了四個層級：模型層、接口層、核心層、界面層。四個層級之間的關系如下圖所示：
實現上，在Android Studio分為了相應的四個模塊(Module)：model、api、core、app。
model為模型層，api為接口層，core為核心層，app為界面層。
model、api、core這三個模塊的類型為library，app模塊的類型為application。
四個模塊之間的依賴設置為：model沒有任何依賴，接口層依賴了模型層，核心層依賴了模型層和接口層，界面層依賴了核心層和模型層。
項目搭建的步驟如下：
創建新項目，項目名稱為KAndroid，包名為com.keegan.kandroid。默認已創建了app模塊，查看下app模塊下的build.gradle，會看到第一行為：
apply plugin: 'com.android.application'
這行表明了app模塊是application類型的。
分別新建模塊model、api、core，Module Type都選為Android Library，在Add an activity to module頁面選擇Add No Activity，這三個模塊做為庫使用，並不需要界面。創建完之後，查看相應模塊的build.gradle，會看到第一行為：
apply plugin: 'com.android.library'
建立模塊之間的依賴關系。有兩種方法可以設置：
第一種：通過右鍵模塊，然後Open Module Settings，選擇模塊的Dependencies，點擊左下方的加號，選擇Module dependency，最後選擇要依賴的模塊，下圖為api模塊添加了model依賴；
第二種：直接在模塊的build.gradle設置。打開build.gradle，在最後的dependencies一項裡面添加新的一行：compile project(':ModuleName')，比如app模塊添加對model模塊和core模塊依賴之後的dependencies如下：
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'com.android.support:appcompat-v7:22.0.0'
compile project(':model')
compile project(':core')
}
通過上面兩種方式的任意一種，創建了模塊之間的依賴關系之後，每個模塊的build.gradle的dependencies項的結果將會如下：
model:
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'com.android.support:appcompat-v7:22.0.0'
}
api:
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'com.android.support:appcompat-v7:22.0.0'
compile project(':model')
}
core:
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'com.android.support:appcompat-v7:22.0.0'
compile project(':model')
compile project(':api')
}
app:
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'com.android.support:appcompat-v7:22.0.0'
compile project(':model')
compile project(':core')
}
創建業務對象模型
業務對象模型統一存放於model模塊，是對業務數據的封裝，大部分都是從接口傳過來的對象，因此，其屬性也與接口傳回的對象屬性相一致。在這個Demo裡，只有一個業務對象模型，封裝了券的基本信息，以下是該實體類的代碼：
/**
* 券的業務模型類，封裝了券的基本信息。
* 券分為了三種類型：現金券、抵扣券、折扣券。
* 現金券是擁有固定面值的券，有固定的售價；
* 抵扣券是滿足一定金額後可以抵扣的券，比如滿100減10元；
* 折扣券是可以打折的券。
*
* @version 1.0 創建時間：15/6/21
*/
public class CouponBO implements Serializable {
private static final long serialVersionUID = -8022957276104379230L;
private int id; // 券id
private String name; // 券名稱
private String introduce; // 券簡介
private int modelType; // 券類型，1為現金券，2為抵扣券，3為折扣券
private double faceValue; // 現金券的面值
private double estimateAmount; // 現金券的售價
private double debitAmount; // 抵扣券的抵扣金額
private double discount; // 折扣券的折扣率（0-100）
private double miniAmount; // 抵扣券和折扣券的最小使用金額
// TODO 所有屬性的getter和setter
}
接口層的封裝
在這個Demo裡，提供了4個接口：一個發送驗證碼的接口、一個注冊接口、一個登錄接口、一個獲取券列表的接口。這4個接口具體如下：
發送驗證碼接口
URL：http://uat.b.quancome.com/platform/api
參數：
輸出樣例：
{ "event": "0", "msg": "success" }
注冊接口
URL：http://uat.b.quancome.com/platform/api
參數：
輸出樣例：
{ "event": "0", "msg": "success" }
登錄接口
URL：http://uat.b.quancome.com/platform/api
其他參數：
輸出樣例：
{ "event": "0", "msg": "success" }
券列表
URL：http://uat.b.quancome.com/platform/api
其他參數：
輸出樣例：
{ "event": "0", "msg": "success", "maxCount": 125, "maxPage": 7, "currentPage": 1, "pageSize": 20, "objList":[
{"id": 1, "name": "測試現金券", "modelType": 1, ...},
{...},
...
]}
在架構篇已經講過，接口返回的json數據有三種固定結構：
{"event": "0", "msg": "success"}
{"event": "0", "msg": "success", "obj":{...}}
{"event": "0", "msg": "success", "objList":[{...}, {...}], "currentPage": 1, "pageSize": 20, "maxCount": 2, "maxPage": 1}
因此可以封裝成實體類，代碼如下：
public class ApiResponse{ private String event; // 返回碼，0為成功 private String msg; // 返回信息 private T obj; // 單個對象 private T objList; // 數組對象 private int currentPage; // 當前頁數 private int pageSize; // 每頁顯示數量 private int maxCount; // 總條數 private int maxPage; // 總頁數 // 構造函數，初始化code和msg public ApiResponse(String event, String msg) { this.event = event; this.msg = msg; } // 判斷結果是否成功 public boolean isSuccess() { return event.equals("0"); } // TODO 所有屬性的getter和setter }
上面4個接口，URL和appKey都是一樣的，用來區別不同接口的則是method字段，因此，URL和appKey可以統一定義，method則根據不同接口定義不同常量。而除去appKey和method，剩下的參數才是每個接口需要定義的參數。因此，對上面4個接口的定義如下：
public interface Api {
// 發送驗證碼
public final static String SEND_SMS_CODE = "service.sendSmsCode4Register";
// 注冊
public final static String REGISTER = "customer.registerByPhone";
// 登錄
public final static String LOGIN = "customer.loginByApp";
// 券列表
public final static String LIST_COUPON = "issue.listNewCoupon";
/**
* 發送驗證碼
*
* @param phoneNum 手機號碼
* @return 成功時返回：{ "event": "0", "msg":"success" }
*/
public ApiResponse sendSmsCode4Register(String phoneNum);
/**
* 注冊
*
* @param phoneNum 手機號碼
* @param code 驗證碼
* @param password MD5加密的密碼
* @return 成功時返回：{ "event": "0", "msg":"success" }
*/
public ApiResponse registerByPhone(String phoneNum, String code, String password);
/**
* 登錄
*
* @param loginName 登錄名（手機號）
* @param password MD5加密的密碼
* @param imei 手機IMEI串號
* @param loginOS Android為1
* @return 成功時返回：{ "event": "0", "msg":"success" }
*/
public ApiResponse loginByApp(String loginName, String password, String imei, int loginOS);
/**
* 券列表
*
* @param currentPage 當前頁數
* @param pageSize 每頁顯示數量
* @return 成功時返回：{ "event": "0", "msg":"success", "objList":[...] }
*/
public ApiResponse> listNewCoupon(int currentPage, int pageSize);
}
Api的實現類則是ApiImpl了，實現類需要封裝好請求數據並向服務器發起請求，並將響應結果的數據轉為ApiResonse返回。而向服務器發送請求並將響應結果返回的處理則封裝到http引擎類去處理。另外，這裡引用了gson將json轉為對象。ApiImpl的實現代碼如下：
public class ApiImpl implements Api {
private final static String APP_KEY = "ANDROID_KCOUPON";
private final static String TIME_OUT_EVENT = "CONNECT_TIME_OUT";
private final static String TIME_OUT_EVENT_MSG = "連接服務器失敗";
// http引擎
private HttpEngine httpEngine;
public ApiImpl() {
httpEngine = HttpEngine.getInstance();
}
@Override
public ApiResponse sendSmsCode4Register(String phoneNum) {
Map paramMap = new HashMap();
paramMap.put("appKey", APP_KEY);
paramMap.put("method", SEND_SMS_CODE);
paramMap.put("phoneNum", phoneNum);
Type type = new TypeToken>(){}.getType();
try {
return httpEngine.postHandle(paramMap, type);
} catch (IOException e) {
return new ApiResponse(TIME_OUT_EVENT, TIME_OUT_EVENT_MSG);
}
}
@Override
public ApiResponse registerByPhone(String phoneNum, String code, String password) {
Map paramMap = new HashMap();
paramMap.put("appKey", APP_KEY);
paramMap.put("method", REGISTER);
paramMap.put("phoneNum", phoneNum);
paramMap.put("code", code);
paramMap.put("password", EncryptUtil.makeMD5(password));
Type type = new TypeToken>>(){}.getType();
try {
return httpEngine.postHandle(paramMap, type);
} catch (IOException e) {
return new ApiResponse(TIME_OUT_EVENT, TIME_OUT_EVENT_MSG);
}
}
@Override
public ApiResponse loginByApp(String loginName, String password, String imei, int loginOS) {
Map paramMap = new HashMap();
paramMap.put("appKey", APP_KEY);
paramMap.put("method", LOGIN);
paramMap.put("loginName", loginName);
paramMap.put("password", EncryptUtil.makeMD5(password));
paramMap.put("imei", imei);
paramMap.put("loginOS", String.valueOf(loginOS));
Type type = new TypeToken>>(){}.getType();
try {
return httpEngine.postHandle(paramMap, type);
} catch (IOException e) {
return new ApiResponse(TIME_OUT_EVENT, TIME_OUT_EVENT_MSG);
}
}
@Override
public ApiResponse> listNewCoupon(int currentPage, int pageSize) {
Map paramMap = new HashMap();
paramMap.put("appKey", APP_KEY);
paramMap.put("method", LIST_COUPON);
paramMap.put("currentPage", String.valueOf(currentPage));
paramMap.put("pageSize", String.valueOf(pageSize));
Type type = new TypeToken>>(){}.getType();
try {
return httpEngine.postHandle(paramMap, type);
} catch (IOException e) {
return new ApiResponse(TIME_OUT_EVENT, TIME_OUT_EVENT_MSG);
}
}
}
而http引擎類的實現如下：
public class HttpEngine {
private final static String SERVER_URL = "http://uat.b.quancome.com/platform/api";
private final static String REQUEST_MOTHOD = "POST";
private final static String ENCODE_TYPE = "UTF-8";
private final static int TIME_OUT = 15000;
private static HttpEngine instance = null;
private HttpEngine() {
}
public static HttpEngine getInstance() {
if (instance == null) {
instance = new HttpEngine();
}
return instance;
}
public T postHandle(Map paramsMap, Type typeOfT) throws IOException {
String data = joinParams(paramsMap);
HttpUrlConnection connection = getConnection();
connection.setRequestProperty("Content-Length", String.valueOf(data.getBytes().length));
connection.connect();
OutputStream os = connection.getOutputStream();
os.write(data.getBytes());
os.flush();
if (connection.getResponseCode() == 200) {
// 獲取響應的輸入流對象
InputStream is = connection.getInputStream();
// 創建字節輸出流對象
ByteArrayOutputStream baos = new ByteArrayOutputStream();
// 定義讀取的長度
int len = 0;
// 定義緩沖區
byte buffer[] = new byte[1024];
// 按照緩沖區的大小，循環讀取
while ((len = is.read(buffer)) != -1) {
// 根據讀取的長度寫入到os對象中
baos.write(buffer, 0, len);
}
// 釋放資源
is.close();
baos.close();
connection.disconnect();
// 返回字符串
final String result = new String(baos.toByteArray());
Gson gson = new Gson();
return gson.fromJson(result, typeOfT);
} else {
connection.disconnect();
return null;
}
}
private HttpURLConnection getConnection() {
HttpURLConnection connection = null;
// 初始化connection
try {
// 根據地址創建URL對象
URL url = new URL(SERVER_URL);
// 根據URL對象打開鏈接
connection = (HttpURLConnection) url.openConnection();
// 設置請求的方式
connection.setRequestMethod(REQUEST_MOTHOD);
// 發送POST請求必須設置允許輸入，默認為true
connection.setDoInput(true);
// 發送POST請求必須設置允許輸出
connection.setDoOutput(true);
// 設置不使用緩存
connection.setUseCaches(false);
// 設置請求的超時時間
connection.setReadTimeout(TIME_OUT);
connection.setConnectTimeout(TIME_OUT);
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
connection.setRequestProperty("Connection", "keep-alive");
connection.setRequestProperty("Response-Type", "json");
connection.setChunkedStreamingMode(0);
} catch (IOException e) {
e.printStackTrace();
}
return connection;
}
private String joinParams(Map paramsMap) {
StringBuilder stringBuilder = new StringBuilder();
for (String key : paramsMap.keySet()) {
stringBuilder.append(key);
stringBuilder.append("=");
try {
stringBuilder.append(URLEncoder.encode(paramsMap.get(key), ENCODE_TYPE));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
stringBuilder.append("&");
}
return stringBuilder.substring(0, stringBuilder.length() - 1);
}
}
至此，接口層的封裝就完成了。接下來再往上看看核心層吧。
核心層的邏輯
核心層處於接口層和界面層之間，向下調用Api，向上提供Action，它的核心任務就是處理復雜的業務邏輯。先看看我對Action的定義：
public interface AppAction {
// 發送手機驗證碼
public void sendSmsCode(String phoneNum, ActionCallbackListener listener);
// 注冊
public void register(String phoneNum, String code, String password, ActionCallbackListener listener);
// 登錄
public void login(String loginName, String password, ActionCallbackListener listener);
// 按分頁獲取券列表
public void listCoupon(int currentPage, ActionCallbackListener> listener);
}
首先，和Api接口對比就會發現，參數並不一致。登錄並沒有iemi和loginOS的參數，獲取券列表的參數裡也少了pageSize。這是因為，這幾個參數，跟界面其實並沒有直接關系。Action只要定義好跟界面相關的就可以了，其他需要的參數，在具體實現時再去獲取。
另外，大部分action的處理都是異步的，因此，添加了回調監聽器ActionCallbackListener，回調監聽器的泛型則是返回的對象數據類型，例如獲取券列表，返回的數據類型就是List，沒有對象數據時則為Void。回調監聽器只定義了成功和失敗的方法，如下：
