IT培训网 - IT职场人学IT技术上IT培训网
Java程序员怎样给代码起个好名字
时间:2016-08-25 11:40:10 来源:Java培训网 作者:IT培训网 已有:名学员访问该课程
想要写出好的代码,需要一点积累,但是想要做好命名,只要有稍好一点的英语基础和自我意识。结合IT培训网郑州Java培训学校的开发经验,总结出若干命名规则,纯属个人的使用习惯,,供大家交流讨论。
1
要使用英文,而且要使用准确的英语,无论是拼写还是语法
名词单数,必须使用单数英文,如Account、Customer。
对于数组,列表等对象集合的命名,必须使用复数,而且最好按照英文的语法基础知识使用准确的复数形式,如Listaccounts、Setstrategies。
对于boolean值的属性,很多开发人员习惯使用isXXX,如isClose(是否关闭),但这里有两点建议:
最好不要带“is”,因为JavaBean的规范,为属性生成get/set方法的时候,会用“get/set/is”,上面的例子,生成get/set方法就会变成“getIsClose/isIsClose/getIsClose”,非常别扭;
由于boolean值通常反映“是否”,所以准确的用法,应该是是用“形容词”,上面的例子,最终应该被改为closed,那么get/set方法就是“getClosed/isColsed/setClosed”,非常符合英语阅读习惯。
2
切忌使用拼音,甚至是拼音首字母组合
笔者在做代码检查的时候,无数次遇到过这样的命名,使人哭笑不得。
3
切忌使用没有任何意义的英语字母进行命名
这是在很多教Java基本语法的书上常见的代码片断,作为教学材料,这样写无可厚非,但作为真正的代码编写,程序员必须要养成良好的习惯,不要使用这种没有任何含义的命名方式,这里可以使用“index”。
4
方法名的命名,需要使用“动宾结构短语”或“是动词+表语结构短语”
笔者曾看到过千奇百怪的方法命名,有些使用名词,有些甚至是“名词+动词”,而且,如果宾语是一个对象集合,还是最好使用复数:
5
对于常见的“增删改查”方法,命名最好要谨慎:
增加:最常见使用create和add,但最好根据英语的语义进行区分,这有助于理解,create代表创建,add代表增加。
比如,要创建一个Student,用createStudent要比用addStudent好,为什么?想想如果有个类叫Clazz(班级,避开Java关键字),现在要把一个Student加入到一个Clazz,Clazz很容易就定义了一个addStudent(Student student)的方法,那么就比较容易混淆。
修改:常见的有alter、update、modify,个人觉得modify最准确。
查询:对于获取单个对象,可以用get或load,但个人建议用get,解释请见第7点的说明,对于不分条件列举,用list,对于有条件查询,用search(最好不要用find,find在英文了强调结果,是“找到”的意思,你提供一个“查询”方法,不保证输入的条件总能“找到”结果)。
删除:常见的有delete和remove,但删除建议用delete,因为remove有“移除”的意思,参考Clazz的例子就可以理解,从班级移除一个学生,会用removeStudent。
6
成员变量不要重复类的名称
例如,很多人喜欢在Account对象的成员变量中使用accountId,accountNumber等命名,其实没有必要,想想成员变量不会鼓孤立的存在,你引用accountId,必须是account.accountId,用account.id已经足够清晰了。
7
如果你在设计业务系统,最好不要使用技术化的术语去命名
笔者曾经工作的公司曾经制订这样的命名规则,接口必须要以“I”开头,数据传输对象必须以“DTO”作为后缀,数据访问对象必须以“DAO”作为后缀,领域对象必须以“DO”作为后缀,我之所以不建议这种做法,是希望设计人员从一开始就引导开发人员,要从“业务”出发考虑问题,而不要从“技术”出发。
所以,接口不需要非得以“I”开头,只要其实现类以“Impl”结尾即可(注:笔者认为接口是与细节无关的,与技术无关,但实现类是实现相关的,用技术化术语无可口非)。
而数据传输对象,其实无非就是保存一个对象的信息,因此可以用“**Info”,如CustomerInfo,领域对象本身就是业务的核心,所以还是以其真实名称出现,比如Account、Customer,至于“DAO”,这一个词来源于J2ee的设计模式,笔者在之前的项目使用“***Repository”命名,意味“***的仓库”,如AccountRepository.
Eric Evans对Repository的概念定义是:领域对象的概念性集合,个人认为这个命名非常的贴切,它让程序员完全从技术的思维中摆脱出来,站在业务的角度思考问题。
说到这里,可能有人会反驳:像Spring、Hibernate这些优秀的框架,不是都在用“I”作为接口开头,用“DAO”来命名数据访问对象吗?没错!但千万别忽略了语义的上下文,Spring、Hibernate框架都是纯技术框架,我这里所说的场景是设计业务系统。
8
宁愿方法名冗长,也不要使用让人费解的简写
命名也是一项很重要的事情,往后几十年,可都是这样了。因此,作为一个优秀的Java程序员,具备给程序起个好名字的能力,也是很重要的。
想了解更多IT资讯,可以通过QQ:3158895217与IT培训网老师互动,或者关注微信“hntedu”相信上市公司的实力。
每期开班座位有限.0元试听抢座开始!
温馨提示 : 请保持手机畅通,咨询老师为您
提供专属一对一报名服务。