自定义仓储中LINQ查询返回的自定义对象是否有特定命名规范?
自定义查询结果对象的命名规范
针对你提到的LINQ查询返回自定义数据的场景,业内有很多实用的命名方式,核心是让名字直接体现对象的用途、包含的数据或业务语义,避免模糊的通用称谓。以下是几种常见且易落地的方案:
1. 基于查询场景命名
直接关联查询的动作或目标,让其他开发者一眼就知道这个对象对应什么查询结果:
- 如果是查询用户的基础信息,可命名为
UserProfileQueryResult - 统计订单月度数据的结果,叫
MonthlyOrderStatsQueryResult - 筛选商品列表的返回对象,命名为
FilteredProductListQueryResult
2. 基于数据用途命名
如果对象是为了特定业务场景展示或处理数据,就围绕用途命名:
- 用于前端列表展示的用户数据,叫
UserListDisplayItem - 导出报表用的订单数据,命名为
OrderReportExportItem - 用于内部系统审批的申请信息,叫
ApprovalApplicationInfo
3. 基于核心业务语义命名
如果对象对应明确的业务概念,直接用业务术语命名,无需额外后缀:
- 比如电商场景中,包含商品基础信息+库存的对象,可直接叫
ProductInventorySummary - 包含用户订单+收货地址的对象,命名为
OrderWithShippingAddress - 汇总用户年度消费情况的对象,叫
AnnualUserSpendSummary
4. 简化后缀的通用方式
如果不想加太长的后缀,也可以用简洁的后缀来区分:
- 用
Result作为后缀:UserSearchResult、OrderCountResult - 用
View作为后缀(适合面向展示的场景):UserProfileView、ProductCardView - 用
Summary作为后缀(适合汇总类数据):OrderSummary、CustomerSummary
避坑提示
- 不要用
Data、Info这类过于宽泛的词单独命名(比如UserData),除非结合前缀能明确语义 - 避免和领域模型(比如
User、Order)重名,防止混淆领域实体和查询结果对象
内容的提问来源于stack exchange,提问作者Ion cojocaru
相关产品推荐
相关产品推荐

