Go+gRPC-Gateway(V2) 微服务实战,小程序登录鉴权服务(五):鉴权 gRPC-Interceptor 拦截器实战

简介: Go+gRPC-Gateway(V2) 微服务实战,小程序登录鉴权服务(五):鉴权 gRPC-Interceptor 拦截器实战

grpc.UnaryInterceptor



VSCode -> Go to Definition 开始,我们看到如下源码:


// UnaryInterceptor returns a ServerOption that sets the UnaryServerInterceptor for the
// server. Only one unary interceptor can be installed. The construction of multiple
// interceptors (e.g., chaining) can be implemented at the caller.
func UnaryInterceptor(i UnaryServerInterceptor) ServerOption {
  return newFuncServerOption(func(o *serverOptions) {
    if o.unaryInt != nil {
      panic("The unary server interceptor was already set and may not be reset.")
    }
    o.unaryInt = i
  })
}


注释很清晰:UnaryInterceptor 返回一个为 gRPC server 设置 UnaryServerInterceptorServerOption。只能安装一个一元拦截器。多个拦截器的构造(例如,chaining)可以在调用方实现。


这里我们需要实现具有如下定义的方法:


// UnaryServerInterceptor provides a hook to intercept the execution of a unary RPC on the server. info
// contains all the information of this RPC the interceptor can operate on. And handler is the wrapper
// of the service method implementation. It is the responsibility of the interceptor to invoke handler
// to complete the RPC.
type UnaryServerInterceptor func(ctx context.Context, req interface{}, info *UnaryServerInfo, handler UnaryHandler) (resp interface{}, err error)


注释很清晰:UnaryServerInterceptor 提供了一个钩子来拦截服务器上一元 RPC 的执行。info 包含拦截器可以操作的这个 RPC 的所有信息。handlerservice 方法实现的包装器。拦截器的职责是调用 handler 来完成 RPC 方法的执行。在真正调用 RPC 服务前,进行各微服务的通用操作(如:authorization)。


Auth Interceptor 编写


一句话描述业务:


  • 从请求头(header) 中拿到 authorization 字段传过来的 token,然后通过 pubclic.key 验证是否合法。合法就把 AccountID(claims.subject) 附加到当前请求上下文中(context)。

核心拦截器代码如下:


type interceptor struct {
  verifier tokenVerifier
}
func (i *interceptor) HandleReq(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error) {
    // 拿到 token
  tkn, err := tokenFromContext(ctx)
  if err != nil {
    return nil, status.Error(codes.Unauthenticated, "")
  }
    // 验证 token
  aid, err := i.verifier.Verify(tkn)
  if err != nil {
    return nil, status.Errorf(codes.Unauthenticated, "token not valid: %v", err)
  }
  // 调用真正的 RPC 方法
  return handler(ContextWithAccountID(ctx, AccountID(aid)), req)
}


具体代码位于 /microsvcs/shared/auth/auth.go


Todo 微服务



一个 Todo-List 测试服务。

这里,我们加入一个新的微服务 Todo,我们要做的是:访问 Todo RPC Service 之前需要经过我们的鉴权 Interceptor 判断是否合法。


定义 proto


todo.proto


syntax = "proto3";
package todo.v1;
option go_package="server/todo/api/gen/v1;todopb";
message CreateTodoRequest {
    string title = 1;
}
message CreateTodoResponse {
}
service TodoService {
    rpc CreateTodo (CreateTodoRequest) returns (CreateTodoResponse);
}


简单起见(测试用),这里就一个字段 title


定义 google.api.Service


todo.yaml


type: google.api.Service
config_version: 3
http:
  rules:
  - selector: todo.v1.TodoService.CreateTodo
    post: /v1/todo
    body: "*"


生成相关代码


microsvcs 目录下执行:


sh gen.sh


会生成如下文件:

  • microsvcs/todo/api/gen/v1/todo_grpc.pb.go
  • microsvcs/todo/api/gen/v1/todo.pb.go
  • microsvcs/todo/api/gen/v1/todo.pb.gw.go

client 目录下执行:


sh gen_ts.sh


会生成如下文件:

  • client/miniprogram/service/proto_gen/todo/todo_pb.js
  • client/miniprogram/service/proto_gen/todo/todo_pb.d.ts


实现 CreateTodo Service


具体见:microsvcs/todo/todo/todo.go


