代码规范-1.0文档

PagePAGE11ofNUMPAGES\*Arabic11代码规范CurrentVersion:V1.0partPART68DateLastUpdated:2013/09/17LastUpdatedBy:HEPENGAuthor:DateCreated:

2013/07/22ApprovedBy:ApprovalDate:

目录1.1 控制层代码规范 31.1.1 包结构保存规范 31.1.2 编码规范 31.2 WEB页面层规范 51.2.1 存放路径规范 51.2.2 编码、命名规范 6控制层代码规范包结构保存规范包路径说明根据项目,核心代码在core里面,对应的action在对应的web项目中根据项目,核心代码在core里面,对应的action在对应的web项目中编码规范Action代码的命名规范Action类的命名为动词＋名词短语＋Action后缀，名称要能体现出业务操作的内容，例如getUnpaidAccountsAction、auditKPIReportAction等。必须继承com.huayu.oms.system.base.action.BaseAction抽象类。接收参数规范Action定义连个成员变量分别对应输入参数和输出参数的两类集合（可选），action对象将输入参数传递到service对象中，service对象返回的结果也必须是action中的输出参数对象类型。Service代码的命名规范Service类接口的命名为名词短语＋Service后缀，例如UserManagementService，ProcessManagementService等。实现类的命名为名词短语＋Service＋实现方式＋Impl后缀，例如UserManagementServiceLocalImpl、UserManagementServiceLDAPImpl等。接口必须继承com.huayu.oms.system.base.service.BaseService接口。实现类必须继承com.huayu.oms.system.base.service.impl.BaseServiceImpl类。查询操作search+名词短语＋List的组合，用来查询一个列表，例如searchUserList，searchDomainList等。分两种情况：返回结果是POJO对象：searchUserList返回结果是DTO对象：searchUserDtoListquery+名词短语的组合，用来根据ID获取单个对象，例如queryKPI，queryProcessInstance等。新增操作create＋名词短语的组合，用来插入一条新的记录，例如createUser，createProcessInstance等。create＋All＋名词短语的组合，用来批量插入多条数据，例如createAllUser，createAllKPI等。更新操作update＋名词短语+ById后缀的组合，用来根据ID更新一条记录，例如updateKPIById，updateUserInfoById等。update＋All＋名词短语的组合，用来更新多条记录，例如updateAllUserInfo、updateAllAccountStatus等。删除操作delete＋名词短语＋ById后缀的组合，用来根据ID删除一条记录，例如deleteFinanceReportById等。delete＋All＋名词短语的组合，用来删除多条记录，例如deleteUserBatch、deleteAllDepartmentReport等。DAO代码的命名规范DAO类接口的命名为名词短语＋Dao后缀，例如UserManagementDao，ProcessManagementDao等。实现类的命名为名词短语＋Dao＋实现方式＋Impl后缀，例如UserManagementDaoDatabaseImpl、UserManagementDaoWebServiceStubImpl等。接口必须继承.BaseDao接口。实现类必须继承.BaseDaoImpl类。以下内容以数据库实现方式为例：查询操作一个查询操作方法原则上只能进行一次查询操作。search+数据对象＋List的组合，用来查询一个列表，例如searchUserList，searchDomainList等，本别对应以TM_USER（entity：user）、TM_DOMAIN（entity：domain）表为主表的查询操作。query+数据对象＋Detail后缀的组合，用来根据ID获取单个对象，例如queryKPIDetail，queryProcessInstanceDetail等，分别对应TM_KPI、TM_PROCESS_INSTANCE表为主表的查询操作。新增操作一个新增操作方法原则上只能对数据库中的一张表进行一次插入操作。create＋数据对象的组合，用来插入一条新的记录，例如createUser，createProcessInstance等，本别对应TM_USER、TM_PROCESS_INSTANCE表的插入操作。create＋数据对象＋Batch后缀的组合，用来批量插入多条数据，例如createUserBatch，createKPIBatch等，本别对应TM_USER、TM_KPI表的插入操作。更新操作一个更新操作方法原则上只能对数据库中的一张表进行一次update操作。update＋数据对象+ById后缀的组合，用来根据ID更新一条记录，例如updateKPIById，updateUserById等，分别对应TM_KPI、TM_USER表的update操作。update＋数据对象＋Batch后缀的组合，用来更新多条记录，例如updateUserBatch、updateAccountBatch等。删除操作一个删除操作方法原则上只能对数据库中的一张表进行一次删除操作。delete＋数据对象＋ById后缀的组合，用来根据ID删除一条记录，例如deleteFinanceReportById，对应TM_FINANCE_REPORT表的delete操作。delete＋数据对象＋Batch后缀的组合，用来删除多条记录，例如deleteUserBatch、deleteDepartmentReportBatch等，分别对应TM_USER、TM_DEPARTMENT_REPORT表的delete操作。POJO代码的命名规范POJO类和数据库表相对应，例如TM_USER表对应的POJO类的名称为….pojo.TmUser类。WEB页面层规范存放路径规范WEBROOT相对文件夹路径说明/css页面样式/js公共JS/WEB-INF/jsp/[BusinessModule]各个业务模块的jsp文件的存放路径/WEB-INF/jsp/system系统模块的jsp文件存放路径待添加编码、命名规范spring配置文件action配置文件配置文件放在cfg/springConfig/action目录下，文件名称为[businessModule].action.xml。bean的id为action类的名称。bean的class为action类的全包名＋类名。scope必须为prototype。一般情况下，actionbean必须继承baseAction的配置。service配置文件配置文件放在cfg/springConfig/service目录下，文件名称为[businessModule].service.xml。bean的id为service类的名称。bean的class为service类的全包名＋类名。scope在一般情况下必须为singleton。一般情况下，servicebean必须继承baseService的配置。一般情况下，一个service会引用一个或多个dao资源。dao配置文件配置文件放在cfg/springConfig/dao目录下，文件名称为[businessModule].dao.xml。bean的id为dao类的名称。bean的class为dao类的全包名＋类名。scope在一般情况下必须为singleton。一般情况下，daobean必须继承baseDao的配置。hibernate配置文件配置文件放在和对应javapojo代码相同的包路径下，文件名称为[pojo类名称].hbm.xml。package为该pojo类的包全路径。class的名称为pojo类的类名，不需要包路径。tiles配置文件在一般情况下，一个tilesdefinition定义必须扩展baseLayout的定义，同时name必须和action的名称相对应。Log配置文件OMS系统使用Log4J模块记录日志信息，配置信息在cfg/log4j.xml中：设置appender的file参数为日志文件存放的路径。开发人员也可根据实际情况调整其它参数。工作流配置文件工作流引擎的配置文件集成在spring的配置文件applicationContext.xml中：代码修改/提交注释规范类注释规范需要表明该类的作用、开发人、建立修改时间、修改原因;方法注释规范 需要表明该方法的作用、参数、返回值、捕获异常信息；注释摸板:/***@version${date}${time}*@author${user}*@see{方法功能/动作描述}*${tags}*@return${return_type}{返回参数说明}*@methodName${enclosing_method}*@exception{说明在某情况下,将发生什么异常}*/修改代码注释规范表明修改时间、修改人、修改原因，并且保留注释原有代码，以便查看项目代码提交提交代码必须注释代码修改了什么功能,如果是bug