10
2018
10

后端开发规范(微服务)【VME项目】

2.1、接口自测标准

接口自测能减少最常见的BUG,有问题也只是小问题,尽量减少联调过程的时间

附:微服务清单中,接口的返回数据格式(可以直接是自测时的Json结果)要加上,现在没有写的话要调通接口才能获取数据格式然后再调整前端数据绑定,太浪费双方时间

联调:前端调用后端微服务(接口),确保参数传值正确;

前端自测:前端保证在后端返回数据正确时前端功能正常;

后端自测:后端保证在前端传的参数正确时功能正常;


2.1.1 查询接口标准

2.1.1.1首先要造一些测试数据(前提)

2.1.1.2 必填参数判空,如果必填参数传值不正确则返回相应提示

2.1.1.2 查询非必填条件为空时(所有非必填参数都为空值)查询接口不报错、数据能正确返回

2.1.1.3 (如果有非必填参数)查询非必填参数不为空时(所有非必填参数都有值)查询接口不报错、数据能正确返回

 

2.1.2 添加、修改接口标准

2.1.2.1必填参数判空,如果必填参数传值不正确则返回相应提示

2.1.2.2 所有参数都有值的情况下,能新增/修改成功,数据库也能查到数据一致

2.1.2.3必填参数都有值、非必填字段都为空的情况下,能新增/修改成功,数据库也能查到数据一致

 

2.2、命名规范

         2.2.1工程名命名规范

                   ly.mp开头并且全部小写

         2.2.2包名命名规范       

                   com.开头并且全部小写

         2.2.3接口命名规范

                   名称以大写I开头

         2.2.4实体类类命名规范

                   命名以Entity结尾,属性字段以字母小写开头(如:private String userID

         2.2.5常量命名规范

                   定义的常量必须全部大写(static final int MIN_WIDTH = 20

         2.2.6类名命名规范

                   是个一名词,采用大小写混合的方式,每个单词的首字母大写(class ImageSprite

         2.2.7变量命名规范

                   采用大小写混合的方式,第一个单词的首字母小写

         2.2.8注释规范

                   使用// /*  */,接口层的方法必须注释,做什么的,参数都是什么含义

         2.2.9编码规范

                   统一全部小写

                  

2.3、微服务清单规范提醒

之前迭代1的微服务清单上没有写返回数据格式,这个是微服务设计规范上是有的,没写的话前端这边联调时要中途修改数据绑定网格,导致联调花更多的时间。要求后端自测通过后,把返回的json格式写上,自测后把返回响应复制过来就行,也不需要额外的时间去编写。

写微服务清单是要花时间,但你不花这点时间,浪费的就是更多的联调的时间。所以,强烈建议后端开发的功能与微服务清单一致,如果哪边有问题防止扯皮,后端说是前端的问题,前端说是后端的问题,虽然问题不大,但有微服务清单参照,谁的问题就很清楚了。




版权声明:
作者:真爱无限 出处:http://www.pukuimin.top 本文为博主原创文章版权归作者所有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文链接.
« 上一篇下一篇 »

相关文章:

评论列表:

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。