开工大吉！简单的说说公司的开发规范！

你们好，很久没有写公众号了，最近有朋友参加面试被问到开发规范的问题，忽然发现天天干着工做，却没有关注这个问题，就想着写篇文章，简单的说下本身公司的开发规范。

关于规范，每一个公司都有本身独特的开发规范，归根结底，好的规范才能提升一个团队的效率，接下来，简单的说下本身公司的开发规范，若是你们能在其中有所收获，就是值得的，欢迎评论区交流。

接口规范：

一、在开发以前必需要先定义接口，定义接口就必需要思考你的需求，逻辑，在写接口文档的时候其实你就已经在你的大脑中实现了一遍你的需求了。

二、你定义的接口也是要有标准的，包括不包含多余的字段，正式环境和测试环境的数据格式必须一致，文档与真实开发出来的接口必须一致等等。

三、在开发的过程当中，若是接口有变化，须要及时和前端或者客户端沟通，避免由于信息的不一样步问题而致使工期延误。

四、还有前端和APP拿到你的接口数据以后不须要再次的进行逻辑处理，好比说，状态字段是int类型，你把全部的枚举类型给他，让他本身去循环判断应该显示哪一个中文，若是接口定义成这样，那这个接口就是不太合格的，你能够在接口返回数据中添加一个字段来避免使用者的多余的工做量。

上线规范：

一、首先在开发完成后，咱们须要自测，自测的标准并非特别的高，只须要经过冒烟测试，可以把正常的流程走通就能够了，千万不要自测还没测好就交给测试，当测试辛辛苦苦的录完数据，走正常的流程的时候报个系统异常，这种心情应该是十分酸爽的。只有当这些常规的测试走通的时候，测试才会给你测那些比较不容易发现的问题，若是测试老是在这些显而易见的问题上兜兜转转，那么在有限的时间内，测出的产品可能质量也并不高。

二、其次测试经过以后，关注下在正式环境上是否须要资源申请，好比说服务器，redis，数据库，这些东西须要提早的给运维提交工单，让运维可以从容不迫的去准备，避免在上线那天由于资源还没准备好而耽误太长的时间。

三、在测试经过，运维准备好资源的时候，就能够部署到线上了，咱们的代码如今应该是在dev分支上，咱们须要把代码合并到master分支上（这里须要说明下，master分支上千万不要修改代码，咱们要时刻保证master分支上的代码是和线上环境保持一致的），以后就能够经过Jenkins或者其余部署工具部署项目了。

四、部署以后，咱们不能直接通知测试来测试了，咱们须要用咱们的测试用例，本身先访问下咱们的正式环境的接口，看下是否正常，以后在通知测试回测。等待着测试汇报答复（每次上线听到测试说没有问题，内心豁然开朗）上线完成。

这里说下，在线上部署的同时须要注意的点，在dev和master分支合并代码以后要进行代码review，避免本身的误操做带来没必要要的问题。

当在正式环境遇到问题的时候，咱们须要先经过本身的测试用例来定位问题，能够单点线上tomcat来肯定服务是否存在代码问题，若是是代码问题，修改后第二次合并代码的时候要慎重，可使用交叉review的方式。若是问题归属配置问题，及时找运维沟通解决。上线完成后，要对master分支上打tag，在tag中说明这次部署上线的主要内容。

以上只是简单的说了下接口文档和上线的规范，接下来还会说数据库设计相关的规范，做为本身的知识总结，也但愿能帮助到其余人。

这里会长期的分享技术干货、平常工做总结与思考，你的点赞和分享是对我最大的支持，感谢。

若是这篇文章让你有所收获，欢迎关注公众号 java技术情报局