工作中总结的开发规范
1.数据库设计规范
(1)表名称:模块前缀_模块名。
(2)主键: varchar(50)。
(3)必须包含:jl_is_del 删除标识 int 数据库存储1&0; ts 时间戳 char(19)。
(4)类型说明
日期类型:char(10)。
日期时间类型:char(19)。
逻辑类型:char(1) 数据库会存储Y&N。
(5)有小数的数值字段数据类型:decimal(20,8)。
(6)富文本数据类型:longtext。
(7)整形数据类型:int。
2.后台开发规范
(1)代码规范
1.controller类的方法名称必须与.json或者.html或者.do的名称一致,方便查询,如果是返回modelAndView,那么jsp文件名称也必须一样,controller类名和requestmapping一致。
1.1.requestMapping路径说明
.html:返回ModelAndView或者String。
.json:返回json数据(Map<String,Object>)。
.do:执行操作,无返回数据或者返回的是文件流,如附件的上传下载。
2. controller中url的配置还必须遵循模块规范,比如任务模块下面如果有多个controller,那么url必须使用以sys_task开头,如TaskTreeController的url配置为/sys_task/tree。
3.java/jsp/js文件命名必须清晰易懂,使用英文统一命名。
4.涉及数据库新增、删除、更新的,都放到service类中进行,保持事务一致性,避免出现回滚不干净。
5.静态变量名称都使用大写,变量名不要使用temp,demo之类。
6.开发过程中对于个人已经确定无用的内容,需要进行删除、注释,避免时间太久遗漏处理造成不必要的问题。
7.循环中尽量不要使用数据库查询,尽量在循环外面统一查询。
8.对自己创建的类,方法,变量进行注释,越详细越好。
3.前端开发规范
(1)缩进与换行:使用一个tab缩进,不要使用空格。

(2)css、javaScript的引入
1.css不管是内部引入还是外部引入,都应该放在<head>标签内。
2.需要提前加载的js可以放在<head>标签内部 ,不需要的js,放在<body>内部。
3.不要引入没有使用的js,css资源文件,提交代码的时候去掉debugger,console.log()以及alert等代码。

浙公网安备 33010602011771号