Android專案架構搭建

天才少年_發表於2019-11-23

1.前言:

安卓屬於小團隊開發,架構的重要性在很多公司其實不是那麼的明顯,加上現在的開源框架層出不窮,更好的幫助我們上手android專案的開發。我前兩年也在公司主導過專案開發,搭建過不少專案,以前主要的傾向是MVC,導致了activity/fragment過大,而且很多公共功能雜亂在專案中,後期維護起來不方便,最近剛好有時間,重新搭建了一個新的框架。(ps:有建議或者更好想法的可以留言。)

2.用到的知識點:

UI----物件導向
資料互動----MVP模式
資料庫------GreenDao
網路圖片載入-----picasso
json解析-----gson
http請求----OKHttp
事件匯流排----eventbus


以上知識點不熟悉的,可以先熟悉下基本知識,如果已經瞭解過,可以直接跳過下面的連結,直接看下文的使用。 MVP模式 講解地址:blog.csdn.net/dfskhgalshg…
GreenDao 講解地址:blog.csdn.net/dfskhgalshg…
picasso 講解地址:blog.csdn.net/dfskhgalshg…
OKHttp 講解地址:鴻神的部落格講解地址: blog.csdn.net/lmj62356579…
eventbus 講解地址:blog.csdn.net/dfskhgalshg…


3.框架整體結構:

這裡寫圖片描述

4.專案目錄結構:

這裡寫圖片描述

bean---------------------------------------------------存放java model物件
biz-----------------------------------------------------業務模組,根據不能業務建立子模組
bridge-------------------------------------------------底層功能實現跟UI層的銜接層
capabilities--------------------------------------------底層功能具體實現(後期專案迭代到一定程度穩定後會考慮以jar形式匯入)
constant-----------------------------------------------常量
ui------------------------------------------------------介面,根據不同業務建立子模組
util-----------------------------------------------------業務層公共方法
view---------------------------------------------------自定義view實現

5.具體解析

還是按照大家的習慣思維,從介面--->資料---->網路----->互動,這樣的層次講解。

1)UI層

UI層其實比較簡單,主要就是用到物件導向的封裝,BaseActivity為基類,同時BaseActivity實現三個介面,分別為CreateInit, PublishActivityCallBack, PresentationLayerFunc,這三個介面的作用依次是:介面初始化,頁面跳轉封裝,頁面互動封裝。PresentationLayerFunc的具體實現是在PresentationLayerFuncHelper裡面,BaseActivity類會初始化該類,把複雜的功能實現抽象出去,輕量化基類。

這裡寫圖片描述

BaseActivity程式碼如下所示:

/**
 * <基礎activity>
 *
 * @author caoyinfei
 * @version [版本號, 2014-3-24]
 * @see [相關類/方法]
 * @since [V1]
 */
public abstract class BaseActivity extends Activity implements CreateInit, PublishActivityCallBack, PresentationLayerFunc, IMvpView, OnClickListener {

    private PresentationLayerFuncHelper presentationLayerFuncHelper;

    /**
     * 返回按鈕
     */
    private LinearLayout back;

    /**
     * 標題,右邊字元
     */
    protected TextView title, right;

    public BasePresenter presenter;

    public final String TAG = this.getClass().getSimpleName();

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        presentationLayerFuncHelper = new PresentationLayerFuncHelper(this);

        initViews();
        initListeners();
        initData();
        setHeader();
        EBApplication.ebApplication.addActivity(this);
        EventBus.getDefault().register(this);
    }

    @Override
    public void setHeader() {
        back = (LinearLayout) findViewById(R.id.ll_back);
        title = (TextView) findViewById(R.id.tv_title);
        right = (TextView) findViewById(R.id.tv_right);
        back.setOnClickListener(this);
    }

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.ll_back:
                finish();
                break;
        }
    }

    public void onEventMainThread(Event event) {

    }

    @Override
    protected void onResume() {
        EBApplication.ebApplication.currentActivityName = this.getClass().getName();
        super.onResume();
    }

    @Override
    public void startActivity(Class<?> openClass, Bundle bundle) {
        Intent intent = new Intent(this, openClass);
        if (null != bundle)
            intent.putExtras(bundle);
        startActivity(intent);
    }

    @Override
    public void openActivityForResult(Class<?> openClass, int requestCode, Bundle bundle) {
        Intent intent = new Intent(this, openClass);
        if (null != bundle)
            intent.putExtras(bundle);
        startActivityForResult(intent, requestCode);
    }

    @Override
    public void setResultOk(Bundle bundle) {
        Intent intent = new Intent();
        if (bundle != null) ;
        intent.putExtras(bundle);
        setResult(RESULT_OK, intent);
        finish();
    }

    @Override
    public void showToast(String msg) {
        presentationLayerFuncHelper.showToast(msg);
    }

    @Override
    public void showProgressDialog() {
        presentationLayerFuncHelper.showProgressDialog();
    }

    @Override
    public void hideProgressDialog() {
        presentationLayerFuncHelper.hideProgressDialog();
    }

    @Override
    public void showSoftKeyboard(View focusView) {
        presentationLayerFuncHelper.showSoftKeyboard(focusView);
    }

    @Override
    public void hideSoftKeyboard() {
        presentationLayerFuncHelper.hideSoftKeyboard();
    }

    @Override
    protected void onDestroy() {
        EBApplication.ebApplication.deleteActivity(this);
        EventBus.getDefault().unregister(this);
        if (presenter != null) {
            presenter.detachView(this);
        }
        OkHttpManager httpManager = BridgeFactory.getBridge(Bridges.HTTP);
        httpManager.cancelActivityRequest(TAG);
        super.onDestroy();
    }

}
複製程式碼