type Service struct {
  Logger *zap.Logger
  todopb.UnimplementedTodoServiceServer
}
func (s *Service) CreateTodo(c context.Context, req *todopb.CreateTodoRequest) (*todopb.CreateTodoResponse, error) {
    // 从 token 中解析出 accountId,确定身份后执行后续操作
  aid, err := auth.AcountIDFromContext(c)
  if err != nil {
    return nil, err
  }
  s.Logger.Info("create trip", zap.String("title", req.Title), zap.String("account_id", aid.String()))
  return nil, status.Error(codes.Unimplemented, "")
}


重构下 gRPC-Server 的启动


我们现在有多个服务了,Server 启动部分有很多重复的,重构一下:

具体代码位于:microsvcs/shared/server/grpc.go


func RunGRPCServer(c *GRPCConfig) error {
  nameField := zap.String("name", c.Name)
  lis, err := net.Listen("tcp", c.Addr)
  if err != nil {
    c.Logger.Fatal("cannot listen", nameField, zap.Error(err))
  }
  var opts []grpc.ServerOption
  // 鉴权微服务是无需 auth 拦截器,这里做一下判断
  if c.AuthPublicKeyFile != "" {
    in, err := auth.Interceptor(c.AuthPublicKeyFile)
    if err != nil {
      c.Logger.Fatal("cannot create auth interceptor", nameField, zap.Error(err))
    }
    opts = append(opts, grpc.UnaryInterceptor(in))
  }
  s := grpc.NewServer(opts...)
  c.RegisterFunc(s)
  c.Logger.Info("server started", nameField, zap.String("addr", c.Addr))
  return s.Serve(lis)
}


接下,其它微服务的gRPC-Server启动代码就好看很多了:

具体代码位于:todo/main.go


logger.Sugar().Fatal(
    server.RunGRPCServer(&server.GRPCConfig{
      Name:              "todo",
      Addr:              ":8082",
      AuthPublicKeyFile: "shared/auth/public.key",
      Logger:            logger,
      RegisterFunc: func(s *grpc.Server) {
        todopb.RegisterTodoServiceServer(s, &todo.Service{
          Logger: logger,
        })
      },
    }),
)


具体代码位于:auth/main.go


logger.Sugar().Fatal(
  server.RunGRPCServer(&server.GRPCConfig{
    Name:   "auth",
    Addr:   ":8081",
    Logger: logger,
    RegisterFunc: func(s *grpc.Server) {
      authpb.RegisterAuthServiceServer(s, &auth.Service{
        OpenIDResolver: &wechat.Service{
          AppID:     "your-appid",
          AppSecret: "your-appsecret",
        },
        Mongo:          dao.NewMongo(mongoClient.Database("grpc-gateway-auth")),
        Logger:         logger,
        TokenExpire:    2 * time.Hour,
        TokenGenerator: token.NewJWTTokenGen("server/auth", privKey),
      })
    },
  }),
)


联调



重构下 gateway server


我们要反向代理到多个 gRPC server 端点了,整理下代码,弄成配置的形式:

具体代码位于:microsvcs/gateway/main.go


