Java 代码格式化

Doris 中 Java 部分代码的格式化工作通常有 IDE 来自动完成。这里仅列举通用格式规则，开发这需要根据格式规则，在不同 IDE 中设置对应的代码风格。

Import Order

  1. org.apache.doris
  2. <blank line>
  3. com
  4. <blank line>
  5. org
  6. <blank line>
  7. java
  8. <blank line>
  9. javax
  10. <blank line>
  • 禁止使用 import *
  • 禁止使用 import static

Checkstyle

现在的 CI 之中会有 formatter-check 进行代码格式化检测。

如果使用 IDEA 进行 Java 开发，请在设置中安装 Checkstyle-IDEA 插件。

在 Tools->Checkstyle 的 Configuration File 里点击 Use a local Checkstyle file，选择项目的 fe/checkstyle.xml 文件。

如果使用 VS Code 进行 Java 开发，请安装 Checkstyle for Java 插件，按照文档Java 代码格式化 - 图1 (opens new window)里的说明和动图进行配置。