PresentationLayerFuncHelper程式碼如下所示:

/**
 * <頁面基礎公共功能實現>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public class PresentationLayerFuncHelper implements PresentationLayerFunc {

    private Context context;

    public PresentationLayerFuncHelper(Context context) {
        this.context = context;
    }

    @Override
    public void showToast(String msg) {
        ToastUtil.makeText(context, msg);
    }

    @Override
    public void showProgressDialog() {

    }

    @Override
    public void hideProgressDialog() {

    }

    @Override
    public void showSoftKeyboard(View focusView) {

    }

    @Override
    public void hideSoftKeyboard() {

    }
}

複製程式碼

三個介面,分別為CreateInit, PublishActivityCallBack, PresentationLayerFunc程式碼如下所示:


/**
 * <公共方法抽象>
 *
 * @author caoyinfei
 * @version [版本號, 2014-3-24]
 * @see [相關類/方法]
 * @since [V1]
 */
public interface CreateInit {
    /**
     * 初始化佈局元件
     */
    public void initViews();

    /**
     * 增加按鈕點選事件
     */
    void initListeners();

    /**
     * 初始化資料
     */
    public void initData();

    /**
     * 初始化公共頭部
     */
    public void setHeader();
}

複製程式碼
/**
 * <頁面跳轉封裝>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public interface PublishActivityCallBack {
    /**
     * 開啟新介面
     *
     * @param openClass 新開頁面
     * @param bundle    引數
     */
    public void startActivity(Class<?> openClass, Bundle bundle);

    /**
     * 開啟新介面,期待返回
     *
     * @param openClass 新介面
     * @param requestCode 請求碼
     * @param bundle 引數
     */
    public void openActivityForResult(Class<?> openClass, int requestCode, Bundle bundle);

    /**
     * 返回到上個頁面
     *
     * @param bundle 引數
     */
    public void setResultOk(Bundle bundle);
}

複製程式碼
/**
 * <頁面基礎公共功能抽象>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public interface PresentationLayerFunc {
    /**
     * 彈出訊息
     *
     * @param msg
     */
    public void showToast(String msg);

    /**
     * 網路請求載入框
     */
    public void showProgressDialog();

    /**
     * 隱藏網路請求載入框
     */
    public void hideProgressDialog();

    /**
     * 顯示軟鍵盤
     *
     * @param focusView
     */
    public void showSoftKeyboard(View focusView);

    /**
     * 隱藏軟鍵盤
     */
    public void hideSoftKeyboard();
}

複製程式碼

對於上層開發而言,工作就比較簡單了,比如登入介面(LoginActivity),只要繼承BaseActivity則可以了,然後用IDE工具,自動匯入必要的override方法。 程式碼如下:

public class LoginActivity extends BaseActivity implements IUserLoginView {

    /**
     * 使用者名稱
     */
    private EditText userName;

    /**
     * 使用者密碼
     */
    private EditText password;

    /**
     * 登入
     */
    private Button login;

    private LoginPresenter mUserLoginPresenter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        setContentView(R.layout.activity_main);
        super.onCreate(savedInstanceState);

        presenter = mUserLoginPresenter = new LoginPresenter();
        mUserLoginPresenter.attachView(this);
    }

    @Override
    public void initViews() {
        userName = (EditText) findViewById(R.id.username);
        password = (EditText) findViewById(R.id.passowrd);
        login = (Button) findViewById(R.id.login);
    }

    @Override
    public void initListeners() {
        login.setOnClickListener(this);
    }

    @Override
    public void initData() {

    }

    @Override
    public void setHeader() {
        super.setHeader();
        title.setText("登入");
    }

    @Override
    public void onEventMainThread(Event event) {
        super.onEventMainThread(event);
        switch (event){
            case IMAGE_LOADER_SUCCESS:
                clearEditContent();
                break;
        }
    }

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.login:
                //13914786934   123456  可以登入
                mUserLoginPresenter.login(userName.getText().toString(), password.getText().toString());
                break;
        }
        super.onClick(v);
    }

    @Override
    public void clearEditContent() {
        userName.setText("");
        password.setText("");
    }

    @Override
    public void onError(String errorMsg, String code) {
        showToast(errorMsg);
    }

    @Override
    public void onSuccess() {
        startActivity(HomeActivity.class,null);
    }

    @Override
    public void showLoading() {

    }

    @Override
    public void hideLoading() {

    }
}

