为AndroidStudio开发mvp插件(MvpHelper)

如果觉得写mvp有点枯燥无味,我们可以做点 cool 的事情:做个 as 插件


help.png

Google官方安卓Mvp架构demo
https://github.com/googlesamples/android-architecture

  • todo-mvp: 基础的MVP架构。
  • todo-mvp-loaders:基于MVP架构的实现,在获取数据的部分采用了loaders架构。
  • todo-mvp-databinding: 基于MVP架构的实现,采用了数据绑定组件。
  • todo-mvp-clean: 基于MVP架构的clean架构的实现。
  • todo-mvp-dagger2: 基于MVP架构,采用了依赖注入dagger2。
  • dev-todo-mvp-contentproviders: 基于mvp-loaders架构,使用了ContenPproviders。
  • dev-todo-mvp-rxjava: 基于MVP架构,对于程序的并发处理和数据层(MVP中的Model)的抽象。

idea插件论坛
https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development

因为对mvp的理解不同,会有很多种方式表达架构,所以插件要极简易读,可扩展性强,所以可以选择:

/**
     * 通过模板生成类
     * @param var1 文件生成路径
     * @param var2 文件名
     * @param var3 模板名
     * @param var4 是否生产类
     * @param var5 模板参数
     */
public abstract PsiClass createClass(@NotNull PsiDirectory var1, @NotNull String var2, @NotNull String var3, boolean var4, @NotNull Map<String, String> var5) throws IncorrectOperationException;

也就是只要定制不同的模板就可以实现扩展性

直接贴下步骤:

  • 1: idea File - new - Project - IntelliJ Platform Plugin
    dir.PNG

    plugin.xml 插件配置信息:
<idea-plugin>
  <id>com.your.company.unique.plugin.id</id>
  <name>Plugin display name here</name>
  <version>1.0</version>
  <vendor email="support@yourcompany.com" url="http://www.yourcompany.com">YourCompany</vendor>

  <description><![CDATA[
      Enter short description for your plugin here.<br>
      <em>most HTML tags may be used</em>
    ]]></description>

  <change-notes><![CDATA[
      Add change notes here.<br>
      <em>most HTML tags may be used</em>
    ]]>
  </change-notes>

  <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html for description -->
  <idea-version since-build="145.0"/>

  <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
       on how to target different products -->
  <!-- uncomment to enable plugin in all products
  <depends>com.intellij.modules.lang</depends>
  -->

  <extensions defaultExtensionNs="com.intellij">
    <!-- Add your extensions here -->
  </extensions>

  <actions>
    <action id="generateMVPField" class="actions.MvpGenerator" text="Generate MVP By String"
            description="Generate MVP" icon="/icons/app_icon.png">
      <add-to-group group-id="GenerateGroup" anchor="first"/>
      <add-to-group group-id="NewGroup" anchor="last"/>
      <keyboard-shortcut keymap="$default" first-keystroke="alt I"/>
    </action>
  </actions>

</idea-plugin>

action:

public class MvpGenerator extends AnAction implements MvpHandler.OnGenerateListener {

    private AnActionEvent actionEvent;
    private MvpHandler mvpHandler;
    private Map<String, String> map = new HashMap<>();

    @Override
    public void actionPerformed(AnActionEvent anActionEvent) {
        this.actionEvent = anActionEvent;
        mvpHandler = new MvpHandler();
        mvpHandler.setTitle("输入名称-生成MVP相关类");
        mvpHandler.setOnGenerateListener(this);
        mvpHandler.pack();
        //设置对话框跟随当前windows窗口
        mvpHandler.setLocationRelativeTo(WindowManager.getInstance().getFrame(anActionEvent.getProject()));
        mvpHandler.setVisible(true);
    }


