Java工程开发命名规范

系统管理员 2022-08-23 00:42 258阅读 0赞

1.包：**java的包名都是由小写单词组成的**，类名的首字母都是大写，也就是我们常用的驼峰写法，包路径一般都是对系统模板的定义与归类。这样看了包名很容易就明白哪一个模块是干什么的，很容易通过对应的包路径找到对应的代码！

在java开发的过程中，每名Java开发人员都可以编写属于自己的java package，为了在编写中保证每一个java package命名的唯一性，要求开发人员在自己定义的包名前加上唯一的前缀。所以多数开发人员采用自己公司的名称.项目名.模块名.*.*.*在互联网上的域名称作为自己程序包的唯一前缀。例如： com.sun.xml.*.*.*

但要是个人的项目我们又应该怎么命名呢？  
“个人的”单词搜索，有“individual、personal、private、one-man”，进一步对以上4个单词词意的分析，并在保证了唯一性，使用每个单词的前4个字母作为前缀，正好和“com”也做了区分。如下：

indi ：
    
         个体项目，指个人发起，但非自己独自完成的项目，可公开或私有项目，版权主要属于发起者。
    
         包名为indi.发起者名.项目名.模块名*.*.*
    
    pers ：
    
         个人项目，指个人发起，独自完成，可分享的项目，版权主要属于个人。
    
         包名为pers.个人名.项目名.模块名*.*.*
    
    priv ：
    
         私有项目，指个人发起，独自完成，非公开的私人使用的项目，版权属于个人。
    
         包名为priv.个人名.项目名.模块名*.*.* 
    
    
    
    另外，我为了区分团队项目和前面所说项目的区分，还有了一下扩展：
    
    team ：
    
         团队项目指由团队发起，并由该团队开发的项目，版权属于该团队所有。
    
         包名为team.团队名.项目名.模块名*.*.* 
    
    com ：
    
         公司项目：由项目发起的公司所有。
    
         包名为com.公司名.项目名.模块名*.*.*

2：类：首字母大写，如果一个类由多个单词构成，那么每个单词的首字母都大写，而且中间不使用任何的连接符。尽量使用英文。如ConnectionFactory

3：方法：首单词全部小写，如果一个方法由多个单词构成，那么从第二个单词开始首字母大写，不使用连接符。addPerson

4：属性：与方法相同。如ageOfPerson

5：常量：所有单词的字母都是大写，如果有多个单词，那么使用下划线链接即可。