review项目实体类经验干货分享（精华）

今天review了项目部分实体类。感觉有些小的心得和思考，不敢独享，故分享给大家，也分享给记性不好的自己。嘎嘎~

因为项目中每个人负责的模块不一样，编程风格和命名风格也有不同，这就对代码的可读性造成了影响。

尤其在实体类命名的时候，我觉着有几个字段是我们要注意的（且应该在项目开始的时候和成员新加入的时候要告诉他们一定要这样做）：

1、联系电话、移动电话、固定电话

这个是个神坑字段，首先是因为开始我们表里只有<联系电话>这个字段，只存储 移动电话 ，而随着业务发展，可能会多出需要存储 固定电话 的需求。这个时候命名就会发生混乱，让后来进入项目的人看起来很蒙圈。

因为对电话的命名字段有很多，举个栗子：tel、phone、telephone、number（取号码之意，我的项目里面就有一个这样的字段）、mobilephone(移动电话)、mobilePhone(移动电话)、fixedTelephone(固定电话)、话)、fixedPhone(固定电话)、phoneNumber、phoneNum(我很早之前喜欢的脑残命名)......

ps：我现在做的项目在命名和规范问题上已经非常非常棒了，但依然存在 tel、phone、number这三种命名。

每个人的习惯不同，命名方式自然不同，可能这事没有对错，谁能说用tel命名的人要比用phone命名的人low呢？但统一的就是对的。

我建议是这样

a、初始的<联系电话>字段使用 mobilePhone，若日后有又固定电话的需求，修改mobilePhone的注释为--<移动电话>，并加上固定电话的字段fixedPhone。（但是有一种情况是将来<移动电话>和<固定电话>存在一个字段中，这种命名会让人看不懂）。

b、初始<联系电话>字段使用 phone，日后有<固定电话>的需求的时候，使用fixedPhone。这种命名我还是很满意的，可以解决a方案中的移动和固话在一个字段的情况，而且在原有字段加修饰词的方式我也很喜欢。

2、单价、总价、价格 等关于钱的命名（之后还会有和价格组合的字段，也要统一，例如：boxPrice、goodsPrice等）

这个字段也歧义颇多。开始的需求可能只是有一个货物的<单价>或<价格>，可能在别的表中又会有这个货物的<总价>，命名的不统一就容易造成理解的难度增加或者理解错误。

这个字段常用命名有：price、money、cost、unitPrice（单价）、totalPrice（总价）。

我建议是这样的

a、在确定需求会有<单价>和<总价>的时候使用unitPrice和totalPrice应该是最清晰的，但有时不确定会不会有总价的概念的时候，b方案可能更好。

b、<单价>使用price，若将来有了<总价>概念后增加 totalPrice。

ps：感觉在面对不确定需求的时候，先使用简单单词作为命名，之后需求增加的之后对后续字段加上形容词总是好的解决方案。

3、备注命名

备注命名可能引起的歧义并不多，保持统一就好。

常用：remark（我最喜欢的）、remarks、note（我项目中的）、comment

4、部门 的命名

<部门>这个总有人喜欢缩写（dept），但有些人就是喜欢全拼（department）。我个人喜欢缩写，但这无所谓的，只要统一就ok

5、标识 的命名

标志即flag。但不要单独使用flag这个作为字段名，没人知道这是什么flag，标识着什么。比如删除标志要delFlag，或者deleteFlag。这样大家才知道你这是什么标识。还有就是字段里面的值的问题。比如我喜欢里面用数字0和1作为标志。但这个一定要统一，计算机业界0为false，非0为true。大家一定要按照这个来填充字段，不要弄反了，让后来的人摸不到头脑。