📖 Java编码规范指南
命名规范
- 类名使用
UpperCamelCase
(如:StudentManager
) - 方法名使用
lowerCamelCase
(如:calculateTotalPrice
) - 常量名全大写,单词间用下划线分隔(如:
MAX_RETRY_COUNT
) - 包名全小写(如:
com.example.service
)
- 类名使用
代码结构
- 单层继承,避免多层嵌套
- 使用
public
、protected
、private
明确访问修饰符 - 方法长度不超过 15 行,逻辑单一
注释规范
- 方法注释需包含用途、参数、返回值和异常说明
- 类注释描述功能和作者信息
- 避免注释冗余,优先用代码表达意图
格式化规范
- 使用 4 个空格缩进,避免 Tab
- 控制语句后空一行(如:
if
、for
、switch
) - 异常处理需明确日志记录
安全规范
- 输入参数需校验合法性(如:非空、范围)
- 密码处理使用
BCrypt
或SHA-256
- 避免硬编码敏感信息,使用配置中心
🔗 扩展阅读:Java_最佳实践
📌 本规范遵循《阿里巴巴 Java 开发手册》和 Oracle 官方推荐标准,欢迎补充更多细节或提出建议!