阿里巴巴 Select 查询命名规范大全
1. 基础命名模式
核心公式：动词 + 名词 + 限定条件 + 返回类型
| 部分 | 阿里巴巴常用词 | 示例 |
|---|---|---|
| 动词 | select,find,get,query | select（最正式） |
| 名词 | 表名或实体名 | User,Order,Product |
| 限定 | ByXxx,ByXxxAndYyy,ForXxx | ById,ByNameAndStatus |
| 返回 | 可省略，或加List,Page,Count | List,Page,One,Count |
2. 各种场景的具体命名
场景1：单条记录查询
// 根据ID查询UserDOselectById(@Param("id")Longid);UserDOfindById(@Param("id")Longid);UserDOgetById(@Param("id")Longid);// 根据唯一键查询UserDOselectByUsername(@Param("username")Stringusername);UserDOselectByEmail(@Param("email")Stringemail);UserDOselectByMobile(@Param("mobile")Stringmobile);// 查询单个字段值StringselectNameById(@Param("id")Longid);IntegerselectStatusById(@Param("id")Longid);场景2：列表查询
// 查询所有List<UserDO>selectAll();List<UserDO>findAll();List<UserDO>listAll();// 条件查询列表List<UserDO>selectByStatus(@Param("status")Integerstatus);List<UserDO>selectByDeptId(@Param("deptId")LongdeptId);List<UserDO>selectByNameLike(@Param("name")Stringname);// 多条件查询List<UserDO>selectByStatusAndDeptId(@Param("status")Integerstatus,@Param("deptId")LongdeptId);List<UserDO>selectByCreateTimeBetween(@Param("startTime")DatestartTime,@Param("endTime")DateendTime);场景3：分页查询
// 分页查询所有Page<UserDO>selectPage(Page<UserDO>page);// 条件分页查询Page<UserDO>selectPageByStatus(Page<UserDO>page,@Param("status")Integerstatus);Page<UserDO>selectPageByCondition(Page<UserDO>page,@Param("condition")UserQueryConditioncondition);场景4：统计查询
// 计数LongselectCount();Integercount();LongcountAll();// 条件计数LongselectCountByStatus(@Param("status")Integerstatus);LongcountByDeptId(@Param("deptId")LongdeptId);// 存在性检查BooleanexistsByUsername(@Param("username")Stringusername);BooleanexistsByEmail(@Param("email")Stringemail);场景5：Map格式查询
// 单条MapMap<String,Object>selectAsMapById(@Param("id")Longid);Map<String,Object>selectUserMap(@Param("id")Longid);// 列表MapList<Map<String,Object>>selectListAsMaps();List<Map<String,Object>>selectMapsByStatus(@Param("status")Integerstatus);List<Map<String,Object>>selectAllAsMaps();// 指定字段MapList<Map<String,Object>>selectIdAndNameAsMaps();List<Map<String,Object>>selectSimpleInfoAsMaps();3. 你的业务场景专用命名
飞行数据相关查询
// 基础查询List<FlightDataDO>selectByFlightRecordId(@Param("flightRecordId")LongflightRecordId);List<FlightDataDO>selectByRecordIdAndType(@Param("recordId")LongrecordId,@Param("dataType")StringdataType);// Map格式List<Map<String,Object>>selectFlightDataAsMaps(@Param("flightRecordId")LongflightRecordId);List<Map<String,Object>>selectHeightDataAsMaps(@Param("flightRecordId")LongflightRecordId);List<Map<String,Object>>selectSpeedDataAsMaps(@Param("flightRecordId")LongflightRecordId);// 统计LongcountByFlightRecordId(@Param("flightRecordId")LongflightRecordId);Map<String,Object>selectStatsByFlightRecordId(@Param("flightRecordId")LongflightRecordId);告警规则相关查询
// 规则查询List<AlarmRuleDO>selectByConfigId(@Param("configId")LongconfigId);List<AlarmRuleDO>selectEnabledByConfigId(@Param("configId")LongconfigId);List<AlarmRuleDO>selectByConfigIdAndType(@Param("configId")LongconfigId,@Param("ruleType")StringruleType);// Map格式List<Map<String,Object>>selectRulesAsMaps(@Param("configId")LongconfigId);Map<String,List<Map<String,Object>>>selectRulesGroupByType(@Param("configId")LongconfigId);告警分析业务查询
// 分析相关List<Map<String,Object>>selectForAlarmAnalysis(@Param("configId")LongconfigId,@Param("flightRecordId")LongflightRecordId);List<Map<String,Object>>selectAnalysisResult(@Param("analysisId")StringanalysisId);Page<Map<String,Object>>selectAnalysisHistory(Page<?>page,@Param("query")AnalysisQueryquery);4. 阿里巴巴内部特殊命名
复杂查询命名
// 联表查询List<UserWithDeptDO>selectUserWithDeptByUserId(@Param("userId")LonguserId);List<Map<String,Object>>selectUserJoinDept(@Param("deptId")LongdeptId);// 嵌套查询List<UserDO>selectWithSubQuery(@Param("minOrderCount")IntegerminOrderCount);// 聚合查询Map<String,Object>selectUserStats(@Param("deptId")LongdeptId);List<Map<String,Object>>selectGroupByDept();// 窗口函数List<Map<String,Object>>selectWithRank(@Param("deptId")LongdeptId);批量查询命名
// IN查询List<UserDO>selectByIds(@Param("ids")List<Long>ids);List<UserDO>selectByUsernames(@Param("usernames")List<String>usernames);// 批量Map查询List<Map<String,Object>>selectMapsByIds(@Param("ids")List<Long>ids);Map<Long,UserDO>selectMapByIds(@Param("ids")List<Long>ids);// 返回Map结构5. 阿里巴巴的命名约定俗成
前缀约定
// select 系列（最规范）UserDOselectById(Longid);List<UserDO>selectListByStatus(Integerstatus);// find 系列（查询语义）UserDOfindById(Longid);List<UserDO>findAll();// get 系列（获取语义）UserDOgetById(Longid);List<UserDO>getAll();// query 系列（复杂查询）Page<UserDO>queryPage(UserQueryquery);List<UserDO>queryByCondition(UserConditioncondition);后缀约定
// List - 返回列表List<UserDO>selectListByDeptId(LongdeptId);// Page - 返回分页Page<UserDO>selectPageByStatus(Page<?>page,Integerstatus);// Count - 返回数量LongselectCountByStatus(Integerstatus);// One - 返回单个UserDOselectOneByUsername(Stringusername);// Map - 返回Map格式Map<String,Object>selectMapById(Longid);List<Map<String,Object>>selectMapListByStatus(Integerstatus);6. 实战中的最佳实践
原则1：保持一致性
// ✅ 好：统一风格UserDOselectById(Longid);List<UserDO>selectByStatus(Integerstatus);Page<UserDO>selectPage(Page<UserDO>page);// ❌ 不好：风格混乱UserDOgetById(Longid);List<UserDO>findListByStatus(Integerstatus);Page<UserDO>queryPage(Page<UserDO>page);原则2：方法名自解释
// ✅ 好：清晰明了List<UserDO>selectByDeptIdAndStatus(LongdeptId,Integerstatus);UserDOselectByUsernameAndPassword(Stringusername,Stringpassword);// ❌ 不好：模糊不清List<UserDO>selectUsers(LongdeptId,Integerstatus);// 参数意义不明UserDOselectUser(Stringparam1,Stringparam2);// 参数名无意义原则3：避免过长
// ✅ 好：适中长度List<UserDO>selectByDeptId(LongdeptId);UserDOselectByUsername(Stringusername);// ❌ 不好：过长List<UserDO>selectAllUserRecordsByDepartmentIdentifier(LongdeptId);// 太长了！7. 你的业务完整示例
@MapperpublicinterfaceFlightDataMapperextendsBaseMapper<FlightDataDO>{// === 基础查询 ===FlightDataDOselectById(Longid);List<FlightDataDO>selectByFlightRecordId(LongflightRecordId);List<FlightDataDO>selectByRecordIdAndType(LongrecordId,StringdataType);// === Map格式查询 ===Map<String,Object>selectMapById(Longid);List<Map<String,Object>>selectMapsByFlightRecordId(LongflightRecordId);List<Map<String,Object>>selectSimpleMapsByRecordId(LongrecordId);// === 统计查询 ===LongcountByFlightRecordId(LongflightRecordId);IntegercountByRecordIdAndType(LongrecordId,StringdataType);Map<String,Object>selectStatsByFlightRecordId(LongflightRecordId);// === 存在性检查 ===BooleanexistsBySeqIdAndRecordId(IntegerseqId,LongflightRecordId);// === 分页查询 ===Page<FlightDataDO>selectPageByRecordId(Page<FlightDataDO>page,LongflightRecordId);Page<Map<String,Object>>selectMapPageByRecordId(Page<?>page,LongflightRecordId);// === 批量查询 ===List<FlightDataDO>selectBySeqIds(@Param("recordId")LongrecordId,@Param("seqIds")List<Integer>seqIds);Map<Integer,FlightDataDO>selectMapBySeqIds(@Param("recordId")LongrecordId,@Param("seqIds")List<Integer>seqIds);// === 业务专用查询 ===List<Map<String,Object>>selectForAlarmAnalysis(LongflightRecordId);List<Map<String,Object>>selectHeightDataForAnalysis(LongflightRecordId);List<Map<String,Object>>selectSpeedDataForAnalysis(LongflightRecordId);// === 扩展查询 ===List<Map<String,Object>>selectWithFlightRecord(LongflightRecordId);List<Map<String,Object>>selectDetailByRecordId(LongflightRecordId);}8. 阿里巴巴的黄金法则
记住这几点：
- 用
select开头- 最规范 - 名词用实体名-
User,Order,Product - 条件用
ByXxx-ById,ByStatus - 返回类型可暗示-
List,Page,Count - Map格式加
AsMaps或Map- 可选
快速决策树：
要查什么？ ├── 单条记录 → selectById / selectByXxx ├── 多条记录 → selectListByXxx / selectByXxx (返回List) ├── 分页 → selectPageByXxx ├── 统计 → selectCountByXxx / countByXxx ├── 存在 → existsByXxx ├── Map格式 → selectAsMapsByXxx / selectMapByXxx └── 复杂业务 → selectFor[业务场景]ByXxx对于你的selectFlightDataListByRecordId：
- ✅ 是阿里巴巴标准命名
- 如果要加关联表，建议：
selectFlightDataWithFlightRecordByRecordId
