如何使用 grpc 状态代码并根据客户端构建响应？

Question

我想知道当我们发送回用户时处理 grpc 状态代码和响应的最佳方法是什么？

func (us *customerService) FetchResponse(ctx context.Context, request *custPbV1.CustomerRequest) (*custPbV1.CustomerResponse, error) {
    meta := service.MetadataFromContext(ctx)
    clientId := meta.ClientId
    if clientId <= 0 {
        msg := fmt.Sprintf("could not retrieve client info for clientId:%d", clientId)
        // is this right way to return it?
        return nil, status.Error(codes.NotFound, msg)
    }

    resources := request.GetResources()
    if len(resources) == 0 {
        // is this right way to return it?
        err := status.Error(codes.InvalidArgument, "value cannot be null. (Parameter 'resources')")
        return nil, err
    }

    return us.GenerateCustomerInfo(clientId, resources)
}

我的原型非常简单 -

service CustomerService {
   rpc FetchResponse(CustomerRequest) returns (CustomerResponse) {};
}

message CustomerRequest {
   string resources = 1;
}

message CustomerResponse {
   string proc = 1;
   string data = 2;
}

GenerateCustomerInfo 方法将返回 CustomerResponse 和 error 两者。但如果出现错误，那么状态码会是什么？我试图弄清楚人们在返回 grpc 状态代码和响应给用户时遵循的标准是什么。是否必须将状态代码返回给客户端？

在响应对象中也有错误属性是个好主意吗？任何演示如何返回 grpc 状态和响应的最佳实践的示例都将对我有用。

Answer 1

这样做是完全可以的：

err := status.Error(codes.InvalidArgument, "value cannot be null. (Parameter 'resources')")
return nil, err

这将告诉您的客户端存在错误，并且有了这些信息，客户端可以检查状态代码和状态消息，如下所示：

resp, err = server.FetchResponse(context.Background(), req)
s, ok := status.FromError(err)

if ok { // there is an error
   fmt.Printf("Code: %d, Message: %s\n", s.Code(), s.Message())
}

GenerateCustomerInfo 方法将返回 CustomerResponse 和错误。但如果出现错误，那么状态码会是什么？

对于 GenerateCustomerInfo，我们没有太多信息可以重现，但在我看来，您应该返回类似以下内容：

return &custPbV1.CustomerResponse{
    Proc: "YOUR_PROC",
    Data: "YOUR_DATA",
}, nil

通过在错误中返回 nil，您将向客户端显示没有错误，在前面的代码中给出的 ok 将为 false。

在响应对象中也有错误属性是个好主意吗？

为此，您绝对可以添加一个错误属性，但是有必要这样做吗？您已经可以拥有 StatusCode 和 Message。它只会不必要地增加有效负载的大小。

但是如果GenerateCustomerInfo返回任何错误，那么我应该返回什么状态代码？我也需要定义它吗？

给定 GenerateCustomerInfo 的潜在实现如下：

func GenerateCustomerInfo() (*pb.CustomerResponse, error) {
    // some code
    if err {
        st := status.Error(codes.Internal /*or other*/, "a message")
        return nil, err
    }

    return &pb.CustomerResponse{
        Proc: "",
        Data: "",
    }, nil
}

它基本上会返回 CustomerResponse 或 nil 这完全是父函数所需要的。