项目管理规范

一、项目强制执行
1、POM中所有jar包的引用必须是有效的,并且需要保证jar包的版本统一。

2、POM中如果是多模块项目,必须注释清楚每个模块的具体功能。

3、数据库表的命名不用统一前缀,要按照业务功能统一命名。

4、数据库表必须有主键且使用ID命名,逻辑外键使用关联表名加ID,例如:user_id。

5、数据库表之间统一使用主键进行关联。

6、 数据库表的编码格式必须使用:utf8mb4。

7、 数据库表名、字段名必须有注释,表名和项目中实体必须一致。

8、数据库中状态、类型等都使用枚举名存储,不允许使用数字存储。

9、数据库字段优先使用非空约束,业务逻辑非空的字段必须设置非空约束。

10、数据库需要建立唯一索引的字段必须建立。

11、 在项目中,开发包名必须明确按照业务区分好,禁止出现一个包下面有各种各样大量文件,必须按功能进行分包 。例如:定时任务需要按功能模块分别放到不同的包下面,现在有项目几十个定时任务放到一个包下面。

12、项目中状态、类型等都使用枚举,不允许使用数字。

13、 项目中必须要使用hibernate validation框架进行入参校验,不允许出现因输入字符过长导致的数据库字段超长异常。

14、项目必须通过阿里的规范扫描后才能提交git。

15、项目中的重复代码统一封装工具类,公共的代码要提取出来作为统一公共类。

16、项目中已经废弃的业务逻辑代码,要及时删除,有效期为1个月,后期再使用的时候可以进行重构开发。

17、项目中每个类和方法要写明代码注释,方便后期代码阅读和问题处理。

18、 项目中RedisKey的命名要按业务来区分管理,方便维护。

19、项目中Redis在使用时要设置过期时间,理论上建议不超过24小时,具体的可按实际的业务场景进行设置,如果因业务需求不能设置过期时间的要注明原因。

20、 项目中对外服务必须要有xss攻击过滤、跨域处理。

21、 项目中代码嵌套层不允许超过3层。

22、项目中要按照职责进行类、包拆分,一个service类最多3个对外方法,禁止使用如user、common笼统词汇进行命名。

23、IDEA必须安装阿里规范、findbugs软件。

24、代码审查出的问题要及时修改,并且要及时分享,其它的项目要同步进行检查并修复。

25、所有账号信息必须在配置文件中配置,不允许写在程序中,交易密钥及密码等敏感信息需要加密。

二、 项目推荐执行

1、 每个类上面都有对勾。

2、 针对项目上线后可能变化较频繁的信息,建议在数据库中创建数据字典表,不要配置在配置文件中,避免修改时需要重启服务。

3、 后台进行导出数据查询的时候,由于pageHelper分页查询数据时会执行count命令,建议不使用pageHelper进行分页查询,在代码中查询一次总量,后续自行实现分页查询。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容