複製程式碼

大家應該看得出,acitivty裡面全是介面,開發gg只要把想應實現填到對應的介面中即可,這樣實現的好處有幾個: 1.每個頁面都是這種統一的格式,後期人員流動後維護方便。 2.公共處理,比如title欄,每個頁面都有,各個頁面去單獨實現,程式碼冗餘,這邊抽到BaseActivity 裡面setHeader()方法去統一處理,當時各個子類也可以自定義特殊格式,比如title欄上面的titleName的不同。 3.公共方法抽象,避免每個activity重複大量程式碼。

2)資料互動層 可能有人會看到上面的程式碼中有MVP的程式碼,會看不太懂?別急,接下來講解MVP的作用。 之前activity層既做介面,又做業務邏輯,程式碼量特別大,動不動幾百上千行,之前專案上線的時候,領導讓我混淆一下,我當時說,這種程式碼,過幾個月我們自己都看不懂了,還需要混淆嗎?哈哈~~當然是開玩笑。 言歸正傳,我們這邊用MVP代替了MVC,從上面activity可以看出,activity只做兩件事:1、view的建立。2、使用者互動。那業務邏輯我們放在哪裡呢?這裡我們引入Presenter層,用來專門處理業務邏輯,並通過IMvpView介面實現跟activity的互動(mvp具體講解,前面已經很詳細的介紹過,地址:blog.csdn.net/dfskhgalshg…

程式碼如下: 上面我們說過,Presenter與View互動是通過介面。所以我們這裡需要定義一個IUserLoginView ,難點就在於應該有哪些方法,我們這個是登入頁面,其實有哪些功能,就應該有哪些方法,比如登入成功,失敗,彈出載入框這些都要通知ui(Activity)去更新。所以定義瞭如下方法:

/**
 * <功能詳細描述>
 *
 * @author caoyinfei
 * @version [版本號, 2016/5/4]
 * @see [相關類/方法]
 * @since [V1]
 */
public interface IMvpView {
    void onError(String errorMsg, String code);

    void onSuccess();

    void showLoading();

    void hideLoading();
}
複製程式碼
/**
 * <功能詳細描述>
 *
 * @author caoyinfei
 * @version [版本號, 2016/5/4]
 * @see [相關類/方法]
 * @since [產品/模組版本]
 */
public interface IUserLoginView extends IMvpView {
    void clearEditContent();
}
複製程式碼

LoginPresenter 為登入的業務實現類,他需要做兩件事:1、業務處理。2.通知頁面資料重新整理。業務處理很簡單,這邊不做介紹了。Presenter與頁面互動是通過介面實現的,這邊通過繼承基類BasePresenter,從而實現介面attachView(V view),這邊的view是個泛型,在這裡,他其實是IUserLoginView,LoginActivity會實現這個介面,在初始化LoginPresenter 的時候,會把自身傳過來mUserLoginPresenter.attachView(this);-----這段程式碼是在LoginActivity的onCreate中,這樣 Presenter通知頁面重新整理就只要通過介面就可以了。

/**
 * <基礎業務類>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public interface Presenter<V> {
    void attachView(V view);

    void detachView(V view);
}

複製程式碼
/**
 * <基礎業務類>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public abstract class BasePresenter<V extends IMvpView> implements Presenter<V> {
    protected V mvpView;

    public void attachView(V view) {
        mvpView = view;
    }

    @Override
    public void detachView(V view) {
        mvpView = null;
    }
}

複製程式碼
/**
 * <功能詳細描述>
 *
 * @author caoyinfei
 * @version [版本號, 2016/5/4]
 * @see [相關類/方法]
 * @since [產品/模組版本]
 */
public class LoginPresenter extends BasePresenter<IUserLoginView> {

    public LoginPresenter() {

    }

    public void login(String useName, String password) {
        //網路層
        mvpView.showLoading();
        SecurityManager securityManager = BridgeFactory.getBridge(Bridges.SECURITY);
        OkHttpManager httpManager = BridgeFactory.getBridge(Bridges.HTTP);

        httpManager.requestAsyncPostByTag(URLUtil.USER_LOGIN, getName(), new ITRequestResult<LoginResp>() {
                    @Override
                    public void onCompleted() {
                        mvpView.hideLoading();
                    }

                    @Override
                    public void onSuccessful(LoginResp entity) {
                        mvpView.onSuccess();
                        EBSharedPrefManager manager = BridgeFactory.getBridge(Bridges.SHARED_PREFERENCE);
                        manager.getKDPreferenceUserInfo().saveString(EBSharedPrefUser.USER_NAME, "abc");
                    }

                    @Override
                    public void onFailure(String errorMsg) {
                        mvpView.onError(errorMsg, "");
                    }

                }, LoginResp.class, new Param("username", useName),
                new Param("pas", securityManager.get32MD5Str(password)));
    }
}
複製程式碼
public class LoginActivity extends BaseActivity implements IUserLoginView {

    /**
     * 使用者名稱
     */
    private EditText userName;

    /**
     * 使用者密碼
     */
    private EditText password;

    /**
     * 登入
     */
    private Button login;

    private LoginPresenter mUserLoginPresenter;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        setContentView(R.layout.activity_main);
        super.onCreate(savedInstanceState);

        presenter = mUserLoginPresenter = new LoginPresenter();
        mUserLoginPresenter.attachView(this);
    }

    @Override
    public void initViews() {
        userName = (EditText) findViewById(R.id.username);
        password = (EditText) findViewById(R.id.passowrd);
        login = (Button) findViewById(R.id.login);
    }

    @Override
    public void initListeners() {
        login.setOnClickListener(this);
    }

    @Override
    public void initData() {

    }

    @Override
    public void setHeader() {
        super.setHeader();
        title.setText("登入");
    }

    @Override
    public void onEventMainThread(Event event) {
        super.onEventMainThread(event);
        switch (event){
            case IMAGE_LOADER_SUCCESS:
                clearEditContent();
                break;
        }
    }

    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.login:
                //13914786934   123456  可以登入
                mUserLoginPresenter.login(userName.getText().toString(), password.getText().toString());
                break;
        }
        super.onClick(v);
    }

    @Override
    public void clearEditContent() {
        userName.setText("");
        password.setText("");
    }

    @Override
    public void onError(String errorMsg, String code) {
        showToast(errorMsg);
    }

    @Override
    public void onSuccess() {
        startActivity(HomeActivity.class,null);
    }

    @Override
    public void showLoading() {

    }

    @Override
    public void hideLoading() {

    }
}
複製程式碼

