一種我認為比較好的MVP寫法封裝，你值得擁有

weixin_33976072發表於2018-07-27
MVP封裝

EasyMvp

一個簡單強大且靈活的MVP框架。
專案地址：EasyMvp

特點

  • 一個 Activity 可以繫結多個 Presenter，以達到最大的複用功能。
  • 採用註解的方式實現依賴注入，減少耦合。
  • 可以靈活管理生命週期。
  • 使用起來方便簡單
  • 使用例子可以在專案中找到。

使用方法

（以簡單的登陸註冊為例）

  • 單個 Presenter 的情況
  1. 定義好你的契約類如 LoginContract:
public interface LoginContract {
    interface Presenter<V> extends BaseContract.Presenter<V> {
        void login();
    }

    interface View extends BaseContract.View {
        void loginSuccess();
    }
}
  1. 編寫 LoginPresenter 繼承 BasePresenter 並實現你的 Presenter 介面：
public class LoginPresenter extends BasePresenter<LoginContract.View> implements LoginContract.Presenter<LoginContract.View> {

    @Override
    public void login() {
        mView.loginSuccess();
    }
}
  1. Activity 繼承 BaseMvpActivity 並實現你的 View 介面：
@CreatePresenter(presenter = LoginPresenter.class)
public class ExampleActivity3 extends BaseMvpActivity<LoginPresenter> implements LoginContract.View {

    @Override
    protected int getContentView() {
        return R.layout.activity_main;
    }

    @Override
    public void init() {
        getPresenter().login();
    }

    @Override
    public void loginSuccess() {
        Log.i("ExampleActivity1", "登陸成功");
    }
}

其中在 Activity 中，Presenter 例項的獲取方法可以有上面程式碼所示的通過 getPresenter 來獲取，這種方法需要在 BaseMvpActivity 後面
填入泛型引數你的 Presenter 實現類，比如上面所示的 LoginPresenter。
除了這種方法，也可以通過註解的方式獲取例項：

@CreatePresenter(presenter = LoginPresenter.class)
public class ExampleActivity3 extends BaseMvpActivity implements LoginContract.View {
    @PresenterVariable
    private LoginPresenter mLoginPresenter;

    @Override
    protected int getContentView() {
        return R.layout.activity_main;
    }

    @Override
    public void init() {
        mLoginPresenter.login();
    }

    @Override
    public void loginSuccess() {
        Log.i("ExampleActivity1", "登陸成功");
    }
}

如果不喜歡註解，還可以通過直接獲取的方式獲取：

@CreatePresenter(presenter = LoginPresenter.class)
public class ExampleActivity3 extends BaseMvpActivity implements LoginContract.View {

    private LoginPresenter mLoginPresenter;

    @Override
    protected int getContentView() {
        return R.layout.activity_main;
    }

    @Override
    public void init() {
      mLoginPresenter = getPresenterProviders().getPresenter(0);
      mLoginPresenter.login();
    }

    @Override
    public void loginSuccess() {
        Log.i("ExampleActivity1", "登陸成功");
    }
}

通過 getPresenterProviders().getPresenter(int index) 方法獲取，傳入的引數是你通過 @CreatePresenter 註解傳入的 class 物件的
陣列下標，這裡因為只有一個 Presenter, 所以傳 0 即可。

  • 多個 Presenter 的情況

多個 Presenter 的情況前兩個步驟跟上面一樣，主要是在 Activity 繫結這邊有些區別：

@CreatePresenter(presenter = {LoginPresenter.class, RegisterPresenter.class})
public class ExampleActivity1 extends BaseMvpActivity implements LoginContract.View, RegisterContract.View {

    @PresenterVariable
    private LoginPresenter mLoginPresenter;
    @PresenterVariable
    private RegisterPresenter mRegisterPresenter;

    @Override
    protected int getContentView() {
        return R.layout.activity_main;
    }

    @Override
    public void init() {
        //也可以通過這種方式去獲取例項
        //mLoginPresenter = getPresenterProviders().getPresenter(0);
        //mRegisterPresenter = getPresenterProviders().getPresenter(1);

        mLoginPresenter.login();
        mRegisterPresenter.register();
    }

    @Override
    public void loginSuccess() {
        Log.i("ExampleActivity1", "登陸成功");
    }

    @Override
    public void registerSuccess() {
        Log.i("ExampleActivity1", "註冊成功");
    }
}

