POJO规范
1.所有的POJO类型都应该符合以下设计标准:
- 所有属性都是私有的(`private`)
- 每个属性都有对应的、命名规范的Setter & Getter
- 通过专业的开发工具生成即可
- 应该生成`hashCode()`和`equals()`方法,且保证:2个对象中所有属性值都相同时,返回相同的`hashCode()`,且这2个对象的`equals()`对比结果为`true`
- 通过专业的开发工具生成即可
- 通过IntelliJ IDEA生成时,还有多种代码模版可选择,选择任何一个模版均可
- 实现序列化接口(`Serializable`)
- 可以不生成序列化版本ID
以上规范是业内共同认可的,且认为你都会按此规范来编码,所以,许多框架都会自动调用其中的Setter & Getter方式,甚至会使用`Serializable`来声明你的对象。
2.关于POJO类的命名
在项目中,可能存在多种定位不同的POJO类型,例如某些类型中的属性是与数据库中的表字段一一对应的,这种类型通常称之“实体”,但是,它并不能解决此种数据类型的所有业务!
以“用户”数据为例,数据表中的字段可能有:
- ID
- 用户名
- 密码
- 昵称
当用户注册时,涉及的只有:用户名、密码、昵称,并不涉及ID
当用户登录时,涉及的只有:用户名、密码,并不涉及ID和昵称
- 用户登录时,可能还需要提交“验证码”,原本的实体类并没有
当用户需要修改密码时,需要提交的是:原密码、新密码、确认新密码,原本的实体类将不可用
所以,实体类型并不适用于每个业务!客户端发起的不同请求,需要提交的数据都是不同的!另外,从数据库中查询的数据,也不应该使用实体类型,因为每次查询所需要的数据是不同的!
综合来看,客户端提交的数据与实体可能是不同的,从数据库中查询的结果和实体可能也是不同的,所以,在项目中会存在多种定位不同的POJO类型,通常,不同定位的POJO类型,在命名时,应该添加一些后缀:
3.阿里巴巴的建议:
【参考】各层命名规约:
1.数据对象:xxxDO,xxx 即为数据表名。
DO = Data Object
2.数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
DTO = Data Transfer Object
3.展示对象:xxxVO,xxx 一般为网页名称。
VO = View Object
VO = Value Object> - POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。
【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO / DTO / VO / AO
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
在项目中,每种定位的POJO到底使用什么后缀,并没有标准的约定,只要满足:
- 不使用`POJO`作为后缀
- 同种定位的多个类,使用相同的后缀