后端开发规范

我整理了一个规范文档,叫 《Re:后端开发手册》
,就是希望和我一起做项目的后端开发人员,在开发前能够反复看看这份文档。 正文部分主要涉及下面四个模块:

开发规范

我们项目组算是历史悠久,这些年因为人员的变更,以及开发人员技术水平的参差不齐,代码风格和数据结构五花八门。例如,接口响应成功的编码,有的人是 ok
,有的人是 success
,而有的人则是直接返回 状态码200
。而在数据库创建表时,版本号、创建人、创建时间、更新人、更新时间,这五个基础字段的命名方式都不统一。

本章节中,我们初步定义了数据库层面上,相关的数据结构设计规范。而在spring boot开发上,依照目前最流行的RESTful API规范,定义了接口设计和开发规范要求。期望达到的效果是,每个人不管业务代码能力如何,至少创建的表、接口返回的数据结构是一样的。目前整理的规范有:

  • Java开发规范。
  • Oracle数据库规范。
  • RESTful API 规范。

技术工具

在日常spring boot 开发过程中,有很多在基础开发时,普遍要用到的功能。我们将实现这类功能的第三方插件,其纳入 技术工具
的章节。 例如,在使用数据库数据源时,最好是要搭配数据源连接池使用,以保证数据库连接的稳定。这里就选用了业界好评的Druid,讲解了如何在spring boot项目中,规范地配置和使用Druid连接池。 另外,所有开发好的后端接口,都伴随着一份详细的接口文档。并且要保证代码的每次变动之后,对应的接口文档也能很快得到更新。Swagger简直就是这种模式下的救星,只需要遵守它的规则,就能在程序运行时,自动生成一份在线的接口文档。

Unicorn框架

这是自开发的一个spring boot框架,帮助我们规范开发过程,也封装了一些可复用的功能模块。

例如,接入企业的单点登录之后的接口安全问题,就需要懂得当前系统单点登录原理的人,写验证token和保证接口安全的代码。如果每个人每创建一个新的项目,都要重新写一遍这些代码,会平白增加多少无意义的工作量?

框架还实现了swagger的一些基础功能配置,业务异常处理等功能。Unicorn框架作为一个良好的 容器
,现有的功能只是一个开端。更重要的是,以后可以借助这个基础框架,发布更多的标准功能,规范团队开发。

Re:从零开始

这章主要是给刚开始编程之旅的新人看的,每隔段时间就会有一些新入加入我们的团队,其中有些人可能都没有spring boot基础。以前我总让他们去百度spring教程,那么现在就多了一个选择。本章节会手把手带你安装环境,创建表,创建项目,再到写代码。

这个章节我反反复复写了好几遍。一方面,担心在基础开发规范上埋下了坑,另一方面,的确每次写完都有新的感悟。

这篇文章有点水,具体的规范正文部分还是要看具体文档,再次附上链接地址 《Re:后端开发手册》

原文 

https://segmentfault.com/a/1190000022366399

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 后端开发规范

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址