3)網路層 網路由於google在6.0後不再使用httpclient,之前專案中通過httpclient實現了網路通訊,現在跟隨google,換成OKHttp框架。這個框架的講解不再介紹了,比較簡單,我貼一個鴻神的部落格講解地址: blog.csdn.net/lmj62356579… 我這邊做的事情是,對OKHttp再做了一層封裝,更方便我們使用。

/**
 * <http公共解析庫>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public class OkHttpUtil {

    Handler handler = new Handler() {

    };

    private final String TAG = OkHttpUtil.class.getSimpleName();

    private static OkHttpUtil manager;

    private OkHttpClient mOkHttpClient;

    public final int TIMEOUT = 20;

    public final int WRITE_TIMEOUT = 20;

    public final int READ_TIMEOUT = 20;

    /**
     * 請求url集合
     */
    private HashMap<String, Set<String>> requestMap;

    public OkHttpUtil() {
        requestMap = new HashMap<String, Set<String>>();
        mOkHttpClient = new OkHttpClient();

        mOkHttpClient.setConnectTimeout(TIMEOUT, TimeUnit.SECONDS);
        mOkHttpClient.setWriteTimeout(WRITE_TIMEOUT, TimeUnit.SECONDS);
        mOkHttpClient.setReadTimeout(READ_TIMEOUT, TimeUnit.SECONDS);
    }

    public static OkHttpUtil getInstance() {
        if (manager == null) {
            synchronized (OkHttpUtil.class) {
                if (manager == null) {
                    return new OkHttpUtil();
                }
            }
        }
        return manager;
    }
    /*********************************************************** get請求*********************************************************/

    /**
     * 非同步Get請求 具體實現
     *
     * @param url             請求url
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncGetEnqueue(String url, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        String constructUrl = constructUrl(url, params);
        Request request = new Request.Builder()
                .get()
                .url(constructUrl)
                .build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz));
    }

    /**
     * 非同步Get請求 具體實現(可取消)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncGetEnqueueByTag(String url, String activityName, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        addRequestUrl(activityName, url);
        String constructUrl = constructUrl(url, params);
        Request request = new Request.Builder()
                .get()
                .url(constructUrl)
                .tag(url)
                .build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz, activityName));
    }

    /**
     * 構造get請求的url
     *
     * @param url    不帶引數的url
     * @param params 引數
     * @return 帶引數的url
     */
    private String constructUrl(String url, Param... params) {
        StringBuilder sb = new StringBuilder();
        sb.append(url);
        if (params.length != 0) {
            sb.append("?");
        } else {
            return sb.toString();
        }

        for (Param param :
                params) {
            sb.append(param.key + "=" + param.value + "&");
        }
        return sb.toString().substring(0, sb.length() - 1);
    }

    /*********************************************************** post請求*********************************************************/
    /**
     * 非同步POST請求  具體實現
     *
     * @param url             請求url
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncPost(String url, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        FormEncodingBuilder builder = new FormEncodingBuilder();
        for (Param param :
                params) {
            builder.add(param.key, param.value);
        }
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz));
    }

    /**
     * 非同步POST請求  具體實現(可取消)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        addRequestUrl(activityName, url);
        FormEncodingBuilder builder = new FormEncodingBuilder();
        for (Param param :
                params) {
            builder.add(param.key, param.value);
        }
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).tag(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz, activityName));
    }


    /**
     * 非同步DELETE請求  具體實現
     *
     * @param url             請求url
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncDelete(String url, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        String finalUrl = constructUrl(url, params);
        Request request = new Request.Builder()
                .delete()
                .url(finalUrl)
                .build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz));
    }
    /*********************************************************** 檔案請求*********************************************************/
    /**
     * 非同步POST請求 單檔案上傳
     *
     * @param url             請求url
     * @param file            待上傳的檔案
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPost(String url, File file, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);
        for (Param param :
                params) {
            builder.addFormDataPart(param.key, param.value);
        }
        builder = constructMultipartBuilder(builder, file, key);
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz));
    }

    /**
     * 非同步POST請求 單檔案上傳(可取消)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param file            待上傳的檔案
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, File file, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        addRequestUrl(activityName, url);
        MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);
        for (Param param :
                params) {
            builder.addFormDataPart(param.key, param.value);
        }
        builder = constructMultipartBuilder(builder, file, key);
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).tag(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz, activityName));
    }

    /**
     * 非同步POST請求 多檔案上傳
     *
     * @param url             請求url
     * @param files           待上傳的檔案s
     * @param keys            待上傳檔案的keys
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPost(String url, File[] files, String[] keys, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);
        for (Param param :
                params) {
            builder.addFormDataPart(param.key, param.value);
        }
        for (int i = 0; i < files.length; i++) {
            builder = constructMultipartBuilder(builder, files[i], keys[i]);
        }
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz));
    }

    /**
     * 非同步POST請求 多檔案上傳(可取消)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param files           待上傳的檔案s
     * @param keys            待上傳檔案的keys
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, File[] files, String[] keys, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        addRequestUrl(activityName, url);
        MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);
        for (Param param :
                params) {
            builder.addFormDataPart(param.key, param.value);
        }
        for (int i = 0; i < files.length; i++) {
            builder = constructMultipartBuilder(builder, files[i], keys[i]);
        }
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).tag(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz, activityName));
    }

    /**
     * 非同步POST請求 單圖片上傳上傳
     *
     * @param url             請求url
     * @param files           待上傳圖片陣列
     * @param fileName        待上傳圖片名
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPost(String url, byte[] files, String fileName, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);
        for (Param param :
                params) {
            builder.addFormDataPart(param.key, param.value);
        }
        RequestBody requestBody = RequestBody.create(MediaType.parse("image/*"), files);
        builder.addFormDataPart(key, fileName, requestBody);
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz));
    }

    /**
     * 非同步POST請求 單圖片上傳上傳(可取消)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param files           待上傳圖片陣列
     * @param fileName        待上傳圖片名
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, byte[] files, String fileName, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        addRequestUrl(activityName, url);
        MultipartBuilder builder = new MultipartBuilder().type(MultipartBuilder.FORM);
        for (Param param :
                params) {
            builder.addFormDataPart(param.key, param.value);
        }
        RequestBody requestBody = RequestBody.create(MediaType.parse("image/*"), files);
        builder.addFormDataPart(key, fileName, requestBody);
        RequestBody body = builder.build();
        Request request = new Request.Builder().post(body).url(url).tag(url).build();
        mOkHttpClient.newCall(request).enqueue(new TRequestCallBack(iTRequestResult, clazz, activityName));
    }

    /**
     * 構造多部件builer
     *
     * @param builder 當前例項化MultipartBuilder
     * @param file    待上傳檔案
     * @param key     對應的引數名
     * @return 構造後的MultipartBuilder
     */
    private MultipartBuilder constructMultipartBuilder(MultipartBuilder builder, File file, String key) {
        String name = file.getName();
        RequestBody requestBody = RequestBody.create(MediaType.parse(guessMimeType(name)), file);
        builder.addFormDataPart(key, name, requestBody);
        return builder;
    }

    /**
     * 獲取檔案型別
     *
     * @param path
     * @return
     */
    private String guessMimeType(String path) {
        FileNameMap fileNameMap = URLConnection.getFileNameMap();
        String contentTypeFor = fileNameMap.getContentTypeFor(path);
        if (contentTypeFor == null) {
            contentTypeFor = "application/octet-stream";
        }
        return contentTypeFor;
    }

    /**
     * 增加請求標誌
     *
     * @param activityName
     * @param url
     */
    private void addRequestUrl(String activityName, String url) {
        if (requestMap.containsKey(activityName)) {
            requestMap.get(activityName).add(url);
        } else {
            Set<String> urlSet = new HashSet<String>();
            urlSet.add(url);
            requestMap.put(activityName, urlSet);
        }
    }

    /**
     * 取消正在請求的url
     *
     * @param url 請求url
     */
    public void cancelRequest(String url) {
        try {
            mOkHttpClient.getDispatcher().cancel(url);
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }

    /**
     * 取消當前頁面正在的請求
     *
     * @param activityName
     */
    public void cancelActivityRequest(String activityName) {
        try {
            if (requestMap.containsKey(activityName)) {
                Set<String> urlSet = requestMap.get(activityName);
                for (String url : urlSet) {
                    mOkHttpClient.getDispatcher().cancel(url);
                }
                requestMap.remove(activityName);
            }
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }

    /*************************************************************
     * 回撥方法
     *********************************************************/
    class TRequestCallBack<T> implements Callback {

        private ITRequestResult<T> mITRequestResult;

        private Class<T> clazz;

        private String notifyMsg = "";

        private String activityName;

        public TRequestCallBack(ITRequestResult<T> mITRequestResult, Class<T> clazz) {
            this.mITRequestResult = mITRequestResult;
            this.clazz = clazz;
        }

        public TRequestCallBack(ITRequestResult<T> mITRequestResult, Class<T> clazz, String activityName) {
            this.mITRequestResult = mITRequestResult;
            this.clazz = clazz;
            this.activityName = activityName;
        }

        @Override
        public void onFailure(Request request, IOException e) {
            EBLog.e(TAG, request.toString() + e.toString());
            if (!isHaveActivtyName(activityName)) return;
            notifyMsg = NETWORK_ERROR;
            postErrorMsg();
        }

        @Override
        public void onResponse(Response response) throws IOException {
            if (!isHaveActivtyName(activityName)) return;
            if (response.isSuccessful()) {
                String result = response.body().string(); //方法只能呼叫一次
                EBLog.i(TAG, result);
                final T res = GsonHelper.toType(result, clazz);
                int code = -1;
                if (res != null && res instanceof BaseResp) {
                    code = ((BaseResp) res).getRetcode();
                    switch (code) {
                        case 000000:
                            postSucessMsg(res);
                            break;
                        case 10005:
                        case 10011:
                            //自動登入
                        default:
                            notifyMsg = ((BaseResp) res).getRetinfo();
                            postErrorMsg();
                            break;
                    }
                } else {
                    notifyMsg = SERVER_ERROR;
                    postErrorMsg();
                }
            } else {
                notifyMsg = NETWORK_ERROR;
                postErrorMsg();
            }
        }

        /**
         * 主執行緒傳送錯誤訊息
         */
        private void postErrorMsg() {
            handler.post(new Runnable() {
                @Override
                public void run() {
                    mITRequestResult.onCompleted();
                    mITRequestResult.onFailure(notifyMsg);
                }
            });
        }

        /**
         * 主執行緒傳送正確訊息
         */
        private void postSucessMsg(final T res) {
            handler.post(new Runnable() {
                @Override
                public void run() {
                    mITRequestResult.onCompleted();
                    mITRequestResult.onSuccessful(res);
                }
            });
        }

        /**
         * 當前activity是否存在
         *
         * @param activityName
         */
        private boolean isHaveActivtyName(String activityName) {
            if (GeneralUtils.isNotNullOrZeroLenght(activityName)) {
                return requestMap.containsKey(activityName);
            } else {
                return true;
            }
        }
    }

    public static String SERVER_ERROR = "請求失敗,請稍後再試";

    public static String NETWORK_ERROR = "您的網路狀況不佳,請檢查網路連線";

    public void destory() {
        manager = null;
    }
}

複製程式碼
/**
 * <功能詳細描述>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/8]
 * @see [相關類/方法]
 * @since [產品/模組版本]
 */
public interface ITRequestResult<T> {

    public void onSuccessful(T entity);

    public void onFailure(String errorMsg);

}

複製程式碼
/**
 * <引數類>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/8]
 * @see [相關類/方法]
 * @since [V1]
 */
public class Param {
    public Param() {
    }

    public Param(String key, String value) {
        this.key = key;
        this.value = value != null ? value : "";
    }

    public Param(String key, int value) {
        this.key = key;
        this.value = value + "";
    }

    String key;

    String value;
}
複製程式碼

應該已經很清楚了,我的做的事情有三個: 1.定義ITRequestResult介面,用於處理網路請求後的回撥,並且此介面中的回撥在主執行緒中(OKHttp返回介面Callback是在子執行緒中 )。 2.TRequestCallBack介面實現。 集中統一處理網路層異常碼然後返回到UI層。 集中統一處理網路層正常情況,通過json庫,把網路返回解析成java model返回給UI層。 3.get,post,cancel方法封裝,方便呼叫。

4)Bridge層抽象

