Arch4系统开发指南-开发规范篇 联系客服

发布时间 : 星期一 文章Arch4系统开发指南-开发规范篇更新完毕开始阅读ff144655c281e53a5802ff8b

Arch4系统开发指南-开发规范篇 中科软科技股份有限公司

5.1 文件命名规范

除特别用途外,文件名区分大小写,每个单词的首字母大写。

5.1.1 页面文件(表单)命名规则

环境为:.jsp 操作名为:

操作名 Edit View Query 适用文件类型 JSP JSP JSP 含义 编辑 显示 查询 规则为:对象+操作+环境

以对象User为例,其文件名称如下所示:

文件名 UserEdit.jsp UserQuery.jsp 含义 用户编辑表单 用户查询表单 5.1.2 页面片段文件(表单)命名规则

环境为:.jspf

规则为:对象+操作+环境 示例如下所示:

文件名 RegistMainEdit.jspf

含义 报案主信息编辑表单片段 RegistThirdCarEdit.jspf 报案三者车信息编辑表单片段 5.1.3 Java文件命名规则

规则为:对象+操作+环境

以对象User为例,其文件名称如下所示: 包名 ins.claim.schema.model ins.claim.user.service.facade ins.claim.user.service.spring ins.claim.user.web 文件名 PrpDuser.java UserService.java UserServiceSpringImpl.java UserAction.java 5.2 Java程序命名规范

5.2.1 Java包命名规则

包名中所有字母均为小写。如: ins.claim ins.claim.user

第 9 页 共 20 页

Arch4系统开发指南-开发规范篇 中科软科技股份有限公司

ins.claim.defloss

5.2.2 Java类命名规则

按Java规则,首字母大写,之后的每个单词的首字母也大写。

注意:当表名为PrpLXXX(或PrpCXXX、PrpTxxx)时, Prp作为一个单词,LXXX作为一个单词 如表名为prpduser时类名为PrpDuser 典型类名如下:

对象名(表名) prpduser prplregist prpldeflossmain Policy

类名 PrpDuser PrpLregist PrpLdeflossMain Policy 5.2.3 Java属性命名规则

规则1:首字母小写,之后的每个单词的首字母也大写。 如policyNo,itemNo

规则2:如果首字母之后的字母按规则1应该为大写时,改为小写。 如ID应该为id 如ISBN应该为isbn

如usercname应该为userCName

注:这是因为JavaBean规范中对于iD的访问是按ID的方式进行的,如果页面上写iD则无法访问到。为了避免混淆,用规则2处理,直接从最底层避免这种问题。

5.2.4 Java方法命名规则

方法名为 动词+名词,如新增报案方法名为 addRegist,更新报案为updateRegist 下表为标准的几种方法前缀。 方法前缀 prepareAdd add prepareUpdate update prepareFind find delete view findByXXX 说明 准备增加 增加 准备更新 更新 准备查询 查询 删除 查看 示例 prepareAddUser、prepareAddRole addUser、addRole prepareUpdateUser、prepareUpdateRole updateUser、updateRole prepareFindUser、prepareFindRole findUser、findRole deleteUser、deleteRole viewUser、viewRole 按XXX查询 findByUserCode 第 10 页 共 20 页

Arch4系统开发指南-开发规范篇 中科软科技股份有限公司

5.3 词根表

在命名的时候,参照部门定义的词根表进行。里面包含词根的英文名、缩写及对应的中文意思。 部门词根表的文件名为“FI-WordRoot.xml”。

第 11 页 共 20 页

Arch4系统开发指南-开发规范篇 中科软科技股份有限公司

6 开发规范

6.1 子系统/模块规范

6.1.1 子系统命名规范

规则为 应用名+子系统名 如保险系统包名为ins

则中科软理赔子系统包名为 ins.claim

6.1.2 模块命名规范

按照业务划分,如理赔包括报案、立案、结案等环节,可以按照环节划分模块。即报案模块、立案模块、结案模块等。

中科软第二代理赔子系统报案模块包名为对应的包名为ins.claim.regist 中科软第二代理赔子系统立案模块包名为对应的包名为ins.claim.claim 每个模块下都有相同的包结构,参“3.2.2Java程序目录结构”:

6.1.3 特殊模块

除了对应业务的模块外,还包括接口模块。负责与外部系统的交互,如中科软第二代理赔子系统接口模块包名为对应的包名为ins.claim.interf

包名 ins.claim.interf ins.claim.interf.servlet ins.claim.interf.webservice ins.claim.interf.XXX

说明 公共模块根目录 与外部系统通过Servlet交互的目录 与外部系统通过WebService方式交互的目录 与外部系统通过XXX方式交互的目录 6.2 WEB层规范

6.2.1 命名规范

1. Action类必须存放在ins.subsystems.module.web包下。

第 12 页 共 20 页