JavaEE项目开发--基础篇-1--JavaEE开发之SSH+maven开发规范小结（规范就是标准，不容小视）

作者：Jans-pursue  题目：JavaEE开发之SSH+maven开发规范小结  副标题：规范就是标准，不容小视  QQ:1250913085

一、命名规范

1.1 总体原则

见名知意，尽量是别人可以一看到名字就可以推测出它的意思，不得随随便便取一些毫无意义的名称。

1.2 文档名称

名称-（姓名）-日期-（版本号）  ——     项目开发规范-金果-2012-10-09-V1.0。

1.3 项目名称

全英文，大小写无要求，但是名称需要表达出整个工程的核心业务内容，达到见名知意。

1.4 包名称

      全英文，一律小写，第一层包名称建议使用项目名称（或是团队、公司等的标志来命名，eg：新思路、com.nth.）的前三个字母；后面几层的包名称根据层次结构的名称或者模块的名称来命名。

      例如：

 

图1-1 包命名-1

1.5 类名称

      全英文，首字母大写；可以采取多个单词拼接的形式，那么各个单词的首字母都要大写。别外对于接口而言，名称首字母以大写的I开头。

 

图1-2 类命名-1

1.6 属性名称

      全英文，首字母小写；可以采取多个单词拼接的形式，那么除了第一个单词以外，其余各个单词的首字母都要大写。

 

图1-3 属性命名-1

1.7 方法名称

      全英文，首字母小写；可以采取多个单词拼接的形式，那么除了第一个单词以外，其余各个单词的首字母都要大写。

 

图1-4 方法命名-1

二、层次结构

2.1 项目目录结构及其说明

      整体系统采用的是Maven+S2SH+Freemarker模式开发。

（1）类组织结构图

 

图1-4 方法命名-1

主要问题：缺少值对象VO；

（2）资源配置文件目录结构图

 

图2-2 资源配置文件目录结构图-1

（3）web文件目录结构图

 

图2-3 web文件目录结构图-1

2.2 层次之间调用关系

（1）基本的三层结构

 

图2-4 基本三层结构-1

      一个实际的软件项目开发，必须有层次的划分。分层并不一定会提高程序的执行效率，相反，在一定的程度上还会降低程序的执行效率，但是非常有利于软件的解藕，所以分层是非常有必要的。通常情况下会采用基本自上而下的三层结构：UI层、业务逻辑层、数据访问层，下层为上层提供支持，上层会调用下层的服务。

（2）面向接口编程

图2-5 面向接口编程-1 

      分层之后，各层次之间就应该是接口级别的依赖关系了（当然model也是要上下流动的，它是接口中的数据传递参数），接口是各层之间的契约。接口需要上下层之间共同去制定，一旦定好之后，接口就是大家需要共同遵守的标准。下层需要去实现接口规定的功能，上层会去调用接口提供的功能而不用去知道它的具体实现。

2.3 基本的配置文件

（1）简述Spring中bean的基本配置

具体的配置文件：

 

图2-6 基本的Spring配置-1

 

配置文件相关的类：

 

图2-7 基本的Spring配置-2

（2）基本的struts配置

系统总体的配置：

 

图2-8 基本的struts配置-1

 

某个模块的配置：

 

图2-9 基本的struts配置-2

 

未完待续……

 

作者友情提示：

　　原始作者：Jans-pursue；

　　原始博客：JavaEE开发之SSH+maven开发规范小结；

　　QQ邮箱： 1250913085@qq.com；