Java开发中的命名规范

来源:互联网 发布:临汾行知学校 编辑:程序博客网 时间:2024/05/29 19:50

      在软件开发中,命名是非常重要的一个方面。尤其是在团队开发中大型的项目中,命名的规范不可忽视。开发过大型项目的的软件工程师都可能遇过这种情况,在项目的命名不规范,导致代码的可读性下降,看不懂其他工程师写的代码,这是个很严重的问题。对于项目后续维护来说,也是不可想像的。除此之外,注释也一样不可忽视,尤其在Java开发中。时间久了,有可能你再回头看你写的代码,由于没有注释,你也看不懂是什么意思。所以在此,收集了一些关于在Java开发中命名规范的细节,希望对于Java开发的工程师来说,有点帮助。

1、Java工程包结构命名规范:

     所有的包都以类似于com.accp.ssh06为前缀,组成的单词全部都要小写,单词与单词之间以点号分隔。
     注:com代表你属于什么组织,比如公司就用com,如果是个人开发的一班用net,如果是开源组织一般用org等。以此类推,accp代表你的公司是什么名字,比如accp就是一个公司名称代号,如果是个人的一搬用个人的名字,ssh06代表项目名称,是什么项目就用什么项目名称。我很喜欢用org开头,因为Java是开源免费的。
     当前缀包写好后就到了具体的功能包结构,以下以com.accp.ssh06为前缀的例子:

     (1)servlet可以放到com.accp.ssh06.web.servlet包下面;
   (2)struts的action放到com.accp.ssh06.web.action包下面;
     (3)struts的form放到com.accp.ssh06.web.form包下面;
     (4)filter可以放到com.accp.ssh06.web.filter包下面;
   (5)所有的web工程监听器类放到com.accp.ssh06.web.listener包下面,也就是说所有与web层相关的内容都放到com.accp.ssh06.web下面的子包中;

     (6)所有的业务接口类(包括所有的spring的业务接口)都放到com.accp.ssh06.biz包下面;
     (7)所有业务类的实现类都放到com.accp.ssh06.biz.impl下面;

     (8)所有的数据库访问接口都放到com.accp.ssh06.dao包下面;
     (10)所有的数据库访问实现类都放到com.accp.ssh06.dao.impl包下面;

     (11)所有的实体类都放到com.accp.ssh06.entity包;

     (12)所有自己构建的值对象(VO)都放到com.accp.ssh06.vo包下面;

     (13)一搬所有的工具类都放到com.accp.ssh06.util包下面;
     (14)一般所有的通用类都放到com.accp.ssh06.common包下面;

     (15)如果工程中有启动功能的类放到com.accp.ssh06.context包下面。

2、Java类名的命名规范:

     组成类名的每个单词的首字母要大写,如: AccpTeacher。而且类的取名要有一定的实在意义,让人一看就懂,明白你写的这个类是什么意思,有什么用。如:TeacherDaoImpl表示老师类的数据访问层接口的实现类,里面实现了Dao中的所有方法。

3、Java变量名和方法名的命名规范:

     组成变量名和方法名的第一个单词首字母小写,第二个单词以后首字母大写,如:firstChild、createElement()。与Java类名的命名规范一样,变量名和方法名的命名也要有一定的实际意义,让团队成员一看就懂。

4、Java常量名的命名规范:

     组成常量名的所有单词都要大写,多个单词中间用下划线分隔,如:MAX_NUM。与前面Java类名、变量名和方法名一样,命名也有实际意义。如:MAX_NUM表示一个数字的最大值,因为MAX是最大的意思,NUM是数字的意思。这样,团队中的其他成员一看就明白。

原创粉丝点击