Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
User Main Head Middle Tail 业务对象 表名 布局名 布局名 布局名 员工 主表 头部 中部 尾部 3.1.4 典型操作名
操作名 Edit View Query deleteByPK deleteXXX findXXX findByXXX addXXX updateXXX initXXX
适用文件类型 JSP JSP JSP Java Java Java Java Java Java Java 含义 编辑 显示 查询 按主键删除 按对象删除本身 查询 按XXX查询，请勿使用getXXX 添加 更新 初始化 注意：getXXX易和getter方法混淆，所以不建议使用，用findByXXX方法代替 3.1.5 举例
3.1.5.1 JSP文件举例1
表单EngageEdit.jsp，分解如下：
3.1.5.2 JSP文件举例2
表单MainHeadEdit.jsp，表示基本信息头部编辑，分解如下：
第 6 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
3.1.5.3 Java文件举例
类UserServiceSpringImpl.java，表示用户服务的Spring实现，分解如下：
在Java文件中，操作不体现在文件名中，而体现在该Java类的方法中
3.2 目录命名规范
除特别用途外，目录名必须全部为小写。
3.2.1 页面目录命名规则
webapp为应用的目录。
第 7 页 共 20 页
Arch4系统开发指南-开发规范篇 中科软科技股份有限公司
目录 pages pages/user WEB-INF WEB-INF/classes WEB-INF/lib widgets widgets/sui widgets/yui2
说明 应用的页面文件目录 应用的User模块的页面文件目录 Web应用系统部分，包括配置文件、库文件、类文件等 类文件目录 Jar文件目录 WEB组件目录（所有的外部公共组件都放在这里） SUI组件目录 YUI2组件目录(YUI2的目录，供SUI使用) 3.2.1.1 举例
以新增报案模块功能为例说明如何确定目录名 1． 确定根目录名
pages
2． 确定模块目录名
模块为报案，对应关键字为regist
所以报案模块的目录名为 pages/regist
3.2.2 Java程序目录结构
4
5
包名 ins.helloworld ins.helloworld.user ins.helloworld.user.model ins.helloworld.user.service ins.helloworld.user.service.facade ins.helloworld.user.service.spring ins.helloworld.user.web
说明 演示系统 模块根目录 模块对应的POJO对象目录 服务目录 服务接口目录 Spring方式的服务实现目录 Struts2方式的Action目录 第 8 页 共 20 页
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 页