每個專案中的重複程式碼特別多,很多專案喜歡抽象公共方法類,但是專案的時間一久,可能你自己都不清楚,這個方法是否定義過,寫在哪裡,勤快的人會全域性搜一遍,有些同學可能會嫌麻煩,自己新建一個util類,寫上自己的名字,頓時感覺自己萌萌的。

這邊,我們引入了BridgeFactory,用來統一管理基礎功能,類似本地服務的實現原理。 BridgeFactory裡面實現了檔案,網路,資料庫,安全等等管理類的實現,並儲存了各類管理類的引用。業務層或者上層呼叫底層實現時,一律通過BridgeFactory去訪問,而不是直接的呼叫。

/**
 * <中間連線層>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public class BridgeFactory {

    private static BridgeFactory model;

    private HashMap<String, Object> mBridges;

    private BridgeFactory() {
        mBridges = new HashMap<String, Object>();
    }

    public static void init(Context context) {
        model = new BridgeFactory();
        model.iniLocalFileStorageManager();
        model.initPreferenceManager();
        model.initSecurityManager();
        model.initUserSession();
        model.initCoreServiceManager(context);
        model.initOkHttpManager();
    }

    public static void destroy() {
        model.mBridges = null;
        model = null;
    }

    /**
     * 初始化本地儲存路徑管理類
     */
    private void iniLocalFileStorageManager() {
        LocalFileStorageManager localFileStorageManager = new LocalFileStorageManager();
        model.mBridges.put(Bridges.LOCAL_FILE_STORAGE, localFileStorageManager);
        BridgeLifeCycleSetKeeper.getInstance().trustBridgeLifeCycle(localFileStorageManager);
    }

    /**
     * 初始化SharedPreference管理類
     */
    private void initPreferenceManager() {
        EBSharedPrefManager ebSharedPrefManager = new EBSharedPrefManager();
        model.mBridges.put(Bridges.SHARED_PREFERENCE, ebSharedPrefManager);
        BridgeLifeCycleSetKeeper.getInstance().trustBridgeLifeCycle(ebSharedPrefManager);
    }

    /**
     * 網路請求管理類
     */
    private void initOkHttpManager() {
        OkHttpManager mOkHttpManager = new OkHttpManager();
        model.mBridges.put(Bridges.HTTP, mOkHttpManager);
        BridgeLifeCycleSetKeeper.getInstance().trustBridgeLifeCycle(mOkHttpManager);
    }

    /**
     * 初始化安全模組
     */
    private void initSecurityManager() {
        SecurityManager securityManager = new SecurityManager();
        model.mBridges.put(Bridges.SECURITY, securityManager);
        BridgeLifeCycleSetKeeper.getInstance().trustBridgeLifeCycle(securityManager);
    }

    /**
     * 初始化使用者資訊模組
     */
    private void initUserSession() {
    }

    /**
     * 初始化Tcp服務
     *
     * @param context
     */
    private void initCoreServiceManager(Context context) {
    }


    private void initDBManager() {
    }

    /**
     * 通過bridgeKey {@link Bridges}來獲取對應的Bridge模組
     *
     * @param bridgeKey {@link Bridges}
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <V extends Object> V getBridge(String bridgeKey) {
        final Object bridge = model.mBridges.get(bridgeKey);
        if (bridge == null) {
            throw new NullPointerException("-no defined bridge-");
        }
        return (V) bridge;
    }
}

複製程式碼

並且,通過BridgeLifeCycleListener 介面,實現各個底層功能管理類的統一初始化跟銷燬工作,保持跟app的生命週期一致。程式碼如下:

/**
 * 如果Bridge層的生命週期和App的生命週期相關(在Application
 * onCreate的時候初始化,在使用者雙擊back鍵退出),則實現此介面,屆時統一初始化和銷燬
 */
