很多企业在启动软件开发的时候，完成没有命名规范，导致代码的可读性极差。而业界对于命名，却没有一个统一的命名规范，比如说，获取客户列表，Java类的方法是用get***List还是list****？这些完全的统一的规范 。
这里给出SaaS行业额命名规范，参考了阿里编码规范，加上我十几年来对业务的理解而写成的，可以作为一个开发人员形成一个统一的规范，建议一个项目在启动之前，采用该规范。
该规范并不是行业规范，是基于作者我十年内的经验写成的，可以说具备非常高的可信度，如果开发人员没有这个方面的命名规范，建议采纳。
- JAVA类主要后缀命名规范
| 类型 |
后缀 |
例子 |
说明 |
| DAO类 |
Dao |
UserDao |
扫描二维码关注公众号，回复：
2630072 查看本文章
|
| Service接口类 |
Service |
UserService |
|
| Service实现类 |
ServiceImpl |
UserServiceImpl |
|
| Controller类 |
Controller |
UserController |
实现HTTP访问 |
| 数据对象 |
无后缀 |
User |
数据对象，类名即为数据表名 |
| 数据传送对象 |
DTO |
UserDTO |
前面为业务领域相关的名称 |
| 展示对象 |
VO |
UserVO |
展示对象，前面一般为网页名称 |
| Spring Boot入库程序 |
Application |
OaApplication |
|
| JUnit测试类 |
Test |
UserTest |
|
| 异常类 |
Exception |
CrmException |
|
| 工具类 |
Utils |
MailUtils |
|
| 枚举类 |
Enum |
MessageTypeEnum |
|
| 常量类 |
Constants |
NsqConstants |
|
| 属性类 |
Properties |
ImProperties |
这个类用来保持从统一配置台或者配置文件获取的配置数据 |
| 工厂类 |
Factory |
EncoderFactory |
工厂类用来构造各种实现类 |
| 连接池类 |
Pool |
IoSessionPool |
|
| NSQ消费者处理类 |
Handler |
CustomerTrajectoryHandler |
|
| 类型 |
前缀 |
例子 |
说明 |
| 获取单个对象 |
get |
getCrmDetail |
|
| 获取多个对象 |
list |
listUserInfo |
|
| 获取统计值 |
count |
countUser |
|
| 插入 |
save/insert |
insertCustomerRelation |
|
| 删除 |
remove/delete |
removeOneUser |
|
| 更新 |
Update |
updateCrmDetail |
|
3.1 通用术语
| 中文名称 |
含义 |
英文名称 |
缩写 |
| 客户 |
指企业员工的客户，联系人 |
Crm |
Crm |
| 用户/员工 |
|
User |
User |
| 帐号 |
|
Account |
Account |
| 操作员/操作 |
指后台企业管理配置的操作人，是具有操作权限的用户，如新增员工 |
Operator/Operate |
Operator/Oper |
| 管理者 |
|
Administrator |
Admin |
| 访客 |
|
Visitor |
Visitor |
| 公司 |
指公司客户 |
Company |
Comp |
| 企业 |
|
Corporation |
Corp |
| 代理商 |
|
Agent |
Agent |
| 密码 |
|
Password |
Pass |
| 权限认证 |
|
Authority |
Auth |
| 设置/配置 |
资料设置，密码设置等 |
Configuration |
Config |
| 创建时间 |
创建时间，创建人，更新时间，更新人这四个字段一般用在表上面，前两个记录表数据的创建信息，后两个记录表数据的更新时间 |
Create time |
Create time |
| 创建人 |
|
Create by |
Create by |
| 更新时间 |
|
Update time |
Update time |
| 更新人 |
|
Update by |
Update by |
| 开始时间 |
开始时间和结束时间，一般用在查询中 |
Start time |
Start time |
| 结束时间 |
|
End time |
End time |
| 通知 |
指系统发出的消息，如通知用户系统升级 |
Notice |
Notice |
| 消息 |
指用户发送的消息 |
Message |
Msg |
| 字数限制 |
|
Word limit |
limit |
| 通讯录 |
如：通讯录导入 |
Address book |
Address book |
| 模板 |
如：导入模板 |
Template |
Template |
| 安全 |
|
Security |
Security |
| 昵称/别名 |
|
Alias |
Alias |
| 第三方 |
|
Third party |
3party |
| 应用 |
|
Application |
App |
| 状态 |
|
Status |
Status |
| 域名 |
|
Domain |
Domain |
| 备注 |
|
Remark |
Remark |
| 附件 |
|
Attachment |
Attach |
| 批量 |
|
Batch |
Batch |
| 任务 |
|
Task |
Task |
| 升级 |
|
Upgrade |
Upgrade |
| 设备 |
泛指手机、电脑等 |
Device |
Device |
| 目录 |
|
Dir |
Dir |
| 过期 |
|
Expire |
Expire |
| 地址 |
|
Address |
Addr |
| 迁移 |
数据迁移等 |
Migration/migrate |
Migrate |
| 金额 |
指钱相关的数额 |
Amount of money |
Amount |
| 数额 |
客户总数，在线个数等 |
Numbers |
Nums |
| 统计 |
|
Statistics |
statis |
| 收入 |
收入和支出是类型，而金额没有分类型。比如说，收入表里面有个字段表示金额 |
Revenue |
Revenue |
| 支出 |
|
Expenditure |
Expend |
| 冲突 |
|
Conflict |
Conflict |
| 成功 |
|
Success |
Success |
| 失败 |
|
Fail |
3.2 IM相关业务术语
| 中文名称 |
含义 |
英文名称 |
缩写 |
| 在线 |
|
Online |
Online |
| 离线 |
|
Offline |
Offline |
| 个性签名 |
|
Signature |
Sign |
| 聊天 |
|
Chat |
Chat |
| 聊天记录 |
|
Chat Record |
Chat Record |
| 自动回复 |
|
Auto reply |
Auto reply |
| 在线客服 |
|
Web chat |
WebChat |
| 中文名称 |
含义 |
英文名称 |
缩写 |
| 组织架构/部门 |
|
Organization |
Orga |
| 职位 |
员工的职位 |
Position |
Position |
| 价格 |
|
Price |
Price |
| 合同 |
|
Contract |
Contract |
| 订单 |
|
Order |
Order |
| 发票 |
|
Invoice |
Invoice |
| 产品 |
|
Product |
Product |
| 账单 |
|
Bill |
Bill |