Java 代码格式化程序和美化程序
指导
Java 代码格式化程序和美化程序
使用行业标准的样式预设,即时格式化和美化您的 Java 代码。粘贴混乱或格式不一致的 Java 代码,即可获得干净、结构正确的输出,匹配 Google Java 样式或 Oracle 代码约定 — 并完全控制缩进、花括号放置和导入排序。
如何使用
将您的 Java 代码粘贴到输入区域。选择一个样式预设来自动配置格式化选项,或手动调整缩进宽度、花括号样式和导入排序,以匹配您的项目约定。格式化后的代码会在输出面板中即时更新 — 一键复制。
特征
- 样式预设 – 使用 Google Java 样式(2 个空格缩进,100 个字符行限制)和 Oracle 代码约定(4 个空格缩进,80 个字符行限制)进行一键格式化。
- 导入排序 – 自动对导入语句进行分组和排序:java.* 在前,javax.* 在后,然后是第三方软件包,最后是静态导入。
- 注解处理 – 将注解保留在声明之前的单独行上,并进行适当的格式化和缩进。
- 花括号样式 – 在类、方法和控制结构的花括号放置方面,可以选择行尾 (K&R) 或下一行 (Allman) 样式。
- 可配置缩进 – 设置缩进宽度(2、4 或 8)并选择空格或制表符。
- 空行规范化 – 强制在方法、字段和类部分之间保持一致的空格。
- 实时格式化 – 输入或更改任何格式化选项时,输出会即时更新。
何时使用此工具
在代码审查、标准化格式以提交到共享存储库或在 Google 和 Oracle 样式约定之间进行转换时,可以使用此工具来清理 Java 代码。对于重新格式化代码片段以用于文档、教程或 Stack Overflow 答案(其中一致的格式很重要)来说,它特别有用。
常问问题
-
Google Java 样式和 Oracle 代码约定之间有什么区别?
Google Java 样式使用 2 个空格的缩进、100 个字符的行限制,并在导入排序和 Javadoc 格式方面有具体规则。Oracle 代码约定(较旧的 Sun 标准)使用 4 个空格的缩进、80 个字符的行限制,并遵循更传统的 Java 格式。Google 的样式在现代开源项目中应用更广泛,而 Oracle 的约定在企业代码库中仍然很常见。
-
为什么导入顺序在 Java 中很重要?
一致的导入顺序可防止多个开发人员向同一文件添加导入时发生合并冲突。如果没有标准顺序,每个开发人员都会在不同的位置添加导入,从而在版本控制合并期间导致不必要的冲突。大多数 Java 样式指南按类别(java.*、javax.*、第三方、静态)对导入进行分组,并在每个组内按字母顺序排序。
-
Java 代码应该使用空格还是制表符进行缩进?
Google Java 样式和 Oracle 代码约定都规定使用空格 — Google 使用 2 个空格,Oracle 使用 4 个空格。制表符在现代 Java 项目中很少使用,因为不同的编辑器以不同的方式呈现制表符宽度,导致外观不一致。Java 社区已基本标准化使用空格,缩进宽度是主要变化点。
-
什么是 google-java-format,它与 IDE 格式化程序相比如何?
google-java-format 是一个开源的命令行工具,可将 Java 代码重新格式化为符合 Google Java 样式。与可配置的 IDE 格式化程序(IntelliJ、Eclipse)不同,google-java-format 是有主见的,并产生一个规范的输出 — 完全消除了样式争论。它可以集成到 CI 管道中,以便在每次提交时自动强制执行格式化。
