背景
在給Java局部變量的實體賦值時，往往有很多setter，一個一個寫很麻煩，也會漏掉，因此開發一款插件，可以自動生成局部變量實體的所有setter。
插件效果如下：
可以在plugin marketplace 搜索：Summon Setters
源碼參考：Summon-all-setters
開發前
IDEA plugin 通過 Java 或 Kotlin 語言編寫，官方目前推薦Kotlin語言，依賴管理使用 Gradle。
插件框架初始化可以手動通過Gradle創建，也可以從官方的Template下載，默認為Kotlin語言。
參考文檔：
- Developing a Plugin
- idea插件開發文檔
也可以參考開源的插件實現，在 Intellij Plugin Marketplace搜索相關功能插件，點開Source Code欄（可能沒有）
同時IDEA可安裝插件開發插件：Plugin DevKit。
為了方便查看文件的PSI樹形結構，設置IDEA安裝目錄下的bin目錄的idea.properties文件中的idea.is.internal=true，通過主菜單的Tools->View PSI Structure即可查看。
目錄結構
這裏使用Github上的intellij-platform-plugin-template，目錄結構如下：
.
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── build.gradle.kts
├── gradle
│ ├── libs.versions.toml
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── qodana.yml
├── settings.gradle.kts
└── src
└── main
├── kotlin
│
└── resources
└── META-INF
├── plugin.xml
└── pluginIcon.svg注意事項
開發時，gradle.properties 中需要引入相關依賴：
...
platformPlugins = com.intellij.java
...同時 plugin.xml 中也要設置:
<!-- Plugin Configuration File. Read more: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html -->
<idea-plugin>
...
<depends>com.intellij.java</depends>
<description><![CDATA[
這裏填寫介紹，不能少於40個字符，同時README.md文件中也要寫，不然無法提交到marketPlace
]]>
</description>
...
</idea-plugin>
README.md:
<!-- Plugin description -->
這裏填寫介紹，不能少於40個字符
<!-- Plugin description end -->同時默認的圖標pluginIcon.svg需要替換掉，圖標規範參考 plugin-icon-file
Summon Setters 插件開發
在實施代碼開發前，要考慮通過什麼方式生成，自定義Action？自定義Extension？兩種方式都能實現，參考了市面上的兩種實現，發現第二種更直觀簡單寫。
這裏我們擴展Intention Extension。Intention Extension即為代碼的提示擴展，快捷鍵option/alt + enter。
我們在plugin.xml中註冊Extension:
<idea-plugin>
...
<extensions defaultExtensionNs="com.intellij">
<intentionAction>
<language>JAVA</language>
<!-- 生成setters，不帶參數 -->
<className>io.github.bty834.SummonSettersIntentionAction</className>
</intentionAction>
<intentionAction>
<language>JAVA</language>
<!-- 生成setters，帶默認參數 -->
<className>io.github.bty834.SummonSettersWithDefaultsIntentionAction</className>
</intentionAction>
</extensions>
</idea-plugin>SummonSettersIntentionAction 需要繼承com.intellij.codeInsight.intention.PsiElementBaseIntentionAction
看一下需要實現的幾個方法：
import com.intellij.codeInsight.intention.HighPriorityAction
import com.intellij.codeInsight.intention.PriorityAction
import com.intellij.codeInsight.intention.PsiElementBaseIntentionAction
import com.intellij.openapi.editor.Editor
import com.intellij.openapi.project.Project
import com.intellij.psi.PsiElement
class MyIntentionExtension : PsiElementBaseIntentionAction(), HighPriorityAction {
override fun getFamilyName(): String {
TODO("一組extension共用的名稱，我們這裏定義的兩個extension使用同一個familyName")
}
override fun getText(): String {
TODO("intention展示時的名稱")
}
override fun getPriority(): PriorityAction.Priority {
// intention的優先級排序，com.intellij.codeInsight.intention.HighPriorityAction接口的方法
return PriorityAction.Priority.TOP
}
override fun isAvailable(project: Project, editor: Editor?, element: PsiElement): Boolean {
TODO("判斷當前光標處是否可以展示該intention")
}
override fun invoke(project: Project, editor: Editor?, element: PsiElement) {
TODO("運行intention extension")
}
}我們要實現isAvailable方法，判斷能否展示當前intention:
自動生成setter，需要判斷當前光標指向的是不是局部變量，且局部變量有含有setter的類：
// 獲取當前局部變量的類
fun getLocalVariableContainingClass(psiElement: PsiElement): PsiClass? {
val psiLocalVar: PsiLocalVariable = PsiTreeUtil.getParentOfType(psiElement, PsiLocalVariable::class.java) ?: return null
if (psiLocalVar.parent !is PsiDeclarationStatement) {
return null
}
return PsiTypesUtil.getPsiClass(psiLocalVar.type)
}
// 判斷當前類是否有setter
fun checkClazzHasValidSetters(psiClass: PsiClass?): Boolean {
psiClass ?: return false
if (psiClass.hasAnnotation("lombok.Setter") || psiClass.hasAnnotation("lombok.Data") {
return true
}
val fields: Array<PsiField> = psiClass.allFields
if (fields.any { it.hasAnnotation("lombok.Setter") }) {
return true
}
if (psiClass.allMethods
.filter {
it.hasModifierProperty(PsiModifier.PUBLIC)
&& it.name.startsWith("set")
&& !it.hasModifierProperty(PsiModifier.STATIC)
&& !it.hasModifierProperty(PsiModifier.ABSTRACT)
&& !it.hasModifierProperty(PsiModifier.DEFAULT)
&& !it.hasModifierProperty(PsiModifier.NATIVE)
}
.any { it.name.startsWith("set") }) {
return true
}
return false
}滿足以上條件，我們開始生成setter代碼，大致步驟如下：
- 定位光標當前的局部變量；
- 找到當前局部變量的類以及類中的setter，包含手寫的setter和lombok的
@Data和@Setter，lombok註解又分為註解在類上和註解在字段上，並且要忽略靜態setter方法； - 生成代碼（包含縮進）並插入當前代碼編輯區。
先看一下一個局部變量該有的PSI樹形結構：
override fun invoke(project: Project, editor: Editor?, element: PsiElement) {
// 先找到PsiLocalVariable類型的父級元素，必須為PsiDeclarationStatement
val localVariable: PsiLocalVariable =
PsiTreeUtil.getParentOfType(element, PsiLocalVariable::class.java) ?: return
// 不是就返回
if (localVariable.parent !is PsiDeclarationStatement) {
return
}
// 獲取局部變量的類
val psiClass = PsiTypesUtil.getPsiClass(localVariable.type)
// 獲取該類的所有setter函數名
val setterMethodNames: List<String> = CommonUtil.getSetterMethodNames(psiClass)
// 局部變量的變量名
val variableName: String = localVariable.name
// 找到代碼縮進量：
val psiDocumentManager = PsiDocumentManager.getInstance(project)
val containingFile: PsiFile = localVariable.containingFile
val document = psiDocumentManager.getDocument(containingFile) ?: return
val indentNum: Int = CommonUtil.getIndentSpaceNumsOfCurrentLine(document, localVariable.parent.textOffset)
val insertSetterStr: StringBuilder = StringBuilder()
setterMethodNames.forEach {
// 縮進
insertSetterStr.append(" ".repeat(indentNum))
// setter
insertSetterStr.append("$variableName.$it();\n")
}
// 寫入編輯區
document.insertString(localVariable.parent.textOffset + localVariable.parent.textLength + 1, insertSetterStr.toString())
psiDocumentManager.doPostponedOperationsAndUnblockDocument(document)
psiDocumentManager.commitDocument(document)
FileDocumentManager.getInstance().saveDocument(document)
}