《(2020年）(售后服务）中国联通云门户-流程服务项目-开发及编码规范》由会员分享，可在线阅读，更多相关《(2020年）(售后服务）中国联通云门户-流程服务项目-开发及编码规范（71页珍藏版）》请在金锄头文库上搜索。
1、中国联通云门户项目中国联通云门户项目 流程服务流程服务 项目开发及编码规范 中国联合网络通信集团有限公司 2020 06 16 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 2 页共 71 页 产权说明产权说明 本文件中出现的任何文字叙述 文档格式 插图 照片 方法 过程等内容 任何个人 机构未经授 权许可 不得复制或引用本文件的任何片断 无论是通过电子形式或非电子形式 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 3 页共 71 页 文档信息文档信息 项目名称 中国联通云门户项目 项目经理 肖永威文档版本号 v 1 1 项目阶段
2、 设计阶段文档版本日期 2012 年 12 月 120 日 起草人 张玉明起草日期 2012 年 12 月 13 日 评审人 评审日期 评审方式 会议评审 邮件评审 版本历史版本历史 版本号版本日期作者说明 v 1 02012 12 13 张玉明创建文档 v 1 12012 12 17 张玉明 修订文档 增加 WS 配置 classpath 增加流程建模复用组件配置及使用规范 v 1 22012 12 18 张玉明增加 4 5 Identifiers 数据提取 v 1 32012 12 18 张玉明 刘彦利增加 3 3 5 方法集和命名空间 v 1 42012 12 20 张玉明增加 4 8
3、4 9 节 v 1 52013 01 22 张玉明增加 3 3 7 节 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 4 页共 71 页 目目 录录 1概述 7 1 1目标 7 1 2名词解释 7 2功能设计 7 2 1页面设计 7 2 1 1页面设计一般原则 7 2 1 2XFORM开发原则 7 2 1 3菜单 7 2 1 4调试 7 2 2数据库设计 8 2 2 1原则 8 2 2 2主键 8 2 2 3关联 8 2 2 4触发器 8 2 2 5索引 9 2 3流程设计 9 2 3 1原则 9 3项目构建与编码规范 10 3 1项目开发工具一览表 10 3
4、2开发资源及服务器信息 11 3 2 1SVN服务器 11 3 2 2Cordys BOP4 开发服务器 12 3 3CORDYS BOP 平台 13 3 3 1测试环境租户建立规范 13 3 3 2CWS项目构建方案 13 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 5 页共 71 页 3 3 3CWS项目项目开发注意 19 3 3 4备份策略 19 3 3 5方法集和命名空间 19 3 3 6方法 21 3 4编程公共命名 22 3 4 1类命名 22 3 5JAVASCRIPT命名 22 3 5 1类成员变量命名 22 3 5 2普通变量命名 23 3
5、5 3类成员方法 24 3 5 4普通方法 24 3 6JAVA命名 24 3 6 1类成员变量与普通变量 24 3 6 2类成员方法 25 3 6 3包命名 25 3 7数据库命名 25 3 7 1表和字段命名 25 3 7 2主键命名 25 3 7 3外键命名 26 3 7 4视图命名 26 3 7 5序列命名 26 3 7 6存储过程命名 26 3 7 7函数命名 27 3 7 8触发器命名 27 4技术实现 27 4 1业务逻辑实现方案选择 27 4 2页面 28 4 3BPM 32 4 3 1流程松耦合性 32 4 3 2流程事务性 33 4 3 3流程建模复用组件配置及使用规范 3
6、4 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 6 页共 71 页 4 4消息映射 34 4 4 1消息结构 34 4 4 2消息删除 35 4 4 3本地变量 35 4 4 4子流程 36 4 4 5并行处理 36 4 4 6Web Service Method 41 4 4 7JavaScript编码 41 4 4 8JAVA编码 42 4 4 9数据库连接 47 4 4 10数据库连接 47 4 5IDENTIFIERS数据提取 47 4 6调试与测试 48 4 6 1调试 48 4 6 2Webgateway 48 4 6 3WS AppServer调
7、试 49 4 6 4NOM内存泄漏检测与调试 49 4 7单元测试 49 4 8开发工具整合 49 4 8 1Subclipse SVN插件安装 49 4 8 2Cordys CoE 插件 58 4 8 3eclipse中安装tomcat插件 58 4 9开发过程中性能及故障处理 63 4 9 1限制流程实例中循环的最大数量 63 4 9 2MySQL主从复制Binary Log清理 64 4 9 3Eclipse Performance 64 4 9 4Cordys 自定义认证类及BCP JAR路径配置 65 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 7
8、页共 71 页 1 1概述概述 指导云流程服务项目开发 提供设计 开发 编码的参考 执行规范 1 1目标 规范项目各环节实施 开发 编码规范 以及故障处理 调优问题汇总记录 此文档会在整个项 目实施过程中不断维护 保持版本更新 1 2名词解释 Cordys CWS REST BinLog 2 2功能设计功能设计 2 1页面设计 2 1 1 页面设计一般原则 2 1 2 XFORM 开发原则 2 1 3 菜单 菜单项应当赋予角色 而不是直接赋给用户 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 8 页共 71 页 2 1 4 调试 可以使用 fiddler htt
9、pwatch firebug IE developerToolbar 来对 Http 请求及 JS 脚本进行调试 和性能调优 2 2数据库设计 2 2 1 原则 数据库设计必须符合第一范式 数据库只保留基本逻辑约束 包括以下方面 主键 主子表关联外键约束 属性表不添加外键约束 所有数据库设计的内容体现在数据模型文档中 针对特定字段的约束体现在该字段的属性和注释 中 需要特别说明的 可以在物理模型图中加 Notes 注意 由于本项目中使用的是 Cordys BOP 平台产品 在 BOP 中能够提供 API 来解决的或者可以 通过查询平台系统表提取数据的 原则上不要再增加新表来辅助设计和逻辑实现
10、以避免后期与应用 耦合性过高 2 2 2 主键 以单一整形或字符串类型字段做主键 2 2 3 关联 当一个表通过外键引用另一个表时 往往主表的删除意味着相关记录的删除 如果确认这里的业 务逻辑是正确的 而且没有其他的影响 可以使用 级联删除 选项来简化代码 但必须在相应的数 据库模型上有所体现 同样的 级联更新 也起到类似的作用 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 9 页共 71 页 2 2 4 触发器 对于一些简单的 基本业务无关的数据操作 可以使用触发器来实现 比如生成序列号 但业务 相关的 复杂的逻辑 则避免在触发器中实现 2 2 5 索引 对于
11、查询频度远高于修改的数据表 或者需要经常对查询结果排序的表 创建相应的索引 2 3流程设计 2 3 1 原则 以详细设计为准 模型设计摘要如下 1 创建流程模型时修改流程的 namespace 如下所示 2 泳道颜色使用双色交替 循环使用 cordys 提供的第 1 个颜色和第 2 个颜色 3 泳道间的间距 1px 4 泳道的长度要统一 5 decision 的描述用 是否 条件描述为 是 否 摆放位置应在连接线的起始 端 水平连线上方 垂直连线右侧 偏移位移在 5px 以内 6 当 decision 的出口在 3 条或 3 条以上 根据实际业务情况进行描述 7 活动节点间的连线 水平或垂直平
12、行时用直线 除此之外用带直角的连线 8 group 组件上下边框应大于泳道边界 1px group 的描述有实际的业务含义 9 流程中的组件大小用 default 如果文字太多 超过 50 字时 可根据实际情况调整 10 相同组件的大小在同一流程模型中保持一致 11 流程的起始位置在上方 结束位置在下方 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 10 页共 71 页 循环中驳回节点尽可能共用 以减少驳回节点个数 3 3项目构建与编码规范项目构建与编码规范 本项目开发基于 Cordys BOP 4 1 平台进行开发 Cordys 层使用 SOAP WS 进行服
13、务开发 中 间层使用 RESTful 的 WS 对外暴露资源和服务 REST 风格的 WS 使用 Jboss Resteasy 作为框架的基础上进行开发 开发测试服务器使用 Apache Tomcat 7 0 JDK 统一使用 1 6 Eclipse 需要 eclipse jee juno 版 并整合 Cordys CoE 插件 作为 WS 开发 IDE 开发数据库使用 MySQL 5 5 推荐使用 5 5 19 版 生产环境使用 MySQL Master Slave 模式 前端连接使用 MySQL Proxy 模式进行 JDBC 连接 开发工程包 DEMO 中提供了 Ant 打包脚本 方便进
14、行服务打包 第三方常用的 lib 库则都包含在 EIP DEMO 工程中 请避免使用其他版本的库 每个 EIP 服务的客户端是一个 Jar 文件 命名为 XXX impl jar 最新的客户端 jar 文件以现网运 行的版本为准 开发工程包请向开发人员索取 3 1项目开发工具一览表 平台 Cordys BOP4 1 Cu7 MySQL Server MySQL Server Community 5 5 19 Eclipse IDE eclipse javaee juno with Cordys CoE plugin Svn plugins Eclipse update site URL htt
15、p subclipse tigris org update 1 8 x MySQL Tools Navicat for MySQL 10 0 11 enterprise edition Web Contanier Apache Tomcat v7 0 Web Browser Google Chrome 最新版 Mozilla Firefox IE 8 推荐使用 Chrome 浏览器进行 开发 SSH 客户端 Xmanager 3 0 SecureCRT 7 0 推荐使用 XME 3 0 可以直接使用图形界面 FTP 客户端 Xftp Filezilla XML 格式化工具 foxe XML 格
16、式化工具 XPathVisualizer 1 3 0 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 11 页共 71 页 文本编辑工具 Notepad 6 22 3 2开发资源及服务器信息 3 2 1 SVN 服务器 1 项目开发服务器地址 项目开发服务器地址 https 10 64 6 98 8443 svn cloudbpm 项目开发人员帐号 联系配置管理员获取 开发服务器管理员帐号 远程桌面 adminstrator 密码 联系相关人员 IP 10 64 6 98 SVN 客户端需使用 TortoiseSVN 1 7 2 公司 公司 SVN 服务器 服务器 项目根路径 http 10 64 8 160 svn 20121123 YMHLCFW 注意 本节以下所述 SVN 地址均相对此项目 SVN 根路径 中国联通云门户流程服务项目中国联通云门户流程服务项目 项目开发及编码规范 第 12 页共 71 页 开发工程开发工程 SVN 地址 地址 Cordys 中 CWS 创建项目工程时绑定的 SVN 地址 00Developing 02code clou
