大彬大约 1 分钟

设计接口要注意什么?

  1. 接口参数校验。接口必须校验参数,比如入参是否允许为空,入参长度是否符合预期。
  2. 设计接口时,充分考虑接口的可扩展性。思考接口是否可以复用,怎样保持接口的可扩展性。
  3. 串行调用考虑改并行调用。比如设计一个商城首页接口,需要查商品信息、营销信息、用户信息等等。如果是串行一个一个查,那耗时就比较大了。这种场景是可以改为并行调用的,降低接口耗时。
  4. 接口是否需要防重处理。涉及到数据库修改的,要考虑防重处理,可以使用数据库防重表,以唯一流水号作为唯一索引。
  5. 日志打印全面,入参出参,接口耗时,记录好日志,方便甩锅。
  6. 修改旧接口时,注意兼容性设计。
  7. 异常处理得当。使用finally关闭流资源、使用log打印而不是e.printStackTrace()、不要吞异常等等
  8. 是否需要考虑限流。限流为了保护系统,防止流量洪峰超过系统的承载能力。
Loading...