科技

多module開發時module模板外掛開發

Java · 發表 2018-12-03 21:04:36

摘要： 0.前言現在app比較流行的一種開發方式就是元件化開發，之前我曾經寫過一篇文章 Kotlin搭建元件化應用模板，介紹如何進行元件化開發的，但是這其中有個問題，每次建立業務module都需要重新修改androidmanifest檔案、build檔案，建立各種包，感覺及其麻煩，所以我...

0.前言

現在app比較流行的一種開發方式就是元件化開發，之前我曾經寫過一篇文章

ofollow,noindex">Kotlin搭建元件化應用模板，介紹如何進行元件化開發的，但是這其中有個問題，每次建立業務module都需要重新修改androidmanifest檔案、build檔案，建立各種包，感覺及其麻煩，所以我打算寫一個外掛來自動生成模板module。

1.需求

製作外掛，根據module名和包名生成對應的module模板

2.程式碼

2.1下載Intellij Idea

2.2建立Plugin專案

image

2.3定義plugin.xml配置檔案

<idea-plugin>
<id>com.skateboard.modulegenerator</id>
<name>元件化模板module產生器</name>
<version>1.0</version>
<vendor email="[email protected]" url="http://www.yourcompany.com">YourCompany</vendor>

<description><![CDATA[
用來產生模板module
]]></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="173.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>
<!-- Add your actions here -->
<group id="com.skateboard.modulegenerator" popup="true" text="GenerateModule">
<action id="MultiModuleGenerator" class="com.skateboard.modulegenerator.GeneratorAction"
text="ModuleGenerator" description="Use to generate module">
<add-to-group group-id="FileMenu" anchor="first"/>
<keyboard-shortcut keymap="$default" first-keystroke="shift ctrl P"/>
</action>
</group>
</actions>

</idea-plugin>

其中的<name>和<description>就是外掛名稱和功能描述，會在你安裝外掛時顯示。<actions>標籤定義了外掛的一些動作，其中<group>定義了外掛顯示的選單名稱和顯示樣式，<add-to-group>定義了將會把GenerateModule選單欄新增到File選單下。<actiton>定義了action的程式碼的位置。

2.4對話方塊的編寫

當點選ModuleGenerator選項後，會出現一個對話方塊，讓你輸入module的名稱以及包名，這個對話方塊其實就是用java swing編寫的

ublic class ModuleInfoDialog extends JDialog {

private DialogCallback dialogCallback;

private final static String OK = "OK";

private final static String CANCEL = "CANCEL";

private final static String TITLE = "建立新module";

private final static String MODULE_NAME_HINT = "請輸入模組名稱:";

private final static String PACKAGE_NAME_HINT = "請輸入包名:";

private final static String ERROR_MESSAGE = "模組名和包名不能為空";

public ModuleInfoDialog(DialogCallback dialogCallback) {
setSize(450, 300);
setModal(true);
setTitle(TITLE);
prepareUI();
this.dialogCallback = dialogCallback;

}

private void prepareUI() {


GridBagLayout gridBagLayout = new GridBagLayout();
JPanel contentPannel = new JPanel();
contentPannel.setLayout(gridBagLayout);

GridBagConstraints constraints = new GridBagConstraints();
constraints.gridx = 0;
constraints.gridy = 0;
constraints.gridwidth = 1;
constraints.weightx = 0;


JLabel moduleHintLabel = new JLabel();
moduleHintLabel.setText(MODULE_NAME_HINT);
contentPannel.add(moduleHintLabel, constraints);

constraints.gridx = 0;
constraints.gridy = 1;
constraints.weightx=0;
JLabel packageNameHintLabel = new JLabel();
packageNameHintLabel.setText(PACKAGE_NAME_HINT);
contentPannel.add(packageNameHintLabel, constraints);

constraints.gridx = 1;
constraints.gridy = 0;
constraints.weightx=1;
constraints.fill=GridBagConstraints.HORIZONTAL;
JTextField moduleNameImp = new JTextField();
moduleNameImp.setForeground(Color.WHITE);
contentPannel.add(moduleNameImp, constraints);

constraints.gridx = 1;
constraints.gridy = 1;
constraints.weightx=1;
constraints.fill=GridBagConstraints.HORIZONTAL;
JTextField packageNameImp = new JTextField();
packageNameImp.setForeground(Color.WHITE);
contentPannel.add(packageNameImp, constraints);


JLabel errorLabel = new JLabel();
errorLabel.setForeground(Color.RED);
errorLabel.setVisible(false);


JButton okBtn = new JButton();
okBtn.setText(OK);
okBtn.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
if (moduleNameImp.getText().isEmpty() || packageNameImp.getText().isEmpty()) {
errorLabel.setVisible(true);
errorLabel.setText(ERROR_MESSAGE);
return;
}
if (dialogCallback != null) {
dialogCallback.onOkClicked(moduleNameImp.getText(), packageNameImp.getText());
}
dispose();
}
});


JButton cancelBtn = new JButton();
cancelBtn.setText(CANCEL);
cancelBtn.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {

if (dialogCallback != null) {
dialogCallback.onCancelClicked();
}
dispose();
}
});

constraints.anchor=WEST;
constraints.weightx=0;
constraints.gridx = 0;
constraints.gridy = 2;
contentPannel.add(okBtn, constraints);

constraints.fill=GridBagConstraints.NONE;
constraints.gridy = 2;
constraints.gridx = 1;
contentPannel.add(cancelBtn, constraints);

constraints.gridy = 3;
constraints.gridx = 0;
contentPannel.add(errorLabel, constraints);

setContentPane(contentPannel);
}


interface DialogCallback {

void onOkClicked(String moduleName, String packageName);

void onCancelClicked();
}


public static void pop(DialogCallback callback) {
ModuleInfoDialog infoDialog = new ModuleInfoDialog(callback);
Dimension screenSize = Toolkit.getDefaultToolkit().getScreenSize();
infoDialog.setLocation(screenSize.width / 2 - infoDialog.getWidth() / 2, screenSize.height / 2 - infoDialog.getHeight() / 2);
infoDialog.setVisible(true);
}

}

沒什麼特別要說的，就是構建了一個dilaog，其中的靜態方法pop（）用來顯示這個dialog

2.5action的編寫

當我們點選ModuleGenerator的這個選項時，會產生一個action，這裡要實現對應的邏輯，就是我們建立模板檔案的地方。首先建立一個類GeneratorAction並繼承自AnAction，同時需要複寫actionPerformed方法，看一下GeneratorAction的actionPerformed方法

ModuleInfoDialog.pop(new ModuleInfoDialog.DialogCallback() {
@Override
public void onOkClicked(String moduleName, String packageName) {
generateModuleFiles(moduleName, packageName, e.getProject().getBasePath());
e.getProject().getBaseDir().refresh(true, true);

}

@Override
public void onCancelClicked() {

}
});

首先就是產生剛才說的用來輸入module名和包名的dialog，當點選ok按鈕後，就會建立專案模板檔案和同步工程檔案了。其中的generateModuleFils方法就是建立相應的資料夾和檔案的，具體實現看程式碼就好了，沒什麼可說的。

3.問題

gradle檔案中指定的intellij的版本號

intellij {
version '2018.1'
}

plugin.xml中指定的idea的build version

<idea-version since-build="181.0"/>

要和android studio的版本相對應，否則會出現錯誤

plugin *** is incompatible with this installation

4.專案地址

github

gradle執行runIde 這個task