Boost.Beast中的WebSocket装饰器(Decorator)机制详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00929/article/details/148524356

Boost.Beast中的WebSocket装饰器(Decorator)机制详解

beast HTTP and WebSocket built on Boost.Asio in C++11 项目地址: https://gitcode.com/gh_mirrors/be/beast

装饰器概述

在Boost.Beast库中，WebSocket装饰器(Decorator)是一种强大的机制，允许开发者在发送WebSocket HTTP升级请求或响应之前对其进行定制化修改。这种机制特别适用于需要在WebSocket握手阶段添加特定HTTP头信息或修改现有内容的场景。

装饰器的核心概念

装饰器本质上是一个可调用对象(函数指针、函数对象或lambda表达式)，它会在发送HTTP消息之前被调用。装饰器接收一个可修改的消息引用，开发者可以在这个阶段对消息进行各种操作。

Boost.Beast为装饰器提供了两种主要类型：

request_type：表示HTTP升级请求的类型
response_type：表示HTTP升级响应的类型

装饰器的使用方式

1. 普通函数装饰器

最简单的装饰器形式是一个普通函数，专门处理HTTP请求：

void decorate_request(request_type& req)
{
    req.set("User-Agent", "MyClient");
    req.set("X-Client-Version", "1.0");
}

2. 设置装饰器

装饰器必须在握手操作之前设置到WebSocket流上：

ws.set_option(stream_base::decorator(decorate_request));

3. 函数对象装饰器

对于更复杂的逻辑，可以使用函数对象作为装饰器：

struct decorator
{
    std::string user_agent;
    
    void operator()(request_type& req)
    {
        req.set("User-Agent", user_agent);
    }
};

// 使用
ws.set_option(stream_base::decorator(decorator{"MyClient/1.0"}));

4. Lambda表达式装饰器

C++11及以上版本支持使用lambda表达式：

ws.set_option(stream_base::decorator(
    [](request_type& req)
    {
        req.set("User-Agent", "MyClient");
    }));

高级用法

处理请求和响应的通用装饰器

可以创建同时处理请求和响应的装饰器：

struct decorator
{
    void operator()(request_type& req)
    {
        req.set("X-Request-ID", generate_id());
    }
    
    void operator()(response_type& res)
    {
        res.set("X-Response-ID", generate_id());
    }
};

使用移动语义的装饰器

装饰器支持移动语义，可以处理移动专属类型：

auto decor = std::make_unique<decorator>();
ws.set_option(stream_base::decorator(
    [d = std::move(decor)](request_type& req)
    {
        (*d)(req);
    }));