|
|
|
|
@ -33,17 +33,17 @@ team team.团队名.项目名.模块名.…… 团队项目，指由团队发起
@@ -33,17 +33,17 @@ team team.团队名.项目名.模块名.…… 团队项目，指由团队发起
|
|
|
|
|
|
|
|
|
|
对于一些特殊特有名词缩写也可以使用全大写命名，比如 XMLHttpRequest，不过笔者认为缩写三个字母以内都大写，超过三个字母则按照要给单词算。这个没有标准如阿里巴巴中 fastjson 用 JSONObject 作为类命，而 google 则使用 JsonObjectRequest 命名，对于这种特殊的缩写，原则是统一就好。 |
|
|
|
|
|
|
|
|
|
属性 约束 例 |
|
|
|
|
抽象类 Abstract 或者 Base 开头 BaseUserService |
|
|
|
|
枚举类 Enum 作为后缀 GenderEnum |
|
|
|
|
工具类 Utils 作为后缀 StringUtils |
|
|
|
|
异常类 Exception 结尾 RuntimeException |
|
|
|
|
接口实现类 接口名+ Impl UserServiceImpl |
|
|
|
|
领域模型相关 /DO/DTO/VO/DAO 正例：UserDAO 反例：UserDo， UserDao |
|
|
|
|
设计模式相关类 Builder，Factory 等 当使用到设计模式时，需要使用对应的设计模式作为后缀，如 ThreadFactory |
|
|
|
|
处理特定功能的 Handler，Predicate, Validator 表示处理器，校验器，断言，这些类工厂还有配套的方法名如 handle，predicate，validate |
|
|
|
|
测试类 Test 结尾 UserServiceTest， 表示用来测试 UserService 类的 |
|
|
|
|
MVC 分层 Controller，Service，ServiceImpl，DAO 后缀 UserManageController，UserManageDAO |
|
|
|
|
| 属性 约束 例 |
|
|
|
|
| 抽象类 Abstract 或者 Base 开头 BaseUserService |
|
|
|
|
| 枚举类 Enum 作为后缀 GenderEnum |
|
|
|
|
| 工具类 Utils 作为后缀 StringUtils |
|
|
|
|
| 异常类 Exception 结尾 RuntimeException |
|
|
|
|
| 接口实现类 接口名+ Impl UserServiceImpl |
|
|
|
|
| 领域模型相关 /DO/DTO/VO/DAO 正例：UserDAO 反例：UserDo， UserDao |
|
|
|
|
| 设计模式相关类 Builder，Factory 等 当使用到设计模式时，需要使用对应的设计模式作为后缀，如 ThreadFactory |
|
|
|
|
| 处理特定功能的 Handler，Predicate, Validator 表示处理器，校验器，断言，这些类工厂还有配套的方法名如 handle，predicate，validate |
|
|
|
|
| 测试类 Test 结尾 UserServiceTest， 表示用来测试 UserService 类的 |
|
|
|
|
| MVC 分层 Controller，Service，ServiceImpl，DAO 后缀 UserManageController，UserManageDAO |
|
|
|
|
|
|
|
|
|
### 四，方法 |
|
|
|
|
|
|
|
|
|
@ -70,50 +70,51 @@ MVC 分层 Controller，Service，ServiceImpl，DAO 后缀 UserManageController
@@ -70,50 +70,51 @@ MVC 分层 Controller，Service，ServiceImpl，DAO 后缀 UserManageController
|
|
|
|
|
|
|
|
|
|
##### 4.3 按需求才执行的方法 |
|
|
|
|
|
|
|
|
|
| 位置 | 单词 | 意义 | 例 | |
|
|
|
|
|:-------|:---------|:--------------------------------|:-------------| |
|
|
|
|
| Suffix | IfNeeded | 需要的时候执行，不需要的时候什么都不做 | drawIfNeeded | |
|
|
|
|
| Prefix | might | 同上 | mightCreate | |
|
|
|
|
| Prefix try 尝试执行，失败时抛出异常或是返回 | errorcode tryCreate |
|
|
|
|
| Suffix OrDefault 尝试执行，失败时返回默认值 getOrDefault |
|
|
|
|
| Suffix OrElse 尝试执行、失败时返回实际参数中指定的值 getOrElse |
|
|
|
|
| Prefix force 强制尝试执行。error 抛出异常或是返回值 forceCreate, forceStop |
|
|
|
|
| 位置 | 单词 | 意义 | 例 | |
|
|
|
|
|:-------|:-----------------------|:--------------------------------|:-------------| |
|
|
|
|
| Suffix | IfNeeded | 需要的时候执行，不需要的时候什么都不做 | drawIfNeeded | |
|
|
|
|
| Prefix | might | 同上 | mightCreate | |
|
|
|
|
| Prefix try 尝试执行，失败时抛出异常或是返回 errorcode | tryCreate | |
|
|
|
|
| Suffix OrDefault 尝试执行，失败时返回默认值 | getOrDefault | |
|
|
|
|
| Suffix OrElse 尝试执行、失败时返回实际参数中指定的值 | getOrElse | |
|
|
|
|
| Prefix force 强制尝试执行。error 抛出异常或是返回值 | forceCreate, forceStop | |
|
|
|
|
|
|
|
|
|
##### 4.4 异步相关方法 |
|
|
|
|
|
|
|
|
|
位置 单词 意义 例 |
|
|
|
|
Prefix blocking 线程阻塞方法 blockingGetUser |
|
|
|
|
Suffix InBackground 执行在后台的线程 doInBackground |
|
|
|
|
Suffix Async 异步方法 sendAsync |
|
|
|
|
Suffix Sync 对应已有异步方法的同步方法 sendSync |
|
|
|
|
Prefix or Alone schedule Job 和 Task 放入队列 schedule, scheduleJob |
|
|
|
|
Prefix or Alone post 同上 postJob |
|
|
|
|
Prefix or Alone execute 执行异步方法（注：我一般拿这个做同步方法名） execute, executeTask |
|
|
|
|
Prefix or Alone start 同上 start, startJob |
|
|
|
|
Prefix or Alone cancel 停止异步方法 cancel, cancelJob |
|
|
|
|
Prefix or Alone stop 同上 stop, stopJob |
|
|
|
|
| 位置 单词 意义 例 |
|
|
|
|
| Prefix blocking 线程阻塞方法 blockingGetUser |
|
|
|
|
| Suffix InBackground 执行在后台的线程 doInBackground |
|
|
|
|
| Suffix Async 异步方法 sendAsync |
|
|
|
|
| Suffix Sync 对应已有异步方法的同步方法 sendSync |
|
|
|
|
| Prefix or Alone schedule Job 和 Task 放入队列 schedule, scheduleJob |
|
|
|
|
| Prefix or Alone post 同上 postJob |
|
|
|
|
| Prefix or Alone execute 执行异步方法（注：我一般拿这个做同步方法名） execute, executeTask |
|
|
|
|
| Prefix or Alone start 同上 start, startJob |
|
|
|
|
| Prefix or Alone cancel 停止异步方法 cancel, cancelJob |
|
|
|
|
| Prefix or Alone stop 同上 stop, stopJob |
|
|
|
|
|
|
|
|
|
##### 4.5 回调方法 |
|
|
|
|
|
|
|
|
|
位置 单词 意义 例 |
|
|
|
|
Prefix on 事件发生时执行 onCompleted |
|
|
|
|
Prefix before 事件发生前执行 beforeUpdate |
|
|
|
|
Prefix pre 同上 preUpdate |
|
|
|
|
Prefix will 同上 willUpdate |
|
|
|
|
Prefix after 事件发生后执行 afterUpdate |
|
|
|
|
Prefix post 同上 postUpdate |
|
|
|
|
Prefix did 同上 didUpdate |
|
|
|
|
Prefix should 确认事件是否可以发生时执行 shouldUpdate |
|
|
|
|
| 位置 单词 意义 例 |
|
|
|
|
| Prefix on 事件发生时执行 onCompleted |
|
|
|
|
| Prefix before 事件发生前执行 beforeUpdate |
|
|
|
|
| Prefix pre 同上 preUpdate |
|
|
|
|
| Prefix will 同上 willUpdate |
|
|
|
|
| Prefix after 事件发生后执行 afterUpdate |
|
|
|
|
| Prefix post 同上 postUpdate |
|
|
|
|
| Prefix did 同上 didUpdate |
|
|
|
|
| Prefix should 确认事件是否可以发生时执行 shouldUpdate |
|
|
|
|
|
|
|
|
|
##### 4.6 操作对象生命周期的方法 |
|
|
|
|
|
|
|
|
|
单词 意义 例 |
|
|
|
|
initialize 初始化。也可作为延迟初始化使用 initialize |
|
|
|
|
pause 暂停 onPause ，pause |
|
|
|
|
stop 停止 onStop，stop |
|
|
|
|
abandon 销毁的替代 abandon |
|
|
|
|
destroy 同上 destroy |
|
|
|
|
dispose 同上 dispose |
|
|
|
|
| 单词 | 意义 | 例 | |
|
|
|
|
|:---------|:----------------|:---------------| |
|
|
|
|
| initialize | 初始化。也可作为延迟初始化使用 | initialize | |
|
|
|
|
| pause | 暂停 | onPause ，pause | |
|
|
|
|
| stop | 停止 | onStop，stop | |
|
|
|
|
| abandon | 销毁的替代 | abandon | |
|
|
|
|
| destroy | 同上 | destroy | |
|
|
|
|
| dispose | 同上 | dispose | |
|
|
|
|
|
|
|
|
|
##### 4.7 与集合操作相关的方法 |
|
|
|
|
|
|
|
|
|
|
