命名规范:企业级微服务模块前缀命名规范全景梳理

在 Java SpringCloud/SpringBoot 微服务架构体系中,模块英文缩写前缀是企业研发统一编码规范的核心部分。 作用:

  1. 快速区分代码归属业务域,通过类名一眼识别所属微服务;

  2. 避免多模块下 PO、Form、Service、Controller 类重名冲突;

  3. 统一团队认知,新人上手成本极低;

  4. 适配多租户、中台化架构拆分(用户中心、订单中台、商品中台等)。

本文分为:通用中台基础模块、电商行业全套业务模块、后台管理系统模块、通用技术中间件模块四大板块,搭配多表格 + 命名示例 + 适用场景完整梳理。

一、中台基础公共模块(所有业务系统必备底层中台)

属于整个公司通用基础支撑服务,所有业务线都会依赖调用

表 1:基础中台模块前缀对照表

|------|----------------------|---------|------------------------------------|-----------------------------------------|
| 缩写前缀 | 英文全称 | 中文模块名称 | 核心负责业务 | 代码命名示例 |
| UC | User Center | 用户中心 | 账号登录、注册、个人信息、角色、菜单、权限、部门、员工、用户收货地址 | UcRoleController、UcUserForm、UcAddressPO |
| SCC | System Config Center | 系统配置中心 | 全局字典、参数配置、轮播图、公告、系统开关 | SccDictService、SccConfigForm |
| FILE | File Center | 文件存储中心 | 图片上传、文件下载、OSS 存储、附件管理 | FileUploadController、FileInfoPO |
| MSG | Message Center | 消息中心 | 短信、站内信、APP 推送、邮件、消息模板 | MsgSmsService、MsgPushForm |
| PAY | Payment Center | 支付中台 | 微信支付、支付宝、余额支付、订单退款、支付流水 | PayOrderPO、PayRefundForm |
| TRC | Transaction Center | 分布式事务中台 | Seata 事务协调、跨服务事务一致性、事务日志 | TrcTxRecordMapper |
| AUTH | Authorization | 认证授权中心 | OAuth2、JWT 令牌签发、网关鉴权、登录校验 | AuthTokenService |

二、电商行业全套业务微服务模块(最主流企业场景)

适用于 B2C 商城、生鲜电商、线下零售商城全链路业务

表 2:电商核心业务域模块前缀规范

|--------------|---------------|---------|-------------------------|--------------------------------|
| 缩写前缀 | 英文全称 | 模块中文名 | 业务范围 | 代码示例 |
| PROD / GOODS | Product | 商品模块 | 商品上下架、分类、规格、库存、图片、详情、品牌 | ProdGoodsPO、ProdCategoryForm |
| ORD | Order | 订单模块 | 下单、订单履约、取消订单、售后、订单流水、发货 | OrdOrderController、OrdItemPO |
| CART | Cart | 购物车模块 | 用户购物车增删改查、购物车选中结算 | CartItemService、CartForm |
| STOCK | Stock | 库存模块 | 商品库存扣减、预占库存、库存回滚、库存预警 | StockSkuMapper、StockDeductForm |
| COUP | Coupon | 优惠券模块 | 优惠券发放、领取、核销、满减规则、活动券 | CoupTicketPO、CoupRuleService |
| PROM | Promotion | 营销活动模块 | 秒杀、拼团、限时折扣、满减活动、首页营销 | PromSeckillForm、PromActivityPO |
| LOG | Operation Log | 操作日志模块 | 用户行为日志、管理员操作审计、访问日志 | LogOperatePO、LogLoginService |
| WARE | Warehouse | 仓储物流模块 | 仓库管理、入库出库、打包、物流轨迹、运费计算 | WareShipForm、WareHousePO |
| RET | Return | 售后退换货模块 | 退货申请、退款审核、换货、售后工单 | RetOrderService、RetApplyForm |

三、后台管理平台通用系统模块(OA/CRM/ERP 管理系统)

多用于企业内部管理、客户管理、人事办公系统

表 3:后台管理系统模块前缀

|------|----------------------------------|----------|----------------------|-------------------------------|
| 缩写前缀 | 英文全称 | 模块名称 | 业务内容 | 命名示例 |
| OA | Office Automation | 办公 OA 模块 | 审批流、请假、考勤、公文、日程、公告 | OaLeaveForm、OaApprovalService |
| CRM | Customer Relationship Management | 客户管理 | 客户线索、客户跟进、商机、合同、客户回访 | CrmCustomerPO、CrmContractForm |
| HR | Human Resource | 人事人力资源 | 员工档案、薪资、社保、招聘、绩效考核 | HrStaffController、HrSalaryPO |
| FIN | Finance | 财务模块 | 对账、发票、收支流水、财务报表、回款 | FinBillPO、FinReconcileForm |
| BIZ | Business | 通用业务模块 | 自定义业务单据、基础业务表单 | BizBillService |

