接口设计的原则

1、接口参数的校验。

2、注意接口的兼容性(修改原有对外接口,一定要注意兼容性)。

3、设计接口时,充分考虑接口的可扩展性。

4、防重处理。

5、重点接口,考虑线程池隔离。

6、调用第三方接口要考虑异常和接口超时(有重试机制)。

7、接口实现考虑熔断和降级。

8、日志打印。接口的关键代码,要有关键日志保驾护航。

9、接口的功能要具备单一性。

10、某些接口场景,使用异步更为合理。

11、优化接口耗时,远程串行调用考虑并行调用。

12、接口合并或者说考虑批量处理思想(数据库操作或远程调用,能批量操作就避免循环调用)。

13、接口实现过程中,恰当使用缓存。

14、接口考虑热点数据隔离。

15、配置化。

16、接口幂等。

17、读写分离,优先考虑读从库,注意主从延迟问题。

18、接口主体返回的数据量,如果数据量较大需要分页。

19、好的接口实现,离不开SQL优化。

20、代码锁的粒度控制好。

21、接口状态和错误需要统一明确。

22、接口要考虑异常处理(尽量不要使用e.printStackTrance(),可能会导致内存沾满)。

23、优化程序逻辑。

24、接口实现过程中,注意大文件、大事务、大对象。

25、接口需要考虑限流。

26、代码实现时,注意运行时异常(空指针,下标越界等)。

27、保证接口的安全性(token机制)。

28、分布式事务,如何保证。

29、避开事务失效的一些场景。

30、掌握常用的设计模式。

31、考虑线程安全性。

32、接口定义清晰易懂,命名规范。

33、接口版本控制。

34、注意代码的规范问题。

35、保证接口正确性,就是保证更少的bug。

36、学会沟通,跟前端沟通,跟产品沟通。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值