一.安装插件
- 打开IntelliJ IDEA,点击菜单栏的File,然后选择Settings打开设置对话框。
- 在设置窗口左侧的目录中,展开Plugins选项。
- 在右上角的搜索框中输入Alibaba Java Coding Guidelines进行搜索。
- 找到对应的插件后,点击插件旁边的Install按钮进行安装。
- 安装完成后,会提示你重启IntelliJ IDEA以应用插件,点击Restart IDE。
二、配置插件
重启IDE后,Alibaba Java Coding Guidelines插件会自动生效,但有时需要对其进行一些配置以满足特定的需求:
- 在设置窗口(File > Settings )中,找到并进入Editor > Inspections。
- 在右侧的检查列表中,找到Ali-Check分类,这里列出了所有遵循的编码规范检查项。
- 你可以勾选或取消勾选具体的检查项来启用或禁用它们,根据你的项目需求进行定制。
- 若要全局启用或禁用该插件的检查,可以通过检查项旁边的复选框来控制,位于分类标题旁边。
三、运行检查
- 在编辑器中打开Java文件,IDEA会在代码中高亮显示不符合Alibaba编码规范的地方。
- 可以Tools > 阿里编码规约 > 编码规约扫描
- 也可以通过右键点击文件夹或文件,点击编码规约扫描
- 还可以通过右键点击文件夹或文件,选择Analyze > Run Inspection by Name...,然后在弹出的对话框中选择Alibaba相关的检查项,进行指定项检查。
- 扫描完成后,扫描结果主要分为 Blocker(阻挡者)、Critical(严重问题)、Major(主要的)三个大类,它们表示的是问题的严重程度,严重程度由高到低为:Blocker > Critical > Major。点击问题可查看详细说明,有些问题可根据给出提示一键修改。