Kratos框架HTTP与gRPC逻辑复用设计方法

冬静吖_8091

冬静吖_8091

2026-10-10

751人浏览

原创

kratos项目通过统一定义common.proto、复用领域模型与错误码,并抽取独立biz层,实现http与grpc共用同一套业务逻辑、参数校验和错误处理。

kratos框架http与grpc逻辑复用设计方法 - php中文网

在Kratos项目中,需让同一套业务逻辑同时支撑HTTP和gRPC两种传输协议,避免重复编写Service方法体、重复校验参数、重复处理错误返回。

统一定义领域模型与错误码

在api/目录下新建common/common.proto,定义共享的message与error enum:

syntax = "proto3";
package kratos.api.common;

import "google/api/annotations.proto";

message Empty {}

message Status {
  int32 code = 1;
  string message = 2;
}

enum ErrorCode {
  UNSPECIFIED = 0;
  NOT_FOUND = 404;
  INVALID_ARGUMENT = 400;
  INTERNAL_ERROR = 500;
}

【必须将common.proto置于api/common/路径下,且package名严格为kratos.api.common】否则后续生成的Go类型无法被其他proto正确import,编译时报错“cannot find package”。

在业务proto中复用公共定义

以api/greeter/greeter.proto为例,直接import并使用:

import "api/common/common.proto";
import "google/api/annotations.proto";

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {
    option (google.api.http) = { get: "/greeter/hello" };
  }
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
  kratos.api.common.Status status = 2;
}

这一步做完后,执行kratos proto client api/greeter/greeter.proto,生成的pb.go中HelloReply.Status字段类型会自动映射为*common.Status,无需手动转换。

抽取独立的Biz层实现复用逻辑

第一步:在internal/biz/目录下创建greeter.go,定义纯业务结构体与方法:

type GreeterUsecase struct {
  repo Repo
}

func (uc *GreeterUsecase) SayHello(ctx context.Context, name string) (string, error) {
  if name == "" {
    return "", errors.New("name is required")
  }
  return fmt.Sprintf("Hello %s", name), nil
}

Kratos框架 2.8.2
Kratos框架 2.8.2

Kratos框架 2.8.2 源码包下载,针对 Watch Resolver goroutine 测试及指标、日志默认值问题进行修正。

下载

第二步:在internal/service/中分别实现HTTP Handler与gRPC Server,都调用同一Biz层:

// internal/service/greeter_service.go
func (s *GreeterService) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloReply, error) {
  msg, err := s.uc.SayHello(ctx, req.Name)
  if err != nil {
    return &pb.HelloReply{Status: &common.Status{Code: 400, Message: err.Error()}}, nil
  }
  return &pb.HelloReply{Message: msg, Status: &common.Status{Code: 0, Message: "OK"}}, nil
}

// internal/server/http.go 中的 handler
func (s *GreeterService) sayHelloHandler() http.HandlerFunc {
  return func(w http.ResponseWriter, r *http.Request) {
    name := r.URL.Query().Get("name")
    msg, err := s.uc.SayHello(r.Context(), name)
    if err != nil {
      http.Error(w, err.Error(), http.StatusBadRequest)
      return
    }
    json.NewEncoder(w).Encode(map[string]string{"message": msg})
  }
}

错误码与HTTP状态码自动对齐

方法一:在Biz层返回标准error,由transport层统一转译

在internal/transport/http/middleware/error.go中添加中间件:

func ErrorTranslator() middleware.Middleware {
  return func(handler middleware.Handler) middleware.Handler {
    return func(ctx context.Context, req any) (any, error) {
      reply, err := handler(ctx, req)
      if err != nil {
        switch {
        case errors.Is(err, biz.ErrNotFound):
          return nil, transport.NewError(http.StatusNotFound, err.Error())
        case errors.Is(err, biz.ErrInvalidArgument):
          return nil, transport.NewError(http.StatusBadRequest, err.Error())
        default:
          return nil, transport.NewError(http.StatusInternalServerError, "internal error")
        }
      }
      return reply, nil
    }
  }
}

方法二:gRPC端复用同一套error判定逻辑,在server.go中注册时传入统一的Unmarshaler

srv := grpc.NewServer(
  grpc.UnaryInterceptor(grpc_middleware.ChainUnaryServer(
    grpc_recovery.UnaryServerInterceptor(),
    grpc_zap.UnaryServerInterceptor(zapLogger),
    biz.ErrorUnaryServerInterceptor(), // 复用biz包里的拦截器
  )),
)

这一步做完后,无论HTTP还是gRPC调用,只要Biz层返回biz.ErrInvalidArgument,上层就会自动映射为400或gRPC的StatusCode_INVALID_ARGUMENT,无需在每个Service方法里重复写switch。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

2026.02.24

206

7

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

2026.02.24

113

7

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

2026.02.24

657

10

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

2026.02.24

218

7

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

2026.02.24

457

7

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

2026.02.24

208

7

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

2026.02.26

564

7

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

2026.02.26

225

7

Golang 实际项目案例:从需求到上线
Golang 实际项目案例:从需求到上线

《Golang 实际项目案例:从需求到上线》以真实业务场景为主线,完整覆盖需求分析、架构设计、模块拆分、编码实现、性能优化与部署上线全过程,强调工程规范与实践决策,帮助开发者打通从技术实现到系统交付的关键路径,提升独立完成 Go 项目的综合能力。

2026.02.26

62

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kratos框架快速入门
Kratos框架快速入门

共0课时 | 0人学习

Kratos框架v3文档
Kratos框架v3文档

共0课时 | 0人学习