IntelliJ IDEA中Java代码格式化设置指南

IntelliJ IDEA Java 代码格式化设置指南

一 快速上手与常用快捷键

• 格式化当前文件：在编辑器内按下 Ctrl + Alt + L（Windows/Linux） 或 Cmd + Option + L（macOS）；若弹出确认框，选择 Run 即可。
• 格式化选中片段：先选中代码片段，再按上述快捷键，仅对选区生效。
• 优化导入：使用 Ctrl + Alt + O（Windows/Linux） 或 Cmd + Option + O（macOS），可删除未使用导入并排序。
• 批量格式化：在项目工具窗口中右键模块/目录，选择 Reformat Code，可一次性处理多文件。
• 菜单路径：也可通过 Code → Reformat Code 执行。

二 代码风格核心设置

• 入口路径：File → Settings → Editor → Code Style → Java（macOS 为 Preferences）。
• 常用配置项：
  • Tabs and Indents：建议勾选 Use tab character: 不勾选，将 Tab size / Indent 设为 4 个空格。
  • Wrapping and Braces：配置 if/for/while、方法参数、数组/集合初始化 等的换行与大括号位置（如 K&R、BSD 风格）。
  • Blank Lines：控制类、方法、字段、注释之间的空行数量，提升可读性。
  • Spaces：设置运算符、括号、逗号、分号、注解、泛型尖括号等处的空格策略。
  • Hard wrap at：建议设置为 120（或团队约定值），配合续行缩进（如 Continuation indent: 8）以获得更可控的换行。

三 团队统一与配置共享

• 导出/导入代码风格：在 Code Style → Java 页面右上角齿轮图标选择 Export Scheme / Import Scheme，导出为 XML 并在团队内共享。
• 推荐做法：将 code-style.xml 放入项目根目录并提交到 Git，所有成员导入同一方案以保持风格一致。
• 保存即自动格式化：开启 Settings → Tools → Actions on Save，勾选 Reformat code 与 Optimize imports，每次 Ctrl + S / Cmd + S 自动排版与清理导入（团队需达成一致后再启用，避免提交大量格式变更）。

四 进阶与常见问题

• 跳过指定区域：启用格式化标记（Formatter off/on）。路径 Settings → Editor → Code Style → Formatter，勾选 Enable formatter markers in comments，在需要跳过的区域首尾添加注释标记（如 // @formatter:off 与 // @formatter:on），格式化时将保留该区域原有格式。
• 快捷键冲突：在 Settings → Keymap 中搜索 Reformat Code，右键 Add Keyboard Shortcut 自定义快捷键。
• 批量处理与选项：在项目视图对目录/模块右键 Reformat Code，可勾选 Optimize imports、Rearrange entries 等选项后执行。
• 与规范工具结合：配合 Checkstyle-IDEA 或 Spotless 插件做更严格的规范校验与自动修复，弥补仅靠 IDE 格式化的不足。