如上所示，假如一個 Activity 中需要同時用到 LoginPresenter 和 RegisterPresenter 中的某些方法，只需要使用註解
@CreatePresenter 依次傳入它們的 class 物件即可完成繫結。同樣地為了得到各個 Presenter 的例項，可以通過 @PresenterVariable
註解去獲取，當然如果不喜歡用註解，也可以通過 getPresenterProviders().getPresenter(int index) 方法去獲取哦。

  • 不需要使用 Mvp 的情況

並不是所有地方都需要用到 Mvp，當不需要用的時候，其實也沒什麼特別，就正常用就行：

public class ExampleActivity4 extends BaseMvpActivity {
    @Override
    protected int getContentView() {
        return R.layout.activity_main;
    }

    @Override
    public void init() {

    }
}

編寫 BasePresenter, BaseContract, BaseMvpActivity 等一些基礎類

上面例子中有用到 BasePresenter, BaseContract, BaseMvpActivity 等一些基礎類，這裡給出一種例子，使用者可根據自己需要去編寫。

  • BaseContract

BaseContract 是基礎契約類：

public interface BaseContract {
    interface View {
        void showError(String msg); //展示錯誤提示

        void complete();  //操作完成，比如網路請求等

        void showProgressUI(boolean isShow); //展示 loading UI等
    }

    interface Presenter<V> {
        void attachView(Context context, V view); //繫結View

        void detachView(); //解綁View

        boolean isAttachView(); //判斷是否繫結View

        void onCreatePresenter(@Nullable Bundle savedState); //Presenter建立後呼叫

        void onDestroyPresenter();  //Presenter銷燬後呼叫

        void onSaveInstanceState(Bundle outState);  //跟 onSaveInstanceState 方法一樣
    }
}

可以看到就是定義了一些公共的介面方法。因為 Presenter 需要跟具體的 View 繫結，所以弄了個泛型。

  • BasePresenter

BasePresenter 就是基礎的 BasePresenter 了，作用也是實現一些公共的 Presenter 介面方法：

public class BasePresenter <V extends BaseContract.View> implements BaseContract.Presenter<V> {

    protected Context mContext;
    protected V mView;

    protected void onCleared() {

    }

    @Override
    public void attachView(Context context, V view) {
        this.mContext = context;
        this.mView = view;
    }

    @Override
    public void detachView() {
        this.mView = null;
    }

    @Override
    public boolean isAttachView() {
        return this.mView != null;
    }

    @Override
    public void onCreatePresenter(@Nullable Bundle savedState) {

    }

    @Override
    public void onDestroyPresenter() {
        this.mContext = null;
        detachView();
    }

    @Override
    public void onSaveInstanceState(Bundle outState) {

    }
}

實現了 BaseContract.Presenter 介面，然後裡面的一些方法看需要去實現，一般像 attachView，detachView ，isAttachView 等方法是一定要實現的，
因為這些與生命週期繫結有關，可以做資源的賦值和釋放等操作。

  • BaseMvpActivity

這個大家都知道，就是 Activity 的基類了，看看它的一種實現：

public abstract class BaseMvpActivity<P extends BaseContract.Presenter> extends AppCompatActivity implements BaseContract.View {

    private PresenterProviders mPresenterProviders;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(getContentView());
        mPresenterProviders = PresenterProviders.inject(this);
        mPresenterProviders
                .of()
                .get()
                .attachView(this, this);
        mPresenterProviders.onCreatePresenter(savedInstanceState);
        init();
    }

    @Override
    protected void onSaveInstanceState(Bundle outState) {
        super.onSaveInstanceState(outState);
        mPresenterProviders.onSaveInstanceState(outState);
    }

    protected abstract int getContentView();

    public abstract void init();

    protected P getPresenter() {
        return mPresenterProviders.getPresenter(0);
    }

    public PresenterProviders getPresenterProviders() {
        return mPresenterProviders;
    }

    @Override
    public void showError(String msg) {

    }

    @Override
    public void complete() {

    }

    @Override
    public void showProgressUI(boolean isShow) {

    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        mPresenterProviders.detachView();
    }
}

BaseMvpActivity 後面定義的泛型 P 主要是為了一個 Presenter 的時候使用 getPresenter() 方法時用到的，程式碼如上面例子所示。可以看看 getPresenter() 的實現：

protected P getPresenter() {
    return mPresenterProviders.getPresenter(0);
}

也只是呼叫了 PresenterProviders.getPresenter(int index) 方法而已。