    @Override
    public void onGenerate(String text) {

        JavaDirectoryService directoryService = JavaDirectoryService.getInstance();

        //当前工程
        Project project = actionEvent.getProject();
        map.put("NAME", text);
        map.put("PACKAGE_NAME", Util.getPackageName(project));

        //鼠标右键所选择的路径
        IdeView ideView = actionEvent.getRequiredData(LangDataKeys.IDE_VIEW);
        PsiDirectory directory = ideView.getOrChooseDirectory();

        assert directory != null;
        if (directory.getName().contains("contract") && directory.findFile(text + "Contract.java") == null) {
            directoryService.createClass(directory, text + "Contract", "GenerateContractFile", true, map);
        }

        if (directory.getName().contains("model") && directory.findFile(text + "Model.java") == null) {
            directoryService.createClass(directory, text + "Model", "GenerateModelFile", true, map);
        }

        if (directory.getName().contains("presenter") && directory.findFile(text + "Presenter.java") == null) {
            directoryService.createClass(directory, text + "Presenter", "GeneratePresenterFile", true, map);
        }


    }

    @Override
    public void onCancel() {
        mvpHandler.setVisible(false);
    }
}

dialog: (action下,右键,new dialog)

public class MvpHandler extends JDialog {
    private JPanel contentPane;
    private JButton buttonOK;
    private JButton buttonCancel;
    private JTextArea textArea1;
    private OnGenerateListener listener;

    public void setOnGenerateListener(OnGenerateListener listener) {
        this.listener = listener;
    }

    public MvpHandler() {
        setContentPane(contentPane);
        setModal(true);
        getRootPane().setDefaultButton(buttonOK);

        buttonOK.addActionListener(e -> listener.onGenerate(textArea1.getText().trim()));

        buttonCancel.addActionListener(e -> listener.onCancel());

        // call onCancel() when cross is clicked
        setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
        addWindowListener(new WindowAdapter() {
            public void windowClosing(WindowEvent e) {
                listener.onCancel();
            }
        });

        // call onCancel() on ESCAPE
        contentPane.registerKeyboardAction(e -> listener.onCancel(), KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
    }

    public interface OnGenerateListener{
        void onGenerate(String text);
        void onCancel();
    }

}

MvpHandler.form 拖动控件


dialog.PNG

Util:

public class Util {

