首页 > 其他分享 >gRPC 高级——Interceptor 拦截器

gRPC 高级——Interceptor 拦截器

时间:2024-07-13 20:27:32浏览次数:19  
标签:拦截器 请求 err proto gRPC grpc go Interceptor

gRPC拦截器是一种用于在RPC方法调用的生命周期中拦截和处理请求和响应的机制。拦截器允许开发者在请求到达实际服务方法之前或在响应返回客户端之前执行自定义逻辑。它们类似于中间件,广泛应用于日志记录、身份验证、请求修改等场景。

拦截器的种类

客户端拦截器(Client Interceptors)

客户端拦截器在客户端发出请求和接收响应时进行拦截。它们常用于添加认证信息、日志记录、修改请求等。

服务器拦截器(Server Interceptors)

服务器拦截器在服务器接收请求和发送响应时进行拦截。它们常用于验证身份、记录日志、修改响应等。

使用场景

日志记录

拦截器可以记录每个请求的详细信息,包括方法名、请求参数、响应结果和处理时间等。

身份验证

在请求到达实际服务方法之前,通过拦截器验证身份信息,确保请求来自合法客户端。

错误处理

拦截器可以捕获和处理请求过程中发生的错误,返回统一的错误响应。

请求和响应修改

拦截器可以在请求到达服务方法之前或响应返回客户端之前对其进行修改,例如添加或移除某些字段。

拦截器使用示例

0.目录树如下

以grpc入门的代码作为示例:

.
├── client
│   └── client.go
├── proto
│   ├── helloworld_grpc.pb.go
│   ├── helloworld.pb.go
│   └── helloworld.proto
└── server
    └── server.go
1. proto文件
syntax = "proto3";

option go_package = "grpc/proto";

service Hello {
  rpc Hello(HelloRequest) returns (HelloResponse);
}

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string response = 1;
}

利用命令生成对应的go文件

cd proto/
protoc meta.proto --go_out=. --go-grpc_out=.
2.服务端拦截器
1.建立server/server.go
package main

import (
	"context"
	"fmt"
	"google.golang.org/grpc"
	"net"

	"go-try/grpc_interceptor/proto"
)

type HelloServer struct {
	proto.UnimplementedHelloServer
}

func (s *HelloServer) Hello(ctx context.Context, request *proto.HelloRequest) (*proto.HelloResponse, error) {
	return &proto.HelloResponse{
		Response: "Hello " + request.Name,
	}, nil
}

func main() {
	// 定义一个UnaryServerInterceptor
	interceptor := func(ctx context.Context, req any,
		info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp any, err error) {
		// 接收到请求后的逻辑
		fmt.Println("接收到了一个新的请求")
		// 调用原始的handler处理请求
		response, _ := handler(ctx, req)
		// 请求处理完成后的逻辑
		fmt.Println("请求已经完成")
		// 返回处理结果和nil错误
		return response, nil
	}

	// 将定义的拦截器设置到gRPC服务器的选项中
	opts := grpc.UnaryInterceptor(interceptor)

	server := grpc.NewServer(opts)
	proto.RegisterHelloServer(server, &HelloServer{})
	listen, err := net.Listen("tcp", "0.0.0.0:8080")
	if err != nil {
		panic("faild to listen : " + err.Error())
	}
	err = server.Serve(listen)
	if err != nil {
		panic("faild to start grpc : " + err.Error())
	}
}

2.建立client/client.go
package main

import (
	"context"
	"fmt"

	"google.golang.org/grpc"

	"go-try/grpc_interceptor/proto"
)

func main() {
	conn, err := grpc.NewClient("0.0.0.0:8080", grpc.WithInsecure())
	if err != nil {
		panic(err)
	}
	defer conn.Close()

	cli := proto.NewHelloClient(conn)
	msg, err := cli.Hello(context.Background(), &proto.HelloRequest{Name: "zs"})
	if err != nil {
		panic(err)
	}
	fmt.Println(msg)
}

3. 分别运行server.go和client.go

server端运行结果如下:

接收到了一个新的请求
请求已经完成
3.客户端拦截器
1. 修改client/client.go的main函数
func main() {
	interceptor := func(ctx context.Context, method string,
		req, reply any, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
		// 发起请求之前的逻辑
        start := time.Now()
        // 发请求
		err := invoker(ctx, method, req, reply, cc, opts...)
        // 发起请求之后的逻辑
		fmt.Println("耗时: %s", time.Since(start))
		return err
	}

	var opts []grpc.DialOption
	opts = append(opts, grpc.WithInsecure())
	opts = append(opts, grpc.WithUnaryInterceptor(interceptor))

	conn, err := grpc.NewClient("0.0.0.0:8080", opts...)
	if err != nil {
		panic(err)
	}
	defer conn.Close()

	cli := proto.NewHelloClient(conn)
	msg, err := cli.Hello(context.Background(), &proto.HelloRequest{Name: "zs"})
	if err != nil {
		panic(err)
	}
	fmt.Println(msg)
}

