【idea】idea插件编写教程，博主原创idea插件 欢迎下载

前言：经常使用Objects.equals(a,b)方法的同学 应该或多或少都会因为粗心而传错参， 例如日常开发中 我们使用Objects.equals去比较 status(入参)，statusEnum(枚举), 很容易忘记statusEnum.getCode() 或 statusEnum.getVaule() ，再比如 我们比较一个订单code时 orderCode(入参),orderDTO(其它业务对象) 很容易忘记orderDTO.getCode() 因为Objects.equals()两个参数都是Object类型，idea默认不会提示告警, 如果经常使用该方法 你一定很清楚的明白我在说什么。

针对以上痛点，博主编写了一个idea插件: Equals Inspection , 插件代码本身很简单，极其轻量级。难得的是 在目前暂没发现有人做了这件事时，而博主想到了可以通过IDE告警方式去解决问题，并且实际行动了。此外，知道该用什么API本身是件不容易的事，而阅读代码时，已经处于一个上帝视角，则会显得非常简单。

Q：为什么是IDE插件层面，而不是在java项目中重写一个工具类 针对类型判断呢？
A：
1.效率问题:java项目代码判断 说明要执行到该方法时才能校验，很多时候我们编写完，在测试环节被提了bug，我们自己断点执行一遍，才能发现传错了参，插件层面在我们编写时即可提醒，节省了大量时间.

2.设计问题: 很重要的一点，java项目层面的提示，要怎么提示？throw new RuntimeExection? 显然不太合理吧，例如在设计一些框架/通用代码时，类型就是可以不一致 难道抛一个异常阻止程序运行吗？插件尽管会提示报错，但它归根结底都只是一个样式，并不会阻止程序运行。

使用前后效果对比：

使用前没有告警
在这里插入图片描述

使用后示例：

在这里插入图片描述
vo.getStatus(Integer类型)与枚举比较时，能直接提示我们类型不一致
（正确写法是StatusEnum.AWAIT.getValue() 与枚举类型的值进行比较）
在这里插入图片描述

以下就以博主编写的插件为例 ，写一篇如何编写idea插件的教程

注：本文由csdn博主 孟秋与你 编写，如您在其它地方看到本文，很可能是被其它博主爬虫/复制过来的，文章可能会持续更新，强烈建议您搜索：孟秋与你csdn 找到原文查看

第一步：创建插件项目
tips:
1.需要jdk11
2.以idea2021.1版本为例，不同idea版本可能有所差异

new project ->IntelliJ Platform Plugin-> Project SDK (需要jdk11)

在这里插入图片描述

第二步：修改plugin.xml文件内容及创建java代码

其中plugin.xml的description节点，需要40个字符以上，否则插件上传时会报错。

编写插件的核心难点在于，我们不知道idea的api是什么，什么情况用什么api。
以下是可以参考的几点：

  1. idea官方文档 https://plugins.jetbrains.com/docs/intellij/welcome.html
  2. github idea 示例项目:https://github.com/JetBrains/intellij-sdk-code-samples
<idea-plugin>
  <id>csdn-mengqiuyuni</id>
  <name>Equals参数类型检查</name>
  <version>0.1.0</version>
  <vendor email="1005738053@qq.com" url="https://blog.csdn.net/qq_36268103"> </vendor>

  <description><![CDATA[
      <li>check java.lang.Objects equals method params type ,if not match,idea will show the error line</li><br>
      <li>could reduce Objects.equals(a,b) error params type by mistake</li><br>
      <li>notice:this plugin can only inspect your code,it's just reminder java developers,but don't impact code execution,and never change or fix your code.</li>
    ]]></description>

  <change-notes><![CDATA[
      <li>github:qiuhuanhen,project name :objects-equals-inspect</li><br>
      <li>beta version.csdn:孟秋与你</li><br>
      <li>the first beta version,welcome,update date:2024.01.09</li>
    ]]>
  </change-notes>

  <vendor>qiuhuanhen</vendor>

  <!-- please see https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html for description -->
  <idea-version since-build="173.0"/>

  <!-- please see https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html
       on how to target different products -->
  <depends>com.intellij.modules.platform</depends>
  <depends>com.intellij.java</depends>
  <depends>com.intellij.modules.java</depends>

  <extensions defaultExtensionNs="com.intellij">
    <localInspection
            language="JAVA"
            displayName="Title"
            groupPath="Java"
            groupBundle="messages.InspectionsBundle"
            groupKey="group.names.probable.bugs"
            enabledByDefault="true"
            level="ERROR"
            implementationClass="com.qiuhuanhen.ObjectsEqualsInspection"/><!--java类所在路径-->
  </extensions>

