数据库规范:
1、如果使用MYSQL数据库做为开发库,在创建数据库时,需要设置做到表名、字段名不区分大小写。这里修改mysql数据库。
但字段的值需要区分大小写。这里在创建的时候,字段类型要设置如下:varchar(10) binary;
2、设计表时,分部署场景主键全部使用雪花算法生成的id来代替数值型的自增主键,普通小型项目int自增主键性能更好;
3、字段属性要按业务要求严格使用相应的字段类型,不要使用字符串类型代替数值型、日期型等。
4、外键关联字段字符类型需一致,例如都使用utf-8-mb4,否则索引无法生效;
后台代码规范:
1、controller的方法中,一定要使用try...catch...来捕获,防止出现错误,前台出现500错误。
2、controller中,请使用logger来记录日志,不要出现e.printStackTrace();
3、类名首字母大写,方法名首字母小写,变量首字母小写,静态常量全大写。
4、controller中,不要在同一方法中同时调用两个或多个service方法,这样可能会出现事务问题。如果需要调用多个service,在一个service中调用其他service。
5、通用dao中的方法,适用于绝大部分场景。在没有特殊情况下,不要随意修改通用dao。
6、请最大限度使用hql与数据库交互,有特殊情况可酌情使用原生sql。
7、代码中如果有多种情况,需要使用 1 2 3 此类硬编码进行编码的时候,请将这些值转为常量进行比较,便于维护。
8、一个方法编码行数不宜过长,如果过长,可抽取部分代码建一个私有方法,以供调用。
9、代码注释模板以及代码格式化模板,请在eclipse中导入同级目录中的xml文件。导入后,记得将用户名修改成自己的。
10、session request response等类型不要传到service层处理,可在controller层处理后,再将需要的参数传给service。
svn或者git提交规范:
1、所有提交都需要写上注释;