fix: 复用 client，降低socket消耗

Author: vissong

botgo.go

@@ -33,10 +33,10 @@ func SelectOpenAPIVersion(version openapi.APIVersion) error {
 // NewOpenAPI 创建新的 openapi 实例，会返回当前的 openapi 实现的实例
 // 如果需要使用其他版本的实现，需要在调用这个方法之前调用 SelectOpenAPIVersion 方法
 func NewOpenAPI(token *token.Token) openapi.OpenAPI {
-	return openapi.DefaultImpl.New(token, false)
+	return openapi.DefaultImpl.Setup(token, false)
 }
 
 // NewSandboxOpenAPI 创建测试环境的 openapi 实例
 func NewSandboxOpenAPI(token *token.Token) openapi.OpenAPI {
-	return openapi.DefaultImpl.New(token, true)
+	return openapi.DefaultImpl.Setup(token, true)
 }

examples/receive-and-send/process.go

@@ -31,7 +31,7 @@ func (p Processor) ProcessMessage(input string, data *dto.WSATMessageData) error
 		toCreate.Ark = genReplyArk(data)
 	}
 	if _, err := p.api.PostMessage(context.Background(), data.ChannelID, toCreate); err != nil {
-		log.Fatalln(err)
+		log.Println(err)
 	}
 	return nil
 }