</idea-plugin>


package com.qiuhuanhen;

import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.ProblemHighlightType;
import com.intellij.codeInspection.ProblemsHolder;
import com.intellij.psi.*;
import org.jetbrains.annotations.NotNull;


/**
 * @author qiuhuanhen
 */
public class ObjectsEqualsInspection extends LocalInspectionTool {

    @NotNull
    @Override
    public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
        return new MyVisitor(holder);
    }

    private static class MyVisitor extends JavaElementVisitor {
        private final ProblemsHolder holder;

        public MyVisitor(ProblemsHolder holder) {
            this.holder = holder;
        }

        @Override
        public void visitMethodCallExpression(PsiMethodCallExpression expression) {
            super.visitMethodCallExpression(expression);

            String methodName = expression.getMethodExpression().getReferenceName();

            if ("equals".equals(methodName)) {

                PsiExpressionList argumentList = expression.getArgumentList();
                PsiExpression[] expressions = argumentList.getExpressions();


                if (expressions.length == 2) {
                    PsiType arg1Type = expressions[0].getType();
                    PsiType arg2Type = expressions[1].getType();

                    // 都为空 不做提示  注：即使idea会提示 type不为空 ，为防止插件报NPE 还是有大量的非空判断
                    if (null == arg1Type && null == arg2Type) {
                        return;
                    }

                    // 其一为空 给出错误提示
                    if (null == arg1Type || null == arg2Type) {
                        holder.registerProblem(expression, "Objects.equals parameters are not of the same type.", ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
                        return;
                    }
                    // 这是忽视某些通用类，框架 用于比较反射class类型的情况
                    if (arg1Type.getCanonicalText().contains("Class") && arg2Type.getCanonicalText().contains("Class")) {
                        return;
                    }

                    if (isByte(arg1Type) && isByte(arg2Type)) {
                        return;
                    }
                    if (isShort(arg1Type) && isShort(arg2Type)) {
                        return;
                    }
                    if (isInt(arg1Type) && isInt(arg2Type)) {
                        return;
                    }
                    if (isLong(arg1Type) && isLong(arg2Type)) {
                        return;
                    }
                    if (isFloat(arg1Type) && isFloat(arg2Type)) {
                        return;
                    }
                    if (isDouble(arg1Type) && isDouble(arg2Type)) {
                        return;
                    }
                    if (isChar(arg1Type) && isChar(arg2Type)) {
                        return;
                    }
                    if (isBoolean(arg1Type) && isBoolean(arg2Type)) {
                        return;
                    }


                    if (!arg1Type.equals(arg2Type)) {

                        holder.registerProblem(expression, "Objects.equals parameters are not of the same type.", ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
                    }
                }
            }
        }

        private boolean isInt(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.INT.equals(unboxedType)) {
                // 是 int 类型
                return true;
            }

            return PsiType.INT.equals(type) || "java.lang.Integer".equals(type.getCanonicalText());
        }

        private boolean isLong(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.LONG.equals(unboxedType)) {
                // 是 long 类型
                return true;
            }

            return PsiType.LONG.equals(type) || "java.lang.Long".equals(type.getCanonicalText());
        }

        private boolean isDouble(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.DOUBLE.equals(unboxedType)) {
                return true;
            }

            return PsiType.DOUBLE.equals(type) || "java.lang.Double".equals(type.getCanonicalText());
        }

        private boolean isFloat(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.FLOAT.equals(unboxedType)) {
                return true;
            }

            return PsiType.FLOAT.equals(type) || "java.lang.Float".equals(type.getCanonicalText());
        }

        private boolean isBoolean(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.BOOLEAN.equals(unboxedType)) {
                return true;
            }

            return PsiType.BOOLEAN.equals(type) || "java.lang.Boolean".equals(type.getCanonicalText());
        }

        private boolean isByte(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.BYTE.equals(unboxedType)) {
                return true;
            }

            return PsiType.BYTE.equals(type) || "java.lang.Byte".equals(type.getCanonicalText());
        }

        private boolean isChar(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.CHAR.equals(unboxedType)) {
                return true;
            }

            return PsiType.CHAR.equals(type) || "java.lang.Char".equals(type.getCanonicalText());
        }

        private boolean isShort(PsiType type) {
            PsiPrimitiveType unboxedType = PsiPrimitiveType.getUnboxedType(type);
            if (PsiType.SHORT.equals(unboxedType)) {
                return true;
            }

            return PsiType.SHORT.equals(type) || "java.lang.Short".equals(type.getCanonicalText());
        }

    }
}

