讲师中心 微信公众号
AI工具推荐 视频效率加速

怎么编写符合阿里巴巴 Java 开发手册的变量命名规范

浅枫大大_3201

浅枫大大_3201

发布时间:2026-04-04 19:32:03

|

515人浏览过

|

来源于php中文网

原创

变量名必须用英文小写字母加下划线(snake_case),禁止驼峰命名;布尔字段须以is_开头且getter为getIsXxx;禁用拼音、缩写、数字或下划线开头命名;DTO字段名须与数据库列名严格一致。

怎么编写符合阿里巴巴 java 开发手册的变量命名规范

变量名必须用英文小写字母加下划线,不能用驼峰

阿里巴巴 Java 开发手册明确禁止使用 camelCase 命名变量(比如 userName、maxRetryCount),要求统一用 snake_case。这不是风格偏好,而是强制规范——尤其在 DTO、VO、DAO 层的字段命名中,IDEA 里开 Alibaba Java Coding Guidelines 插件会直接标红警告。

常见错误现象:private String userToken; → 违规;应改为 private String user_token;

  • 所有普通变量、字段、方法参数都适用该规则,包括 static final 常量(但常量本身要用大写+下划线,如 MAX_RETRY_COUNT)
  • 类名、方法名、包名仍保持标准 Java 驼峰(UserServiceImpl、saveUser、com.alibaba.xxx),仅字段/变量层切换
  • MyBatis 的 resultMap 或 JPA 的 @Column(name = "user_name") 必须与数据库列名一致,而数据库列名也应是 snake_case,否则映射会出错

布尔类型变量必须以 is_ 开头,且 getter 方法也要匹配

手册特别强调:布尔字段不能叫 valid、enabled,必须是 is_valid、is_enabled。否则 Spring、MyBatis 等框架反射读取时可能误判——它们默认按 isXxx() 查找 getter,而你若只写 isValid(),对应字段却是 valid,就断开了约定。

实操建议:

立即学习“Java免费学习笔记(深入)”;

Java注释规范Skills
Java注释规范Skills

当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。

下载
  • 定义字段:private Boolean is_deleted;(注意不是 deleted)
  • 生成 getter:public Boolean getIsDeleted() { return is_deleted; } —— 必须是 getIsDeleted,不是 isDeleted(后者会被 Spring 当作 boolean 原生类型处理,且不兼容 Boolean 包装类)
  • 如果用 Lombok,要显式指定:@Getter public Boolean is_deleted;,否则 @Getter 默认生成 isDeleted(),反而违规

避免拼音、缩写、数字开头或纯数字命名

像 shouji(手机)、usrNm(user name)、2nd_try 这类命名,手册直接列为“禁止”。它们破坏可读性,也容易引发 IDE 自动补全混乱或序列化失败(如 Jackson 默认忽略下划线开头字段,但 _id 又是常见场景,需额外配置)。

典型陷阱:

  • private String usr_name; → 错误缩写,应为 user_name
  • private Integer order_2nd_count; → 数字出现在中间,违反“字母+下划线”原则,应改为 order_second_count
  • private String _status; → 下划线开头,Jackson 默认不序列化,若必须用,得加 @JsonProperty("_status")

DTO/VO 字段命名和数据库列名必须严格对齐

手册隐含一个硬性约束:只要用了 MyBatis 或 JDBC 模板,DTO 类字段名就必须和数据库 SELECT 出来的列名完全一致(大小写+下划线)。比如数据库有 create_time,DTO 就不能写成 created_time 或 createAt,否则查出来是 null。

真实项目中高频出问题的地方:

  • MySQL 默认不区分大小写,但字段定义是 user_id,你 DTO 写成 userId,MyBatis 的自动映射(autoMappingBehavior=FULL)不会帮你转换
  • 用 @Results 手动映射时,@Result(property = "user_name", column = "user_name") 里的 property 值必须和 DTO 字段名一字不差
  • Swagger 文档生成依赖字段名,命名不一致会导致接口文档显示 userName,但实际 JSON 返回却是 user_name,前端同学会懵

最稳妥的做法:建表语句里用 snake_case,Java DTO 里字段名照抄,连注释都保持同步更新。别指望框架替你“智能适配”。

热门AI工具

更多
Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

11157

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

8262

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

7132

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1204

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

968

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1436

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2929

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20211

2023.08.03

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

20

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn