SRPC项目教程：实现自定义过滤器机制

SRPC项目教程：实现自定义过滤器机制

【免费下载链接】srpc RPC framework based on C++ Workflow. Supports SRPC, Baidu bRPC, Tencent tRPC, thrift protocols. 项目地址: https://gitcode.com/gh_mirrors/sr/srpc

概述

在分布式系统中，RPC(远程过程调用)框架的过滤器机制是一个非常重要的功能组件。SRPC作为一款高性能RPC框架，提供了灵活的过滤器接口，允许开发者在请求处理的不同阶段插入自定义逻辑。本文将详细介绍如何在SRPC中实现自定义过滤器，并通过一个完整的示例展示其应用场景。

过滤器机制的核心概念

SRPC的过滤器机制基于RPCFilter基类实现，主要特点包括：

1. 双向拦截：过滤器可以同时作用于客户端和服务端
2. 模块化设计：通过RPCModuleType区分不同类型的模块
3. 上下文传递：通过RPCModuleData在不同处理阶段传递数据

实现自定义过滤器

1. 定义过滤器类

class MyFilter : public RPCFilter
{
public:
    MyFilter() : RPCFilter(RPCModuleTypeCustom)
    {
    }

    bool server_begin(SubTask *task, RPCModuleData& data) override
    {    
        auto iter = data.find("my_auth_key");
        if (iter != data.end() && iter->second.compare("my_auth_value") == 0)
        {
            fprintf(stderr, "[FILTER] auth success : %s\n", iter->second.c_str());
            return true;
        }

        fprintf(stderr, "[FILTER] auth failed : %s\n",
                iter == data.end() ? "No auth" : iter->second.c_str());
        return false;
    }
};

这个自定义过滤器实现了简单的认证逻辑，检查请求中是否包含正确的认证信息。

2. 关键点解析

• 构造函数：必须指定模块类型为RPCModuleTypeCustom
• server_begin方法：在服务端处理请求开始时被调用
• 返回值：返回true表示通过验证，false表示拒绝请求

完整示例实现

1. 服务端实现

class ExampleServiceImpl : public Example::Service
{
public:
    void Echo(EchoRequest *req, EchoResponse *resp, RPCContext *ctx) override
    {
        resp->set_message("Hi back");
        fprintf(stderr, "[SERVER] Echo() get req: %s\n", req->message().c_str());
    }
};

int main()
{
    // 初始化
    GOOGLE_PROTOBUF_VERIFY_VERSION;
    signal(SIGINT, sig_handler);
    signal(SIGTERM, sig_handler);

    // 创建并配置服务器
    SRPCServer server;
    ExampleServiceImpl impl;
    server.add_service(&impl);

    // 添加自定义过滤器
    MyFilter my;
    server.add_filter(&my);

    // 启动服务器
    if (server.start(1412) == 0)
    {
        fprintf(stderr, "[SERVER] Server with filter is running on 1412\n");
        send_client_task();
        wait_group.wait();
        server.stop();
    }
    else
        perror("[SERVER] server start");

    google::protobuf::ShutdownProtobufLibrary();
    return 0;
}

2. 客户端实现

void send_client_task()
{
    Example::SRPCClient client("127.0.0.1", 1412);

    auto callback = [](EchoResponse *resp, RPCContext *ctx)
    {
        if (ctx->success())
            fprintf(stderr, "[CLIENT] callback success\n");
        else
            fprintf(stderr, "[CLIENT] callback status[%d] error[%d] errmsg : %s\n",
                    ctx->get_status_code(), ctx->get_error(), ctx->get_errmsg());
    };

    EchoRequest req;
    req.set_name("Tutorial 19");

    // 发送成功案例
    auto *task = client.create_Echo_task(callback);
    req.set_message("For success case");
    task->serialize_input(&req);
    task->add_baggage("my_auth_key", "my_auth_value");
    task->start();

    // 发送失败案例
    task = client.create_Echo_task(callback);
    req.set_message("For failure case");
    task->serialize_input(&req);
    task->add_baggage("my_auth_key", "randomxxx");
    task->start();
}

实际运行效果

当运行这个示例时，可以看到以下输出：

1. 成功案例：

   • 过滤器验证通过
   • 服务端处理请求
   • 客户端收到成功响应

2. 失败案例：

   • 过滤器验证失败
   • 请求被拒绝
   • 客户端收到错误响应

应用场景扩展

自定义过滤器在RPC框架中有广泛的应用场景：

1. 认证授权：如示例中的简单认证，也可以实现更复杂的OAuth/JWT验证
2. 请求日志：记录请求的元数据信息
3. 限流控制：实现QPS限制等流量控制策略
4. 参数校验：检查请求参数的合法性
5. 数据转换：在请求处理前对数据进行预处理

最佳实践建议

1. 性能考虑：过滤器逻辑应尽量轻量，避免影响整体性能
2. 错误处理：提供清晰的错误信息，便于问题排查
3. 可配置化：考虑将过滤器的关键参数设计为可配置的
4. 链式调用：可以设计多个过滤器形成处理链

总结

SRPC的自定义过滤器机制为开发者提供了强大的扩展能力，通过本文的示例，我们了解了如何实现一个简单的认证过滤器。在实际项目中，可以根据具体需求实现更复杂的过滤器逻辑，从而构建更加安全、可靠的RPC服务。

【免费下载链接】srpc RPC framework based on C++ Workflow. Supports SRPC, Baidu bRPC, Tencent tRPC, thrift protocols. 项目地址: https://gitcode.com/gh_mirrors/sr/srpc