Go语言中gRPC服务器停止后执行清理操作的实现方法

gRPC Go官方并没有提供你示例代码中用到的grpc.CleanUpInterceptor选项，这个用法是不存在的。要实现服务器停止后立即执行清理操作，有以下几种可靠的方式：

方式一：在服务器停止方法后直接调用清理函数 #

grpc.Server的Stop()和GracefulStop()方法都是阻塞式的——Stop()会立即终止所有连接并关闭服务器，GracefulStop()会等待现有请求处理完成后再关闭服务器，两者都会直到服务器完全停止才返回。因此你可以在调用这两个方法后直接执行清理逻辑：

import (
    "errors"
    "log"
    "net"
    "os"
    "os/signal"
    "syscall"

    "google.golang.org/grpc"
)

func cleanUp() {
    // 这里执行你的清理操作，比如关闭数据库连接、释放资源等
}

func main() {
    lis, err := net.Listen("tcp", ":50051")
    if err != nil {
        log.Fatalf("failed to listen: %v", err)
    }

    sOpts := []grpc.ServerOptions{
        // 添加你的服务器选项，比如拦截器
        grpc.UnaryInterceptor(unaryInterceptor),
    }
    s := grpc.NewServer(sOpts...)

    // 启动服务器（放在goroutine中避免阻塞主逻辑）
    go func() {
        if err := s.Serve(lis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
            log.Fatalf("failed to serve: %v", err)
        }
    }()

    // 监听终止信号（比如Ctrl+C或系统终止命令）
    sigChan := make(chan os.Signal, 1)
    signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
    <-sigChan

    log.Println("Shutting down gRPC server...")
    // 优雅停止服务器（或使用s.Stop()强制停止）
    s.GracefulStop()
    // 服务器完全停止后执行清理
    cleanUp()
    log.Println("Cleanup completed.")
}

方式二：自定义服务器结构体包装清理逻辑 #

如果你需要将清理逻辑与服务器本身绑定，可以自定义一个嵌入grpc.Server的结构体，重写Stop()和GracefulStop()方法，确保服务器停止后自动执行清理：

import (
    "errors"
    "log"
    "net"
    "os"
    "os/signal"
    "syscall"

    "google.golang.org/grpc"
)

func cleanUp() {
    // 你的清理操作
}

type CustomGRPCServer struct {
    *grpc.Server
    cleanup func()
}

// 重写Stop方法，停止服务器后执行清理
func (s *CustomGRPCServer) Stop() {
    s.Server.Stop()
    s.cleanup()
}

// 重写GracefulStop方法，优雅停止后执行清理
func (s *CustomGRPCServer) GracefulStop() {
    s.Server.GracefulStop()
    s.cleanup()
}

func main() {
    lis, err := net.Listen("tcp", ":50051")
    if err != nil {
        log.Fatalf("failed to listen: %v", err)
    }

    sOpts := []grpc.ServerOptions{
        grpc.UnaryInterceptor(unaryInterceptor),
    }
    baseServer := grpc.NewServer(sOpts...)
    // 创建自定义服务器，绑定清理函数
    customServer := &CustomGRPCServer{
        Server:  baseServer,
        cleanup: cleanUp,
    }

    go func() {
        if err := customServer.Serve(lis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
            log.Fatalf("failed to serve: %v", err)
        }
    }()

    sigChan := make(chan os.Signal, 1)
    signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
    <-sigChan

    log.Println("Shutting down gRPC server...")
    customServer.GracefulStop()
    log.Println("Cleanup completed.")
}

注意事项 #

• gRPC的拦截器（如UnaryInterceptor）是用于处理单个请求的生命周期（比如请求前后的逻辑），无法用来处理服务器停止后的全局清理，你的初始思路存在误解。
• 如果清理操作涉及异步任务，需要确保主goroutine等待清理完成后再退出，避免程序提前终止。

内容的提问来源于stack exchange，提问作者k1r1t0