微服务接口校验

三丰 soft张三丰

微服务接口校验

API 设计方案

Http的请求分为URL约定规则、请求参数规则 URL规则: http://{server}/{product}/{version}/{logic}/{method}?{query_string}　

1.server: 为具体的服务域名
2.product: 为应用工程名
3.version: 为具体版本号, 便于将来的功能扩展, 可以暂定为 v1, v2
4.logic: 为具体业务逻辑的初步划分, 比如后端管理方法, app端的请求方法
5.method: 具体业务的方法
具体的请求参数, 由指定的method方法决定, 全都作为HTTP GET/POST的参数列表。

Http的响应规则

HTTP响应码为200, 返回结果为JSON字符串的形式: 　　　　如果响应结果正确,则返回结果如下所示:


{　　
　　　　　　data : { // 请求数据，对象或数组均可
　　　　　　　　user_id: 123,
　　　　　　　　user_name: "zwz",
　　　　　　　　user_avatar_url: "http://www.abc.com/1.jpg"
　　　　　　　　...
　　　　　　},
　　　　　　msg : "done", // 请求状态描述，调试用
　　　　　　success : 1,
　　　　　　code" : 1001, // 业务自定义状态码
　　　　　　extra : { // 其他扩展的数据，字段、内容不定
　　　　　　　　type: 1,
　　　　　　　　desc: "签到成功！"
　　　　　　}
　　　　}

如果响应结果失败,则返回如下结果:


{
　　　　　　data : { // 请求数据，对象或数组均可
　　　　　　},
　　　　　　msg : "Internal Server Error", // 请求状态描述，调试用
　　　　　　success : 0,
　　　　　　code : 5001, // 业务自定义状态码
　　　　　　extra : {
　　　　　　}
　　　　}
}

错误码

API 在设计的时候，最好不要将业务错误码与HTTP状态码的绑定,重新定义一套业务错误码，来区分HTTP 的状态码。　　　　状态码的定义也最好有一套规范，类似于HTTP 的状态码，可以按照用户相关、授权相关、各种业务，做简单的分类。


// Code 业务自定义状态码定义示例
　　　　// 授权相关
　　　　1001: 无权限访问
　　　　1002: access_token过期
　　　　1003: unique_token无效
　　　　...

　　　　// 用户相关
　　　　2001: 未登录
　　　　2002: 用户信息错误
　　　　2003: 用户不存在

　　　　// 业务相关
　　　　3001: 业务XXX
　　　　3002: 业务XXX

　　　　// 系统异常
　　　　5001：Internal Server Error

Spring请求参数校验

SpringMVC支持的数据校验是JSR303的标准，通过在bean的属性上打上@NotNull、@Max等进行验证。JSR303提供有很多annotation接口，而SpringMVC对于这些验证是使用hibernate的实现，所以我们需要添加hibernate的一个validator包：框架已经提供校验如下：


@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null,不能为 null , 可以为 ""
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式

Hibernate Validator提供的校验注解：
@NotBlank(message =) 只能作用在String上，不能为null，而且调用trim()后，长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空，不能为 null、"",可以为 " "
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内

总结

当然，单纯依赖框架提供的校验不能够满足实时变化的业务，所以需要自己根据业务写一些自定义的校验规则，当然这个也比较简单。