java spring项目
Spring为您提供了一个方便的工具,可确保您的Java项目具有一致的“ Spring”风格! 认识Spring Java Format插件集!
该工具已于今年5月发布,当前版本为0.0.6。
设置的插件包括:
- 应用包装和空白约定的源格式化程序
- 一个Checkstyle插件,可在整个代码库中实现一致性
该项目的目的是提供一致性,因此,每个插件通常都不可配置。 这意味着您需要更改代码以匹配所需的约定,而不能配置插件约定以匹配您的样式。
还请参见:
根据其GitHub存储库 ,大多数编码约定和样式都来自Spring Framework和Spring Boot项目。 Spring Framework手动格式化代码,而Spring Boot使用自动格式化。
您应该记住的一件事是,仅格式和Checkstyle不足以产生真正一致的代码。 您可以在此处找到一些在开发Spring Boot时可能有用的技巧。
入门
如果您希望尝试一下,让我们看看如何开始。
Maven
对于源格式,将spring-javaformat-maven-plugin
到您的build
插件中:
<build>
<plugins>
<plugin>
<groupId>io.spring.javaformat</groupId>
<artifactId>spring-javaformat-maven-plugin</artifactId>
<version>0.0.6</version>
</plugin>
</plugins>
</build>
~/.m2/settings.xml
的io.spring.javaformat
插件组如下:
<pluginGroups>
<pluginGroup>io.spring.javaformat</pluginGroup>
</pluginGroups>
现在,您可以运行./mvnw spring-javaformat:apply
重新格式化代码。
Gradle
对于源格式,将spring-javaformat-gradle-plugin
到您的build
插件中:
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath("io.spring.javaformat:spring-javaformat-gradle-plugin:0.0.6")
}
}
apply plugin: 'io.spring.javaformat'
该插件将format
和checkFormat
任务添加到您的项目中。 运行标准Gradle check
任务时,将自动应用checkFormat
任务。
蚀
使用Eclipse,只要在项目构建脚本中发现Maven或Gradle插件,就会自动激活该插件。
如果您需要自定义插件应用的项目特定设置,则应在项目的根目录中添加一个.eclipse
文件夹。 该文件夹中的所有.prefs
文件都将被复制到项目.settings
文件夹中。 通常,您将提供自己的org.eclipse.jdt.core.prefs
和org.eclipse.jdt.ui.prefs
文件。
为了安装插件,您可以使用io.spring.javaformat.eclipse.site
zip文件。 您可以从repo.spring.io下载最新版本或使用更新站点 。
IntelliJ IDEA
就像在Eclipse中一样,在项目构建脚本中发现Maven或Gradle插件时,也会自动激活该插件。 Spring Java Format图标( )也将显示在状态栏中,以指示格式化程序处于活动状态。 您可以使用标准
code
→ reformat code
操作来格式化代码。
要安装该插件,您可以使用spring-javaformat-intellij-plugin
jar文件。 您可以在这里找到最新版本。
翻译自: https://jaxenter.com/tool-spring-java-format-151270.html
java spring项目
所有评论(0)