為什么要開發(fā)QuickCompare Plugin？
沒有QuickCompare Plugin的時(shí)候：
intellij打開多個(gè)Project的時(shí)候，我們想比較其中兩個(gè)Project的任意文件，intellij自帶和指定的外部比較工具會比較麻煩。右鍵當(dāng)前文件，選擇Compare with，然后彈出繁瑣的文件選擇框，再選擇想比較的文件。公司的項(xiàng)目，會經(jīng)常遇到比較同步多個(gè)Project文件的情形，這個(gè)時(shí)候用intellij自帶的文件比較就會很浪費(fèi)時(shí)間啦。都說了時(shí)間比金錢更寶貴，我們怎么能在這上面浪費(fèi)時(shí)間呢？
使用QuickCompare Plugin之后：
- 右鍵彈出菜單，選擇Select left file for compare，鎖定左側(cè)文件
- 打開第二個(gè)文件，右鍵選擇Compare to “***”。So easy 有木有?
開發(fā)QuickCompare Plugin Step:
1)前期準(zhǔn)備：開發(fā)環(huán)境搭建及插件工程建立。具體參見官方tutorial:
開發(fā)環(huán)境搭建
http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/setting_up_environment.html
創(chuàng)建插件工程
http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/creating_plugin_project.html
2)在intellij編輯器右鍵加入菜單
在Plugin中一個(gè)菜單項(xiàng)對應(yīng)一個(gè)Action。建立一個(gè)Action的最簡單方法就是利用Intellij右鍵的new Action向?qū)А?br>
Action對應(yīng)的菜單在編輯器中哪個(gè)地方顯示，可以在plugin.xml中配置。plugin.xml是intellij插件的描述文件，有點(diǎn)相當(dāng)于AndroidManifest.xml對于Android APP的作用。
action節(jié)點(diǎn)的class表明由哪個(gè)class進(jìn)行初始化。
add-to-group 節(jié)點(diǎn)表明action會在intellij UI上哪個(gè)區(qū)域進(jìn)行顯示。一個(gè)action可以加在多個(gè)地方。
<actions>
<group id="QuickCompareGroup" text="" description="">
<separator/>
<action id="MyPlugin.SelectLeft" class="SelectLeft" text="Select Left for Compare" description="SelectLeft">
</action>
<action id="MyPlugin.CompareTo" class="CompareTo" text="CompareTo" description="CompareTo">
</action>
<!-- The <separator> element defines a separator between actions.
It can also have an <add-to-group> child element. -->
<separator/>
<add-to-group group-id="NavbarPopupMenu" anchor="before" relative-to-action="FindUsages"/>
<add-to-group group-id="EditorPopupMenu" anchor="before" relative-to-action="Github.Create.Gist"/>
<add-to-group group-id="ProjectViewPopupMenu" anchor="before" relative-to-action="Github.Create.Gist"/>
</group>
</actions>
action對應(yīng)的class需集成Action類，action菜單被點(diǎn)擊后actionPerformed會被執(zhí)行
action的update方法，會時(shí)不時(shí)的被intellij IDE SDK框架調(diào)用，用來更新自身的狀態(tài)及UI
public class SelectLeft extends AnAction {
private BC mInstance = (BC) ApplicationManager.getApplication().getComponent("BC");
@Override
public void update(AnActionEvent e) {
super.update(e);
}
@Override
public void actionPerformed(AnActionEvent e) {
// TODO: insert action logic here
VirtualFile vFile = e.getData(PlatformDataKeys.VIRTUAL_FILE);
mInstance.setLeftFile(vFile);
mInstance.setCurrentState(BC.SelectState.WAITFORCOMPARE);
}
}
3）在Settings中加入intellij插件設(shè)置
插件自身配置同樣可以在plugin.xml中聲明
一個(gè)配置類需實(shí)現(xiàn) Configurable接口，Configurable一個(gè)有7個(gè)方法，分別簡單介紹下:
- public String getDisplayName()；
顯示在設(shè)置中心的設(shè)置項(xiàng)名稱 - public String getHelpTopic()；
幫助提示文字，具體顯示在哪，暫時(shí)還沒測試過 - public JComponent createComponent()；
重點(diǎn)方法！創(chuàng)建配置UI布局 - public boolean isModified()；
返回是否配置修改過，這個(gè)方法會經(jīng)常被系統(tǒng)框架調(diào)用 - public void apply() throws ConfigurationException ；
設(shè)置下面的apply按鈕被點(diǎn)擊時(shí)調(diào)用 - public void reset()；
設(shè)置界面的reset點(diǎn)擊時(shí)調(diào)用 - public void disposeUIResources()；
界面關(guān)閉釋放資源
4）配置保存
intellij插件有多種持久化數(shù)據(jù)的方法。在我們插件中我們只需要保存外部比較工具Beyond compare的可執(zhí)行文件地址。因此我們使用PropertiesComponent 保存設(shè)置。PropertiesComponent使用方法非常簡單：
- 獲取PropertiesComponent單例實(shí)例
PropertiesComponent component = PropertiesComponent.getInstance(); - 設(shè)置鍵值對
component.setValue("bc", mPathTextField.getText());
5）調(diào)用外部工具進(jìn)行比較
本質(zhì)上QuickCompare Plugin還是調(diào)用外部工具進(jìn)行比較的，所以我們需要通過命令行方式調(diào)用Beyond Compare。
JAVA調(diào)用外部可執(zhí)行程序使用Runtime.getRuntime().exec 接口。
注意：給可執(zhí)行程序傳遞參數(shù)的時(shí)候最好使用字符串?dāng)?shù)組方式傳遞，不要直接使用字符串拼接寫在一個(gè)字符串中，否則可能會遇到路徑中的空格等奇葩問題。
private void compare(VirtualFile leftFile,VirtualFile rightFile){
Process p = null;
try {
System.out.println("before compare...");
PropertiesComponent component = PropertiesComponent.getInstance();
if (StringUtil.isEmpty(component.getValue("bc"))){
System.out.println("pls set bc path first...");
}else {
String comparePath = component.getValue("bc");
String[] execStringArray = new String[]{comparePath,leftFile.getPath(),rightFile.getPath()};
Runtime.getRuntime().exec(execStringArray);
System.out.println("after compare...");
}
} catch (IOException e) {
System.out.println("compare exception...");
e.printStackTrace();
} catch (Exception e){
System.out.println("compare exception...");
e.printStackTrace();
}
}
QuickCompare Plugin github https://github.com/nziyouren/QuickComparePlugin
歡迎Fork & Contribute