第三步：打成jar包
在这里插入图片描述
没有main方法则不用选择main class
在这里插入图片描述
在这里插入图片描述

第四步：发布插件
在这里插入图片描述

发布插件没有什么难点，唯一值得注意的是description非常严格，必须要40个字符以上，且不能有非拉丁字符，博主在反复修改后发现不能有任何中文，最后把description里面的中文都改成了英文。

插件项目源码地址：https://github.com/qiuhuanhen/objects-equals-inspect
下载一：（ idea团队给博主发了邮件 插件最开始的命名不规范 目前在重新审核 不知道后续结果 先在github下载吧）
idea插件商店搜索： Equals Inspection

下载二：github https://github.com/qiuhuanhen/objects-equals-inspect

releases区
在这里插入图片描述
安装方式：1. 直接将jar包拖进idea，2.重启idea

打开项目方式：
在github下载博主的项目，idea打开后 默认是常规项目，这时我们需要稍作处理
在这里插入图片描述

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
最后一步：
在这里插入图片描述

最后: 原创不易 ，欢迎各位在idea插件商店下载Equals Inspection ， 给github项目点上star 非常感谢各位

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

运筹说 第90期 | 网络计划-图解评审法

运筹说 第90期 | 网络计划-图解评审法

前述章节的网络计划方法主要研究以时间为主要参数的确定型网络模型&#xff0c;其中的概率型网络模型也只讨论工作公式的不确定性&#xff0c;并没有对事项或工作的不确定性进行讨论。由于这类网络模型的建立有严格的规则&#xff0c;大量研究与开发类计划尚无法表达。因从本期…
阅读更多...
程序翻译过程详解

程序翻译过程详解

一、快速认识gcc和g gcc和g都是编译器&#xff0c;C语言可以用gcc或者是g来进行编译&#xff0c;但推荐使用gcc来进行编译。但C语言只能用g编译器来进行编译。 1.1语言和编译器的自举的过程 为了更好地认识gcc和g&#xff0c;在这里可以给大家介绍一下语言和编译器的自举的过程…
阅读更多...
盘点那些好用的知识库软件，赶紧收藏起来

盘点那些好用的知识库软件，赶紧收藏起来