2.分别运行server.go和client.go

client端运行结果如下:

请求耗时: %s 1.487169ms

拦截器应用场景

开源项目:go-grpc-middleware

总结

gRPC 拦截器是一种用于在 RPC 调用的生命周期中拦截和处理请求与响应的机制,类似于中间件。它们广泛应用于日志记录、身份验证、错误处理和请求修改等场景,能够在请求到达实际服务方法之前或响应返回客户端之前执行自定义逻辑,从而提高系统的灵活性和可维护性。拦截器有客户端和服务器两种类型,可以帮助开发者简化代码、增强功能,但也可能增加一些性能开销。

标签:拦截器,请求,err,proto,gRPC,grpc,go,Interceptor
From: https://blog.csdn.net/MPY_3/article/details/140405795

相关文章

  • Interceptor 拦截器
    1、拦截器的介绍拦截器使用场景:登录验证:对于需要登录才能访问的网址,使用拦截器可以判断用户是否已登录,如果未登录则跳转到登录页面。权限校验:根据用户权限对部分网址进行访问控制,拒绝未经授权的用户访问。请求日志:记录请求信息,例如请求地址、请求参数、请求时间等,用于排查......
  • protobuf-net.Grpc 笔记
    众所周知,Grpc很好用,但每次都需要手动编写*.proto文件,protobuf-net.Grpc个人感觉最大的优势是不用写*.proto文件,相关教程如下:https://learn.microsoft.com/zh-cn/aspnet/core/grpc/code-first?view=aspnetcore-8.0https://protobuf-net.github.io/protobuf-net.Grpc/gettingst......
  • 研究gRPC所给的helloworld例子
    这里我以编写一个远程过程调用,客户端传过来请求,远程过程调用就可以返回当前时间。(daytime服务器熟知端口是13,这里并不是搭建daytime,只是为了测试远程过程调用是否成功)CMakeLists.txt文件的编写cmake_minimum_required(VERSION3.8)project(HelloWorldCCXX)include(../cmake/......
  • 在C++中使用gRPC框架
    概览在gRPC里客户端应用可以像调用本地对象一样直接调用另一台不同机器上的服务端应用的方法,使得您能够更容易地创建分布式应用和服务。与许多RPC系统类似,gRPC也是基于以下理念:定义一个服务,指定其能够被远程调用的方法(包括参数和返回类型)。在服务器端实现这个接口,并运行一个gRPC......
  • MyBatis拦截器在实际项目中的应用
    MyBatis 是一个流行的Java持久层框架,它简化了数据库访问的复杂性,为开发者提供了强大的功能。其中,MyBatis拦截器是一个非常有用的特性,可以帮助开发者灵活地解决各种问题。一、MyBatis拦截器1.1从执行SQL语句的核心流程说起在MyBatis中,要执行一条SQL语句,会涉及......
  • 讲解一下Axios源码中,拦截器是怎么实现的
    面试中我们经常会被问道Axios的原理是怎么样的,它的拦截器是怎么实现的?下面我们来简单讲一下Axios的拦截器是如何实现的。Axios的拦截器实现基于Axios的核心原理,即Axios实例是一个包含请求和响应拦截器堆栈的对象。当发出请求或接收响应时,Axios会遍历这些拦截器,并按照添加......
  • 解决nacos报错 Caused by: io.grpc.netty.shaded.io.netty.channel.unix.Errors$Nati
    报错信息:org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:918)atorg.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:583)atorg......
  • 拦截器和过滤器适用场景,及其使用倾向
    拦截器(Interceptor)和过滤器(Filter)在Web应用中扮演着不同的角色,尽管它们都可以用来拦截请求和响应,但它们的适用场景和工作原理有显著的不同。以下是它们各自的一些典型适用场景:过滤器(Filter)过滤器是JavaEE的一部分,它由Servlet容器管理,可以应用于所有进出Web应用的请求和响应。过......
  • SpringBoot拦截器中获取注解、拦截器中注入Service
    拦截器中获取注解来源:https://blog.csdn.net/wangmx1993328/article/details/81030268/publicclassJWTInterceptorimplementsHandlerInterceptor{privateSysSettingServicesysSettingService;//构造函数传入ServicepublicJWTInterceptor(SysSettingServ......
  • [解决]Acton拦截器读取body内容后,方法内无法读取到body内容
    注意:1、在拦截器处理Stream时,应避免使用using语句包裹StreamReader,因为这会导致Stream在读取完成后关闭,进而阻止后续的读取尝试2、考虑到性能和稳定性,应尽可能使用异步方法读取Streamreader.ReadToEndAsync()3、当在拦截器中读取并处理Body后,记得将Stream位置重置context......