然後 BaseMvpActivity 實現了 BaseContract.View 介面，預設實現了一些公共方法，當你繼承它的時候，需要可以重寫他們。

主要說一下 PresenterProviders，這個類的作用是解析用到的註解以及完成繫結和解綁 View 等一些公共的 Presenter 操作。

  1. 首先呼叫 inject 方法例項化，傳入上下文引數。
  2. 通過呼叫 of() , get() , attachView() 方法即可完成 @CreatePresenter 註解解析，@PresenterVariable 註解解析以及 View 的繫結三個操作。
  3. 然後通過它的例項 mPresenterProviders 在對應的方法回撥中完成其他操作。

下面簡單分析一下 PresenterProviders 具體實現：

  1. 關於註解的知識，可以看這篇文章，看完應該就懂了：深入理解Java註解型別(@Annotation)
  2. PresenterStore 類：
    這個類的主要作用就是將 Presenter 的例項儲存起來，用的是 HashMap 實現：
private static final String DEFAULT_KEY = "PresenterStore.DefaultKey";
private final HashMap<String, P> mMap = new HashMap<>();

public final void put(String key, P presenter) {
    P oldPresenter = mMap.put(DEFAULT_KEY + ":" + key, presenter);
    if (oldPresenter != null) {
        oldPresenter.onCleared();
    }
}

public final P get(String key) {
    return mMap.get(DEFAULT_KEY + ":" + key);
}

public final void clear() {
    for (P presenter : mMap.values()) {
        presenter.onCleared();
    }
    mMap.clear();
}

因為需要處理的是一個或多個 Presenter 物件，所以這樣做的目的是為了可以統一管理和查詢，所以 attachView 和 detachView 的真正實現也都在這裡：

public void attachView(Context context, BaseContract.View view) {
    for (Map.Entry<String, P> entry : mMap.entrySet()) {
        BasePresenter presenter = entry.getValue();
        if (presenter != null) {
            presenter.attachView(context, view);
        }
    }
}

public void detachView() {
    for (Map.Entry<String, P> entry : mMap.entrySet()) {
        BasePresenter presenter = entry.getValue();
        if (presenter != null) {
            presenter.detachView();
        }
    }
}

當然其他一些 Presenter 的公共實現也可以這麼做。

  1. 然後到了主要的 PresenterProviders 類
    這個類主要看幾個方法，第一個 of() 方法：
public <P extends BasePresenter> PresenterProviders of() {
    CreatePresenter createPresenter = mContext.getClass().getAnnotation(CreatePresenter.class);
    if (createPresenter != null) {
        Class<P>[] classes = (Class<P>[]) createPresenter.presenter();
        for (Class<P> clazz : classes) {
            String canonicalName = clazz.getCanonicalName();
            try {
                mPresenterStore.put(canonicalName, clazz.newInstance());
            } catch (InstantiationException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
    }
    return this;
}

of() 方法主要的作用是解析 @CreatePresenter 註解，過程是這樣的：首先獲取到註解上所有定義的 class 物件陣列 classes，然後
迴圈，取它們的 canonicalName 作為 key ,呼叫 newInstance 方法例項化後作為 value 存入上面說到的 HasMap 中。

接下來是 get 方法：

public <P extends BasePresenter> PresenterProviders get() {
    for (Field field : mContext.getClass().getDeclaredFields()) {
        //獲取欄位上的註解
        Annotation[] anns = field.getDeclaredAnnotations();
        if (anns.length < 1) {
            continue;
        }
        if (anns[0] instanceof PresenterVariable) {
            String canonicalName = field.getType().getName();
            P presenterInstance = (P) mPresenterStore.get(canonicalName);
            if (presenterInstance != null) {
                try {
                    field.setAccessible(true);
                    field.set(mContext, presenterInstance);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
    return this;
}

get 方法主要的作用就是為將用 @PresenterVariable 註解標記的物件在 HashMap 中找到對應的例項，並賦值。過程是
這樣的，首先通過 getDeclaredFields 獲取類上所以的變數的 Field，然後判斷如果該變數有標記 @PresenterVariable
註解的話，就取它的 Type 對應的 Name，這個 Name 的值是會與 canonicalName 一樣的，所以就可以通過它作為 key
在 HashMap 中查詢對應的例項，找到後通過 Field 的 set 方法給變數賦值。

整個過程就完成了，是不是很簡單。在實際的運用過程中可以根據自己額需要做對應的修改。
喜歡就給個 Star 吧，歡迎留言提 Issues 和建議。

相關文章