开发规范及框架说明文档

鼎尖ERP开发规范

框架介绍

基础框架包含了base,basedata,basedata-web,log,log-web, workflow,workflow-web, framework,web。其中以framework和-web为后缀的Project为web支持项目，其它的为业务基础项目。

base,提供dao层的基础接口及实现。

basedata,提供基础数据类型，集成业务基础数据(如组织，人员，岗位等)。

log,提供日志支持。

workflow,提供流程中心支持。

framework,通用web页面功能实现，如列表，编辑，数据选择器，左树右表等。

web，负载所有模块的web资源，及集成各个模块。

模块命名规范

新增一个模块需要增加两个项目，分别命名为是XXX,XXX-web。

XXX 包含模块相关model,模块相关dao，模块相关service

XXX-web 包含模块相关controller类

数据库命名规范

a)表的命名为T_模块名_实体名，如T_BROKER_ROOM, oracle中全部为大写

b)存储过程命名SP_模块名_存储过程名

c)视图命名V_模块名_视图名

d)表中字段的命名必须以F开头，表中的字段名应和实体中的字段命名保持一致如

id -> FID, name -> FNAME，number -> FNUMBER, 如果是外键必须以FK开头以ID 结尾，FKORGID

包结构规范

开发框架采用spring+mybatis框架，包含有4层，model层,dao层,service 层，controller层, 现以基础项目(basedata)的组织子模块(org)为例

model的包名

com.dingjian.模块名.子模块名.model .model

enum的包名

com.dingjian.模块名.子模块名.enums .enums

dao 的包名

com.dingjian.模块名.子模块名.dao .dao

daoImpl 的包名

com.dingjian.模块名.子模块名.dao.impl .dao.impl

xml 的包名

com.dingjian.模块名.子模块名

service 的包名

com.dingjian.模块名.子模块名.service .service serviceImpl的包名

com.dingjian.模块名.子模块名.service.impl .service.impl controller的包名

com.dingjian.模块名.子模块名.controller .controller

类命名规范

所有的类名，必须以完整的英文单词，禁止出现中文拼音，或者不完整的单词

a)所有的controller必须以Controller结尾，controller类按功能，列表处理类以

ListController结尾，单据编辑类以EditController结尾

b)所有的service接口必须以Service结尾，如RoomService, 实现类必须以ServiceImpl

结尾，如RoomServiceImpl

c)所有的dao接口必须以Dao结尾，如RoomDao, 实现类必须以DaoImpl结尾，如

RoomDaoImpl

d)所有的实体类符合骆驼命名法

实体类字段的命名规范

所有的字段，必须以完整的英文单词，禁止出现中文拼音，或者不完整的单词

字段后面需要加上字段的注释，实体头部必须加上对应表的名字。

前台文件命名规范

前台文件分为JSP,JS,CSS三类

a)JSP 实体类相关编辑JSP和列表JSP 以实体类名为开头，后面加EDIT 和LIST。如

组织实体的新增和列表JSP命名为OrgEdit.jsp OrgList.jsp

编辑页面引入公用JSP头文件EditUIHead.jsp

列表界面引入公用JSP头文件ListUIHead.jsp

其他界面引入公用JSP头文件commonHead.jsp

移动界面引入公用JSP头文件mobileHead.jsp

JSP文件位置放在web项目webapp/WEB-INF/views/模块名/子模块名/下

JS文件放在web项目webapp/default/js/module/模块名/子模块名/下

b)JSP所引用js尽量命名与JSP保持一致; JSP所引用css尽量命名与JSP保持一致

SQL维护规范

Sql位置--svn下sql项目，由于同时支持Oracle和mysql数据库，需要分别维护Oracle和mysql的升级文件和数据初始化文件，分别在文件夹initsql项目，upgradesql项目。Mysql_create.sql,Mysql_init.sql

Oracle_create.sql,Oracle_init.sql

1)Oracle脚本书写规范

1. 查询判断时所有表名，列名大写

select count(*) from User_Tab_Columns where table_name=表名（大写）and column_name=字段名（大写）

select count(*) from user_TABLES where table_name = 表名（大写）；

2. execute immediate 语句里面不要出现引号''

3. 注意日期格式，确保正确

4. 提交前自己到数据库跑一下，确保能够执行

--添加岗位类型表添加人：欧海兵添加日期：2013-09-11

select count(1) into num from user_tables s where s.TABLE_NAME =