应用系统开发规范V1.0

重庆农商行信贷管理系统

开发规范

重庆农商行信贷管理系统项目组

2010-09

目录

1.概述 (5)

系统技术框架 (5)

概述 (5)

图例 (6)

平台与业务组件接口设计 (7)

2.代码开发规范 (10)

2.1.命名规范 (10)

2.1.1.应用目录结构规范 (10)

2.1.2.包结构与命名 (10)

2.1.3.类/接口命名 (14)

2.1.4.成员变量及方法命名 (15)

2.1.5.局部变量命名（及声明） (15)

2.2.代码书写规范 (16)

2.2.1.总体原则 (16)

2.2.2.类/接口定义 (16)

2.2.3.文本格式 (17)

2.3.注释规范 (18)

2.3.1.程序注释 (18)

2.3.2.文档注释（JavaDoc） (19)

2.4.内容规范 (20)

2.4.1.toString (20)

2.4.2.Log (20)

2.4.3.文件编码 (21)

2.5.JSP页面编码 (21)

2.6.包结构定义 (22)

2.7.业务实体类（DOMAIN）编码 (22)

2.8.操作类（Operation）编码 (22)

2.9.组件类（Component）编码 (23)

2.10.组件代理类（Agent）编码 (23)

1.1.组件接口实现类（Interface）编码 (24)

1.2.组件异常类（Exception）编码 (24)

8.开发项命名规则 (25)

8.1.文件命名 (25)

8.2.标签命名 (25)

9.开发活动规范 (25)

9.1.小组同步 (25)

版本记录

版本编号创建1.0

1.概述

本文档用于定义“重庆农商行信贷管理系统项目”中的源代码开发规范以及其他开发项的命名规则，并且对日常开发活动进行规范，以提高工作效率，保证工作质量。

系统技术框架

概述

利用EMP的IOC功能统一配置文件

使用定义的数据库联接统一数据库连接

统一技术框架，根据项目情况采用如下两种方式

⏹MVC +业务组件+ 表模型

⏹MVC +业务组件+JDBC

业务组件(BIZ COMPONENT)结构

DOMAIN:业务实体的VO，用于存储业务实体数据，贯穿EMP的OPERATION，业务组

件的COMONET，AGENT，DAO层。

COMONENT：具体实现业务逻辑的JAVABEAN，调用AGENT，并被EMP的OPERATION

调用。

AGENT：主要调用DAO及其他资源API（如通讯组件等）。

DAO：由EMP提供的数据库访问对象。

INTERFACE：业务组件间组件统一对外接口。

图例

平台与业务组件接口设计

系统层次划分

为便于清晰地划分支撑平台功能、技术实现与业务逻辑，下图结合支撑平台与业务组件将整个系统从功能结构上分为四个层次。

界面层: 为用户与系统的接口，其使用EMP IDE工具生成主体页面代码，开发人员可适当调整，并使用js对界面要素进行访问与操作，在这一层负责界面逻辑的处理。

接入层: 为EMP基础支撑平台与业务逻辑功能接口（既平台调用业务逻辑的入口），其由EMP容器提供（使用EMP MVC实现对界面HTTP请求的响应，在对应的Operation中调用业务逻辑），在这一层负责一笔业务交易的完整处理（同一事务），以及平台与业务组件间的数据格式转换等基础的功能。

业务逻辑层：以业务组件为基本单元来完成各类不同的业务需求，其由各个业务组件组成，在这一层负责各个业务逻辑、业务流程处理的实现，但不宜包含技术细节，技术细节应屏蔽在技术实现层中。

技术实现层：为组件中业务逻辑的具体实现，其由各个业务代理组件，在这一层负责完成所有的技术细节，例如调用表模型提供的TableModelDAO中的通用功能。

业务组件结构

对业务功能将以两个次层进行划分——业务组件与业务构件，业务组件，作为业务功能划分基本单元，其由若干个业务代理来实现；多个相关的业务组件组成一个业务构件，业务构件作为最顶层的业务划分。例如下图所示，客户构件内，有若干个业务组件。业务构件将对应代码中的包这一层，而业务组件与业务代理对应完成业务处理类。

客户构件

对公客户组件

对私客户组件

客户管理组件

客户代理客户管理代理

构件配置文件

业务构件：是组件的集合，用于对同一类有内在联系的业务组件的包装，负责与其它业务模块之间的边界化分，其物理介质对应一个文件目录与一个构件配置文件。

业务组件：是业务逻辑的基本单元，用于对同一类业务逻辑的包装，负责业务功能之间的边界化分，其物理介质对应一个java 类文件（所有业务组件需继承CMISComponent 类）。

业务代理：代理业务组件完成具体的技术实现细节，其物理介质对应一个java 类文件（所有业务代理需继承CMISAgent 类）。

注：在该构件配置文件中，${xxx1} ${xxx2}表示属性的键名

支撑平台与业务组件间接口实现描述

对于普通的Web 应用系统，在EMP 支撑平台中是通过配置MVC 中的Action 实现接入，并在Operation 中调用后台的业务组件，在业务组件中调用业务代理，在业务代理中调用底层的技术组件。下面类图中描述了业务组件类与平台技术组件内之间关系。