-1-
密级:共享
概要设计(DD)
IOIF 设计说明书 V2.2
(程序员共享)
修改历史记录
序
号
版本号
内容
作者
编制日期
1.
2.1
根据框架完成框架使用说明与设计描述
Weizd
2012/9/8
2.
2.1
定义验证规则,定义多级联运,定义 UI 规范
Weizd
2012/9/8
3.
2.2
提供分布式事务支持,提供 redis 支持
Weizd
2013/5/15
魏子栋(QQ1320655768)
-2-
目录
第一章 引言 ............................................................................................................................................ 5
1.1 目的 ......................................................................................................................................... 5
1.2 概述 ......................................................................................................................................... 5
1.3 文档目标用户 ......................................................................................................................... 5
1.4 缩略语 ..................................................................................................................................... 6
1.5 参考文档 ................................................................................................................................. 6
第 2 章 IOIF 总体描述 ................................................................................................................... 7
2.1 IOIF 技术框架 ......................................................................................................................... 7
2.2 IOIF 技术架构 ......................................................................................................................... 8
2.3 运行环境与配置管理 ............................................................................................................. 8
2.3.1
应用服务器
..................................................................................................................... 8
2.3.2 JDK ...................................................................................................................................... 9
2.3.3
开发工具及插件
............................................................................................................. 9
2.3.4
数据库
............................................................................................................................. 9
2.3.5
相关开源版本
................................................................................................................. 9
第 3 章 IOIF 设计与描述 ............................................................................................................. 11
3.1 数据库子系统 ....................................................................................................................... 11
3.1.1
概述
............................................................................................................................... 11
3.1.2
设计与分析
................................................................................................................... 11
3.1.3
相关类图
....................................................................................................................... 13
3.1.4
应用举例
....................................................................................................................... 15
3.2 数据源与事务 ....................................................................................................................... 16
3.2.1
概述
............................................................................................................................... 16
3.2.2
设计描述
....................................................................................................................... 16
3.2.3
多数据源与事务关系
................................................................................................... 16
3.2.4
配置模板与示例
........................................................................................................... 17
3.3 框架设计 ............................................................................................................................... 17
3.3.1
框架提供的功能
........................................................................................................... 17
3.3.2 IOIF
提供的工具
.............................................................................................................. 28
3.3.3
通常项目可重用类与功能
........................................................................................... 32
3.3.4
配置文件
....................................................................................................................... 33
3.3.5
相关技术应用
............................................................................................................... 34
-3-
第 4 章 安装配置 ............................................................................................................................... 38
4.1 数据库环境搭建 ................................................................................................................... 38
4.1.1
创建数据库
................................................................................................................... 38
4.2 开发环境的搭建 ................................................................................................................... 38
4.3 应用服务器的安装(以 TOMCAT 为例) ................................................................................. 39
第 5 章 项目规范与约束 ................................................................................................................... 40
5.1 框架结构概述 ....................................................................................................................... 40
5.1.1
数据库命名规范
........................................................................................................... 40
5.1.2
应用后台包类结构
....................................................................................................... 40
5.1.3
应用客户端目录结构
................................................................................................... 40
5.2 客户端 FRAME 使用与规范 .................................................................................................. 42
5.2.1
目录结构
....................................................................................................................... 42
5.2.2
客户端
Frame
命名规范
.............................................................................................. 42
5.2.3 Frame
使用说明
................................................................................................................ 42
5.2.4 Page
入口说明
.................................................................................................................. 43
5.2.5
字符类型约束规范
....................................................................................................... 43
5.2.6 Frame
参考范例
................................................................................................................ 44
5.3 JAVA 编码规范 ...................................................................................................................... 44
5.4 JAVA 开发规范 .................................................................................................................... 45
5.4.1 STRUTS ............................................................................................................................. 45
5.4.2
业务逻辑规范
............................................................................................................... 45
5.4.3
包结构定义
................................................................................................................... 45
5.4.4
系统配置文件及相应工具
........................................................................................... 46
5.5 数据库设计规范 ................................................................................................................... 47
5.5.1
命名规范
....................................................................................................................... 47
5.5.2 SQL
语句规范
................................................................................................................... 48
5.5.3
数据完整性规范(编码期)
....................................................................................... 48
5.5.4
数据库性能优化规范(运行期)
............................................................................... 49
5.5.5
设计工具和版本划分
................................................................................................... 49
5.6 SVN 使用规范 ...................................................................................................................... 49
附录(框架截图) ................................................................................................................................ 50
5.7 框架类结构截图 ................................................................................................................... 50
5.8 框架配置文件截图 ............................................................................................................... 51
5.9 框架客户端结构截图 ........................................................................................................... 52
-5-
第一章 引言
1.1 目的
整合常用的 J2EE、J2SE 与开源项目,针对 J2EE 类项目形成一个可快速开发的平台。
1.2 概述
软件开发思想从面向过程到 OOP 面向对象,再到 AOP 面向方面,每一次新思想的提出都能
够降低对程序员的要求,加快软件开发的进度。该框架在实现的过程中提出一个新的概念 IOP
“面向项目的开发”。在这个思想的指导下,结合当前流行的框架与技术,开发实现了一个面向
项目的集成框架,命名为 IOIF。IOIF 避免了对某个项目的依赖,使之成为一个主流 B/S 与 C/S
项目通用的框架。IOIF 的提出是为了避免每个项目重新考虑与实现框架,在提高项目开发进度
的同时,框架在设计上也封装了一些程序员容易出错的地方,使整个项目更安全更健壮。
IOIF 以 EXTJS 为前端,以 Spring、Struts、Hibernate 为后端,整合了 Proxool、Log4j、Quartz、
Oscache、Castor、Memcached、redis 等优秀的开源软件。
支持 Tomcat6 及 Resin3 等应用服务器,支持 Oracle、MYSQL 等数据库。IOIF 不依赖于应
用服务器可支持 J2SE 的开发。
实现的主要功能有:客户端 Frame、客户端 VAD、异常处理、错误处理、AOP 日志管理、
计划任务、操作日志管理、数据分页功能、线程池管理、内存缓存管理。主要工具有:系统日志
工具、应用属性配置工具、系统属性配置工具、TOOLS 工具、邮件发送工具、MD5 工具等。
1.3 文档目标用户
产品经理;
项目经理;
项目策划;
项目架构师;
项目开发工程师;
系统测试工程师;