J2EE设计规范(详细).docVIP

J2EE设计规范 总 则 本规范定义了J2EE体系下的软件设计应提供的设计文档，文档内容，文档格式，以期能够使J2EE体系下的设计能够做到规范化和合理化。 本规范遵从J2EE1.4.1规范，如发生冲突，以J2EE1.4.1规范为准。 J2EE体系下的软件设计应遵从以下顺序：软件架构设计(组件模型设计(组件详细设计；软件架构设计(页面导航设计(表示层详细设计。 规范适用于J2EE体系下的软件架构设计、组件模型设计、组件详细设计、表示层详细设计。 J2EE体系下的软件设计应遵照本规范进行评审。 本文档的阅读对象为所有J2EE体系下的软件设计人员、开发人员和评审人员。 该规范的解释权归属于公司技术委员会。 软件架构设计规范 软件架构设计作为软件的基本蓝图，其设计应遵循4＋1视图模型，其设计内容应包含以下四项： 逻辑架构设计 物理架构设计 实现架构设计 部署架构设计 下面是以上四种设计的具体规范。 逻辑架构设计 逻辑架构设计的前提条件是需求用例分析，逻辑架构应与需求用例保持一致。逻辑架构描述了系统中全部的功能模块和模块间的逻辑关系（数据依赖关系和业务逻辑依赖关系），其具体内容和要求包括以下几方面： 逻辑架构应表示出系统的全部功能模块。 功能模块划分应遵循从顶向下的原则，先有子系统架构，然后根据子系统架构确定子系统模块架构。 逻辑架构的设计应遵从多层架构的基本要求，对各子系统、模块进行层次划分，并应详细说明各个层次的划分标准。 逻辑架构还应该表示出系统中各子系统之间的关联关系，包括数据支持关系，业务逻辑处理支持关系；关联关系之间的强弱即是否上层模块必须有下层模块的支持（数据支持和业务逻辑支持）才可运行。 逻辑架构设计除子系统、模块关联关系图之外，还应提交逻辑架构说明。逻辑架构说明中应概要说明每个子系统、模块的功能和所处理的业务逻辑，并应指出其详细需求所在的需求文档位置，以方便设计人员查找阅读。 逻辑架构以图形方式表示，采用微软的软件Visio制作，在图中应提供相应的图示。不同层次的模块应用不同颜色进行标示。 物理架构设计 物理架构设计的前提条件是需求用例分析。物理架构包括了软件的物理结构和软件部署环境的物理拓扑两部份，物理结构中包括软件所使用的中间件、数据库、Application Server、HTTP Server，以及他们之间的逻辑关系。其具体内容和要求包括以下几个方面： 物理架构设计应本着控制成本、减少开发量的原则选择中间件。 设计中应说明主业务系统与所使用的中间件的支持关系，数据交换方式。 如果中间件需使用数据库，应说明中间件与数据库之间的具体关系，已经中间件数据库与主业务系统数据的关系（在物理上一致还是分离）。 如果主业务系统数据库中的数据需要在使用中迁移，应说明迁移方式，以及主业务系统数据库与其他数据库之间的关系。 物理架构中应清晰的表示出系统中的数据流向。 在物理架构中选用的中间件应说明其厂商；如果采用开发源代码的中间件，应说明该中间件由那个开源组织开发，所采用的版本，以及在线文档链接，以便于设计人员查找。 物理架构中应说明系统运行环境的物理网络拓扑，物理Application Server、HTTP Server、数据库服务器所处具体服务器在拓扑中的位置。 应详细说明系统运行环境的物理服务器的具体要求，如几CPU，多少内存，硬盘要求、防火墙等等。如可能最好注明服务器的生产厂商和型号。 物理结构和网络拓扑以图形方式表示，采用MicroSoft Visio制作，在图中应提供相应的图示。 物理结构和网络拓扑图说明采用MicroSoft Word编写。 实现架构设计 实现架构中定义了软件的实现方式（技术体系）和软件的代码结构。其具体内容和要求包括以下几个方面： J2EE体系下的软件实现应遵从MVC模式，根据多层架构将软件分为模型层、视图层和控制层。 针对每一层次详细说明该层次所采用的J2EE体系下的何种技术，如模型层采用的是EJB还是JavaBean，视图层是否采用TagLib等等。 如果在某个层次采用了FrameWork，应在该层次说明该FrameWork的内部运行机制；如果该FrameWork为开源软件，应说明由何开源组织开发，使用的版本。 应该详细说明各个层次之间进行数据通讯的机制。 应定义系统中的异常处理机制，以及如何将异常转化为提示信息的处理。 定义系统中的事务处理原则和采用的方式。如果采用EJB作为模型层实现方式，则应使用平台提供的JTA支持系统事务处理。 如果系统中有配置文件，应定义配置文件的内部结构，命名规则和存放路径。 实现架构应包含组件结构图，使用该图表现系统中所具有的具体组件名称和组件之间的逻辑关系，组件结构图可采用MicroSoft Visio或Rational Rose制作。 组件结构图应提供相关说明