实用配置
提示词忽略大小写
File -> Settings,找到Code Completion,把这个勾去掉,(有的idea版本是选择选项 选择none即可),例如String 输入string 、String 都可以提示
设置多行tab
idea默认是选择显示单行的,File -> Settings,找到Editor Tabs,如下图,我们把这个去掉,就可以显示多行tab
(注意:tab过多也会自动关闭,将settings -> editor -> General -> Editor tabs -> tab limit 数值设大就好)
自动导包、自动移除无用的包
File -> Settings,找到Auto Imports,勾选如下图即可
类注释模板
File -> Settings(快捷键:Ctrl + Alt + s) -> Editor -> File and Code Templates,设置需要配置注释的文件类型
选择需要配置注释的文件,填入以下内容
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
* packageName ${PACKAGE_NAME}
* @author 你的名字
* @version JDK 8
* @className ${NAME} (此处以class为例)
* @date ${DATE} ${TIME}
* @description TODO
*/
public class ${NAME} {
}
点击apply应用,效果如下
方法注释模板
File -> Settings(快捷键:Ctrl + Alt + s) -> Editor -> Live Templates,找到Java类目
点击右侧+号添加Live Template
Abbreviation中填写描述缩写;
Description 填写此Template的描述,任意字符都可;
右侧Options下面的勾选上;
右侧的Options选择Enter,含义为:方法签名写好后,输入/**后按Enter生成注释;
最下边的警告选择java勾选即可
在Template text中填写以下内容
**
* @description TODO
*
* @date $date$ $time$
* @author wangchengyun
$param$
* @return $return$
*/
然后点击右侧的Apply,再点击Edit variables
Param脚本如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters())
Return脚本如下:
groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())
点击apply应用,效果如下
设置鼠标悬浮提示
File –> settings –> Editor –> Code Editing 勾选Show quick documentation
关闭代码检查
关闭代码检查可以减少资源使用,但不推荐全部关闭,项目中不会使用到的关闭就行
File –> settings –> Editor –> Inspections
常用插件
插件安装
在线安装
通过 File > Settings > Plugins > Marketplac,搜索需要安装的插件,按照提示安装重启idea即可;
导入架包
通过 File > Settings > Plugins>设置图标>Install Plugin from Disk….,选择下载好的插件安装包,点击确定即可安装,最后按提示重启idea即可;
1、GenerateSerialVersionUID
在需要序列化的类使用Alt + Insert 快速生成SerialVersionUID
2、EasyYapi
对比swagger不需要写繁杂的swagger注解,只要求代码注释遵循全球统一的JavaDoc规范
支持导出到Yapi、Postman脚本、Markdown文档、Json
完成后设置底部回出现EasyApi的栏目,选中进行配置修改(主要是改了下图红线的位置,不修改使用默认配置也可以,可以试试使用json5和不使用json5的区别)
接口上的注释自动会生成接口名称和接口的描述信息,实体类里的注释也会自动生成文档里的字段说明
Controller方法返回值必须表现为泛型,否则生成文档时不能识别具体data对象里面的字段,
a)在Controller类或Controller类方法上右键 -> Export Yapi
b)在API接口类中运行Shift+Alt+E,可以选择全量/部分接口及生成文件的类型(yapi、postmain、markdown等),点击Enter即可生成对应文件。
根据生成的文件类型使用相应工具打开,如下图
3、Translation
Translation是一个翻译插件,可以将源码翻译为中文,也可以在开发过程中快速帮助我们对类、方法、参数、变量进行命名翻译
注意:Translation插件默认翻译引擎是谷歌的,但是从前几年谷歌翻译已经不支持,所以需要切换其他翻译引擎,见下图
File -> Settings -> Tools,找到Translation/翻译,选择有道翻译
需要前往有道云官网(有道智云AI开放平台)申请免费的程序ID和程序密钥
点击确定即可得到程序ID和程序密钥,回填到idea的配置栏中,按提示确定重启即可
4、MyBatisCodeHelperPro
MyBatisCodeHelperPro 是国人开发的一款 MyBatis 开发辅助插件。功能丰富,包含了 MybatisX的 java 和 xml 文件互跳功能、xml 中字段提示功能、代码生成功能、xml 中 SQL 执行功能等。
直接下载的插件是需要激活才可以使用,请查看激活教程
代码生成、SQL执行功能需要配合idea自带的Database连接工具使用
配置好数据库连接之后,既可在xml中执行sql,如果有入参,则输入相应参数
5、CamelCase
字符串格式转换,Shift + Alt + U,可在多种格式(大驼峰、小驼峰、全大写、全小写、下划线等)之间转换
可在File -> Settings -> Editor,找到Camel Case,进行格式配置
6、Auto filling Java call arguments
参数补全,当在方法A中调用方法B时,由于方法B具有较多参数,使用Alt+Enter 组合键,调出 “Auto fill call parameters”,即可自动填充方法B的参数
7、CheckStyle
CheckStyle 侧重检查编码格式和代码风格规范,如命名规范、Javadoc注释规范、空格规范、size度量(如过长的方法)、重复代码、多余Imports等,从而有效约束开发人员更好地遵循代码编写规范。Checkstyle主要是文法层面的代码编写规范的分析,对bug几乎没什么发现能力。
打开View -> Tool Windows -> CheeckStyle,选择Google Checks,点击运行即可
8、Alibaba Java Coding Guidelines
Alibaba Java Coding Guidelines 专注于Java代码规范,目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后,将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来,并且大部分可以自动修复,它还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在。
打开Tools -> 阿里编码规约 -> 编码规约扫描,即可对当前文件进行扫描
运行后的结果
扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major
选中其中的一个问题项目,会出现如下内容
9、FindBugs
FindBugs 侧重于发现代码中存在的bug,如运行时错误检测(空指针检查、未合理关闭资源、字符串相同判断错(==,而不是equals)等),它可以简单高效全面地帮助我们发现程序代码中存在的bug以及潜在隐患,针对各种问题,它提供了简单的修改意见供我们参考;
点击 Analyze->analyze code 想要分析的文件名/包名/module名/project;