【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.htmlon 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"><localInspectionlanguage="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@Overridepublic 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;}@Overridepublic 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.mzph.cn/news/610338.shtml

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

相关文章

Oracle之 第三篇 PL/SQL基础

Oracle之 第三篇 PL/SQL基础

目录 Oracle之 第三篇 PL/SQL基础 PL/SQL程序块 PL/SQL语言 PL/SQL的基本结构 PL/SQL块分类 一、PL/SQL语言 二、PL/SQL 常量 、变量 合法字符 数据类型 LOB 数据类型 属性类型 运算符 常量 PL/SQL常量 1 、变量的声明 2、属性类型 % type 变量赋值 %type…
阅读更多...
NR cell配置带宽时，如何设置carrierBandwidth？

NR cell配置带宽时，如何设置carrierBandwidth？

NR中带宽在38.101中有规定。 如上是FR1 38.101-1中与带宽设定有关的table&#xff0c;协议中根据SCS规定的传输带宽和可以配置的RB 数如上表&#xff0c;也就是说在实网下或者lab测试配置带宽时要根据上表内容去配置&#xff0c;举例如下。 如上图分别是几种带宽的配置参数&…
阅读更多...
Matlab绘制双纵轴图（yyaxis函数）

Matlab绘制双纵轴图（yyaxis函数）

