PAFA新架构规范.doc

本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 1 页 共 19 页 项目名称编 号 20050427 拟 制樊荣 版本号讨论稿审 核马骏 PAFA新架构规范 密 级共 19 页批 准马骏 更改信息更改信息 更改日期版本部门及更改人版本说明 2005 04 200 2 樊荣初版 2005 4 261 0 马骏修改 2005 6 281 1 刘申岭修改 PAFAPAFA 新架构规范新架构规范 创建日期 2005 06 21 定版日期 中国平安保险 集团 股份有限公司中国平安保险 集团 股份有限公司 信息管理中心信息管理中心 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 2 页 共 19 页 目录目录 1 概述概述 2 1 1PAFA 新架构规范分类 2 1 2标记约定 2 1 3名词解释 2 1 4本文档中引用到的系统 应用 说明 2 1 5标记约定 2 2 2 公共平台服务及公共平台服务及 PAFAPAFA SDKSDK 的组件使用规范 的组件使用规范 2 2 1概述 2 2 2PAFA SDK 组件使用规范 2 2 3RM 使用规范 2 2 4工作流使用规范 2 2 5EAI 使用规范 2 2 6其它公共平台服务的使用规范 2 3 3 团队开发规范团队开发规范 2 3 1概述 2 3 2人员组织 2 3 2 13 2 1项目小组成员的角色 职责和分工项目小组成员的角色 职责和分工 2 3 2 23 2 2分工方式分工方式 2 3 2 33 2 3岗位轮流岗位轮流 2 3 3团队开发配置管理 2 4 4 PAFAPAFA 开发规范开发规范 2 4 1概述 2 4 2命名规范 2 4 2 14 2 1PackagePackage 包结构规范包结构规范 2 4 2 1 14 2 1 1PackagePackage 分类和命名原则分类和命名原则 2 4 2 1 24 2 1 2WebWeb 层层 PackagePackage 命名规范命名规范 2 4 2 1 34 2 1 3业务层业务层 PackagePackage 命名规范命名规范 2 4 2 1 44 2 1 4集成层集成层 PackagePackage 命名规范命名规范 2 4 2 1 54 2 1 5模块级模块级 commoncommon 2 4 2 1 64 2 1 6应用级的应用级的 commoncommon 2 4 2 1 7系统级的系统级的commoncommon 2 4 2 24 2 2PAFAPAFA 组件命名规范组件命名规范 2 4 2 34 2 3JNDIJNDI 命名规范命名规范 2 4 2 3 1EJB 的 JNDI 命名规范 2 4 2 3 2DataSource 的 JNDI 命名规范 2 4 2 3 3JMS 的 JNDI 命名规范 2 4 2 44 2 4URLURL 命名规范命名规范 2 4 2 5配置文件 日志文件及其他文件命名规范配置文件 日志文件及其他文件命名规范 2 4 2 5 1日志文件命名规范 2 4 2 5 2新架构配置文件名规范 2 4 2 5 3其它文件命名规范其它文件命名规范 2 4 3PROPERTIES文件中的变量命名规范 2 4 4CONTEXT PROPERTIES 文件中的变量命名规范 2 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 3 页 共 19 页 4 4 1JNDI url变量的命名规范变量的命名规范 2 4 4 2JNDI 用户名变量的命名规范 用户名变量的命名规范 2 4 4 3JNDI 用户密码变量的命名规范 用户密码变量的命名规范 2 4 5其他PROPERTIES文件中的变量命名规范 2 4 6配置文件存放的子目录规范 2 4 6 1Application 子目录存放的配置文件 2 4 6 2Biz 子目录存放的配置文件 2 4 6 3Core子目录存放的配置文件 2 4 6 4ejb子目录存放的配置文件 2 4 6 5web 层子目录存放的配置文件 2 4 7异常处理规范 2 4 8日志记录规范 2 5 5 PAFAPAFA 设计规范设计规范 2 5 1概述 2 5 2组件间调规范 2 5 2 1Web 层调用规范 2 5 2 2Action 组件调用规范 2 5 2 3Service 组件调用规范 2 5 2 4BO 组件调用规范 2 5 2 5DAO 组件调用规范 2 5 2 6SAO 组件调用规范 2 5 3组件设计规范 2 5 3 1Action 设计规范 2 5 3 2Service 设计规范 2 5 3 3BO 设计规范 2 5 3 4DAO 设计规范 2 5 3 5SAO 设计规范 2 5 3 6DTO 设计规范 2 5 4系统设计规范 2 5 5事务控制规范 2 6 6 PAFAPAFA 测试规范测试规范 2 7 7 PAFAPAFA 应用系统打包及部署规范应用系统打包及部署规范 2 8 8 PAFAPAFA 系统之间服务及数据集成标准和规范系统之间服务及数据集成标准和规范 2 9 9 PAFAPAFA J2EEJ2EE 系统标准开发流程 方法论 的规范系统标准开发流程 方法论 的规范 2 10 10 PAFAPAFA 技术培训 培训流程 培训内容规范技术培训 培训流程 培训内容规范 2 11 11 PAFAPAFA 设计文档模版及模版的标准化内容规范设计文档模版及模版的标准化内容规范 2 12 12 PAFAPAFA 公共平台项目发布流程规范公共平台项目发布流程规范 2 13 13 PAFAPAFA 公共平台项目申请及注册流程规范公共平台项目申请及注册流程规范 2 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 4 页 共 19 页 PAFAPAFA 新架构规范新架构规范 1 1 概述概述 PAFA 3 0 beta 5 以后 将陆续制定各种规范 这些规范面向不同的用户 适合不同的应用 场合 这些规范既是我们设计和开发基于新架构的业务系统应该遵守的守则 更是我们设计和开 发 的指南 它将告诉我们在各种不同的情况下 应该如何分析设计和开发业务系统 避免出现无 所适从 混乱 不标准的情况 遵守新架构规范的业务系统将更易于沟通和维护 更易于经验和资源的共享 更标准和规 范 1 11 1PAFAPAFA 新架构规范分类新架构规范分类 团队开发管理规范 公共平台服务及 pafa 组件使用规范 开发规范 设计规范 测试规范 打包 部署规范 系统集成规范 技术培训规范 系统开发设计标准方法和流程 方法论 规范 技术文档模版及标准内容样板规范 公共平台标准流程 包括申请使用 版本发布 等规范 如下表所示 新架构规范新架构规范 分类名称分类名称变更变更 类型类型 备注和说明备注和说明 开发规范修改Pafa 开发规范主要规定了基于pafa 新架构的业务系统开发过程中 在代码编程方面的规范 主要包含以下几方面内容 1 命名规范 package pafa sdk 组件 EJB DataSource 类 方法 文件名 pafa 配置文件等的命名规范 2 组件使用规范 Log Exception Message 等的使用规范 3 代码优化 垃圾对象收集等规范 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 5 页 共 19 页 4 代码调试规范 新架构禁止在代码中写 System out println 语句打印字符串和对象的值来调 试程序 而只能使用Log 或者pafa 提供的 代码调试的功能DevLog 设计规范新增 该规范主要规定了在基于pafa 新架构的业务系统设计方面的规范 主要包含以下几方面内容 1 pafa 组件之间互相调用的规范 比如规定Action 可以调用别的Action Action 不能调用BO等 不能把 BO抛到WEB层等规范 2 pafa 组件设计规范 规定了每个pafa 组件的设计要求 比 如规定满足什么样的条件是BO组件 规定了BO等组件的使用方 法 3 系统设计原则和方案 规定了在不同的情况下应该采取的设 计方案 比如规定了在什么情况下可以面向对象编程 使用BO对象 什么情况下可以面向过程编程 采用package JDBC等实现方 式 4 Trasaction 事务控制规范 规定了根据不同的事务控制的复 杂度应该采取的不同的设计和实现方式 测试规范待补充 该规范规定了基于新架构的业务系统的测试内容 流程 手段等规 范 需要建立pafa 测试架构和体系 打包 部署规范新增 该规范规定了新架构下业务系统的开发 测试 生产三种不同的 环境有不同的打包和部署方法 本规范详细描述了这些不同的打包 和部署的实现方式 团队开发管理规范待补充 该规范主要规定了基于pafa 新架构的业务系统在团队开发方面的 建议 1 项目小组成员的角色 职责和分工 新架构采用的新的技术比较多 相对于旧架构比较复杂 专 业化的角色分工是比较好的快速提高技能 简化开发的方法 新架构将根据新架构的特点定义几个角色和职责 各项目组可 以根据各自项目的人力资源情况为每个成员分配角色 2 分工方式 新架构建议根据层来分工 比如按照WEB层 BIZ 层 集成层 等分工 而不是按照模块分工 3 岗位轮流 根据层来分工将导致只能熟悉某一层的设计开发 对其他层 的设计开发不熟悉 建议每隔一段时间大家可以换岗 更换 自己的角色 4 配置文件的修改 技术培训规范待补充 目前各部门各项目组缺乏统一 标准的 技术培训 培训流程 培 训内容的规范 比较随意 需要建立pafa 技术培训体系 同时结合拟建立的pafa 在 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 6 页 共 19 页 线文档中心 便于培训 该规范待完成 系统集成规范待补充该规范规定了集团的业务系统之间服务集成 数据集成 的标准和接口 公共平台服务及 pafa 组件使用规范待补充该规范pafa 定义了包括的um rm cif2 工作流 EAI portal sso 等所有公共平台服务及组件的使用范围 对象 设计方案等 规范 beta 5 将首先发布 pafa sdk 工作流 规则引擎平台 包含 的组件及服务的部分使用规范 um cif2 等使用规范需要有相关 项目组制定 举例 a 工作流派工规则的实现规范 工作流的派工规则需要使用规则引擎实现 b pafa sdk 组件使用规范 pafa sdk 包含很多组件和服务 有的组件是所有业务系统 必须使用的 比如 Log Exception web framework message 统一管理等 有些组件业务系统可以根据情况决定是否使用 比如 jsp 的data bingding 对于很复杂的页面 如果pafa 的data bingding 不能满足需要 可以使用传统的办法通过 request getParameter 方式 取得数据并手工编码绑定DTO对象 c um使用规范 需要um 组制订 sdk 比如规定用户认证等功能必须使用 um 菜单及部分的数据 权限管理功能可以由业务系统自己开发 系统开发设计标准方法和流程 方法 论 规范 待补充 该规范规定了基于j2ee的业务系统分析设计的标准的流程和方 法 目前我公司没有系统开发方法论的规范 系统的设计和开 发不规范 比如很多业务系统的设计缺乏业务建模 抽取业务实体 等流程 实际上是纯粹的面向过程的开发 还有些业务系统没有设计 直接做代码编程 快上线了在 补充架构设计文档供架构复审 该规范待完成 技术文档模版及标准内容样板规范待补充目前公司虽然发布了架构设计 用例 测试等各种文档的模版 但 总的来说比较复杂 特别是这些模版内容都是空的 没有标准的内 容样板 这样的话 大家写文档的时候就没有标准可供参考 我们将和CMM组合做做这个工作 希望新架构的文档和模版能够减轻大家负担 便于和设计及代码的 修改同步 公共平台标准流程 包括申请使用 版本发布 等规范 待补充 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 7 页 共 19 页 1 21 2标记约定标记约定 标记功能说明举例 xxx xxx 表示这是一个需要在另外的地方 进行修改的变量 pafa log home um jndi url xxx xxx 表该部分是可选的 groupname 表示该部分需要用户替换为相应 的字符串 1 31 3名词解释名词解释 apappnamepname 指应用的名称 可以直接采用 ear 包的名称 groupgroupname name 是用户可以自己指定的具有某有含义的字符串名称 该名称的制定原则是便于并行开发 区分和维护 不可以使用 1 2 a b 等没有意义的字符或者采用开发人员姓名等容易发 生变化的字符串作为 groupname scoscopename pename 是指 JDBC 和 JMS 等资源被共享的范围 资源的共享范围scopename 的取值举例 ear 包内共享ear 包名称 pospa18 某子应用系统中共享子应用系统名称 pos 整个应用系统中共享应用系统名称 elis s serviceprovider erviceprovider 服务提供者 指向 um CIF2 等向其他系统提供服务的系统 1 41 4本文档中引用到的系统 应用 说明本文档中引用到的系统 应用 说明 为了能更清楚的表述 本文档中引用了大量的系统名称 应用名称 各系统间的引用关系只是作演示说 明不保证根真实的系统引用完全一致 系统 应用 名称系统说明 elis 寿险系统 pos 保全系统 是 elis 系统的一个子系统 pospa18 ear pos 系统提供 pa18 系统使用的一个 ear 包 pa18 新 pa18 门户网站系统 cif2 CIF2 系统 um 用户集中管理系统 1 51 5标记约定标记约定 2 2 公共平台服务及公共平台服务及 PAFAPAFA SDKSDK 的组件使用规范 的组件使用规范 2 12 1概述概述 该规范定义了包括 um rm cif2 工作流 EAI portal sso pafa sdk 等所有公共平台服务及组件 的使用范围 对象 设计方案等规范 2 22 2PAFAPAFA SDKSDK 组件使用规范组件使用规范 待补充 2 32 3RMRM 使用规范使用规范 待补充 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 8 页 共 19 页 2 42 4工作流使用规范工作流使用规范 待补充 2 52 5EAIEAI 使用规范使用规范 待补充 2 62 6其它公共平台服务的使用规范其它公共平台服务的使用规范 待补充 3 3 团队开发规范团队开发规范 3 13 1概述概述 该规范主要对基于 pafa 新架构的业务系统在工作分工 项目管理方面的建议 3 23 2人员组织人员组织 3 2 1项目小组成员的角色 职责和分工项目小组成员的角色 职责和分工 新架构采用的新的技术比较多 相对于旧架构比较复杂 专业化的角色分工是比较好的快速提高技能 简化开 发的方法 新架构将根据新架构的特点定义几个角色和职责 各项目组可以根据各自项目的人力资源情况为每 个成员分配角色 3 2 23 2 2分工方式分工方式 新架构建议根据层来分工 比如按照 WEB 层 BIZ 层 集成层等分工 而不是按照模块分工 同时根据技能按 EJB 数据库 Sql PAFA Web 技术等划分 3 2 33 2 3岗位轮流岗位轮流 根据层来分工将导致只能熟悉某一层的设计开发 对其他层的设计开发不熟悉 建议每隔一段时间大家可以 换岗 更换自己的角色 3 33 3团队开发配置管理团队开发配置管理 在团队开发过程中 可以为应用多个配置文件 PAFA 的与业务相关的配置文件 基本上都可以根据模块和应 用配置多个配置文件 团队开发过程中 这些文件不需要做文件合并就能配合使用 4 4 PAFAPAFA 开发规范开发规范 4 14 1概述概述 pafa 开发规范主要规定了基于 pafa 新架构的业务系统开发过程中在代码编程方面的规范 主要包含以下几 方面内容 1 命名规范 2 组件使用规范 3 代码优化 垃圾对象收集等规范 4 代码调试规范 新架构禁止在代码中写 System out println 语句打印字符串和对象的值来调试程 序 而只能使用 Log 或者 pafa 提供的代码调试的功能 从 beta 5 版本开始提供 4 24 2命名规范命名规范 4 2 14 2 1PackagePackage 包结构包结构规范规范 4 2 1 14 2 1 1 PackagePackage 分类和命名原则分类和命名原则 1 先根据 系统 system 子系统 application 模块 module 划分目录 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 9 页 共 19 页 2 然后在模块内部按照 WEB BIZ Integration 层对 Package 包结构进行分类 3 在模块 子系统 系统目录创建 common 目录 用于存放这些层次共享的类 接口等对象 4 2 1 24 2 1 2 WebWeb 层层 PackagePackage 命名规范命名规范 com paic system application module web controller validation util common 4 2 1 34 2 1 3 业务层业务层 PackagePackage 命名规范命名规范 com paic system application module biz action service service impl bo bo validation async codetable util common 4 2 1 44 2 1 4 集成层集成层 PackagePackage 命名规范命名规范 com paic system application module integration sao sao impl dao dao impl common 4 2 1 54 2 1 5 模块模块级级 commoncommon 该目录由于存放在 模块 一级共享的类和接口等对象 mon dto util 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 10 页 共 19 页 message 4 2 1 64 2 1 6 应用级的应用级的 commoncommon 该目录由于存放在 应用 一级共享的类和接口等对象 mon message util dto 4 2 1 74 2 1 7 系统级的系统级的commoncommon 该目录由于存放在 系统 一级共享的类和接口等对象 mon message util dto 4 2 24 2 2PAFAPAFA 组件命名规组件命名规范范 PAFA 新架构定义了BO DAO SAO Controller 等各种Interface 接口 业务系统需要自己 去扩展或者实现这些接口 为此 PAFA 对于业务系统需要扩展的接口和实现类规定了具体的 命名规范 如下表所示 PAFAPAFA 定义的组件定义的组件 或接口名称或接口名称 需要业务系统自己扩展或定义的接口需要业务系统自己扩展或定义的接口 的命名规范的命名规范 接口实现类接口实现类 的命名规的命名规 范范 WebController 不需要业务系统自己定义接口 XxxControllerController Action 不需要业务系统自己定义接口 XxxActionAction XxxActionBeanActionBean Service XxxServiceServiceXxxPojoServicePojoService XxxEjbServiceEjbService BO BO 组件没有接口 也不需要业务系统自己定义接口业务对象的名字 Validator 实现 PAFA 提供的该接口就可以 不需要业务系统自己定 义接口 XxxValidatorValidator PafaDAOXxxDAODAOXxxIbatisDAOIbatisDAO PafaSAO XxxSAOSAO 该接口是访问公共平台服务以外 如 cif2 的服 务集成接口 XxxUMSAOUMSAO 访问 UM 的 SAO 接口 XxxCif2SAOCif2SAO 访问 UM 的 SAO 接口 XxxRMSAORMSAO 访问规则引擎的 SAO 接口 XxxWFSAOWFSAO 访问工作流的 SAO 接口 XxxEjbSAO XxxPojoSAO XxxEAISAO XxxEjbUMSAO XxxPojoUMSAO XxxEAIUMSAO 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 11 页 共 19 页 DTO 不需要业务系统自己定义接口 XxxDTO 4 2 34 2 3JNDIJNDI 命名规范命名规范 4 2 3 1 EJB 的 JNDI 命名规范 规范规范 1 在 EJB 的 JNDI 名称中加上 appnameappname 2 jndi 中的命名遵从 JAVA 类名的命名格式 详细变化如下详细变化如下 规范举例备注 PafaACejb PafaACejb pa18 PafaAC TxnActionBeanejb PafaTxn ActionBean ejb pa18 PafaTxnActio nBean ejb EJB Remote 接口类名或者有 意义的简写 ejb pa18 PolicyServic e 用户自定义 EJB EJB Remote 接口的全类 名格式 com paic pa18 policy biz ejb PolicyService 其中 appname 是 pa18 EJB 的 Remote 接口类名是 PolicyService EJB Remote 接 口的全类名是 com paic pa18 policy biz ejb Policy Service 4 2 3 2 DataSource 的 JNDI 命名规范 规范规范 1 在 DataSource 的 JNDI 名称中加上 scopenamescopename 表示该资源的共享范围 2 jndi 中的命名遵从 JAVA 类名的命名格式 3 非 XA 数据源名称以 jdbc 开头以 DS 结尾 4 XA 数据源名称以 jdbc 开头以 DS XA 结尾 详细如下详细如下 规范举例备注 jdbc pospa18 PolicyDS 表示数据源 PolicyDS 只 在 pospa18 ear 中共享 jdbc pos ApplicantSZDS 表示数据源 applicantSZDS 在 pos 子 系统中共享 数据源 jdbc 数据源名称 jdbc elis FZtest01DS XA 表示数据源 fztest01DS 是 XA 数据源 并且在 elis 系统中共享 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 12 页 共 19 页 4 2 3 3 JMS 的 JNDI 命名规范 规范规范 1 在 JMS 的 JNDI 名称中加上 scopenamescopename 表示该资源的共享范围 2 jndi 中的命名遵从 JAVA 类名的命名格式 3 连接工厂名称以 jms 开头以 ConnectionFactory 结尾 4 Queue 名称以 jms 开头以 Queue 结尾 5 Topic 名称以 jms 开头以 Topic 结尾 详细如下详细如下 规范举例备注 连接工厂jms 连接 工厂名称 jms elis AsynConnectionF actory 表示连接工厂 AsynConnectionFact ory 在 elis 系统中共 享 Queuejms Queue 名称 jms pospa18 ActionQueue 表示 Queue ActionQueue 在 pospa18 ear 包中共 享 Topicjms Topic 名称 jms pos AsynTopic 表示 Topic AsynTopic 在 pos 子 系统中共享 4 2 44 2 4URLURL 命名规范命名规范 基于新架构业务系统的 Request 请求 URL 有 screen do 两种形式 他们有不同的用途 其作用如下表所示 Request URL 请求 作用两种请求实现或配置的区别 screen 请求 screen 请求只做页面导航 不掉 用业务层的业务逻辑 Service 实现起来比较简单 因为 不需要自己创建 controller 而只需 要在 WebContext xml 配置文件中配置 该 screen 请求和 PAFA 提供的 com paic pafa app web servlet mvc ParameterizableViewController 就可 以 do 请求 do 请求 调用业务层的业务逻辑 Service 然后显示结果页面 需要创建业务系统自己的 Controller 然后在要在 WebContext xml 配置文件中配置 do 和 该 Controller 之间的对应 关系 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 13 页 共 19 页 4 2 54 2 5配置文件 日志文件及其他文件命名规范配置文件 日志文件及其他文件命名规范 文件名命名规范包括 文件名命名规范包括 1 文件名中所有字母小写 2 不同单词之间用 连接 3 对于需要进行团队开发或者项目比较大的可以增加 groupname 名称 4 对于需要技术支持部进行修改 包括 PAFA 提供的配置文件和用户自己增加的配置文件 的文件 需要 在文件名中增加 appname 4 2 5 1 日志文件命名规范 规范举例备注 错误日志 pafa log home error xml wls usr apps logs pa18 error xml 审计日志 pafa log home audit xml wls usr apps logs pa18 audit xml 跟踪日志 程序员使 用 pafa log home trace xml wls usr apps logs pa18 trace xml 记录 pafa 运 行状况的日 志 pafa log home pafa l og wls usr apps logs pa18 pafa log 其中 appname 就 是 pa18 变量 pafa log home 的值 是 wls usr a pps logs 说明说明 1 1 pafa log home 代表日志文件存放的目录 2 2 日志文件存放目录的规范在开发环境下由用户自己定义 在生产环境下遵循技术支持部现有规范在生产环境下遵循技术支持部现有规范 同同 时技术支持部可以根据情况自行设置调整时技术支持部可以根据情况自行设置调整 通过 D 命令进行修改 举例 Dpafa log home wls usr apps logs 4 2 5 2 新架构配置文件名规范 规范举例备注 core context xmlcore context xml Web 层和 biz 层公用的配置文 件 配置了日志 pafaAC 的 JNDI 等信息 common context xmlcommon context xml 开发环境下使用的日志 devlog propertiesdevlog properties 从 PAFA3 0 开 始 生产环境 下可以没有该 文件 message error groupname properties message error policy xml Message 配置文件 message info groupname properties message info policy xml 定义 WEB 层组件的 PAFA 配置文 件 web context groupname xml web context policy xml sqlmap config xmlsqlmap config xml Ibatis 配置文件 sqlmap mapping groupname xml sqlmap mapping policy xml 其中 policy 就 是 groupname 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 14 页 共 19 页 定义 Biz 层组件的 PAFA 配置文 件 biz context groupname xml biz context policy xml 无 context propeties context pa18 properties 其中 pa18 就 是 appname 4 2 5 34 2 5 3 其它文件命名规范其它文件命名规范 待补充 4 34 3propertiesproperties 文件中的变量命名规范文件中的变量命名规范 格式举例备注 pa18 jndi url t3 xx xx xx xx 7001 表示 pa18 系统 biz 层 向业务层向 pa18 系统 web 层提供服务的地址 CIF2 jndi url t3 xx xx xx xx 3001 表示 CIF2 系统提供服 务的地址 pos pa18 web jndi url t3 xx xx xx xx 4003 表示 pos 系统向 pa18 系统提供 web 层 页面 服务的地址 pos pa18 biz jndi url t3 xx xx xx xx 4005 表示 pos 系统向 pa18 系统提供 biz 层服务的 地址 um pa18 user jndi url t3 xx xx xx xx 5001 表示 um 系统向 pa18 系 统提供 user 服务的地 址 serviceproviderserviceprovider groupnamegroupname jndi urljndi url um pa18 service jndi url t3 xx xx xx xx 5003 表示 um 系统向 pa18 系 统提供 service 服务的 地址 说明 说明 这里这里 groupnamegroupname 可以是服务受益的系统 也可以是某个功能模块可以是服务受益的系统 也可以是某个功能模块 可以出现多个层次结构 可以出现多个层次结构 4 44 4context propertiescontext properties 文件中的变量命名规范文件中的变量命名规范 格式举例备注 pa18 jndi principal v xx xx 表示 pa18 系统 biz 层 向业务层向 pa18 系统 web 层提供服务的用户 名 pos pa18 web jndi principal v xx xx 表示 pos 系统向 pa18 系统提供 web 层 页面 服务的用户名 serviceproviderserviceprovider groupnamegroupname jndi jndi principalprincipal pos pa18 biz jndi principal v xx xx 表示 pos 系统向 pa18 系统提供 biz 层服务的 用户名 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 15 页 共 19 页 um pa18 user jndi principal v xx xx 表示 um 系统向 pa18 系 统提供 user 服务的用 户名 um pa18 service jndi principal v xx xx 表示 um 系统向 pa18 系 统提供 service 服务的 用户名 说明 说明 这里这里 groupnamegroupname 可以是服务受益的系统 也可以是某个功能模块可以是服务受益的系统 也可以是某个功能模块 可以出现多个层次结构 可以出现多个层次结构 4 4 14 4 1JNDIJNDI urlurl 变量的命名规范变量的命名规范 格式举例备注 pa18 jndi credential pwdxx 表示 pa18 系统 biz 层 向业务层向 pa18 系统 web 层提供服务的用户 密码 pos pa18 web jndi credential pwdxx 表示 pos 系统向 pa18 系统提供 web 层 页面 服务的用户密码 pos pa18 biz jndi credential pwdxx 表示 pos 系统向 pa18 系统提供 biz 层服务的 用户密码 um pa18 user jndi credential pwdxx 表示 um 系统向 pa18 系 统提供 user 服务的用 户密码 serviceproviderserviceprovider groupnamegroupname jndi jndi credentialcredential um pa18 service jndi credential pwdxx 表示 um 系统向 pa18 系 统提供 service 服务的 用户密码 说明 说明 这里这里 groupnamegroupname 可以是服务受益的系统 也可以是某个功能模块可以是服务受益的系统 也可以是某个功能模块 可以出现多个层次结构 可以出现多个层次结构 4 4 24 4 2JNDIJNDI 用户名变量的命名规范 用户名变量的命名规范 4 4 3JNDIJNDI 用户密码变量的命名规范 用户密码变量的命名规范 4 54 5其他其他 propertiesproperties 文件中的变量文件中的变量命名规范命名规范 1 1 在变量前面增加在变量前面增加 appnameappname 或者本应用的系统名称 或者本应用的系统名称 2 2 采用类似上述文件的格式 使用小写字母拼写各单词并用采用类似上述文件的格式 使用小写字母拼写各单词并用 分隔 分隔 4 64 6配置文件存放的子目录规范配置文件存放的子目录规范 新架构的几个配置文件在开发阶段分别按其作用存放在 ejb application core web biz 子目录下 如下表所 示 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 16 页 共 19 页 子目录名称子目录名称存放的配置文件名称存放的配置文件名称备注备注 Webweb context groupname xml tiles defs xml message info groupname properties message error groupname properties weblogic xml web xml Bizbiz context groupname xml sqlmap config xml sqlmap mapping groupname xml Corecore context xml common context xml devlog properties log4j properties Ejbejb jar xml weblogic ejb jar xml applicationapplication xml 4 6 14 6 1ApplicationApplication 子目录存放的配置文件子目录存放的配置文件 只有一个应用配置文件 名称 application xml 该配置文件是 j2ee 规范规定的系统配置文件 4 6 24 6 2BizBiz 子目录存放的配置文件子目录存放的配置文件 biz context groupname xml 定义 biz 层组件 sqlmap config xml 定义 biz 层组件 指明 ibaitis 执行时的参数和对应配置文件 sqlmap mapping groupname xml ibatis 配置文件 定义了各种 sql 语句 4 6 3Core 子目录存放的配置文件子目录存放的配置文件 common context xml 定义应用的公用组件 包括访问外部系统的组件 core context xml 定义 logger 等 devlog properties 定义开发调试工具的属性 log4j properties pafa 本身的 Log 配置 4 6 4ejb 子目录存放的配置文件子目录存放的配置文件 ejb jar xml weblogic ejb jar xml 4 6 54 6 5webweb 层层子目录存放的配置文件子目录存放的配置文件 tiles defs xml 固定名称 定义页面布局 web xml 标准 WEB 描述符 weblogic xml Weblogic Web 部署描述符 web context groupname xml 定义 Web 层组件 message info groupname properties 定义了提示消息的配置文件 message error groupname properties 定义了错误消息的配置文件 本文内容涉及中国平安保险 集团 股份有限公司商业秘密 未经书面许可 不得以任何形式披露 传播或扩散 中国平安保险 集团 股份有限公司 版权所有 不得侵犯中国平安保险 集团 股份有限公司 版权所有 不得侵犯 第 17 页 共 19 页 4 74 7异常处理规范异常处理规范 请参考 PAFA3 设计开发指南 相关章节 4 84 8日志记录规范日志记录规范 请参考 PAFA3 设计开发指南 相关章节 5 5 pafapafa 设计规范设计规范 5 15 1概述概述 pafa 设计规范主要规定了在基于 pafa 新架构的业务系统设计方面的规范 主要包含以下几方面内容 pafa 组件之间互相调用的规范 pafa 组件设计规范 规定了每个 pafa 组件的设计要求 系统设计原则和方案 规定了在不同的情况下应该采取的设计方案 Trasaction 事务控制规范 5 25 2 组件间调规范组件间调规范 5 2 1Web 层调用规范 web 层只能够通过 ApplicationController 来访问后台系统 web 层不能直接调用 DAO 外部服务等 5 2 2Action 组件调用规范 Action 组件可以调用其他 Action Service BO DAO SAO 对象 5 2 3Service 组件调用规范 Service 可以调用其他 Service BO DAO SAO 对象 但 Service 不能够调用 Action 组件 5 2 4BO 组件调用规范 Bo 组件可以调用其他 BO DAO SAO 对象 但 Bo 不能够调用 Action 组件方法 在通常情况下 BO 也不能调用 Service 组件 但是 BO 调用数据校验等 Service 组件的情况除外 5 2 5DAO 组件调用规范 DAO 只能通过 iBatis 框架访问数据库数据 不能调用其他组件 5 2 6SAO 组件调用规范 SAO 组件只能访问外部远程系统的 Service 不能调用其他任何组件 5 35 3组件设计规范组件设计规范 5 3 1Action 设计规范 Action 的实现通过 POJO 实现 需要事务处理时 使用 Pafa 提供的 TxnAction EJB 来调用 POJO 的 Action Action 不能够有远程 EJB 实现 如果 TxnAction 提供的系统异常自动回滚的事务处理功能不能够满 足业务需求 用户可以参照 TxnAction 实现自己的 EJB Action 但必须是 Local 的 EJB 5 3 2Service 设计规范 Service 是由 POJO 来实现的 如果需要在 Service 上做事务控制或者需要 Service 需要被远程访问 可以用 EJB 来封装 POJO 的 Service 在需要被远程访问时 要充分考虑到是否支持分布式的交易 同时也要考虑到其 EJB 的事务处理类型 同时在 Service 被远程系统访问时 其封装的 EJB 的对外接口与 POJO 的 Service 接口抛出异常的定义是不一 样的 在对外的访问的 EJB 的 Service 的 Home