從零開始搭建架構實施Android項目
我們先假設一個場景需求:剛有孩子的爸爸媽媽對用照片、視頻記錄寶寶成長有強烈的意愿,但苦于目前沒有一款專門的手機APP做這件事。A公司洞察到市場需求,要求開發團隊盡快完成Android客戶端的開發。以下模擬團隊和工作開展。
- 團隊情況:產品經理1人,Android開發2人,服務端開發2人,UI設計1人。
- 開發周期:兩個月。
- 工作量:大約50個界面。
- 隱含需求:考慮到用戶群體有可能激增的情況,服務端需要有一定的并發能力。
- 前提:原型已設計完成。
1 服務端概要設計
1.1 系統架構
先給出服務端的架構圖。
由于服務端開發有Java、PHP背景,為了快速完成開發任務,我們選擇PHP作為服務端開發語言,順便也把數據庫定為MySQL。考慮后期擴展和數據庫訪問性能,擬引入Redis非關系型數據庫。同時為了提高數據讀的性能,在云服務器和數據庫之間用上緩存,并為數據庫主從備份、讀寫分離。服務器就不搭建在本地了,管理是一大問題。現在云服務器一大把,七牛、阿里云、騰訊云、百度云、金山云等等,技術成熟,而且價格還算公道。在此我們選擇阿里云。為了應對可能面臨的并發問題,云服務器要考慮負載均衡。項目中可能存在大量的需要上傳和下載照片和視頻,我們選擇阿里云的開放存儲服務,同時為了提升各個地區的下載體驗,我們引入CDN。客戶端通過API Service和服務端交換數據,圖片和視頻的下載直接通過CDN。
1.2 模塊劃分
根據需求和原型設計,可能的模塊劃分如下:
- 注冊登錄模塊
- 用戶模塊
- 小孩模塊
- 媒體(圖片+視頻)模塊
- 相冊模塊
- ……
1.3 數據交換和API接口
服務端與客戶端使用JSON交換數據,使用自定義JSON格式,約定返回code、message,實體封裝在result中,支持單個實體、實體列表、多個實體列表,定義如下:
{
"code":500,
"message":"系統異常,請稍后重試",
"result":""
}
{
"code":200,
"message":"登錄成功",
"result":{
"user":{
"userId":1,
"nickName":"Leo",
"email":"Leo@xxx.com",
"gender":0
}
}
}
{
"code":200,
"message":"SUCCESS",
"result":{
"album":{
"kid":{
"kidId":1,
"nickName":"LEE",
"gender":1,
"birthday":"2014-3-6",
......
},
"media":{
"mediaId":123,
"mediaType":1,
"createdTime":193743546746,
"mediaDescription":"這是小孩第一次出去春游",
......
}
}
}
}
主要API接口設計如下:
http://api.xxx.com/service/v1.0/user/login http://api.xxx.com/service/v1.0/user/third-login http://api.xxx.com/service/v1.0/user/register http://api.xxx.com/service/v1.0/user/logout http://api.xxx.com/service/v1.0/user/info/update http://api.xxx.com/service/v1.0/album/upload http://api.xxx.com/service/v1.0/album/update http://api.xxx.com/service/v1.0/album/delete ......
也許你看到了,API做了二級域名映射,同時為了服務端后期API版本的升級管理,在URL中加上了版本標識V1.0。命名方面我盡量做到 restful 的風格。對了,此處沒有使用Https。為了解決數據傳輸的安全,我做了點特別的處理:對請求體和響應結果進行RSA加密(如果服務端返回的數據稍稍過大,這個RSA嚴重影響客戶端解密,后來我換成了AES),所有請求為POST請求,所以API URL后面沒有帶參數,你也看不到任何請求相關的信息。
1.4 數據庫設計
根據需求和原型設計,數據庫的設計大概需要兩周時間。其實一周基本搞定了,但為了考慮充分,留出一周時間來檢驗和調整。數據庫E-R圖略。
2 Android客戶端
2.1 基本結構
Android本身就是MVC,所以我不打算引入 MVP 或 MVVM 。我的理念是職責分層,快速推出Android 1.0。主要的包結構如下:
工程的搭建和包的劃分有各種各樣的,適合自己的就行了。想討論或想看別人怎么做的,點擊這里: App工程結構搭建:幾種常見Android代碼架構分析
2.2 功能劃分
注冊登錄,個人信息,我的小孩,相冊管理,消息通知,系統設置等等。
2.3 引入的第三方技術
重復發明輪子是不可取的。有些模塊根本沒必要自己寫。以下是引入的第三方庫,以及優勢說明。
2.3.1 網絡請求庫android-async-http
- 在匿名回調中處理請求結果
- 在UI線程外進行http請求
- 文件斷點上傳
- 智能重試
- 默認gzip壓縮
- 支持解析成Json格式
- 可將Cookies持久化到SharedPreferences
2.3.2 云巴推送
- 專注于為需要實時數據交換的產品提供完美解決方案
- 基于發布者/訂閱者(publisher/subscriber)模式,集成簡單
- 對比了百度云推送、騰訊信鴿推送,云巴效果更好
- 原極光推送CTO創辦的
2.3.3 xUtils(只使用其中的DbUtils和ViewUtils)
- Android中的ORM框架,一行代碼就可以進行增刪改查
- 支持事務,默認關閉
- 可通過注解自定義表名、列名、外鍵、唯一性約束、NOT NULL約束、CHECK約束等(需要混淆的時候請注解表名和列名)
- Android中的IOC框架,完全注解方式就可以進行UI,資源和事件綁定
- 新的事件綁定方式,使用混淆工具混淆后仍可正常工作
2.3.4 友盟統計
- 國內專業的移動應用統計分析平臺
- 統計和分析流量來源、內容使用、用戶屬性和行為數據
- Crash log跟蹤
2.3.5 云通訊驗證碼
- 解決方案成熟,眾多公司使用
2.3.6 高德地圖定位
- GPS+基站+wifi的混合定位方式
- 接入簡單
2.3.7 異步圖片加載庫Android-Universal-Image-Loader
- 多線程下載圖片,圖片可以來源于網絡,文件系統,項目文件夾assets中以及drawable中等
- 支持隨意的配置ImageLoader,例如線程池,圖片下載器,內存緩存策略,硬盤緩存策略,圖片顯示選項以及其他的一些配置
- 支持圖片的內存緩存,文件系統緩存或者SD卡緩存
- 支持圖片下載過程的監聽
- 根據控件(ImageView)的大小對Bitmap進行裁剪,減少Bitmap占用過多的內存
- 較好的控制圖片的加載過程,例如暫停圖片加載,重新開始加載圖片,一般使用在ListView,GridView中,滑動過程中暫停加載圖片,停止滑動的時候去加載圖片
- 提供在較慢的網絡下對圖片進行加載
2.3.8 阿里云OSS Android客戶端SDK
- 提供文件(圖片、視頻等等)上傳
- 大文件分塊上傳
- 刪除操作(不推薦在客戶端使用)
2.3.9 組件內通訊EventBus
- 基于發布者/訂閱者(publisher/subscriber)模式
- 簡化了應用程序內各組件間、組件與后臺線程間的通信
2.3.10 Android本地數據庫加密庫SQLCipher
- 基于SQLite擴展的開源數據庫,在SQLite的基礎之上增加了數據加密功能
- SQLCipher對Android SDK中所有與數據庫相關的API都制作了一份鏡像,使得開發者可以像操作普遍的數據庫文件一樣來操作SQLCipher
2.4 基礎組件封裝
2.4.1 基礎回調接口
public interface DataCallback {
void onSuccess(Object result);
void onFailure(Object result);
}</pre>
2.4.2 網絡訪問
先看一下登錄的序列圖:
HttpManager類負責調用AsyncHttpWrapper中的post方法,和對服務端返回的數據解密、JSON轉對象、回調上層;AsyncHttpWrapper則負責請求體的封裝加密和其它的校驗參數封裝。看一下HttpManager類的post方法:
public void post(Context context, String url, RequestParams params, final String modelName,
final DataCallback callback) {
AsyncHttpWrapper.post(context, url, params, new AsyncHttpResponseHandler() {
@Override
public void onSuccess(int statusCode, Header[] headers, byte[] responseBody) {
try {
if (modelName != null) {
handleResponse(responseBody, callback, modelName);
} else {
String response = new String(responseBody);
// 解密
response = AES128.getInstance().decrypt(AppUtil.decodeReplace(response));
// JSON轉對象
BaseMessage message = AppUtil.getMessage(response);
if (callback != null) {
// 如果自定義code是200
if (Coder.CODE_200.equals(message.getCode())) {
callback.onSuccess(message.getMessage());
} else {
callback.onFailure(new ServerError(message.getCode()));
}
}
}
} catch (JSONException e) {
LogUtil.e(e);
callback.onFailure("服務端返回的數據不能解析成JSON");
} catch (Exception e) {
LogUtil.e(e);
callback.onFailure(e);
}
}
@Override
public void onFailure(int statusCode, Header[] headers, byte[] responseBody, Throwable error) {
if (callback != null) {
callback.onFailure(error);
if (responseBody != null) {
String s = new String(responseBody);
LogUtil.e(s);
}
}
}
});
}</pre>
AsyncHttpWrapper中的post方法
public static void post(Context context, String url, RequestParams params, AsyncHttpResponseHandler responseHandler) {
// 設置請求頭部信息
generateHeader(context);
// 加密請求參數
String encryParams = AES128.getInstance().encrypt(params.toString());
RequestParams requestParams = new RequestParams();
requestParams.put("param", AppUtil.encodeReplace(encryParams));
client.post(context, url, requestParams, responseHandler);
}</pre>
private static AsyncHttpClient client = new AsyncHttpClient();
2.4.3 Adapter封裝
為了加快開發速度,重用代碼,Adapter的使用有技巧。每次在getView中查找控件id、利用ViewHolder、賦值,最后返回convertView,看著都是差不多的代碼。是時候脫離這個苦海了。先看怎么解決共用的ViewHolder問題。
public static <T extends View> T get(View view, int id) {
SparseArrayCompat<View> viewHolder = (SparseArrayCompat<View>) view.getTag();
if (viewHolder == null) {
viewHolder = new SparseArrayCompat<>();
view.setTag(viewHolder);
}
View childView = viewHolder.get(id);
if (childView == null) {
childView = view.findViewById(id);
viewHolder.put(id, childView);
}
return (T) childView;
}
ViewHolder的作用,就是通過convertView.setTag與convertView進行綁定。當convertView復用時,直接從與之對應的ViewHolder(getTag)中拿到convertView布局中的控件,省去了findViewById的時間。上面的代碼就是這樣的原理。
然后就是CommonAdapter了。
public abstract class CommonAdapter<T> extends BaseAdapter {
protected LayoutInflater inflater;
protected Context context;
protected List<T> datas;
protected final int itemLayoutId;
public CommonAdapter(Context context, List<T> datas, int itemLayoutId) {
this.context = context;
this.inflater = LayoutInflater.from(context);
this.datas = datas;
this.itemLayoutId = itemLayoutId;
}
@Override
public int getCount() {
return datas != null ? datas.size() : 0;
}
@Override
public T getItem(int position) {
return datas.get(position);
}
@Override
public long getItemId(int position) {
return position;
}
@Override
public View getView(int position, View convertView, ViewGroup parent) {
final CommonViewHolder viewHolder = getViewHolder(position, convertView, parent);
convert(viewHolder, getItem(position), position);
return viewHolder.getConvertView();
}
public abstract void convert(CommonViewHolder viewHolder, T item, int position);
}</pre>
好了,不貼代碼了。看不明白了請點擊這里: Android 快速開發系列 打造萬能的ListView GridView 適配器
2.4.5 其它Utils封裝
如AES128加密類、BitmapUtils、SecurePreferences、StringUtil、ToastUtil、IOUtil等等。
2.5 接口測試
為了保證數據交換、加解密正常,首先對某一個接口進行測試,以驗證API Service能正常跑通。比如可以先對登錄進行模擬測試,看是否成功,同時包括異常的測試,服務端是不是處理了邊界異常,返回給客戶端的都是封裝過的異常信息,而不是拋一個敏感信息給客戶端。提前進行接口測試有助于我們的基礎組件運行沒問題,方便后期其它模塊的快速集成。
2.6 快速開發
基礎組件封裝好后,除了少量的從網絡獲取數據邏輯和本地數據庫的增刪改查,客戶端基本上就是界面的布局工作了。界面開發基本看熟練程度和自定義View的重用。
好了,基本就這些。兩個Android開發人員兩個月內完成肯定是可以的,前提是至少有一個熟手。后面再談談 MVP ,畢竟這個客戶端設計沒法進行單元測試,如果業務邏輯越來越復雜,Activity的職責會越來越重,問題多多,不利于后期維護。