说明:四个部分的涉众对象分别是浏览器、前端开发、错误排查人员、用户。其中输出给用户的提示信息
要求:简短清晰、提示友好,引导用户进行下一步操作或解释错误原因,提示信息可以包括错误原因、上下文环境、推荐操作等。 errorCode:参考附表 3。
errorMessage:简要描述后端出错原因,便于错误排查人员快速定位问题,注意不要包含敏感数据信息。
正例:常见的 HTTP 状态码如下
200 OK: 表明该请求被成功地完成,所请求的资源发送到客户端。
401 Unauthorized: 请求要求身份验证,常见对于需要登录而用户未登录的情况。
403 Forbidden:服务器拒绝请求,常见于机密信息或复制其它登录用户链接访问服务器的情况。
404 Not Found: 服务器无法取得所请求的网页,请求资源不存在。
500 Internal Server Error: 服务器内部错误。
正例:errorCode / errorMessage / assetStatus / menuList / orderList / configFlag
反例:ERRORCODE / ERROR_CODE / error_message / error-message / errormessage / ErrorMessage / msg
说明:Java 服务端如果直接返回 Long 整型数据给前端,JS 会自动转换为 Number 类型(注:此类型为双精度浮点数,表示原理与取值范围等同于 Java 中的 Double)。
Long 类型能表示的最大值是 2 的 63 次方-1,在取值范围之内,超过 2 的 53 次方 (9007199254740992)的数值转化为 JS 的 Number 时,有些数值会有精度损失。扩展说明,在 Long 取值范围内,任何 2 的指数次整数都是绝对不会存在精度损失的,所以说精度损失是一个概率问题。
若浮点数尾数位与指数位空间不限,则可以精确表示任何整数,但很不幸,双精度浮点数的尾数位只有 52 位。
反例:通常在订单号或交易号大于等于 16 位,大概率会出现前后端单据不一致的情况,比如,“orderId”:362909601374617692,前端拿到的值却是: 362909601374617660。
【强制】HTTP 请求通过 body 传递内容时,必须控制长度,超出最大长度后,后端解析会出错。
说明:nginx 默认限制是 1MB,tomcat 默认限制为 2MB,当确实有业务需要传较大内容时,可以通过调大服务器端的限制。
用户输入参数的小于 1,则前端返回第一页参数给后端;
后端发现用户输入的参数大于总页数,直接返回最后一页。
说明:缓存有利于减少交互次数,减少交互的平均延迟。
正例:http 1.1 中,s-maxage 告诉服务器进行缓存,时间单位为秒,用法如下,
response.setHeader(“Cache-Control”, “s-maxage=” + cacheSeconds);