詳解基于IDEA2020.1的JAVA代碼提示插件開發(fā)例子
之前因為項目組有自己的代碼規(guī)范,為了約束平時的開發(fā)規(guī)范,于是基于2019.1.3版本開發(fā)了一個代碼提示的插件。但是在把IDEA切換到2020.1版本的時候,卻發(fā)現(xiàn)瘋狂報錯,但是網(wǎng)上關(guān)于IDEA插件開發(fā)的相關(guān)文章還是不夠多,只能自己解決。于是根據(jù)官方的SDK文檔,使用Gradle重新構(gòu)建了一下項目,把代碼拉了過來。下文會根據(jù)2020.1版本簡單開發(fā)一個代碼異常的提示插件,把容易踩坑的地方提示一下。
1、首先先根據(jù)IDEA插件開發(fā)官方文檔,用Gradle新建一個project
選中file -> new -> Project...
,在彈出的窗口左側(cè)選擇Gradle
,彈出以下界面:
默認勾選了Java,需要額外勾選IntelliJ Platform Plugin
來表示這是一個IDEA插件項目,還需要勾選Kotlin/JVM
這一項,為什么要勾選這一項呢,官網(wǎng)是這么介紹的:
To include support for the Kotlin language in the plugin, check the Kotlin/JVM box (circled in green below.) This option can be selected with or without the Java language.
也就是說,如果我們開發(fā)的插件需要對JAVA代碼做支持的話,是要勾選這一項的。所有如果插件是基于JAVA代碼檢查的話,需要勾選這一個選項。
勾選完之后,點擊next,之后的信息根據(jù)自己實際需要填寫即可,然后點擊finish,然后默默等待Gradle構(gòu)建項目,如果可以的話掛個梯子,下載包什么的還是挺慢的。
構(gòu)建完后的項目的目錄結(jié)構(gòu)以及每一個目錄的作用,可以直接去看官方文檔,里面有介紹。
https://www.jetbrains.org/intellij/sdk/docs/tutorials/build_system/prerequisites.html
2、 構(gòu)建完項目后,需要修改build.gradle部分配制
構(gòu)建完后,默認會打開build.gradle
文件,內(nèi)容如下:
plugins { id 'java' id 'org.jetbrains.intellij' version '0.4.19' id 'org.jetbrains.kotlin.jvm' version '1.3.71' } group 'org.example' version '1.0-SNAPSHOT' repositories { mavenCentral() } dependencies { implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8" testCompile group: 'junit', name: 'junit', version: '4.12' } // See https://github.com/JetBrains/gradle-intellij-plugin/ intellij { version '2020.1' } compileKotlin { kotlinOptions.jvmTarget = "1.8" } compileTestKotlin { kotlinOptions.jvmTarget = "1.8" } patchPluginXml { changeNotes """ Add change notes here.<br> <em>most HTML tags may be used</em>""" }
這里有個坑,構(gòu)建完后,我把以前的代碼復制過來,提醒我有部分類沒有找到,也就是說沒有引入對應的jar包。后來我在官網(wǎng)例子里面發(fā)現(xiàn),它的build.gradle
文件,和我的build文件有點不一樣,具體不一樣的地方如下:
// See https://github.com/JetBrains/gradle-intellij-plugin/ intellij { version = '2020.1' plugins = ['java'] sameSinceUntilBuild = true }
它在intellij里面,多了一個plugins = ['java']
的選項,如果缺少這個選項的話,會缺少java-api.jar
等jar等JAVA代碼支持的jar包,導致一些類或者方法不可用。所以如果是JAVA代碼支持的話,build.gradle
文件需要加上plugins = ['java']
這一行。
3、修改plugin.xml文件
plugin.xml
文件是對于本插件的作用的一些描述,以及一些依賴關(guān)系配制,構(gòu)建完后的plugin.xml
文件內(nèi)容如下:
<idea-plugin> <id>org.example.new-plugin-for-java</id> <name>Plugin display name here</name> <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> <!-- please see https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html on how to target different products --> <depends>com.intellij.java</depends> <extensions defaultExtensionNs="com.intellij"> <!-- Add your extensions here --> <localInspection language="JAVA" displayName="test displayer" groupPath="Java" groupBundle="messages.InspectionsBundle" groupKey="group.names.probable.bugs" enabledByDefault="true" level="ERROR" implementationClass="com.nw.TestInsepction"/> </extensions> <actions> <!-- Add your actions here --> </actions> </idea-plugin>
這里有個坑,如果是IDEA2019.2以前的版本的話,這個文件不用其他東西,直接參考網(wǎng)上的插件開發(fā)教程,寫好代碼,就可以正常運行了。但是如果是IDEA2019.2的版本的話,運行的時候會瘋狂報錯,一開始不知道為什么,只能又去翻官方的例子,玩大家一起來找不同,結(jié)果發(fā)現(xiàn)官網(wǎng)的例子,下面的配置信息和默認構(gòu)建的不一樣:
<!-- Evaluates java PSI --> <depends>com.intellij.modules.java</depends>
原來這里的依賴還要改一下,改成上面這樣,那為什么要改成這個依賴呢,這個時候,我才發(fā)現(xiàn)默認構(gòu)建的plugin.xml
里面,在depends上面有一段注釋,大概意思就是,請前往注釋里面的網(wǎng)站去找到如何根據(jù)產(chǎn)品去選擇對應的depends,那就很簡單了,直接上網(wǎng)頁看,里面很多的介紹,以及各種不同的depends是干嘛的。網(wǎng)頁里面有這么一段話:
(2) The Java language functionality was extracted as a plugin in version 2019.2 of the IntelliJ Platform. This refactoring separated the Java implementation from the other, non-language portions of the platform. Consequently, Java dependencies are expressed differently in plugin.xml
depending on the version of the IntelliJ Platform being targeted:
Syntax required for releases prior to 2019.2, allowable in all releases:
plugin.xml
includecom.intellij.modules.java
Syntax for 2019.2 and later releases:
plugin.xml
allowable alternative includecom.intellij.java
build.gradle
required to includeintellij.plugins 'java'
大概意思是,從2019.2版本開始后,java代碼相關(guān)的支持抽成了一個插件,不包含在默認構(gòu)建的包里面了,所以從2019.2版本開始后,plugin.xml
和build.gradle
需要修改成相關(guān)的配置。這也是為什么我們第二步要改build.gradle
的原因。
4、參考網(wǎng)上的例子,編寫第一個代碼提示插件
新建一個java類,內(nèi)容如下,這是一個測試用的提示插件,在所有變量上面提示"this is error"
package com; import com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool; import com.intellij.codeInspection.ProblemsHolder; import com.intellij.psi.JavaElementVisitor; import com.intellij.psi.PsiElementVisitor; import com.intellij.psi.PsiField; import org.jetbrains.annotations.NotNull; /** * 這是一個測試用的提示插件,在所有變量上面提示"this is an error" * @author LiuYeFeng * @date 2020/5/5 * @e-mail nightwind666@163.com */ public class TestInspectionTool extends AbstractBaseJavaLocalInspectionTool { @NotNull @Override public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) { // 返回一個java元素的訪問器,重寫當訪問變量的時候,需要做的操作 return new JavaElementVisitor() { @Override public void visitField(PsiField field) { super.visitField(field); // 注冊問題,也就是在變量上面顯示異常紅色下劃線,并提示"this is an error" // 如果可以的話,這里也可以附帶上快速修復問題的方法 holder.registerProblem(field, "this is an error"); } }; } }
然后在plugin.xml
里面的extensions
添加上面編寫的插件,如下;
<extensions defaultExtensionNs="com.intellij"> <!-- Add your extensions here --> <localInspection language="JAVA" displayName="Test field error" groupPath="Java" groupBundle="messages.InspectionsBundle" groupKey="group.names.probable.bugs" enabledByDefault="true" level="ERROR" implementationClass="com.TestInspectionTool"/> </extensions>
以上配置大致是注冊一個代碼提示組件,里面的參數(shù)會決定你的提示配置在IDEA的哪個分類里面,以及提示的等級,例子里面用ERROR級別,可以查看的簡單一點。
5、開始看代碼提示插件的效果
點擊右上角的debug,等待編譯運行。運行后會彈出一個新的IDEA,這個IDEA會加載了我們編寫的插件,同時在我們原來編寫插件的IDEA可以看到日志輸出等東西,也可以斷點。可以簡單理解為新的IDEA是一個瀏覽器,我們在用網(wǎng)頁調(diào)試后端接口。
因為我們編寫的插件是新寫一個變量,不管三七二十一就會報錯,提示this is an error
,效果如下;
到此,一個完成的代碼異常提示插件,就簡單完成了。
6、代碼提示插件還可以做到的
我們編寫的這個插件,其實是比較簡單的,并沒有做邏輯分析。我們是可以根據(jù)實際需要,去編寫一些項目組本身特有的功能的,例如某些繼承自特殊類的所有字段,必須要有注釋。在Service里面的方法,異常返回之前必須要記錄日志或者一些其他操作等,都是可以做到的,還可以做一些快速修復(quick fix),例如字段沒有注釋可以快速生成注釋。
這就需要對IDEA語法樹相關(guān)有了解,IDEA把代碼抽象成了Psi語法樹,根據(jù)不同的代碼功能劃分為不同的PsiElement
,例如注釋是PsiComment
,字段是PsiField
,方法是PsiMethod
,類是PsiClass
。IDEA本身也提供了相當多的工具類,例如ReferencesSearch
可以尋找類或者方法的引用點,PsiTreeUtil
可以處理代碼語法樹上面的一些操作,例如獲取變量所在的方法,ControlFlowUtil
可以對代碼進行解析等,還有PsiClassUtil
和PsiFieldUtil
等各種相關(guān)性的工具類可以提供各種便捷的操作,這就需要插件開發(fā)者自己去摸索。遇到問題可以去IDEA官方問答論壇去找一下,說不定別人已經(jīng)幫你解決了這個問題了。
附加:
https://www.jetbrains.org/intellij/sdk/docs/intro/welcome.html
https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development
到此這篇關(guān)于詳解基于IDEA2020.1的JAVA代碼提示插件開發(fā)例子的文章就介紹到這了,更多相關(guān)IDEA2020.1 JAVA代碼提示插件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java?Float?保留小數(shù)位精度的實現(xiàn)
這篇文章主要介紹了Java?Float?保留小數(shù)位精度的實現(xiàn)方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-12-12Spring?Security實現(xiàn)接口放通的方法詳解
在用Spring?Security項目開發(fā)中,有時候需要放通某一個接口時,我們需要在配置中把接口地址配置上,這樣做有時候顯得麻煩。本文將通過一個注解的方式快速實現(xiàn)接口放通,感興趣的可以了解一下2022-05-05詳解Java中布隆過濾器(Bloom Filter)原理及其使用場景
布隆過濾器是1970年由布隆提出的,它實際上是一個很長的二進制向量和一系列隨機映射函數(shù),它的作用是檢索一個元素是否存在我們的集合之中,本文給大家詳細的講解一下布隆過濾器,感興趣的同學可以參考閱讀2023-05-05Dubbo Service Mesh基礎架構(gòu)組件改造
Service Mesh這個“熱”詞是2016年9月被“造”出來,而今年2018年更是被稱為service Mesh的關(guān)鍵之年,各家大公司都希望能在這個思潮下領(lǐng)先一步2023-03-03