IDEA插件开发：自动生成setter

news2024/10/6 20:27:52

背景

在给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代码，大致步骤如下：

  1. 定位光标当前的局部变量；
  2. 找到当前局部变量的类以及类中的setter，包含手写的setter和lombok的@Data和@Setter，lombok注解又分为注解在类上和注解在字段上，并且要忽略静态setter方法；
  3. 生成代码（包含缩进）并插入当前代码编辑区。

先看一下一个局部变量该有的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)
    
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1721362.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

Nginx 1.26.0 爆 HTTP/3 QUIC 漏洞，建议升级更新到 1.27.0

Nginx 1.26.0 爆 HTTP/3 QUIC 漏洞，建议升级更新到 1.27.0

据悉&#xff0c;Nginx 1.25.0-1.26.0 主线版本中涉及四个与 NGINX HTTP/3 QUIC 模块相关的中级数据面 CVE 漏洞&#xff0c;其中三个为 DoS 攻击类型风险&#xff0c;一个为随机信息泄漏风险&#xff0c;影响皆为允许未经身份认证的用户通过构造请求实施攻击。目前已经紧急发布…
阅读更多...
【ARM-Linux篇】u-boot编译

【ARM-Linux篇】u-boot编译

一、u-boot简介 uboot是一种通用的引导加载程序&#xff0c;它可以用于多种嵌入式系统&#xff0c;支持多种操作系统&#xff0c;如Linux, Android,NetBSD等。uboot的主要作用是将操作系统内核从存储设备&#xff08;如Flash, SD卡等&#xff09;加载到内存中&#xff0c;并执…
阅读更多...
Thread的stop和interrupt的区别

Thread的stop和interrupt的区别

Thread.stop Thread.stop()方法已被废弃。 因为本质上它是不安全的&#xff0c;使用该方法可能会导致数据、资源不一致的问题&#xff0c; public class ThreadDemo {static class MyThread extends Thread {Overridepublic void run() {while (true) {try {Thread.sleep(10…
阅读更多...
C#WPF数字大屏项目实战03--数据内容区域

C#WPF数字大屏项目实战03--数据内容区域

1、内容区域划分 第一行标题&#xff0c;放了几个文本框 第二行数据&#xff0c;划分成3列布局 2、第1列布局使用UniformGrid控件 最外面放UniformGrid&#xff0c;然后里面放3个GroupBox控件&#xff0c;这3个groupbox都是垂直排列 3、GroupBox控件模板 页面上的3个Group…
阅读更多...
基于SSM的“健身俱乐部网站”的设计与实现（源码+数据库+文档)

基于SSM的“健身俱乐部网站”的设计与实现（源码+数据库+文档)

基于SSM的“健身俱乐部网站”的设计与实现&#xff08;源码数据库文档) 开发语言&#xff1a;Java 数据库&#xff1a;MySQL 技术&#xff1a;SSM 工具&#xff1a;IDEA/Ecilpse、Navicat、Maven 系统展示 系统功能结构图 用户注册界面图 系统登录界面 添加管理员账户界面…
阅读更多...
微服务架构-微服务实施

微服务架构-微服务实施

目录 一、概述 二、微服务拆分 2.1 概述 2.2 拆分原则 2.3 拆分方法 2.3.1 以数据为维度进行拆分 2.3.2 按照使用场景拆分 2.3.3 重要和非重要的拆分 2.3.4 变和不变的拆分 三、微服务通信 3.1 概述 3.2 微服务通信方式选择 3.3 微服务编排 3.4 API接口设计 3.5 …
阅读更多...
CANDela studio新建和编辑服务

CANDela studio新建和编辑服务

服务定义和编辑只能够在CDDT里面进行&#xff0c;思路分为三步&#xff1a; 1、Protocol Services里面添加服务&#xff0c;定义服务的格式、请求和正负响应。 2、根据服务的功能归类到Diagnostic Class Tenplates 3、Variant里面的Supported Diagnostic Classes勾选 然后我…
阅读更多...
CrossOver支持M4新品吗？苹果M4芯片对游戏支持的怎么样？

CrossOver支持M4新品吗？苹果M4芯片对游戏支持的怎么样？

CrossOver是一款可以在不同平台之间无缝切换的软件&#xff0c;它可以让你在MacOS或者Linux操作系统上运行Windows应用程序&#xff0c;无需安装双系统或虚拟机。CrossOver是基于Wine项目开发的&#xff0c;Wine是一个可以在非Windows平台上运行Windows应用程序的兼容层。 那么…
阅读更多...
十四天学会Vue——Vue核心下篇（理论+实战）（第三天）

十四天学会Vue——Vue核心下篇（理论+实战）（第三天）

一、Vue核心下篇 1.15 常用的内置指令 1. v-text <!--准备好一个容器 --><div id"root"><!-- 1.v-text中的字符替换掉div整个字符 --><div v-text"name">你好,{{name}}</div><!-- 2.将标签当做字符串解析 --><di…
阅读更多...
前端3剑客（第1篇）-初识HTML

前端3剑客（第1篇）-初识HTML

