javaWeb后台开发代码规范9652.pdfVIP

javaWeb后台开发代码规范 命名规范 1.基本原则： （1） 采⽤英⽂全称进⾏命名； （2）保持各层级名称基本统⼀； （3）命名英⽂单词⽤全称，避免⽤简称。 1.1 包命名规范 包名称必须全部⽤⼩写。 命名⽅式：com.域名.项⽬名称.项⽬模块.系统分层 如：com.example.ordering.java.dao com.example.ordering.java.controller 1.2 类命名规范 类名以英⽂单词取名，使⽤⼤驼峰式命名法，⾸字母⼤写，多个英⽂单词以⼤写字母间隔，尽量避免使⽤缩写；类名中不允许‘_’、 ‘-’等特殊符号。 1.3 属性命名规范 a.定义属性的位置，在类定义的开始，按照public,protected,package,private顺序放置。 b.尽量⽤相同含义英⽂单词表⽰如：username。第⼀个字母⼩写，中间单词的第⼀个字母⼤写。不要⽤_ 或等符号作为第⼀个字母。单字符的变量名⼀般只⽤ 于⽣命期⾮常短暂的变量。如：i,j,k,m,n⼀般⽤于int。如果变量是集合，则变量名应⽤复数，即以⼩写s结尾 。 c.常量属性：⼀律⼤写，单词间使⽤_分隔。例如：MAX_SIZE 1.4 ⽅法命名规范 ⽅法命名采⽤ “动作+属性” 的⽅法。并且，动作以⼩写字母开始，属性以⼤写字母开始。常⽤的动作有 ：is、get、set、save、add、 del等。⽰例 ：getName() 2. MySQL数据库命名规范及约定 2.1 操作规范 1.如⽆备注，则表中的第⼀个id字段⼀定是主键且为 ⾃动增长； 2. 如⽆备注，则数值类型的字段请使⽤UNSIGNED属性； 3. 如⽆备注，排序字段order_id在程序中默认使⽤降序排列 ； 4. 如⽆备注，所有字段都设置NOT NULL，并设置默认值 ； 5. 如⽆备注，所有的布尔值字段，如is_hot、is_deleted，都必须设置⼀个默认值，并设为0 ； 6. 所有的数字类型字段，都必须设置⼀个默认值，并设为0 ； 7. 针对varchar类型字段的程序处理，请验证⽤户输⼊，不要超出其预设的长度 ； 8. 建表时将数据字典中的字段中⽂名和属性备注写⼊数据表的备注中(“PK、⾃动增长”不⽤写) ； 9. 如⽆说明，建表时⼀律采⽤innodb引擎； 2.2 常⽤表名约定 说明 ：表前缀⽤项⽬名称⾸字母缩写；所以表名都⼩写，单词之间⽤下划线分开，单词都⽤单数形式。 1. user – ⽤户 2. category – 分类 3. goods – 商品、产品等⼀切可交易⽹站的物品都⽤此命名 4. good_gallery – 物品的相册 5. good_cate – 物品的分类，除了单独作为表名，其他地⽅分类单词⼀律⽤缩写cate 4. attr – 属性 5. article – ⽂章、新闻、帮助中⼼等以⽂章形式出现的，⼀般都⽤此命名 6. cart – 购物车 7. feedback – ⽤户反馈 8. order – 订单 9. site_nav – 包括页头和页尾导航 10. site_config – 系统配置表 11. admin – 后台⽤户 【RBAC标准表】 12. role – 后台⽤户⾓⾊【RBAC标准表】 13. access – 后台操作权限，相当于action 【RBAC标准表】 14. role_admin – 后台⽤户对应的⾓⾊【RBAC标准表】 15. access_role – 后台⾓⾊对应的权限【RBAC标准表】 3. 代码提交规范 1.提交前应该冷静、仔细检查⼀下，确保没有忘记加⼊版本控制或不应该提交的⽂件。 2.提交前应该先编译⼀次（idea⾥ctrl+F9），防⽌出现编译都报错的情况。 3.提交前先更新pull⼀次代码，提交前发⽣冲突要⽐提交后发⽣冲突容易解决的多。 4.提交前检查代码是否格式化，是否符合代码规范，⽆⽤的包引⼊、变量是否清除等等。 5.提交时检查注释是否准确简洁的表达出了本次提交的内容。 6.提交代码时必须填写详细备注，如完成功能，注释为“新增XX功能” ； 4. 代码注释规范 1.注释应该使代码更加清晰易懂 2.注释要简洁明了，只要提供能够明确理解程序必要的信息就可以了。如果注释太复杂会影响程序整洁度和阅读感。 3.注释不仅描述程序作了什么，还要描述为什么这样做以及约束。 4.对于⼀般的getter和setter⽅法不⽤注释。 5.类、接⼝、构造函数、⽅法、全局变量必须添加注释。字段属性可以选择添加简单注