知识库软件&#xff0c;这个听起来有些书呆子味道的工具&#xff0c;实际上在企业运营中起着至关重要的作用。它就像公司的大脑&#xff0c;储存着我们的知识&#xff0c;并在我们需要时随时供应。下面&#xff0c;我要向你推荐五款好用的知识库软件&#xff0c;让你的信息管理…
阅读更多...
开启C++之旅（下）：引用、内联函数及现代特性(auto和范围for循环）

开启C++之旅（下）：引用、内联函数及现代特性(auto和范围for循环）

上次介绍了&#xff1a;开启C之旅&#xff08;上&#xff09;&#xff1a;探索命名空间与函数特性&#xff08;缺省参数和函数重载&#xff09; 今天就接着进行c入门的知识讲解 文章目录 1.引用1.1引用概念1.2引用特性1.3常引用其他情况 1.4引用使用场景1.4.1做参数1.4.2做返回…
阅读更多...
.net core IResultFilter 的 OnResultExecuted和OnResultExecuting的区别

.net core IResultFilter 的 OnResultExecuted和OnResultExecuting的区别

//全局过滤器 builder.Services.AddMvc(m > { m.Filters.Add<AllResultFilter>(); }); 1、实现过滤器 public class AllResultFilter : IResultFilter {/// <summary>/// 结果执行后方法/// 不可更改结果/// </summary>/// <param name"con…
阅读更多...
vue下载文件流效果demo(整理)

vue下载文件流效果demo(整理)

在 Vue 项目中&#xff0c;你可以使用 FileSaver.js 库来方便地下载文件流。FileSaver.js 封装了不同浏览器的下载方式&#xff0c;使得下载文件更加简单和兼容。以下是一个完整的示例方法&#xff1a; 首先&#xff0c;安装 FileSaver.js 库&#xff1a; <template>&l…
阅读更多...
使用Go语言的HTTP客户端和服务器

使用Go语言的HTTP客户端和服务器

使用Go语言进行HTTP客户端和服务器开发是一种高效且强大的方式。Go语言的标准库提供了对HTTP协议的全面支持&#xff0c;使得创建HTTP客户端和服务器变得简单。 首先&#xff0c;让我们来看一下如何创建一个简单的HTTP服务器。在Go中&#xff0c;可以使用net/http包来创建HTTP…
阅读更多...
墙地砖外形检测的技术方案-图像分割

墙地砖外形检测的技术方案-图像分割

基础原理 由于对碗口进行缺口检测&#xff0c;因此只需要碗口的边界信息。得到陶瓷碗区域填充后的图像&#xff0c;对图像进行边缘检测。这是属于图像分割中的内容&#xff0c;在图像的边缘中&#xff0c;可以利用导数算子对数字图像求差分&#xff0c;将边缘提取出来。 案例…
阅读更多...
Odrive 学习系列三：在odrive工程中添加SEGGER RTT 日志输出功能

Odrive 学习系列三：在odrive工程中添加SEGGER RTT 日志输出功能

一、背景： 对于嵌入式来讲，有个日志输出真真真真的太重要啦！ SEGGER JLink自带的RTT日志输出对于老嵌入式而言更是开发利器。 Odrive本身的工程是不带这个功能的，尽管使用stlink可以查阅寄存器等，但感觉还是差了点意思。因此在本系列第二节的基础上，希望能给Odrive工程添…
阅读更多...
蓝桥杯AcWing学习笔记 9-2复杂DP的学习（下）

蓝桥杯AcWing学习笔记 9-2复杂DP的学习（下）

蓝桥杯 我的AcWing 题目及图片来自蓝桥杯C AB组辅导课 复杂DP&#xff08;下&#xff09; 非传统DP问题思考方式&#xff0c;全新的DP思考方式&#xff1a;从集合角度来分析DP问题——闫式DP分析法 例题 AcWing 1303. 斐波那契前 n 项和 矩阵乘法快速幂 此题并非dp问题…
阅读更多...
《 乱弹篇（三）》

《 乱弹篇（三）》

题记 前两篇《乱弹》&#xff0c;一是乱弹了“北宋名相寇准的《六悔铭》”&#xff0c;并议及“不择手段&#xff0c;只谋功利”&#xff1b;二是乱弹了晚清重臣、湘军统帅曾国藩的为官之道和处世哲学&#xff0c;并介绍了他在《冰鉴》一书里用来识人的对联和口诀。 这两篇《…
阅读更多...
网络安全自学入门：（超详细）从入门到精通学习路线规划，学完即可就业

网络安全自学入门：（超详细）从入门到精通学习路线规划，学完即可就业

很多人上来就说想学习黑客&#xff0c;但是连方向都没搞清楚就开始学习&#xff0c;最终也只是会无疾而终&#xff01;黑客是一个大的概念&#xff0c;里面包含了许多方向&#xff0c;不同的方向需要学习的内容也不一样。 算上从学校开始学习&#xff0c;已经在网安这条路上走…
阅读更多...
第08章_面向对象编程（高级）拓展练习(关键字:static,代码块,关键字:final,抽象类和抽象方法,接口,内部类,枚举类,注解,包装类)

第08章_面向对象编程（高级）拓展练习(关键字:static,代码块,关键字:final,抽象类和抽象方法,接口,内部类,枚举类,注解,包装类)

文章目录 第08章_面向对象编程&#xff08;高级&#xff09;拓展练习01-关键字&#xff1a;static1、银行账户类2、图形类3、数组工具类4、二分查找5、二分查找6、素数7、阅读代码&#xff0c;分析运行结果8、阅读代码&#xff0c;分析运行结果 02-代码块9、阅读代码&#xff0…
阅读更多...
【嘉立创EDA-PCB设计指南】1.PCB基本概念及原理图绘制

【嘉立创EDA-PCB设计指南】1.PCB基本概念及原理图绘制

前言&#xff1a;本文详解PCB基本概念以及实现MCU最小系统原理图的绘制&#xff08;原理图包括MCU芯片GD32F103C8T6、外部晶振、输出端口、USB输入口、5v转3v3稳压输出、复位按键、唤醒按键、LED&#xff09;。为本专栏后面章节实现PCB绘制做准备。 最终绘制的原理图如下所示&…
阅读更多...
鸿蒙开发-UI-布局-层叠布局

鸿蒙开发-UI-布局-层叠布局

鸿蒙开发-UI-布局 鸿蒙开发-UI-布局-线性布局 文章目录 前言 一、基本概念 二、对齐方式 三、Z序控制 四、使用场景 总结 前言 上文详细学习了线性布局&#xff0c;学习了线性容器内子元素在主轴以及交叉轴上的排列方式&#xff0c;子元素自适应相关的知识点&#xff0c;本文继…
阅读更多...
强化学习（二）多臂老虎机 “Multi-armed Bandits”——2

强化学习（二）多臂老虎机 “Multi-armed Bandits”——2

1、增量算法估计动作价值 由之前的内容可知&#xff0c;某一个动作被选择 n − 1 n-1 n−1 次后&#xff0c;该动作的价值估计值为 Q n ≐ R 1 R 2 ⋯ R n − 1 n − 1 Q_n\doteq\dfrac{R_1R_2\cdotsR_{n-1}}{n-1} Qn​≐n−1R1​R2​⋯Rn−1​​ 很明显&#xff0c;随着…
阅读更多...
小规模团队更适合什么样的客户管理系统？

小规模团队更适合什么样的客户管理系统？

小规模团队更适合什么样的客户管理系统&#xff1f; 一般情况下&#xff0c;小规模对客户管理系统的需求通常有以下特点&#xff1a; 团队规模&#xff1a;小规模&#xff0c;不超过10人——尽可能降低使用成本使用人员&#xff1a;销售人员使用——无代码基础&#xff0c;最…
阅读更多...
学习JavaEE的日子 day12 构造方法 类的制作

学习JavaEE的日子 day12 构造方法 类的制作

Day12 需求&#xff1a;创建人类的对象&#xff0c;并操作对象 分析&#xff1a; 人类 - Person 属性&#xff1a;name、sex、age 方法&#xff1a;eat、sleep 场景&#xff1a;创建多个对象&#xff0c;去操作对象 //测试类&#xff1a;该类中有main方法&#xff0c;测试我们写…
阅读更多...
Mybatis配置动态数据源以及参数传递等

Mybatis配置动态数据源以及参数传递等

Mybatis必知必会 一、Mybatis动态加载数据源 在配置数据源连接时,在企业的真实开发中数据源一般都会写在配置文件中&#xff0c;而不会直接写在mybatis的核心配置文件中 所以,Mybatis为了方便开发人员去动态的获取数据源连接制定了一些特定的标签用于加载这些数据源。 具体做法…
阅读更多...
【leetcode刷题】模拟专题

【leetcode刷题】模拟专题

模拟 一、替换所有的问号1、题目链接2、解析3、代码 二、提莫攻击1、题目链接2、解析3、代码 三、Z字形变换1、题目链接2、解析3、代码 四、外观数列1、题目链接2、解析3、代码 五、数青蛙1、题目链接2、解析3、代码 一、替换所有的问号 1、题目链接 leetcode链接 2、解析 3、…
阅读更多...
最新文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发 尧图建网站