异常信息回传

1. 准备工作

  • dubbo-go cli 工具和依赖工具已安装
  • 创建一个新的 demo 应用

2. 传递异常信息

参考samples dubbo-go-samples/error

用户异常回传介绍

用户可以在 provider 端生成用户定义的异常信息，可以记录异常产生堆栈，triple 协议可保证将用户在客户端获取到异常 message ，并可以查看报错堆栈，便于定位问题。

注意返回 error 非 nil 时，框架不负责其他返回值的传递。

  • 在Triple provider 端返回异常，以 pb 序列化为例：
  1. package main
  3. import (
  4.     "context"
  5. )
  7. import (
  8.     "dubbo.apache.org/dubbo-go/v3/common/logger"
  10.   // 使用可以记录堆栈的异常库，此处以 "github.com/pkg/errors" 为例
  11.     "github.com/pkg/errors"
  12. )
  14. import (
  15.     triplepb "github.com/apache/dubbo-go-samples/api"
  16. )
  19. // 一个实现了 pb 接口的服务提供结构
  20. type ErrorResponseProvider struct {
  21.     triplepb.UnimplementedGreeterServer
  22. }
  24. // 回传错误的接口
  25. func (s *ErrorResponseProvider) SayHello(ctx context.Context, in *triplepb.HelloRequest) (*triplepb.User, error) {
  26.     logger.Infof("Dubbo3 GreeterProvider get user name = %s\n" + in.Name)
  27.   // 返回用户自定义异常
  28.     return &triplepb.User{Name: "Hello " + in.Name, Id: "12345", Age: 21}, errors.New("user defined error")
  29. }
  • 客户端打印异常和堆栈
  1. package main
  3. import (
  4.     "context"
  5. )
  7. import (
  8.     "dubbo.apache.org/dubbo-go/v3/common/logger"
  9.     "dubbo.apache.org/dubbo-go/v3/config"
  10.     _ "dubbo.apache.org/dubbo-go/v3/imports"
  12.     tripleCommon "github.com/dubbogo/triple/pkg/common"
  13. )
  15. import (
  16.     triplepb "github.com/apache/dubbo-go-samples/api"
  17. )
  19. var greeterProvider = new(triplepb.GreeterClientImpl)
  21. func init() {
  22.     config.SetConsumerService(greeterProvider)
  23. }
  25. func main() {
  26.     if err := config.Load(); err != nil {
  27.         panic(err)
  28.     }
  30.     req := triplepb.HelloRequest{
  31.         Name: "laurence",
  32.     }
  34.   // 发起调用
  35.     if user, err := greeterProvider.SayHello(context.TODO(), &req); err != nil {
  36.     // 打印异常信息，err.Error() 将返回用户定义的 message，即 user defined error
  37.         logger.Infof("response result: %v, error = %s", user, err)
  39.     // 打印异常堆栈，需断言为 tripleCommon.TripleError
  40.         logger.Infof("error details = %+v", err.(tripleCommon.TripleError).Stacks())
  41.     }
  42. }
  1. 2021-11-12T18:36:33.730+0800    INFO    cmd/client.go:53        response result: , error = user defined error
  2. 2021-11-12T18:36:33.730+0800    INFO    cmd/client.go:54        error details = [type.googleapis.com/google.rpc.DebugInfo]:{stack_entries:"user defined error
  3. main.(*ErrorResponseProvider).SayHello
  4.        /dubbo-go-samples/error/triple/pb/go-server/cmd/error_reponse.go:40
  5. reflect.Value.call
  6.        /usr/local/go/src/reflect/value.go:543
  7. reflect.Value.Call
  8.        /usr/local/go/src/reflect/value.go:339
  9. dubbo.apache.org/dubbo-go/v3/common/proxy/proxy_factory.(*ProxyInvoker).Invoke
  10.        /Users/laurence/go/pkg/mod/dubbo.apache.org/dubbo-go/v3@v3.0.0-rc4-1/common/proxy/proxy_factory/default.go:145
  11.        ...

可看到报错信息和堆栈

最后修改 December 16, 2022: Fix check (#1736) (97972c1)