要点速览

Twitter 的 Java 规范以「可读性优先」为总原则：当严格遵守规范反而写出更难读的代码时，可读性优先。落地时可先抓住以下要点：

• 格式：不使用 tab，统一空格缩进；单行不超过 100 列；类型用 CamelCase、变量用 camelCase、常量用 UPPER_SNAKE_CASE；不留行尾空格。
• 变量命名：极短名字（如 i）只用于循环下标；变量名包含单位（如 timeoutMs）；不要把元数据（如 typed）嵌入名字。
• 声明：每行只声明一个变量；字段尽量 private final，遵循最小可见性原则。
• 运算符：运算符与等号两侧加空格；复合表达式用括号显式表达优先级。
• 注释与文档：写「为什么」而不是「是什么」；对类与公开方法写 Javadoc；覆写方法通常不必重复文档。
• 导入：禁止通配符导入，保持顺序一致。
• 注解：慎用 @Nullable、@VisibleForTesting 等，让意图显式。
• 可测试性：用 Fake / Mock 隔离依赖，避免测试依赖时间、随机数与线程睡眠（不要 Thread.sleep()）。
• 最佳实践：优先不可变；少暴露可见性；用 finally 或 try-with-resources 清理资源；及时删除死代码；避免可变静态状态。

转载并翻译自 https://google.github.io/styleguide/javaguide.html。个人英语水平有限，应以原文档为标准。

简介

本文档是 Google Java 语言编程规范的 完整 定义。一个 Java 源文件当且仅当遵守本规范时，才可被描述为 Google 风格。

核心要点速览

手册按编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度组织，每条规约按约束力分为【强制】【推荐】【参考】三类。落地时，可以先抓住以下高频、易踩的要点：

• 命名：类用 UpperCamelCase、方法与变量用 lowerCamelCase、常量全大写；禁用拼音与中英夹杂；抽象类用 Abstract / Base 前缀，异常类用 Exception 结尾。
• 常量：不允许魔法值直接出现在代码中；long 赋值必须用大写 L；常量按功能归类，不要用一个巨型常量类。
• 代码格式：缩进用 4 个空格、禁用 tab；单行不超过 120 字符；if/for/while 等保留字与括号之间加空格。
• OOP：包装类型比较用 equals 而非 ==；POJO 布尔字段不加 is 前缀；接口方法不加 public。
• 集合：Arrays.asList 返回的列表不可增删；Map 遍历优先用 entrySet。
• 并发：线程池不允许用 Executors 直接创建；SimpleDateFormat 线程不安全，改用 ThreadLocal 或 DateTimeFormatter。
• 异常与日志：不用异常控制流程；catch 不能吞掉异常；日志用占位符（log.info("id={}", id)）而非字符串拼接。
• 单元测试：遵守 AIR 原则（Automatic、Independent、Repeatable）；增量代码测试覆盖率需达标。
• 安全：用户输入必须校验；敏感数据脱敏；SQL 参数化以防注入。

常见企业级代码规范详解。

相关文章

常见企业级代码规范相关文章。

• 阿里巴巴 Java 开发手册
  • 《阿里巴巴 Java 开发手册》是阿里巴巴集团技术团队的集体经验总结，经历了多次大规模一线实战的检验及不断的完善，反馈给广大开发者。现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如: 数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以 Java 开发者为中心视角，划分为编程规约、异常日志、MySQL 数据库、工程结构、安全规约五大块，再根据内容特征，细分成若干二级子目录。根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中，“说明”对内容做了引申和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。
• Google Java 编程风格指南
  • Google 出品的 《Google Java Code Style在新窗口打开》，由fantasticmao在新窗口打开翻译，对应github仓库在新窗口打开。
• Twitter Java Style Guide
  • 本文是Twitter的Java代码规范。