一、方法一yyaxis函数 x linspace(0,pi); y1 cos(x); yyaxis left; % 激活左边的轴 plot(x,y1) xlabel(X-axis); ylabel(left Y-axis); % 给左y轴添加轴标签hold on yyaxis right; % 激活右边的轴 y2 cos(2*x); plot(x,y2) ylim([-1,1]); % 设置右y轴的界限 ylabel(right Y…
阅读更多...
【前端】前后端的网络通信基础操作（原生ajax, axios, fetch）

【前端】前后端的网络通信基础操作（原生ajax, axios, fetch）

概述 前后端网络请求工具 原生ajaxfetch apiaxios GET和POST请求 get只能发纯文本 post可以发不同类型的数据&#xff0c;要设置请求头&#xff0c;需要告诉服务器一些额外信息 测试服务器地址 有一些公共的测试 API 可供学习和测试用途。这些 API 允许你发送 HTTP 请求…
阅读更多...
24年全国31省份教师资格笔试报名时间汇总报名材料❗

24年全国31省份教师资格笔试报名时间汇总报名材料❗

✅教资报考必备材料&#xff1a;个人证件照、个人证件照材料、个人证件照。 &#x1f550;全国各地区报名时间汇总&#xff1a; 北京 1月12日-15日15:00 广东 1月12日9:30至15日16:00 山东 1月12日-15日15:00 江苏 1月12日-15日12:00 吉林 1月12日-15日16:00 四川 1月12日-15日…
阅读更多...
私域新手必看：这可能是你最快速的入门指南！

私域新手必看：这可能是你最快速的入门指南！

一、认知层&#xff1a;为什么必须做私域&#xff1f; 了解这个问题&#xff0c;必须得观察一下中国现状。根据中国互联网络信息中心&#xff08;CNNIC&#xff09;发布第48次《中国互联网络发展状况统计报告》显示&#xff0c;截至 2021 年 6 月&#xff1a; 而典型电商平台的…
阅读更多...
电口模块SFP-GE-T常见问题解答

电口模块SFP-GE-T常见问题解答

电口模块SFP-GE-T是一种常见的网络设备&#xff0c;用于实现光电信号的转换。在使用电口模块SFP-GE-T的过程中&#xff0c;可能会遇到一些问题。本文将为您解答一些常见问题&#xff0c;并提供一些使用技巧。 一、电口模块SFP-GE-T怎么用&#xff1f; 使用电口模块SFP-GE-T的…
阅读更多...
【手搓深度学习算法】用逻辑回归分类双月牙数据集-非线性数据篇

【手搓深度学习算法】用逻辑回归分类双月牙数据集-非线性数据篇

用逻辑回归分类-非线性数据篇 前言 逻辑斯蒂回归是一种广泛使用的分类方法&#xff0c;它是基于条件概率密度函数的最大似然估计的。它的主要思想是将输入空间划分为多个子空间&#xff0c;每个子空间对应一个类别。在每个子空间内部&#xff0c;我们假设输入变量的取值与类别…
阅读更多...
2024年寒假即将来临 如何实现高质量亲子陪伴?

2024年寒假即将来临 如何实现高质量亲子陪伴?

近日,各地陆续公布了寒假放假时间安排,孩子们期待着迎来一个休闲和轻松的假期。然而,对于许多家长来说,他们也意识到寒假不仅是一个放松的时间,更是一个增进亲子关系的宝贵机会,可以为孩子提供有意义的学习陪伴。 自“双减”政策落地后,学生的课业负担减轻许多,拥有了更多的空余…
阅读更多...
【leetcode 2707. 字符串中的额外字符】动态规划 字典树

【leetcode 2707. 字符串中的额外字符】动态规划 字典树

2707. 字符串中的额外字符 题目描述 给你一个下标从 0 开始的字符串 s 和一个单词字典 dictionary 。你需要将 s 分割成若干个 互不重叠 的子字符串&#xff0c;每个子字符串都在 dictionary 中出现过。s 中可能会有一些 额外的字符 不在任何子字符串中。 请你采取最优策略分割…
阅读更多...
Go 如何处理死锁以提供哪些工具来检测或防死锁？

Go 如何处理死锁以提供哪些工具来检测或防死锁？

并发是 Go 的核心特性&#xff0c;它使程序能够同时处理多个任务。它是现代编程的一个强大组件&#xff0c;如果使用正确&#xff0c;可以产生高效、高性能的应用程序。然而&#xff0c;并发性也带来了顺序编程中不存在的某些类型错误的可能性&#xff0c;其中最臭名昭著的是死…
阅读更多...
拼多多API的未来：无限可能性和创新空间

拼多多API的未来：无限可能性和创新空间

拼多多&#xff0c;作为中国电商市场的巨头之一&#xff0c;自成立以来一直保持着高速的发展态势。其API的开放为开发者提供了无限的可能性和创新空间&#xff0c;使得更多的商业逻辑和功能得以实现。本文将深入探讨拼多多API的未来发展&#xff0c;以及它所具备的无限可能性和…
阅读更多...
面相圆润是有福气的象征

面相圆润是有福气的象征

在中国传统文化中&#xff0c;面相是一个非常重要的概念。相信大家肯定听说过“相由心生”这个成语吧&#xff0c;这就是告诉我们&#xff0c;一个人的面貌其实是可以反映出他内心的状态和气质&#xff0c;也可以反映其性格、健康状况和运势等。而一个圆润的面相&#xff0c;则…
阅读更多...
游泳耳机排行榜前四名，分享几款值得推荐的游泳耳机

游泳耳机排行榜前四名，分享几款值得推荐的游泳耳机

游泳是一项全面锻炼身体的运动&#xff0c;然而&#xff0c;水的阻力有时让人感到运动的笨拙和单调。为了让游泳更具趣味性和挑战性&#xff0c;选择一款高品质的游泳耳机至关重要。以下是游泳耳机排行榜前四名&#xff0c;以及几款强烈推荐的游泳耳机&#xff0c;它们结合防水…
阅读更多...
火狐谷歌兼容性问题整理

火狐谷歌兼容性问题整理

火狐谷歌兼容性问题整理 整理近期项目中遇到的火狐浏览器和谷歌浏览器兼容性问题。 数字输入框实现功能&#xff1a;限制输入框可输入内容类型为Number类型&#xff0c;其他类型不可输入。 &#xff08;1&#xff09;错误实现方法&#xff1a; 此方式在谷歌浏览器中可以实现&…
阅读更多...
【QT-UI】

【QT-UI】

1.使用手动连接&#xff0c;将登录框中的取消按钮使用qt4版本的连接到自定义的槽函数中&#xff0c;在自定义的槽函数中调用关闭函数 #include "mainwindow.h" #include "ui_mainwindow.h"MainWindow::MainWindow(QWidget *parent): QMainWindow(parent), …
阅读更多...
Python中级知识梳理

Python中级知识梳理

1. 文件操作 Python中的文件操作通常使用内置的open()函数来打开文件。以下是一个简单的示例&#xff1a; with open("file.txt", "r") as f:content f.read()print(content)在这个示例中&#xff0c;我们打开了名为"file.txt"的文件&#xf…
阅读更多...
mac 快捷键

mac 快捷键

mac 程序坞 ctrlaltD:打开程序坞 调度中心 Ctrl键↑: 调度中心 Ctrl键↓:应用程序窗口 F11 : 显示桌面 输入法 Ctrl键空格: 切换输入法 Ctrl键Alt(Option)空格: 切换输入法 截屏 帮助 Ctrl键shift键/: 显示帮助
阅读更多...
使用 CSS : 伪元素:after、过渡动画transition实现过渡效果（鼠标悬浮或点击 标签时，底部边框从左到右过渡）

使用 CSS : 伪元素:after、过渡动画transition实现过渡效果（鼠标悬浮或点击 标签时，底部边框从左到右过渡）

首先&#xff0c;给 <span> 标签添加一个父元素&#xff0c;定义属性类名&#xff1a;nav-wrapper &#xff0c;父级设置相对定位。然后&#xff0c;使用 ::after 伪元素来创建一个与底部边框相同宽度的元素&#xff0c;初始时宽度为 0&#xff0c;通过过渡动画transitio…
阅读更多...
「服务器」4.新手小白如何安装服务器环境-宝塔

「服务器」4.新手小白如何安装服务器环境-宝塔

刚开始初始化好的服务器&#xff0c;使用了阿里云客户端&#xff0c;看着网络脚本乱装&#xff0c;后来决定宝塔环境发现有重复的环境&#xff0c;遂决定重新初始化一下&#xff0c;然后重头干起。 重置服务器 将服务器关闭运行状态后&#xff0c;点击重新初始化云盘即可重新初…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023