用户工具


设计目标

  • 简单易用
  • 健壮

接口字段

  • 接口版本
  • 客户端ip(调用机器)
  • 业务标识(调用方标识)
  • traceId(跟踪调用)
  • 请求发起时间(跟踪事件)
  • 重要级别(用于判断降级)
  • maxExecuteTime
    • 允许运行的时间,必须大于应用对外承诺的时间,适用于部分对时间不敏感的场景
  • isTest(是否是测试请求)
  • 请求参数对象(封装所有参数信息)
  • additionMap (其他信息,用于存放一些特殊场景,比如多个业务方在用一个接口,但是某个一个合作方临时有个需求)

返回值字段

ResultDTO

  • 返回结果对象(封装所有返回信息)
  • isSuccess(调用是否成功)
  • isRetry(判断是否可以重试,一般超时可以重试)
  • 状态码
    • 成功
    • 超时
    • 失败其他原因
  • 异常信息(失败原因)
  • 基本判断方法
    • isServerTimeout (服务端超时)
    • isServerRateLimit (服务端限流)

客户端关注

  1. 如果客户端抛出异常,客户端自己处理
  2. 客户端拿到返回结果
    1. isSuccess=true,只有这一种情况表示成功
    2. isSuccess=false,根据isRetry和各自业务需要判断是否需要重试