美文网首页
项目管理规范

项目管理规范

作者: iaiayao | 来源:发表于2022-03-10 14:54 被阅读0次

一、项目强制执行
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进行分页查询,在代码中查询一次总量,后续自行实现分页查询。

相关文章

  • IT软件开发项目管理规范

    为了规范本部门项目管理,提高项目完成质量,提升项目管理效率,特制定本规范。 项目立项 项目确认可行后,开始准备项目...

  • GIT 规范

    git 规范 git 规范一般包括两点:分支管理规范和 git commit 规范。 分支管理规范 一个项目可以创...

  • 今日碎碎念

    今天跟朋友聊起项目管理,我说其实我现在做的也不是规范的项目管理,她说现实生活中就没有规范的项目管理,任何一个项目都...

  • 项目管理规范

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

  • tapd任务规范V0.1.0

    前言 为了规范技术中心项目管理过程,统一管理工具。目前针对已有管理方式决定统一使用tapd进行项目管理,本规范制定...

  • 项目管理语录(1)项目立项

    项目立项是项目管理准入的基本入口、也是项目管理规范的开启,在互联网环境组织下的项目管理却往往忽视这个环节,导...

  • 版本管理

    第一章目的 本规范详细规定软件项目版本管理的对象、存储目录、分支、权限、维护等内容,使软件项目版本管理流程化并规范...

  • 代码分支管理

    吉利能力中台项目上线在即,为规范上线后的代码分支管理和版本管理,制定如下规范,请大家review,有问题...

  • 项目管理入门第一课学习笔记(基本框架)

    项目管理入门live学习笔记(侵删): 项目管理 一、项目管理概述: 1.是什么:一套规范的、理想情况下可以应对各...

  • Java项目版本管理规范

    Java项目版本管理规范 版本命名规则 Prong Boot / Prong Cloud的版本命名规范在maven...

网友评论

      本文标题:项目管理规范

      本文链接:https://www.haomeiwen.com/subject/zswfdrtx.html