public interface BridgeLifeCycleListener {
    public void initOnApplicationCreate(Context context);

    public void clearOnApplicationQuit();
}

複製程式碼

Manager類程式碼如下:

/**
 * <http公共解析庫>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public class OkHttpManager implements BridgeLifeCycleListener {

    @Override
    public void initOnApplicationCreate(Context context) {

    }

    /**
     * 非同步Get請求 泛型返回
     *
     * @param url             請求url
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncGet(String url, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncGetEnqueue(url, iTRequestResult, clazz, params);
    }

    /**
     * 非同步Get請求 帶tag(關閉頁面則取消請求)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncGetByTag(String url, String activityName, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncGetEnqueueByTag(url, activityName, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求
     *
     * @param url             請求url
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncPost(String url, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPost(url, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 帶tag(關閉頁面則取消請求)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPostByTag(url, activityName, iTRequestResult, clazz, params);
    }


    /**
     * 非同步DELETE請求
     *
     * @param url             請求url
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     * @param <T>             泛型模板
     */
    public <T> void requestAsyncDelete(String url, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncDelete(url, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 單檔案上傳
     *
     * @param url             請求url
     * @param file            待上傳的檔案
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPost(String url, File file, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPost(url, file, key, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 單檔案上傳 帶tag(關閉頁面則取消請求)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param file            待上傳的檔案
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, File file, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPostByTag(url, activityName, file, key, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 多檔案上傳
     *
     * @param url             請求url
     * @param files           待上傳的檔案s
     * @param keys            待上傳檔案的keys
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPost(String url, File[] files, String[] keys, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPost(url, files, keys, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 多檔案上傳  帶tag(關閉頁面則取消請求)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param files           待上傳的檔案s
     * @param keys            待上傳檔案的keys
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, File[] files, String[] keys, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPostByTag(url, activityName, files, keys, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 單圖片上傳上傳
     *
     * @param url             請求url
     * @param files           待上傳圖片陣列
     * @param fileName        待上傳圖片名
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPost(String url, byte[] files, String fileName, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPost(url, files, fileName, key, iTRequestResult, clazz, params);
    }

    /**
     * 非同步POST請求 單圖片上傳上傳 帶tag(關閉頁面則取消請求)
     *
     * @param url             請求url
     * @param activityName    請求activityName
     * @param files           待上傳圖片陣列
     * @param fileName        待上傳圖片名
     * @param key             待上傳的key
     * @param iTRequestResult 請求回撥
     * @param clazz           Class<T>
     * @param params          請求引數
     */
    public <T> void requestAsyncPostByTag(String url, String activityName, byte[] files, String fileName, String key, ITRequestResult<T> iTRequestResult, Class<T> clazz, Param... params) {
        OkHttpUtil.getInstance().requestAsyncPostByTag(url, activityName, files, fileName, key, iTRequestResult, clazz, params);
    }

    /**
     * 取消正在請求的url
     *
     * @param url
     */
    public void cancelRequest(String url) {
        OkHttpUtil.getInstance().cancelRequest(url);
    }

    /**
     * 取消當前頁面正在請求的請求
     *
     * @param activity
     */
    public void cancelActivityRequest(String activity) {
        OkHttpUtil.getInstance().cancelActivityRequest(activity);
    }

    @Override
    public void clearOnApplicationQuit() {
        OkHttpUtil.getInstance().destory();
    }
}

複製程式碼

5)多頁面互動 可能會有多個頁面存在邏輯關係,比如HomeActivity載入圖片成功後,要通知LoginActivity上面的EditText內容清除,當然這個需求是我瞎扯的,然而真正開發中的需求何嘗不是這樣呢。我擦,無意間流露出對產品經理的喜愛~~~~。 可能會有人用廣播,用觀察者,應該還有人會定義靜態方法,去直接呼叫,不管怎麼,我不評價,因為我之前也都用過。。。。 我們這邊改成eventbus去做頁面之間的互動,eventbus的好處,相信大家都清楚。 EventBus是一款針對Android優化的釋出/訂閱事件匯流排。主要功能是替代Intent,Handler,BroadCast在Fragment,Activity,Service,執行緒之間傳遞訊息.優點是開銷小,程式碼更優雅。以及將傳送者和接收者解耦。

使用的程式碼如下:

HomeActivity.java類

 @Override
    public void initData() {
        Picasso.with(this).load("http://i.imgur.com/DvpvklR.png").resize(DensityUtil.dip2px(this,200), DensityUtil.dip2px(this,200)).centerCrop().into(image);
        EventBus.getDefault().post(Event.IMAGE_LOADER_SUCCESS);//傳送重新整理通知
    }
複製程式碼

LoginActivity.java類

 @Override
    public void onEventMainThread(Event event) {
        super.onEventMainThread(event);
        switch (event){
            //接受通知
            case IMAGE_LOADER_SUCCESS:
                clearEditContent();
                break;
        }
    }
複製程式碼
 /**
 * <事件型別>
 *
 * @author caoyinfei
 * @version [版本號, 2016/6/6]
 * @see [相關類/方法]
 * @since [V1]
 */
public enum Event {
    /**
     * 圖片成功
     */
    IMAGE_LOADER_SUCCESS,

}
複製程式碼

6)其他公共類的封裝 當然還有很多類的封裝,框架中都有涉及,這邊由於時間問題不一一介紹了,大家可以自行研究。

  • Gson的封裝使用
  • Log的封裝,方便上線,調整優先順序,關閉日誌
  • FileUtil常用檔案操作的封裝
  • LocalFileStorageManager 本地檔案快取目錄封裝
  • SecurityUtils 加解密的封裝(前面有文章介紹過原理,程式碼中不宜出現加密過程,暫時刪除了)
  • 資料庫封裝 (前面有文章介紹過GreenDao,並有例子,這邊不介紹了) blog.csdn.net/dfskhgalshg… ......

6.其他思考

1.Android依賴注入的框架:Dagger、RoboGuice和ButterKnife,依賴注入的框架,見仁見智,有些人很推崇,但是我個人不怎麼喜歡,首先影響了程式碼結構,程式碼交接成本高,個人小專案可以嘗試使用,大的公司專案還是在考慮。
2.該篇文章為單工程框架,下篇文章會介紹元件化架構

專案地址:關注公眾號,留言:Android專案架構搭建原始碼即可獲取。


如有錯誤歡迎指出來,一起學習。

在這裡插入圖片描述

相關文章