    /**
     * AndroidManifest.xml 获取 app 包名
     * @return
     */
    public static String getPackageName(Project project) {
        String package_name = "";
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        try {
            DocumentBuilder db = dbf.newDocumentBuilder();
            Document doc = db.parse(project.getBasePath() + "/app/src/main/AndroidManifest.xml");
            NodeList nodeList = doc.getElementsByTagName("manifest");
            for (int i = 0; i < nodeList.getLength(); i++) {
                Node node = nodeList.item(i);
                Element element = (Element) node;
                package_name = element.getAttribute("package");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return package_name;
    }
}
  • 2: 定制模板:按需求定制
    new - file - xxx.java.ft
    GenerateContractFile.java.ft
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")
package ${PACKAGE_NAME};
#end

import base.IBaseModel;
import base.IBaseView;
import base.IPresenter;


public interface ${NAME}Contract{

    interface I${NAME}View extends IBaseView{

    }

    interface I${NAME}Model extends IBaseModel{

    }

    interface I${NAME}Presenter extends IPresenter<I${NAME}View>{

    }

}

GenerateModelFile.java.ft

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

import ${PACKAGE_NAME}.contract.${NAME}Contract;

import base.IBaseModel;


public class ${NAME}Model implements ${NAME}Contract.I${NAME}Model{

    public static IBaseModel newInstance(){
        return new ${NAME}Model();
    }


}

GeneratePresenterFile.java.ft

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")
package ${PACKAGE_NAME}
;#end

import ${PACKAGE_NAME}.contract.${NAME}Contract;
import ${PACKAGE_NAME}.model.${NAME}Model;

import base.BasePresenter;


public class ${NAME}Presenter extends BasePresenter<${NAME}Contract.I${NAME}View,${NAME}Contract.I${NAME}Model> implements ${NAME}Contract.I${NAME}Presenter{

    @Override
    public ${NAME}Contract.I${NAME}Model bindModel(){
        return (${NAME}Contract.I${NAME}Model)${NAME}Model.newInstance();
    }


}

MVP:
BasePresenter:

public abstract class BasePresenter<T extends IBaseView,M extends IBaseModel> implements IPresenter<T> {


    protected T mView;
    protected M mModel;

    protected CompositeDisposable mDisposable;

    public BasePresenter() {
        this.mModel = bindModel();
        mDisposable = new CompositeDisposable();
    }

    public boolean isViewAttached() {
        return mView != null;
    }


    public void checkViewAttached() {
        if (!isViewAttached()) throw new RuntimeException("未注册View");
    }

    @Override
    public void onAttach(T t) {
        mView = t;
        if (mModel == null) {
            throw new NullPointerException("model没有绑定 不能使用");
        }
    }

    /**
     * return Model
     */
    public abstract M bindModel();

    @Override
    public void onDetach() {
        if (!mDisposable.isDisposed())
            mDisposable.dispose();
        mView = null;
    }


}

IBaseModel:

package base;

/**
 * Created by haoran on 2018/4/4.
 */

public interface IBaseModel {
}

IBaseView :

package base;

/**
 * Created by haoran on 2017/10/30.
 */

public interface IBaseView {


    void showLoading();

    void hideLoading();

    void onError(String message);

}

IPresenter:

package base;

/**
 * Created by haoran on 2017/10/30.
 */

public interface IPresenter<T> {

    void onAttach(T t);

    void onDetach();
    
}

实现类:(引导页为例)... import 忽略
GuideContract:

public interface GuideContract {
    interface IGuideView extends IBaseView{

        void showGuideImages(List<GuideImgBean.PictureListBean> pictureListBeans);

        void showGuideDefaultImage();
    }

    interface IGuideModel extends IBaseModel {
        Observable<List<GuideImgBean.PictureListBean>> getGuideImages();
    }

    interface IGuidePresenter extends IPresenter<IGuideView> {

        void getGuideImages();

    }

}

GuideModel:

public class GuideModel implements GuideContract.IGuideModel {


    public static IBaseModel newInstance() {
        return new GuideModel();
    }

    public Observable<List<GuideImgBean.PictureListBean>> getGuideImages() {
        return ApiHelper.get().getGuideImages(new JSONObject());
    }
}

GuidePresenter:

public class GuidePresenter extends BasePresenter<GuideContract.IGuideView, GuideContract.IGuideModel> implements GuideContract.IGuidePresenter {


    @Override
    public void getGuideImages() {
        checkViewAttached();
        mDisposable.add(mModel.getGuideImages().subscribe(pictureList -> {
            if (pictureList == null || pictureList.size() == 0) {
                mView.showGuideDefaultImage();
            } else {
                mView.showGuideImages(pictureList);
            }
        }, throwable -> mView.showGuideDefaultImage()));
    }

    @Override
    public GuideContract.IGuideModel bindModel() {
        return (GuideContract.IGuideModel) GuideModel.newInstance();
    }
}

根据自己实际的mvp实现类定制模板

  • 3: 打包插件,as引入插件,使用插件(插件开发调试忽略)
    打包:idea里 build - Prapare Pulgine Module 'xxx' for Developer
    项目目录下的jar包
    打开as -- setting pulgine import from disk : jar 包目录
    重启as
    选中目录(含contract , model ,presenter) alt + i(快捷键可在plugine.xml配置)
    或 右键 - new - 点击插件图标
    输入 名称(XXX)--- 生成 java 类
    generate1.PNG

    点击ok
    generate2.PNG

感谢:)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,588评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,456评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,146评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,387评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,481评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,510评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,522评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,296评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,745评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,039评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,202评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,901评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,538评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,165评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,415评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,081评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,085评论 2 352

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,973评论 25 707
  • 昨晚因为那副牌卡的吸引到了那位同学的酒店。在准备抽牌,一张卡掉了下来。 今天在进行自我疗愈的时候,我怎么感知到天使...
    Lotus尹红阅读 176评论 0 0
  • 一……就……+无言的提醒 早上起床后,吉祥在沙发上玩,我们都准备好要吃早饭了?他仍然没有动的意思。 我说,吉祥,你...
    吉祥如意妈阅读 149评论 0 0
  • 在angular-cli.json文件中配置第三方库 1> 引入不带版本号的第三方库 启动页面后发现并没有加载到配...
    飞鱼YE阅读 425评论 0 0