Skip to content

后端代码格式化配置指南

CoderDream edited this page Apr 9, 2022 · 2 revisions

配置的顺序

  1. CC编码规范代码格式化模板
  2. 代码格式化辅助配置
  3. 错误提示使用醒目颜色
  4. 保存时自动优化代码
  5. CC编码规范本地实时检查

CC编码规范代码格式化模板

导入并应用附件中的代码格式化模板文件。

File→Settings→Editor→Code Style→Java→设置图标→Import Schema→IntelliJ IDEA code style XML

选择附件中的CoCoIdeaJavaCodeFormatter文件导入,然后点击Apply或OK。

image.png

此时点击Code→Reformate Code或使用快捷键Ctrl+Alt+L,已经可以将绝大部分代码格式问题解决。剩下的一小部分问题需要通过后面的配置来辅助解决。

image.png

代码格式化辅助配置

版权配置

新增版权配置并应用。

File→Settings→Editor→Copyright→Copyright Profiles→添加图标

Name填写CoCoCopyright

版权信息[第2个输入框Copyright text]填写Copyright (c) CoCo Technologies Co., Ltd. ${today.year}-${today.year}. All rights reserved.

image.png

在File→Settings→Editor→Copyright将默认的版权信息设置为CoCoCopyright

image.png

此时再新增Java文件就会自动添加版权信息了。已有Java文件通过单击右键→Generate→Copyright或使用快捷键Alt+Insert→Copyright来添加版权信息。

image.png

UTF-8格式配置

Java工程所有文件都应该设置为UTF-8格式,来屏蔽编码、构建时不同操作系统默认编码不同导致的莫名其妙的问题。

在File→Settings→Editor→File Encodings按照下图将所有能设置为UTF-8的地方都设置为UTF-8,不要出现其他编码。 包括【Global Encoding】和【Project Encoding】、另外还有Path里面的Encoding、Properties Files也选UTF-8,并且勾选后面的【Transparent native-to-ascii conversion】

Create UTF-8 files 选 【with NO BOM】

image.png

JavaDoc注释配置

导入注释模板。

File→Manage IDE Settings→Import Settings,选择附件中的CoCoIdeaJavaCodeCommentTemplate文件,勾选File templates和Live templates,点击OK完成导入,重启生效。

image.png

image.png

此时新增的Java类文件会自带类注释了。

image.png

如果是已存在的Java类文件,刚刚导入的Live templates包含一个特定关键字clsdoc可以通过TabEnter键自动生成类注释模板。

e14239a316a3f0938fe438440c29a3e0_874x386.gif@900-0-90-f.gif

如果是类成员变量或方法,通过输入默认的/**,敲回车,即可生成注释模板。

2182549b27de65ff40fa888ac9c94a7a_790x295.gif@900-0-90-f.gif

自动去掉未用到的import

File→Settings→Editor→General→Auto Import,勾选上Java下面的optimize imports on the fly,可以自动去掉未用到的import。

image.png

错误提示使用醒目颜色

idea默认的错误提示颜色较浅较淡,可以通过改变idea的颜色配置让错误提示更加醒目。

在File→Settings→Editor→Color Scheme→General→Errors and Warnings下面的错误类型使用加粗或对比强烈的反差背景,来让错误提示更加醒目,提醒自己去修改代码中的错误。

勾选【Bold】,设置【Background】、【Error stripe mark】和【Effects】的颜色

image.png

保存时自动优化代码

接下来的两个配置需要安装第三方的插件来实现。在File→Settings→Plugins→Marketplace中在线搜索插件安装。

Save Actions插件可以实现在保存时自动优化代码。

image.png

不具备外网条件的同事,可以找有外网条件的同事帮忙下载对应IDEA版本的插件版本,离线安装。

image.png

image.png

Save Actions配置的具体含义可以参考其GitHub主页:https://github.com/dubreuia/intellij-plugin-save-actions#java-fixes

推荐勾选如下选项:

  • General勾选第一个
  • Formatting勾选第一个和第二个
  • Java inspection and Quick Fix勾选6个:

And missing @Override annotation及接下来的4个 Remove unused suppress warning annotation

image.png

此时IDEA在保存文件时会顺便优化一下代码。

CC编码规范本地实时检查

  1. 当前MR门禁启用的CodeCheckCC代码风格检查项较少,即使未做过上面的CC代码风格设置,也不影响代码合入。
  2. 即使做了IDEA的代码格式化配置,也不能完全满足CC编码规范。

基于以上两点考虑,需要引入Checkstyle来进一步检查代码。

CheckStyle-IDEA插件可以实现实时代码规范检查。

File→Settings→Plugins→Marketplace右边的安装图标,手工安装 CheckStyle-IDEA-5.42.0.zip 文件大小: 95,360KB

image.png

安装好后,添加附件中的CC编码规范Checkstyle配置文件checkstyle_ruleset_minimal_checkstyle_plugin.xml,命名CoCo Checks

File→Settings→Tools→Checkstyle 进入面板

Scan Scope 选【Only Java sources (including tests) 】

Configuration File 点击【+】进入新增面板:

描述:CC Checks Use a local Checkstyle file 通过【Browse】选中 xxx_checkstyle_plugin.xml文件。

image.png

回到面板,在Configuration File的列表中【勾选】 CoCo Checks来默认激活CC编码规范检查。

image.png

此时可以在Java文件右键点击Check Current File来检查单个文件。

image.png

然后就可以出现检查结果。

image.png

Clone this wiki locally