idea配置记录_ideal 识别<#if count!=0>-优快云博客

本文链接：https://blog.youkuaiyun.com/mikumiku5/article/details/146029968

以后可能有配置电脑新环境的情况，作为一个java程序员，我自然使用的ide也是idea，为了能够快速配置好idea环境，我打算将一些常用的插件及设置记录下来，但由于我使用的是idea2024，可能存在很少部分的插件不存在等情况，比如阿里的代码规范插件Alibaba Java Coding Guidelines，但在2024版的插件市场里也是有几乎一样的插件的，idea插件官网地址：JetBrains Marketplace

一.插件

我就根据字母序来依次记录我现在使用中的插件，并且可能存在一些插件使用有问题或配置不够详细的问题，可以根据插件名称查询具体用法

1.Adapter for Eclipse Code Formatter

在这里插入图片描述

这是一个用于idea中格式化代码的插件，安装完毕后，还需要进行一定的配置，可以自行配置格式化代码的模板，这里我推荐阿里的Java代码格式规范，该代码格式文件地址为：阿里github源文件地址，下载完毕后，点开设置，Settings -> Other Settings -> Adapter for Eclipse Code Formatter中找到配置页，注意图中标记的地方要选中以启用该插件，并设置刚才下载好的代码格式配置文件，后续格式化的时候就会按照该代码规范来格式化了，格式化的快捷键是ctrl + alt + l

在这里插入图片描述

2.Alibaba Java Coding Guidelines

这个和第1个插件是配套的，是检测代码规范的一个插件，同样也是按照阿里的Java开发规范来的，所以第一个建议使用阿里的代码规范模板，在插件市场中，若idea是2021版本的应该直接就能搜到名字一摸一样的，直接下载就行，若是idea2024的，会出现两个版本，如下所示

在这里插入图片描述

我用的是第二个，第一个我也没试过，自行看情况选择即可，一些不符合其规范的代码，它会标记出来，至于其他idea版本我没用过，不过应该也就这两种情况，稍微值得注意一点的情况是，默认它是实时扫描的，如果电脑性能不太好的话，且当前项目代码比较多的话，可能会比较卡，此时可以右键项目，点击关闭实时扫描

在这里插入图片描述

3.Apifox Helper

在这里插入图片描述

Apifox是一个集接口文档、测试等一体的工具，和swagger类似，不过它是单独的一个应用软件，和它类似的还有EasyYapi等，目前由于我在一家小公司，前后端联调工具也是使用的它，比起swagger它的功能更多也更方便，使用它在idea里的插件也就是这个Apifox Helper，可以直接右键就自动将接口上传为接口文档，并可自由编辑，最重要的是它不像swagger那样对代码的侵入度极高，它会扫描接口上的各种注解或注释来生成文档，但对于一些对代码有保密度的公司来说，可能不太好，也许会存在代码泄漏的风险，可能更倾向于本地化部署EasyYapi等方案，具体Apifox及插件Apifox Helper的使用推荐网上搜索更详细的文档

4.CodeGlance Pro

在这里插入图片描述

这是一个在idea中右侧显示代码缩略图的插件，并且可以直接在缩略图上拖动在寻找代码块，是我十分推荐的一个插件

在这里插入图片描述

5.Easy Javadoc

在这里插入图片描述

这是一个能够快速生成类、方法、属性的注释的工具，快捷键是ctrl + \，需要一定的配置，目前只给我出我的配置，更详细的配置可以自行搜索，首先点击设置Settings -> Other Settings -> EasyDoc，首先需要配置一下翻译，他会根据需要注释部分的名称如方法名类名生成，可以网上自行寻找翻译api获取App ID和Secret，我使用的就是百度翻译，是免费的，用的是其通用文本翻译，百度翻译开放平台

在这里插入图片描述

接着点击Settings -> Other Settings -> EasyDoc -> EasyDocJavadoc，可以根据需求自定义配置

在这里插入图片描述

6.Generate All Getter And Setter

在这里插入图片描述

这是一个为pojo类快速调用get和set方法的插件，只需要在变量后面加上.allget或.allset即可调用调用所有的get方法或set方法，使用起来十分方便，和这个类似的还有一个GenerateAllSetter插件，首先需要该pojo类的实现存在，且要在实现处使用alt + enter或右键才能在其实现位置后生成方法，调用没有这个插件那么灵活，不过这个插件目前我使用下来好像存在bug，就是对于泛型类型的会失效

在这里插入图片描述

7.Grep Console

在这里插入图片描述

这是一个可以可以配置idea中控制台打印输出的插件，默认安装后对于不同等级的日志标记更加醒目，也有更多关于idea中控制台的配置可以自行搜索

8.Maven Helper

在这里插入图片描述

这是一个maven相关的插件，主要用来解决maven的依赖冲突

9.MyBatisX

在这里插入图片描述

该插件主要用于生成代码，通过idea里连接数据库，然后右键表弹出生成代码选项，完成后即可生成代码，如基础的实体类、mapper、service等，刚开始一直在用，但由于自定义模板配置比较麻烦，我已经转为使用easycode了，我之前使用如下：