四、通用技术 & 运维支撑模块(技术基础设施服务)

表 4:技术基础设施模块前缀

|------|----------|--------|-------------------------------------|
| 缩写前缀 | 英文全称 | 用途 | 场景 |
| GATE | Gateway | 网关服务 | SpringCloud Gateway 路由转发、限流、熔断 |
| REG | Registry | 注册中心 | Nacos/Eureka 服务注册发现 |
| CONF | Config | 配置中心 | 全局配置文件动态推送 |
| MON | Monitor | 监控中心 | 服务监控、链路追踪、告警(Prometheus+SkyWalking) |
| JOB | Job Task | 定时任务服务 | 分布式定时任务调度(XXL-Job) |

五、配套实体类后缀命名规范(和前缀搭配使用,企业强制标准)

前缀 + 业务名 + 后缀,完整构成 Java 类名称,贯穿 Controller/Service/ 实体

表 5:Java 分层实体后缀含义对照表

|-------------|----------------------|-------------|--------------------|-------------------|
| 类后缀 | 全称 | 分层归属 | 作用说明 | 完整示例 |
| Controller | 控制器 | 控制层 | 接收前端 HTTP 请求入口 | UcRoleController |
| Service | 业务接口 | 业务层接口 | 定义业务抽象方法 | UcRoleService |
| ServiceImpl | 业务实现类 | 业务层实现 | 编写具体业务逻辑 | UcRoleServiceImpl |
| Mapper | 数据访问层 | MyBatis 持久层 | 操作数据库 SQL | UcRoleMapper |
| PO | Persistent Object | 数据库实体 | 和 MySQL 数据表一一映射 | UcRolePO |
| Form | Form DTO | 入参表单 | 前端提交请求入参校验对象 | UcRoleForm |
| DTO | Data Transfer Object | 出参传输对象 | 后端查询数据返回给前端封装 | UcRoleDTO |
| VO | View Object | 视图对象 | 页面展示专属视图封装(复杂页面组装) | UcRoleVO |
| Query | Query DTO | 查询条件对象 | 分页列表查询参数封装 | UcRoleQuery |

六、完整命名案例示范(用户中心角色新增全链路类名)

以你正在编写的「用户中心新增角色」代码为例,整套规范命名串联:

  1. 微服务名:m-uc-provider (uc 用户中心服务)

  2. 控制层:UcRoleController

  3. 入参表单:UcRoleForm

  4. 业务接口:UcRoleService

  5. 业务实现:UcRoleServiceImpl

  6. 数据库实体:UcRolePO

  7. Mapper 接口:UcRoleMapper

七、命名硬性约束规范(企业编码规约)

  1. 模块前缀统一大驼峰首字母大写:Uc、Ord、Prod,禁止全小写 uc、ord;

  2. 业务名词统一小写开头:UcRole(正确)、UcROLE(错误);

  3. 缩写约定俗成,禁止自创生僻缩写,团队统一文档归档;

  4. 一个业务域固定一套前缀,全程不混用;

  5. 微服务名称格式:m-前缀-provider(m 代表 micro 微服务)。

八、易混淆缩写区分对照表

表 6:相近缩写辨析,避免命名出错

|-----|------|-----------------|
| 缩写 | 含义 | 区分要点 |
| UC | 用户中心 | 账号、权限、角色、用户信息专属 |
| SYS | 系统管理 | 字典、系统参数、后台基础配置 |
| ORD | 订单 | 所有订单履约、售后相关 |
| PAY | 支付 | 只负责资金流转、支付流水 |

相关推荐
逻极2 小时前
C# 从入门到精通:现代云原生与AI应用开发实战
ai·云原生·c#·.net
roman_日积跬步-终至千里2 小时前
【从零开始学架构】系统设计的价值:从业务目标到可演进系统
架构
煎饼学大模型11 小时前
Agent 的“大脑-手“解耦架构:当推理层和工具执行层各自独立演进
数据库·人工智能·oracle·架构·agent
Cloud云卷云舒12 小时前
智能体长期记忆技术选型分析报告
云原生·ai-native·haishandb
IT二叔13 小时前
Kubernetes(K8s)-01-简介
云原生·容器·kubernetes
beibeix201517 小时前
MITK中微服务三套注册表数据结构分析
微服务·mitk
韩楚风18 小时前
【参天引擎】一次宕机后的数据恢复,让我把 Cantian 持久化与恢复的六大机制全搞明白了
服务器·网络·数据库·分布式·mysql·架构·cantian
Slice_cy18 小时前
Mint 自研框架设计与实现:从重复开发走向配置驱动(五)
前端·后端·架构