Java中的命名的技巧-白红宇

Java中的命名的技巧

阅读量：6851 次

发布时间：2019-06-26

本文共 2829 字，大约阅读时间需要 9 分钟。

Why

代码可以自解释

What 规范:

项目, 包名小写

类名: 帕斯卡命名法, 每个字母首字母大写, 避免与常用的jdk, spring, mybatis等常用框架重名

方法名, 变量名: 驼峰, 首字母小写

常量,枚举: 全部大写,多个单词下划线‘_’分割

只能包含字母, 数字, 下划线 $, 且不能数字开头

严禁使用汉字拼音

How 类名称单词出现位置含义示例 & 说明 Dao suffix 数据库访问相关

Service, ServiceImpl suffix 业务处理 Controller suffix View相关 Job suffix 任务调度 RpcService suffix 第二三方调用 DummyServiceImpl suffix 模拟的常见于单元测试无法达到的路径 Cache prefix, middle, suffix 缓存相关 Interceptor suffix 拦截常见于Mvc, 在某个动作之前或之后拦截 Filter suffix 过滤流程能否继续往下走 Producer suffix 生产者常见于消息产生 Consumer suffix 消费者常见于消息处理 Event suffix 事件用途广泛 Adaptor suffix 适配器 LogAdaptor Handler suffix 处理常见于消息处理具体的逻辑 Helper suffix 帮助非关键业务逻辑 Provider suffix 提供某种能力 KeyProvider Resolver suffix 解决某种业务 TypeResolver Processor suffix 处理一个任务 ConsoleProcessor Pipeline suffix 分解任务中的一环 Exceutor suffix 处理器常见与任务处理 Config suffix 配置类没有复杂业务, 仅用于配置 Exception suffix 没啥好说的 Context suffix 传递的上下文 Util suffix 没啥好说的 Constants single 定义常量的interface Converter suffix 类型转换 VO

Param

Bundle

suffix 根据场景选用 Validator suffix 校验器 mvc 参数校验 Stream prefix, middle, suffix 流式处理 Support suffix 支撑非关键业务 Selector suffix 选择器根据条件选择一个或多个, 返回一组相关对象 Listener suffix 监听器监听某种行为 Wrapper suffix 包装器 EntityWrapper Generator suffix 产生 IdGenerator Builder suffix 创建器 Strategy suffix 策略 Initializer suffix 初始化 CallBack suffix 回调 Template middle,suffix 模版 Proxy suffix 某某的代理 Plugin suffix 插件

方法名尽量使用动词开头, 如果含义明确也可以使用名称

单词出现位置含义示例 & 说明单词出现位置含义示例 & 说明 insert, save, create prefix 增跟数据库相关,主要使用insert delete,remove prefix 删跟数据库相关,主要使用delete update, increment, decrement prefix 改跟新, 增加, 减少 select, query, get, list prefix 查跟数据库相关,主要使用select Batch middle,suffix 批量 run, execute, submit single, prefix 运行, 提交运行任务, 跟线程有关联 flush single, prefix 清空, 刷新跟缓存, 存储有关, 没有返回, 或抛出异常

真伪判断

is, can, should, has, needs

prefix 判断状态

能否执行某种动作

执行某个命令好还是不好

是否包含有某些数据或属性

调用发是否需要执行某个命令

isMatch

canAccess

shouldAnimate

hasObservers

needsFill