100编程书屋_孔夫子旧书网 当今主流的技术中&#xff0c;可以分为前端和后端两个门类。 前端&#xff1a;简单的理解就是和用户打交道 后端&#xff1a;主要用于组织数据 而前端就Web开发方向来说&#xff0c; 分为三门语言&#xff0c; HTML、CSS、JavaScript 语言作用HT…
阅读更多...
文件夹损坏0字节：原因、恢复方案与预防措施

文件夹损坏0字节：原因、恢复方案与预防措施

在使用电脑或移动设备时&#xff0c;我们有时会遇到文件夹突然损坏并显示为0字节的情况。这种故障不仅令人困惑&#xff0c;更可能导致重要数据的丢失。本文将深入探讨文件夹损坏0字节的现象&#xff0c;分析其产生的原因&#xff0c;并给出两种有效的数据恢复方案&#xff0c;…
阅读更多...
特别实用的8个机器学习算法总结！建议收藏，反复观看！

特别实用的8个机器学习算法总结！建议收藏，反复观看！

个人主页&#xff1a;.Boss.-CSDN博客 目录 1.线性回归&#xff08;Linear Regression&#xff09; 2.多项式回归&#xff08;Polynomial Regression&#xff09; 3.岭回归&#xff08;Ridge Regression&#xff09; 4.Lasso回归&#xff08;Lasso Regression&#xff09; …
阅读更多...
Linux sudo用户权限管理小实验001

Linux sudo用户权限管理小实验001

Linux sudo用户权限管理和审计-初步 1、设置历史指令的保存数量 默认history指令可以查看当前用户执行的1000条历史命令的条目 2、使用export指令设置HISTSIZE环境变量的数量为999999条。 3、基于date指令&#xff0c;输出日期和时间 4、设置linux系统history相关变量&…
阅读更多...
【Springboot】——项目的创建与请求参数应用

【Springboot】——项目的创建与请求参数应用

&#x1f4bb;博主现有专栏&#xff1a; C51单片机&#xff08;STC89C516&#xff09;&#xff0c;c语言&#xff0c;c&#xff0c;离散数学&#xff0c;算法设计与分析&#xff0c;数据结构&#xff0c;Python&#xff0c;Java基础&#xff0c;MySQL&#xff0c;linux&#xf…
阅读更多...
【Qt秘籍】[001]-从入门到成神-前言

【Qt秘籍】[001]-从入门到成神-前言

一、Qt是什么&#xff1f;[概念] Qt是一个跨平台的应用程序开发框架&#xff0c;简单来说&#xff0c;它是一套工具和库&#xff0c;帮助软件开发者编写可以在多种操作系统上运行的图形用户界面&#xff08;GUI&#xff09;应用程序。比如&#xff0c;你用Qt写了一个软件&#…
阅读更多...
Spring-Cloud-CircuitBreaker-Resilience4j （3.1.1）

Spring-Cloud-CircuitBreaker-Resilience4j （3.1.1）

介绍 Resilience4j 是一个专为函数式编程而设计的轻量级容错库。Resilience4j 提供高阶函数&#xff08;装饰器&#xff09;&#xff0c;以增强任何功能接口、lambda 表达式或方法引用&#xff0c;包括断路器、速率限制器、重试或隔板。您可以在任何函数接口、lambda 表达式或…
阅读更多...
LeeCode热题100（两数之和）

LeeCode热题100（两数之和）

本文纯干货&#xff0c;看不懂来打我&#xff01; 自己先去看一下第一题的题目两数之和&#xff1a;. - 力扣&#xff08;LeetCode&#xff09; 简单来说就是让你在一个数组里面找两个数&#xff0c;这两个数的和必须满足等于目标值target才行。 我认为你要是没有思路的话&a…
阅读更多...
CANDela studio基础使用

CANDela studio基础使用

ECU Information 可以修改ECU的名称 里面有个Supported Interfaces&#xff0c;可以在CDDT里面选择支持的通讯接口 可以在tools下面新建internface&#xff0c;也可以从其他CDDT文件里面复制过来&#xff0c;复制的时候注意要另外将里面的参数再复制一次。 也可以在这里点击新…
阅读更多...
Spring Boot 官方不再支持 Spring Boot 的 2.x 版本！新idea如何创建java8项目

Spring Boot 官方不再支持 Spring Boot 的 2.x 版本！新idea如何创建java8项目

idea现在只能创建最少jdk17 使用 IDEA 内置的 Spring Initializr 创建 Spring Boot 新项目时&#xff0c;没有 Java 8 的选项了&#xff0c;只剩下了 > 17 的版本 是因为 Spring Boot 官方不再支持 Spring Boot 的 2.x 版本了&#xff0c;之后全力维护 3.x&#xff1b;而 …
阅读更多...
SpringBoot 七牛云 OSS 私有模式 获取访问链接

SpringBoot 七牛云 OSS 私有模式 获取访问链接

目录 一、问题引出 二、在SpringBoot中获取私有访问路径的操作 一、问题引出 由于七牛云OSS的公有模式存在被盗刷的风险&#xff0c;可能导致服务器额外的费用&#xff0c;于是我选择私有模式进行操作。私有模式的访问路径是一个问题&#xff0c;因为需要对应着token和e这两…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023