@@ -60,7 +60,8 @@ func genReplyContent(data *dto.WSATMessageData) string {
 `
 
 	msgTime, _ := data.Timestamp.Time()
-	return fmt.Sprintf(tpl,
+	return fmt.Sprintf(
+		tpl,
 		message.MentionUser(data.Author.ID),
 		message.MentionChannel(data.ChannelID),
 		msgTime, time.Now().Format(time.RFC3339),

openapi/iface.go

@@ -28,11 +28,9 @@ type OpenAPI interface {
 // Base 基础能力接口
 type Base interface {
 	Version() APIVersion
-	New(token *token.Token, inSandbox bool) OpenAPI
+	Setup(token *token.Token, inSandbox bool) OpenAPI
 	// WithTimeout 设置请求接口超时时间
 	WithTimeout(duration time.Duration) OpenAPI
-	// WithBody 设置 body，如果 openapi 提供设置 body 的功能，则需要自行识别 body 类型
-	WithBody(body interface{}) OpenAPI
 	// Transport 透传请求，如果 sdk 没有及时跟进新的接口的变更，可以使用该方法进行透传，openapi 实现时可以按需选择是否实现该接口
 	Transport(ctx context.Context, method, url string, body interface{}) ([]byte, error)
 	// TraceID 返回上一次请求的 trace id

openapi/v1/openapi.go

@@ -19,10 +19,12 @@ import (
 type openAPI struct {
 	token   *token.Token
 	timeout time.Duration
-	body    interface{}
-	sandbox bool
-	debug   bool
-	trace   string // trace id
+
+	sandbox     bool   // 请求沙箱环境
+	debug       bool   // debug 模式，调试sdk时候使用
+	lastTraceID string // lastTraceID id
+
+	restyClient *resty.Client // resty client 复用
 }
 
 // Setup 注册
@@ -35,29 +37,25 @@ func (o *openAPI) Version() openapi.APIVersion {
 	return openapi.APIv1
 }
 
-// TraceID 获取 trace id
+// TraceID 获取 lastTraceID id
 func (o *openAPI) TraceID() string {
-	return o.trace
+	return o.lastTraceID
 }
 
-// New 生成一个实例
-func (o *openAPI) New(token *token.Token, inSandbox bool) openapi.OpenAPI {
-	return &openAPI{
+// Setup 生成一个实例
+func (o *openAPI) Setup(token *token.Token, inSandbox bool) openapi.OpenAPI {
+	api := &openAPI{
 		token:   token,
 		timeout: 3 * time.Second,
 		sandbox: inSandbox,
 	}
+	api.setupClient() // 初始化可复用的 client
+	return api
 }
 
 // WithTimeout 设置请求接口超时时间
 func (o *openAPI) WithTimeout(duration time.Duration) openapi.OpenAPI {
-	o.timeout = duration
-	return o
-}
-
-// WithBody 设置 body，如果 openapi 提供设置 body 的功能，则需要自行识别 body 类型
-func (o *openAPI) WithBody(body interface{}) openapi.OpenAPI {
-	o.body = body
+	o.restyClient.SetTimeout(duration)
 	return o
 }
 
@@ -67,42 +65,51 @@ func (o *openAPI) Transport(ctx context.Context, method, url string, body interf
 	return resp.Body(), err
 }
 
-func (o *openAPI) request(ctx context.Context) *resty.Request {
-	client := resty.New().
+// 初始化 client
+func (o *openAPI) setupClient() {
+	o.restyClient = resty.New().
 		SetLogger(log.DefaultLogger).
 		SetDebug(o.debug).
 		SetTimeout(o.timeout).
 		SetAuthToken(o.token.GetString()).
 		SetAuthScheme(string(o.token.Type)).
 		SetHeader("User-Agent", version.String()).
-		SetPreRequestHook(func(client *resty.Client, request *http.Request) error {
-			// 执行请求前过滤器
-			// 由于在 `OnBeforeRequest` 的时候，request 还没生成，所以 filter 不能使用，所以放到 `PreRequestHook`
-			return openapi.DoReqFilterChains(request, nil)
-		}).
+		SetPreRequestHook(
+			func(client *resty.Client, request *http.Request) error {
+				// 执行请求前过滤器
+				// 由于在 `OnBeforeRequest` 的时候，request 还没生成，所以 filter 不能使用，所以放到 `PreRequestHook`
+				return openapi.DoReqFilterChains(request, nil)
+			},
+		).
 		// 设置请求之后的钩子，打印日志，判断状态码
-		OnAfterResponse(func(client *resty.Client, resp *resty.Response) error {
-			log.Infof("%v", respInfo(resp))
-			// 执行请求后过滤器
-			if err := openapi.DoRespFilterChains(resp.Request.RawRequest, resp.RawResponse); err != nil {
-				return err
-			}
-			o.trace = resp.Header().Get(openapi.TraceIDKey)
-			// 非成功含义的状态码，需要返回 error 供调用方识别
-			if !openapi.IsSuccessStatus(resp.StatusCode()) {
-				return errs.New(resp.StatusCode(), string(resp.Body()), o.trace)
-			}
-			return nil
-		})
+		OnAfterResponse(
+			func(client *resty.Client, resp *resty.Response) error {
+				log.Infof("%v", respInfo(resp))
+				// 执行请求后过滤器
+				if err := openapi.DoRespFilterChains(resp.Request.RawRequest, resp.RawResponse); err != nil {
+					return err
+				}
+				traceID := resp.Header().Get(openapi.TraceIDKey)
+				o.lastTraceID = traceID
+				// 非成功含义的状态码，需要返回 error 供调用方识别
+				if !openapi.IsSuccessStatus(resp.StatusCode()) {
+					return errs.New(resp.StatusCode(), string(resp.Body()), traceID)
+				}
+				return nil
+			},
+		)
+}
 
-	return client.R().
-		SetContext(ctx)
+// request 每个请求，都需要创建一个 request
+func (o *openAPI) request(ctx context.Context) *resty.Request {
+	return o.restyClient.R().SetContext(ctx)
 }
 
 // respInfo 用于输出日志的时候格式化数据
 func respInfo(resp *resty.Response) string {
 	bodyJSON, _ := json.Marshal(resp.Request.Body)
-	return fmt.Sprintf("[OPENAPI]%v %v, trace:%v, status:%v, elapsed:%v req: %v, resp: %v",
+	return fmt.Sprintf(
+		"[OPENAPI]%v %v, traceID:%v, status:%v, elapsed:%v req: %v, resp: %v",
 		resp.Request.Method,
 		resp.Request.URL,
 		resp.Header().Get(openapi.TraceIDKey),