Android Studio插件開發流程
插件,即Plug-in,一款實用的插件實乃 程序員 工程師們居家旅行、節約時間、渾水摸魚 的必備良器。接下來一起學習下IntelliJ平臺下的IDEA插件的開發流程;
準備事項:
- 1、IntelliJ IDEA;
- 2、Java開發環境及相關編程知識;
插件開發步驟:
1、使用IntelliJ IDEA創建工程
如下圖選擇IntelliJ Platform Plugin 工程,然後按部就班的Next就好:
創建好後,工程結構圖如下所示:
此時會默認打開一個plugin.xml的清單文件(會有紅色下劃線,不要慌,改爲你自己相應的信息即可解決),代碼如下,按照你需要的將id,name,version,vendor,description,change-notes進行響應修改即可:
<idea-plugin>
<id>com.your.company.unique.plugin.id</id>
<name>Plugin display name here</name>
<version>1.0</version>
<vendor email="[email protected]" 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="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 -->
</actions>
</idea-plugin>
2、新建Action
我們在項目的src目錄下新建包名,然後在包內新建Plugin DevKit => Action(如果此時沒有Action選項那麼先看文末的注意事項):
有幾個參數需要介紹下:
- Action ID:就是唯一標識;
- Class Name:該Action類的名字;
- Name:顯示給別人看到的插件的名字;
- Description:該插件的描述信息;
- Groups:插件的顯示位置,這裏我們選擇了ToolsMenu(Tools),就是顯示在Tools菜單欄下(效果見後面展示);
- Anchor:表示插件在該菜單欄中的位置,有First、Last等可選;
- 剩下的是快捷鍵選項,我們先不做處理;
填寫完畢後點擊Next一路進入到SayHello類中,準備進行相關開發工作,
3、編寫代碼
新建的Translate類代碼如下,我們就加入一條測試代碼,用來展示一個輸入對話框:
package com.vsix7.plugin;
import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.ui.Messages;
public class SayHello extends AnAction {
@Override
public void actionPerformed(AnActionEvent e) {
//編寫相應測試代碼
Messages.showMessageDialog(
"Hello World !",
"Title",
Messages.getInformationIcon()
);
}
}
4、測試運行
代碼編寫好後,點擊運行按鈕,此時會打開另一個IntelliJ IDEA,一路Next隨便新建一個項目就好,等創建好後,點擊Tools菜單欄就可以看到我們的SayHello選項了:
點擊Translate可以看到彈出了我們想要的對話框效果Hello World !:
5、打包插件
點擊Build菜單下的Prepare Plugin Module ‘你的項目名’ For Deployment,此時會進行打包,結束後會在項目的根目錄下生成一個以你項目名明明的並以.jar結尾的jar包,比如我這裏顯示:
6、在基於IntelliJ平臺的IDEA中使用插件
在Android Studio中點擊FIle => Settings…,點擊Plugins選項,選擇最下方的 Install Plugin from disk… 按鈕,然後選擇剛剛生成的SayHello.jar文件,然後重啓更新即可看到效果了。
注意右方紅框裏的信息,就是一開始在plugin.xml中所配置的。
好了,插件的開發流程就是這些了,想深入酷炫的插件開發實現更多使用的功能的話,還是需要我們去閱讀API文檔,地址在這裏啦:http://www.jetbrains.org/intellij/sdk/docs/welcome.html 。
注意事項
配置Project SDK,一般找不到新建Action選項的基本都是SDK沒有配置正確。
點擊FIle => Project Structure,在下圖彈出的窗口中點擊Project在右側點擊 New… 按鈕選擇IntelliJ Platform Plugin SDK:
在彈出的窗口中選擇相應的版本:
再選擇本地安裝的相應的Java SDK版本,點擊確定:
然後點擊Apply按鈕後即可。