【Java】代码格式控制工具

¶写在前面

• 是作业的要求，顺便记一下

• 作业

  使用Java或其他代码格式控制工具，对不符合规范的代码进行自动识别，给出提示（java代码规范不做要求，但是应当具有权威性，如阿里的java代码规范）。

• 《阿里巴巴Java开发手册（终极版）》免费下载_在线阅读_藏经阁-阿里云开发者社区 (aliyun.com)

• 藏经阁_阿里云开发者社区_云计算社区-阿里云 (aliyun.com) 我勒个很多好东西啊

¶操作过程

为了实现对不符合规范的Java代码进行自动识别并给出提示，可以采用静态代码分析工具

这些工具能够帮助开发者遵守特定的编码标准，提高代码质量

• 通义回答的三种工具：Checkstyle | PMD | SpotBugs | IntelliJ IDEA 或 Eclipse 插件

¶Checkstyle

Checkstyle 是一个用于检查 Java 源代码是否符合编码标准的开发工具

它可以配置为遵循多种不同的编码规范，包括阿里巴巴的《Java开发手册》

¶安装与配置

¶Maven配置

在pom.xml文件中添加插件配置

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-checkstyle-plugin</artifactId>
      <version>3.1.2</version>
      <configuration>
        <configLocation>ali-checkstyle.xml</configLocation>
        <encoding>UTF-8</encoding>
        <consoleOutput>true</consoleOutput>
        <failsOnError>true</failsOnError>
        <linkXRef>false</linkXRef>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

ali-checkstyle.xml 是阿里巴巴的 Checkstyle 规则文件

¶运行

使用Maven命令行运行Checkstyle

mvn checkstyle:check

¶PMD

PMD 是一个源代码分析工具，它可以帮助查找常见的编程缺陷，如未使用的变量、空的 catch 块、不必要的对象创建等

¶安装与配置

¶Maven配置

• 在pom.xml文件中添加插件配置

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pmd-plugin</artifactId>
      <version>3.16.0</version>
      <configuration>
        <rulesets>
          <ruleset>/path/to/your/ruleset.xml</ruleset>
        </rulesets>
        <targetJdk>1.8</targetJdk>
      </configuration>
      <executions>
        <execution>
          <phase>validate</phase>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

可以根据需要自定义规则集文件

¶运行

使用Maven命令行运行PMD

mvn pmd:check

¶SpotBugs

SpotBugs 是一个用于静态分析 Java 字节码的工具，它可以帮助发现潜在的错误

¶安装与配置

¶Maven配置

• 在pom.xml文件中添加插件配置

<build>
  <plugins>
    <plugin>
      <groupId>com.github.spotbugs</groupId>
      <artifactId>spotbugs-maven-plugin</artifactId>
      <version>4.7.3</version>
      <configuration>
        <effort>Max</effort>
        <threshold>Low</threshold>
        <failOnError>false</failOnError>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>check</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

¶运行

mvn spotbugs:check

¶IntelliJ IDEA 或 Eclipse 插件

IntelliJ IDEA 或 Eclipse都提供了内置的静态代码分析工具

也可以安装 Checkstyle、PMD 和 SpotBugs 的插件来增强代码检查功能

¶IntelliJ IDEA

• 安装插件：
  1. 打开 IntelliJ IDEA
  2. 进入 File -> Settings -> Plugins
  3. 搜索并安装 Checkstyle、PMD 和 SpotBugs 插件
• 配置 Checkstyle：
  1. 进入 File -> Settings -> Editor -> Inspections
  2. 添加 Checkstyle 检查规则文件路径

¶Eclipse

• 安装插件：
  1. 打开 Eclipse。
  2. 进入 Help -> Eclipse Marketplace。
  3. 搜索并安装 Checkstyle、PMD 和 SpotBugs 插件。
• 配置 Checkstyle：
  1. 进入 Window -> Preferences -> Checkstyle。
  2. 添加 Checkstyle 检查规则文件路径

¶自分の实际操作

• IDEA下安装与使用CheckStyle_idea checkstyle commit-CSDN博客

¶来自AI的解释——CheckStyle的作用

• CheckStyle是一个用于帮助程序员编写符合编码规范的 Java 代码的工具。它通过检查源代码中的格式错误、潜在的错误以及不符合团队或项目编码标准的部分来提高代码质量。以下是 CheckStyle在 IntelliJ IDEA (简称 IDEA) 和 Java 开发中的主要用途：

1. 编码规范一致性：

   • CheckStyle 可以根据预定义的规则集（如 Google Java Style Guide, Sun Code Conventions 等）来检查代码，确保所有开发者遵循相同的编码标准。这有助于保持整个项目的代码风格一致，减少因个人偏好导致的差异

2. 代码审查辅助：

   • 在团队合作中，进行代码审查是保证软件质量的重要环节。CheckStyle 能够自动检测出一些常见的编程错误和不良实践，减轻人工代码审查的工作量，并且可以快速指出需要改进的地方

3. 自动化构建过程：

   • 将 CheckStyle 集成到持续集成/持续部署(CI/CD)流程中，可以在每次提交或合并请求时自动运行检查。如果发现违反了编码规范的问题，可以阻止构建成功，从而强制执行编码标准

4. IDEA 插件支持：

   • IntelliJ IDEA 提供了对 CheckStyle 的良好支持，可以通过安装插件的方式将 CheckStyle 集成到 IDE 中。这样，在编写代码的过程中就可以实时获得反馈，及时修正问题，避免后期大规模修改

5. 教育意义：

   • 对于初学者来说，使用 CheckStyle 可以帮助他们更快地学习并适应专业级的编码习惯，避免形成难以改正的坏习惯

6. 提高可读性和可维护性：

   • 通过强制实施良好的编码实践，CheckStyle 有助于提高代码的可读性和可维护性，这对于长期项目尤其重要

7. 减少错误：

   • 某些配置还可以帮助识别可能引起运行时错误的代码模式，例如未使用的变量、不必要的类型转换等，从而在早期阶段就消除这些潜在问题

总之，CheckStyle 是一个非常有用的工具，它不仅能够帮助开发者遵守编码规范，还能促进团队之间的协作，提升整体开发效率和产品质量。在 IntelliJ IDEA 中使用 CheckStyle，可以使这一过程更加顺畅和高效。