读书人

JAVA项目之SSH编码轨范

发布时间: 2012-06-30 17:20:12 作者: rapoo

JAVA项目之SSH编码规范

编码规范目的:风格统一、代码可读性增强,便于维护

适用范围:J2EE项目,用SSH作为开发框架

一、包命名规范

1、servlet类所在包命名规范:公司名称.项目名称.web.servlet

????? 如com.ninetowns.Lims.web.servlet

2、Action类所在包命名规范:公司名称.项目名称.web.struts.action

????? 如com.ninetowns.Lims.web.action

3、Action类所在包命名规范:公司名称.名项目名称.web.form

???? 如com.ninetowns.Lims.web.form

4、hibernate的bean类所在包命名规范:公司名称.名项目名称.bean

???? 如com.ninetowns.Lims.bean

5、全局类所在包命名规范:公司名称.名项目名称.global

???? 如com.ninetowns.Lims.global

6、dao层接口所在包命名规范:公司名称.名项目名称.dao

???? 如com.ninetowns.Lims.dao

7、dao层接口实现类所在包命名规范:公司名称.名项目名称.dao.impl

??? 如com.ninetowns.Lims.dao.impl

8、业务层接口所在包命名规范:公司名称.名项目名称.bus

??? 如com.ninetowns.Lims.bus

9、业务层接口实现类所在包命名规范:公司名称.名项目名称.bus.impl

?? 如com.ninetowns.Lims.bus.impl

二、类命名规范

1、以大写字母开头,多个单词每个单词开头字母大写

??? 如DataFile

2、接口命名:以大写字母“I”开头

?? 如IApplyImport

3、实现类命名:将接口的大写字母“I”去掉,加后缀“Impl”

?? 如ApplyImportImpl

三、其它命名规范

??? 1、变量命名:

变量名首字母必须小写,如果该变量名有多个单词组成,后面的单 词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。

???? 2、常量命名:

??????? 所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而? 且该变量必须是公共、静态、final类型???

???? 3、方法命名:

????? 首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母? 大写,单词与单词之间不要使用"_"做连接。单词不要使用名词

四、项目组织

???? 在项目组织上,分为文档和源文件进行管理

??? 如Lims下有两个文件夹分别是“工作文档”和“code”。在“工作文档”下有“需求分析”、“系统设计”、“数据模型”、“系统原型”、“系统测试”、“部署发布”和“开发计划”等文档;在“code”下放源代码,对其进行版本控制。


Java部分
所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适应,但是在多个开发人员共同写作的情况下,这些规则是必需的。这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。

命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)

Package 的命名
Package 的名字应该都是由一个小写单词组成。

Class 的命名
Class 的名字必须由大写字母开头而其他字母都小写的单词组成

Class 变量的命名
变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。

Static Final 变量的命名
Static Final 变量的名字应该都大写,并且指出完整含义。

参数的命名
参数的名字必须和变量的命名规范一致。

数组的命名
数组应该总是用下面的方式来命名:
byte[] buffer;
复制代码
而不是:
byte buffer[];
复制代码
方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:

    String?newline?=?System.getProperty("line.separator");????System.out.println("Hello?world"?+?newline);??

复制代码
PrintStream
PrintStream 已经被不赞成(deprecated)使用,用 PrintWrite 来代替她


本文来自: 我要JAVA(www.wyjava.com) 详细文章参考:http://www.wyjava.com/forum-viewthread-tid-1567-page-1-authorid-9.html

读书人网 >软件架构设计

热点推荐