设计一个接口需要考虑什么
- 入参合法性校验。参数范围是否合理,参数类型是否正确等
- 接口考虑幂等性 。重复调用的结果和单次调用的结果一致。
- 减少接口的响应时间。如数据库加索引。添加redis 缓存
- 选择合适的接口请求日志 。不同接口设置不同的日志级别
- 统一响应数据格式 。需要返回统一格式的响应体,响应数据会包含三个属性:
状态码
(code),信息描述
(message),响应数据
(data) - 接口单一职责
如何保证接口安全
- 使用https协议。
- 参数校验。参数范围是否合理,参数类型是否正确等
- 统一封装返回值 。需要返回统一格式的响应体,响应数据会包含三个属性:
状态码
(code),信息描述
(message),响应数据
(data) - 区分不同的访问形式。比如是否登录,账号是普通账号还是会员账号,或者管理员账号
- 加验证码。
- 限制访问频率。比如发送短信后,60秒后才能再次发送
慢接口如何排查
线上接口过慢,原因有以下三点:
1.内存使用过高,频繁gc导致cpu占满
2.内存使用不高,但出现了类似死循环的场景
3.死锁。
- 使用
top -c
指令找到负载高的进程id top -Hp X
指令查看该进程的线程id的CPU负载情况,找到CPU负载高的线程id- 使用jstack命令查看该线程的堆栈信息
- 根据堆栈信息找到代码中哪个类的第几行出现了问题