使用spring约定的java代码格式开发应用平台需要注意的点

2021-01-29 21:27:00 暂无评论 . 企业级Java 954

一、gradle组织下的项目目录如下：
spring-boot –主项目名称
–.github –github目录
.gradle –执行gradle wrapper包装器后生成的gradle运行缓存
.idea –idea的配置
build –编译扫描配置
buildSrc –springboot使用gradle编译依赖的类和库，配置文件，项目编译结果
ci –持续部署相关配置
eclipse –恶心的eclipse相关配置
git –官网拉下来的，git相关配置吧
gradle –gradle的wrapper可执行脚本和配置目录
spring-boot-project –springboot子项目
spring-boot-tests –springboot子项目测试项目
src –默认的包路径，里面是checkstyle配置和nohttp的相关代码规范配置

二、关于spring代码格式器的约定：
1.首先针对IntelliJ IDEA安装插件
IntelliJ IDEA 插件为 IntelliJ IDEA 提供自定义的 formatter 支持。每当在项目构建脚本中发现 Maven 或 Gradle 插件时，插件都会自动激活。”Spring JavaformatOn格式”图标（）也将显示在状态栏中，以指示格式化程序处于活动状态。您可以使用标准代码→设置代码格式。code reformat code
要安装插件，请使用 jar 文件。你可以从repo.spring.io（https://repo.spring.io/release/io/spring/javaformat/spring-javaformat-intellij-idea-plugin/0.0.27/）下载，然后在idea插件安装中使用本地方式安装该jar。spring-javaformat-intellij-idea-plugin

2.关于代码格式的约定
大多数编码约定和样式来自spring Framework和Spring Boot项目。Spring Framework 手动格式化代码，其中作为Spring Boot使用自动格式。

排除特定检查
如果最想要，但需要排除一个或两个，您可以在中做类似这样的工作：SpringCheckscheckstyle.xml

<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="com.puppycrawl.tools.checkstyle.Checker">
<module name="io.spring.javaformat.checkstyle.SpringChecks">
<property name="excludes" value="io.spring.javaformat.checkstyle.check.SpringAvoidStaticImportCheck" />
</module>

禁用代码块的格式

某些代码不是特别适合自动格式化。例如，在手动格式化时，Spring 安全配置通常工作得更好。

如果需要禁用特定代码块的格式，可以把它封闭在@formatter:off / @formatter:on设置中：

// @formatter:off

… code not be formatted

// @formatter:on

‘{‘后应该有一个空格。';'后应有空格。

代码字符长度

源代码使用 120 个字符长度。旨在平衡使用 IDE 中的可用水平空间并且避免在 github 等上查看代码时没必要的额外拖拉。

如果你习惯了更长的线条，120个字符可能需要一些时间来习惯。具体来说，如果你有很多嵌套级别，事情可能会开始看起来相当糟糕。通常，如果您看到代码聚集在屏幕右侧，您应该将代码作为信号来使用”提取方法”重构。提取小型专用方法将改进格式设置，并有助于读取代码和调试。

代码（含注释）的行宽不能超过120字符，public类注释长度不能超过90字符，首行不能短于76字符另起一行，不能短于40字符另起一行。 Javadoc 首句应以句号结尾。

空行

将空白行保留到方法实体中有助于使代码更易于扫描。如果仅包含方法之间的空白行，就更容易看到类的整体结构。如果您发现方法中需要空白，请考虑提取私有方法是否可能提供更好的结果。

翻译一下：类的成员之间保留一个空行，结构更清晰，变量、属性和方法都属于成员，只能有一个空行。

注释

尝试为每种公共方法和常量添加 javadoc。私有方法通常不需要 javadoc。
私有成员不能加javadoc注释，可以加普通注释，但是成员间的空行必须留出来，方法体内可以加注释。

检查样式规则将强制所有公共类都具有 javadoc。它们还将确保标记形成良好。@author

Final关键字

私人成员应尽可能声明为Final。局部变量和参数通常不应显式声明为Final变量，因为它增加了太多的噪声。

读法、字段和参数
方法不需要按范围组织。无需将所有类和方法分组在一起。相反，在从上到下扫描文件时，尽量使代码易于阅读。换句话说，尝试在文件中进一步使用方法。使私有方法尽可能接近调用它们的方法。privateprotectedpublic

还建议您尝试与字段和构造函数参数保持一致的顺序。例如：

class Name {

private final String first;

private final String last;

public Name(String first, String last) {
this.first = first;
this.last = last;
}

}

代码导入import顺序
先导入java平台包，再导入第三方包，具体按eclipse规则，springframework的包在gradle api包之下
，不同公司的包加空行隔开。具体规则是：
import static all other imports
blank line
import java.*
blank line
import javax.*
blank line
import org.gradle.*
blank line
import org.springframework.*
blank line
import org.*
blank line
import com.*
blank line
import all other imports
把上面规则在idea-settings-general-editor-codestyle-java下，找imports栏最下面设置。