使用该插件可以自动生成实体类、mapper相关类、service相关类。使用方法为：首先需要在idea中连接数据库，连接成功后，在相关表上右键会出现该插件的名称

在这里插入图片描述

点击后会弹出代码生成选项弹窗，一般项目第一次使用会选择module path，其他选项默认即可，然后点击next即可

在这里插入图片描述

下一步弹窗一般按照图中勾选即可

在这里插入图片描述

根据前面的选项，默认代码是生成在src/main/java/generator目录下，xml则是在resources/mapper下

在这里插入图片描述

一般来说然后将对应文件拖到对应项目实际需要目录中即可，idea会提示重构的，若还是报错，可能是移动文件的顺序不对，可能是包名不对引起的，接着根据实际情况修改一下代码即可，比如类的注释、实体类中主键生成规则注解、TableLogic注解，最后看一下对应列的类型是否符合要求，一般是正确的

10.Nyan Process Bar

一个进度条插件，会展示成彩虹猫的样式，实际上插件里搜索Process Bar还有许多不同的进度条插件

11.One Dark Theme

在这里插入图片描述

idea主题插件，安装后主题颜色以及不同代码的颜色也会变化，我觉得较安装之前区分度更高

在这里插入图片描述

12.Ranbow Brackets Lite

在这里插入图片描述

是Ranbow Brackets免费版，我觉得够用了，可以让多层括号以不同的颜色展示，使得代码更加清晰

13.TONGYI Lingma

阿里的通义灵码AI辅助编程插件，我认为是idea里最好用的一个了

14.easycode

用于生成代码，现在主要使用的代码生成插件，目前我可以通过自己写的模板，根据表一键生成对应的从controller、service、mapper、实体类等相关的增删改查涉及到的代码，对于一些简单的增删改查功能能节约许多时间。它的用法和前面的MyBatisX差不多，都是在数据库表上右键，它可以配置自己的代码模板，使用的模板引擎是velocity，简单学习一下语法即可，当总结出自己的一套代码习惯后，就可以尝试写一套自己的模板，其实方法也比较简单，就是把写的相关代码作为模板的基础，然后慢慢将一些字段替换为通用的名称即可，比如XXXController、XXXService

在这里插入图片描述

二.配置

1.类注释

一般我常用的类的注释是长这样的

/**
 * 关于类的一些描述
 *
 * @author wulinxuan
 * @date 2025-02-14 14:12
 */

当然也可以使用其他注解来描述，比如@Version，@Description，@Since，还涉及到首字母大不大写，比如@Author或@author等等，这都是看个人习惯以及团队风格来的，没有对错。我的习惯一般像上方展示的那样，@author描述作者，@date描述类的创建日期，并且如果有描述的话，会和下方的@author隔开一行

idea默认创建类的时候是不会有任何类注释的，此时就需要我们自己去配置，路径为File -> settings -> Editor -> File and Code Templates，此时候选择Files项中的Class，如下图所示

在这里插入图片描述

此时将内容修改为图上的这样即可，内容如下

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};

#end
#parse("File Header.java")
/**
 * @author wulinxuan
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 */
public class ${NAME} {
}

参考文章：IDEA类和方法注释模板设置（非常详细）_idea 类注释模板-优快云博客

2.idea注释插件

idea在创建方法的时候是不会自动创建方法注释的，需要手动添加，我们一般手动添加的习惯是/** + enter，包括给类手动添加注释也是，如果自定义这些模板的话十分麻烦，比如方法注释中还涉及到参数、返回值，可能还要配合groovy脚本，所以手动生成注释我选择使用idea的一个插件：Easy Javadoc

在这里插入图片描述

安装好后还需要一定的配置，路径为File -> settings -> Other Settings -> EasyDoc，首先需要在通用配置配置一下翻译的方式，就是它会将对应的英文翻译为中文，比如类名、方法名、参数名，里面有许多种翻译方式可以选择，当然也可以选择不翻译，我这里就选择百度翻译，并使用其通用文本API，地址为：百度翻译开放平台，这个API用免费版本完全足够，然后用申请的key和secret填进配置即可

在这里插入图片描述

接着是生成注释的模式等，我的配置如下

在这里插入图片描述

使用方式为将光标移到对应方法、类名或字段，然后按ctrl + \，生成全部文档是ctrl + shift + \，若遇到快捷键冲突，可以在设置里搜索冲突的，然后解决即可，比如我这里就直接将原来绑定的的移除掉

在这里插入图片描述

参考文章：IDEA插件系列（3）：Easy Javadoc插件——快速生成javadoc文档注释-优快云博客

3.实时模板

实时模板(Live Templates)是idea提供的快捷代码生成工具，就是我们平时在idea中输入main、psvm出现提示然后直接enter就会生成预定的代码片段功能，我们也可以适当的将其利用起来，加快我们的开发。首先设置位置位于File -> settings -> Editor -> Live Templates，然后选择其中的Java

在这里插入图片描述