中国联通云门户-流程服务项目-开发及编码规范.docx

中国联通云门户项目流程服务项目开发及编码规范中国联合网络通信集团有限公司2013-01-22产权说明本文件中出现的任何文字叙述、文档格式、插图、照片、方法、过程等内容，任何个人、机构未经授权许可，不得复制或引用本文件的任何片断，无论是通过电子形式或非电子形式编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：第1页 共1页文档信息项目名称：中国联通云门户项目项目经理：肖永威文档版本号：v 1.1项目阶段：设计阶段文档版本日期：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 4.9节v 1.52013-01-22张玉明增加 3.3.7节目 录1 概述 71.1 目标 71.2 名词解释 72 功能设计 72.1 页面设计 72.1.1 页面设计一般原则 72.1.2 XFORM开发原则 72.1.3 菜单 72.1.4 调试 72.2 数据库设计 82.2.1 原则 82.2.2 主键 82.2.3 关联 82.2.4 触发器 82.2.5 索引 92.3 流程设计 92.3.1 原则 93 项目构建与编码规范 103.1 项目开发工具一览表 103.2 开发资源及服务器信息 113.2.1 SVN服务器 113.2.2 Cordys BOP4 开发服务器 123.3 Cordys BOP平台 133.3.1 测试环境租户建立规范 133.3.2 CWS项目构建方案 133.3.3 CWS项目项目开发注意 193.3.4 备份策略 193.3.5 方法集和命名空间 193.3.6 方法 213.4 编程公共命名 223.4.1 类命名 223.5 Javascript命名 223.5.1 类成员变量命名 223.5.2 普通变量命名 233.5.3 类成员方法 243.5.4 普通方法 243.6 Java命名 243.6.1 类成员变量与普通变量 243.6.2 类成员方法 253.6.3 包命名 253.7 数据库命名 253.7.1 表和字段命名 253.7.2 主键命名 253.7.3 外键命名 263.7.4 视图命名 263.7.5 序列命名 263.7.6 存储过程命名 263.7.7 函数命名 273.7.8 触发器命名 274 技术实现 274.1 业务逻辑实现方案选择 274.2 页面 284.3 BPM 324.3.1 流程松耦合性 324.3.2 流程事务性 334.3.3 流程建模复用组件配置及使用规范 344.4 消息映射 344.4.1 消息结构 344.4.2 消息删除 354.4.3 本地变量 354.4.4 子流程 364.4.5 并行处理 364.4.6 Web Service / Method 414.4.7 JavaScript编码 414.4.8 JAVA编码 424.4.9 数据库连接 474.4.10 数据库连接 474.5 Identifiers数据提取 474.6 调试与测试 484.6.1 调试 484.6.2 Webgateway 484.6.3 WS-AppServer调试 494.6.4 NOM内存泄漏检测与调试 494.7 单元测试 494.8 开发工具整合 494.8.1 Subclipse SVN插件安装 494.8.2 Cordys CoE 插件 584.8.3 eclipse中安装tomcat插件 584.9 开发过程中性能及故障处理 634.9.1 限制流程实例中循环的最大数量 634.9.2 MySQL主从复制Binary Log清理 644.9.3 Eclipse Performance 644.9.4 Cordys 自定义认证类及BCP JAR路径配置 651 概述指导云流程服务项目开发，提供设计、开发、编码的参考、执行规范。

1.1 目标规范项目各环节实施、开发、编码规范，以及故障处理、调优问题汇总记录此文档会在整个项目实施过程中不断维护，保持版本更新1.2 名词解释CordysCWSRESTBinLog2 功能设计2.1 页面设计2.1.1 页面设计一般原则2.1.2 XFORM开发原则2.1.3 菜单菜单项应当赋予角色，而不是直接赋给用户2.1.4 调试可以使用fiddler、httpwatch、firebug、IE developerToolbar来对Http请求及JS脚本进行调试和性能调优2.2 数据库设计2.2.1 原则数据库设计必须符合第一范式数据库只保留基本逻辑约束，包括以下方面：l 主键l 主子表关联外键约束属性表不添加外键约束所有数据库设计的内容体现在数据模型文档中，针对特定字段的约束体现在该字段的属性和注释中，需要特别说明的，可以在物理模型图中加Notes注意：由于本项目中使用的是Cordys BOP平台产品，在BOP中能够提供API来解决的或者可以通过查询平台系统表提取数据的，原则上不要再增加新表来辅助设计和逻辑实现，以避免后期与应用耦合性过高2.2.2 主键以单一整形或字符串类型字段做主键。

