SaaS行业命名规范

    很多企业在启动软件开发的时候,完成没有命名规范,导致代码的可读性极差。而业界对于命名,却没有一个统一的命名规范,比如说,获取客户列表,Java类的方法是用get***List还是list****?这些完全的统一的规范 。

    这里给出SaaS行业额命名规范,参考了阿里编码规范,加上我十几年来对业务的理解而写成的,可以作为一个开发人员形成一个统一的规范,建议一个项目在启动之前,采用该规范。

    该规范并不是行业规范,是基于作者我十年内的经验写成的,可以说具备非常高的可信度,如果开发人员没有这个方面的命名规范,建议采纳。

  1. JAVA类主要后缀命名规范

类型

后缀

例子

说明

DAO类

Dao

UserDao

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

2.类方法主要前缀命名规范

类型

前缀

例子

说明

获取单个对象

get

getCrmDetail

获取多个对象

list

listUserInfo

获取统计值

count

countUser

插入

save/insert

insertCustomerRelation

删除

remove/delete

removeOneUser

更新

Update

updateCrmDetail

3.业务常用术语命名规范

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

失败

Failure[黄育源1]

Fail

3.2 IM相关业务术语

中文名称

含义

英文名称

缩写

在线

Online

Online

离线

Offline

Offline

个性签名

Signature

Sign

聊天

Chat

Chat

聊天记录

Chat Record

Chat Record

自动回复

Auto reply

Auto reply

在线客服

Web chat

WebChat

3.3 企业管理服务业务术语

中文名称

含义

英文名称

缩写

组织架构/部门

Organization

Orga

职位

员工的职位

Position

Position

价格

Price

Price

合同

Contract

Contract

订单

Order

Order

发票

Invoice

Invoice

产品

Product

Product

账单

Bill

Bill

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏施炯的IoT开发专栏

Windows 10 IoT Serials 5 - 如何为树莓派应用程序添加语音识别与交互功能

    都说语音是人机交互的重要手段,虽然个人觉得在大庭广众之下,对着手机发号施令会显得有些尴尬。但是在资源受限的物联网应用场景下(无法外接鼠标键盘显示器),如...

21510
来自专栏即时通讯技术

手把手教你读取Android版微信和手Q的聊天记录(仅作技术研究学习)

特别说明:本文内容仅用于即时通讯技术研究和学习之用,请勿用于非法用途。如本文内容有不妥之处,请联系JackJiang进行处理!

8952
来自专栏杨建荣的学习笔记

dg的奇怪问题终结和分区问题答疑 (r7笔记第77天)

今天来说几个问题,一个是对昨天《让我焦灼的四个问题》的升华,不能起博眼球的题目,技术分析给大家兜底了,你们看看有没有类似的问题。 还有几个小问题说说今天的感受和...

3525
来自专栏iOSDevLog

用Kotlin破解Android版微信小游戏-跳一跳成果跳一跳思路源码使用方法参考来源Android 插件 免PC

3936
来自专栏PHP在线

php中关于mysqli和mysql区别的一些知识点分析

一: PHP-MySQL 是 PHP 操作 MySQL 资料库最原始的 Extension ,PHP-MySQLi 的 i 代表 Improvement ,...

29710
来自专栏FreeBuf

【永不消逝的电波(二)】HackRF入门:家用无线门铃信号重放

0x00 前言 在第一篇文章:永不消逝的电波(一):无线电入门篇 我们了解了一下无线电的发展史以及无线电的一些物理知识,在第二篇里我们将用HackRF录制家用...

3127
来自专栏北京马哥教育

给Python新人练手准备的十个简单趣味脚本

? 01. 目录文件分类 前言 有时候,想要对一个目录里的文件进行搜索或者分类操作往往是一件痛苦的事情,下面这个程序的目的是将目录下的文件树以某种分类规则进行...

49810
来自专栏Java与Android技术栈

一个快速分析android app使用了哪些sdk的工具工具使用实现原理写在最后

前段时间我们要准备开始做移动端广告sdk,我需要了解市面上一些常用的广告sdk使用情况。如果一个个app去分析,那工作量会非常庞大,所以就产生了这个工具Anal...

1062
来自专栏农夫安全

如何移除Android应用广告

0x00 前言 我用以前做过的一个小游戏为例,源代码地址:http://git.oschina.net/androidsourcecode/parity,如果不...

4866
来自专栏Python中文社区

怎样用Python实现地理编码

怎样用Python实现地理编码 专栏作者:时空Drei ❈ 时空Drei,德国德累斯顿工业大学在读博士生,个人的擅长领域为:利用Python进行空间数据(遥感G...

4277

扫码关注云+社区

领取腾讯云代金券