serverConfig := []struct {
  name         string
  addr         string
  registerFunc func(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
}{
  {
    name:         "auth",
    addr:         "localhost:8081",
    registerFunc: authpb.RegisterAuthServiceHandlerFromEndpoint,
  },
  {
    name:         "todo",
    addr:         "localhost:8082",
    registerFunc: todopb.RegisterTodoServiceHandlerFromEndpoint,
  },
}
for _, s := range serverConfig {
  err := s.registerFunc(
    c, mux, s.addr,
    []grpc.DialOption{grpc.WithInsecure()},
  )
  if err != nil {
    logger.Sugar().Fatalf("cannot register service %s : %v", s.name, err)
  }
}
addr := ":8080"
logger.Sugar().Infof("grpc gateway started at %s", addr)
logger.Sugar().Fatal(http.ListenAndServe(addr, mux))


测试


微信图片_20220611160617.png

相关文章
|
9月前
|
监控 算法 NoSQL
Go 微服务限流与熔断最佳实践:滑动窗口、令牌桶与自适应阈值
🌟蒋星熠Jaxonic:Go微服务限流熔断实践者。分享基于滑动窗口、令牌桶与自适应阈值的智能防护体系,助力高并发系统稳定运行。
1156 1
Go 微服务限流与熔断最佳实践:滑动窗口、令牌桶与自适应阈值
|
11月前
|
监控 Java API
Spring Boot 3.2 结合 Spring Cloud 微服务架构实操指南 现代分布式应用系统构建实战教程
Spring Boot 3.2 + Spring Cloud 2023.0 微服务架构实践摘要 本文基于Spring Boot 3.2.5和Spring Cloud 2023.0.1最新稳定版本,演示现代微服务架构的构建过程。主要内容包括: 技术栈选择:采用Spring Cloud Netflix Eureka 4.1.0作为服务注册中心,Resilience4j 2.1.0替代Hystrix实现熔断机制,配合OpenFeign和Gateway等组件。 核心实操步骤: 搭建Eureka注册中心服务 构建商品
1487 3
|
存储 NoSQL API
微服务——MongoDB实战演练——需求分析
本文档《5-MongoDB实战演练》聚焦于某头条文章评论业务的需求分析与功能实现。基于MongoDB,需完成以下功能:1)提供基本的增删改查API;2)支持通过文章ID查询相关评论;3)实现评论点赞功能。结合实际业务场景,演示MongoDB在数据存储与操作中的应用,附带示意图帮助理解业务结构。
258 2
微服务——MongoDB实战演练——需求分析
|
缓存 负载均衡 监控
微服务架构下的电商API接口设计:策略、方法与实战案例
本文探讨了微服务架构下的电商API接口设计,旨在打造高效、灵活与可扩展的电商系统。通过服务拆分(如商品、订单、支付等模块)和标准化设计(RESTful或GraphQL风格),确保接口一致性与易用性。同时,采用缓存策略、负载均衡及限流技术优化性能,并借助Prometheus等工具实现监控与日志管理。微服务架构的优势在于支持敏捷开发、高并发处理和独立部署,满足电商业务快速迭代需求。未来,电商API设计将向智能化与安全化方向发展。
600 102
|
9月前
|
Cloud Native Serverless API
微服务架构实战指南:从单体应用到云原生的蜕变之路
🌟蒋星熠Jaxonic,代码为舟的星际旅人。深耕微服务架构,擅以DDD拆分服务、构建高可用通信与治理体系。分享从单体到云原生的实战经验,探索技术演进的无限可能。
微服务架构实战指南:从单体应用到云原生的蜕变之路
|
9月前
|
监控 Cloud Native Java
Spring Boot 3.x 微服务架构实战指南
🌟蒋星熠Jaxonic,技术宇宙中的星际旅人。深耕Spring Boot 3.x与微服务架构,探索云原生、性能优化与高可用系统设计。以代码为笔,在二进制星河中谱写极客诗篇。关注我,共赴技术星辰大海!(238字)
1384 2
Spring Boot 3.x 微服务架构实战指南
|
NoSQL MongoDB 微服务
微服务——MongoDB实战演练——文章评论的基本增删改查
本节介绍了文章评论的基本增删改查功能实现。首先,在`cn.itcast.article.dao`包下创建数据访问接口`CommentRepository`,继承`MongoRepository`以支持MongoDB操作。接着,在`cn.itcast.article.service`包下创建业务逻辑类`CommentService`,通过注入`CommentRepository`实现保存、更新、删除及查询评论的功能。最后,新建Junit测试类`CommentServiceTest`,对保存和查询功能进行测试,并展示测试结果截图,验证功能的正确性。
330 2
|
NoSQL Java MongoDB
微服务——MongoDB实战演练——文章评论实体类的编写
本节主要介绍文章评论实体类的编写,创建了包`cn.itcast.article.po`用于存放实体类。具体实现中,`Comment`类通过`@Document`注解映射到MongoDB的`comment`集合,包含主键、内容、发布时间、用户ID、昵称等属性,并通过`@Indexed`和`@CompoundIndex`注解添加单字段及复合索引,以提升查询效率。同时提供了Mongo命令示例,便于理解和操作。
265 2
|
11月前
|
负载均衡 监控 Java
微服务稳定性三板斧:熔断、限流与负载均衡全面解析(附 Hystrix-Go 实战代码)
在微服务架构中,高可用与稳定性至关重要。本文详解熔断、限流与负载均衡三大关键技术,结合API网关与Hystrix-Go实战,帮助构建健壮、弹性的微服务系统。
1001 1
微服务稳定性三板斧:熔断、限流与负载均衡全面解析(附 Hystrix-Go 实战代码)
|
NoSQL 测试技术 MongoDB
微服务——MongoDB实战演练——MongoTemplate实现评论点赞
本节介绍如何使用MongoTemplate实现评论点赞功能。传统方法通过查询整个文档并更新所有字段,效率较低。为优化性能,采用MongoTemplate对特定字段直接操作。代码中展示了如何利用`Query`和`Update`对象构建更新逻辑,通过`update.inc("likenum")`实现点赞数递增。测试用例验证了功能的正确性,确保点赞数成功加1。
310 0