2.2.3 关联当一个表通过外键引用另一个表时，往往主表的删除意味着相关记录的删除，如果确认这里的业务逻辑是正确的，而且没有其他的影响，可以使用“级联删除”选项来简化代码，但必须在相应的数据库模型上有所体现同样的，“级联更新”也起到类似的作用2.2.4 触发器对于一些简单的，基本业务无关的数据操作，可以使用触发器来实现：比如生成序列号但业务相关的，复杂的逻辑，则避免在触发器中实现2.2.5 索引对于查询频度远高于修改的数据表，或者需要经常对查询结果排序的表，创建相应的索引2.3 流程设计2.3.1 原则以详细设计为准，模型设计摘要如下1.创建流程模型时修改流程的namespace，如下所示： decision的描述用“...是否...”，条件描述为“是”“否”，摆放位置应在连接线的起始端，水平连线上方、垂直连线右侧，偏移位移在5px以内6.当decision的出口在3条或3条以上，根据实际业务情况进行描述7.活动节点间的连线，水平或垂直平行时用直线，除此之外用带直角的连线8. group组件上下边框应大于泳道边界1px，group的描述有实际的业务含义9.流程中的组件大小用default。

如果文字太多（超过50字时），可根据实际情况调整10.相同组件的大小在同一流程模型中保持一致11.流程的起始位置在上方，结束位置在下方循环中驳回节点尽可能共用，以减少驳回节点个数3 项目构建与编码规范本项目开发基于Cordys BOP 4.1平台进行开发Cordys层使用SOAP WS进行服务开发，中间层使用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打包脚本，方便进行服务打包，第三方常用的lib库则都包含在EIP DEMO 工程中，请避免使用其他版本的库每个EIP服务的客户端是一个Jar文件，命名为XXX_impl.jar，最新的客户端jar文件以现网运行的版本为准。

开发工程包请向开发人员索取3.1 项目开发工具一览表平台：Cordys BOP4.1 Cu7MySQL Server：MySQL Server Community 5.5.19Eclipse IDE：eclipse javaee juno with Cordys CoE pluginSvn plugins: Eclipse update site URL: http://subclipse.tigris.org/update_1.8.xMySQL Tools：Navicat for MySQL 10.0.11 enterprise editionWeb Contanier：Apache Tomcat v7.0Web Browser: Google Chrome 最新版，Mozilla Firefox，IE 8 +，推荐使用Chrome浏览器进行开发SSH客户端：Xmanager 3.0 +，SecureCRT 7.0，推荐使用XME 3.0，可以直接使用图形界面，FTP客户端：Xftp,FilezillaXML格式化工具：foxe（XML 格式化工具）、XPathVisualizer 1.3.0文本编辑工具：Notepad++ 6.22…3.2 开发资源及服务器信息3.2.1 SVN服务器1、项目开发服务器地址：https://10.64.6.98:8443/svn/cloudbpm项目开发人员帐号，联系配置管理员获取。

开发服务器管理员帐号：远程桌面：adminstrator 密码：联系相关人员IP：10.64.6.98SVN客户端需使用TortoiseSVN 1.7.*2、公司SVN服务器： 项目根路径：http://10.64.8.160/svn/20121123/YMHLCFW/注意：本节以下所述SVN地址均相对此项目SVN根路径 开发工程SVN地址：² Cordys中CWS创建项目工程时绑定的SVN地址：00Developing/02code/cloudbpm/trunk/projects/bpm-cordys-cws-all² Cordys中CWS中创建的Java代码在Eclipse中编辑时，需下载Eclipse工程，下载地址：00Developing/02code/clo。