响应

提示

hyperlane 框架没有发送响应前通过 ctx 中 get_response 获取的只是响应的初始化实例，里面其实没有数据， 只有当用户发送响应时才会构建出完整 http 响应，此后再次 get_response 才能获取到响应内容

提示

hyperlane 框架对 ctx 额外封装了子字段的方法，可以直接调用大部分子字段的 get 和 set 方法名称， 例如：调用 response 上的 get_status_code 方法， 一般需要从 ctx 解出 response，再调用 response.get_status_code()， 可以简化成 ctx.get_response_status_code().await 直接调用， 推荐优先使用 ctx 的方法，而不是通过获取 ctx 写锁和读锁， 理论上后者性能会更好，但是后者代码可读性不高且容易导致死锁，维护成本较高。使用前者你可能写出以下代码：

pub async fn favicon_ico(ctx: Context) {
    let data: Vec<u8> = plugin::logo_img::func::get_logo_img();
    {
        let mut ctx: RwLockWriteContext =
        ctx.get_write_lock().await;
        let response: &mut Response = ctx.get_mut_response();
        response.set_header(CONTENT_TYPE, IMAGE_PNG);
        response.set_header(CACHE_CONTROL, "public, max-age=3600");
    }
    let send_res: ResponseResult = ctx.send_response(200, data).await;
    ctx
        .get_log()
        .await
        .info(format!("Response result => {:?}", send_res), log_handler);
}

但是使用后者，你的代码会是这样，是不是就无需担心死锁发生了

pub async fn favicon_ico(ctx: Context) {
    let data: Vec<u8> = plugin::logo_img::func::get_logo_img();
    let send_res: ResponseResult = ctx
        .set_response_header(CONTENT_TYPE, IMAGE_PNG)
        .await
        .set_response_header(CACHE_CONTROL, "public, max-age=3600")
        .await
        .send_response(200, data)
        .await;
    let request: Request = ctx.get_request().await;
    ctx
        .log_info(format!("Request result => {}", request), log_handler)
        .await
        .log_info(format!("Response result => {:?}", send_res), log_handler)
        .await;
}

调用规律

• 原 response 的 get 方法的 get 名称后加 response 名称，中间使用_拼接
• 原 response 的 set 方法的 set 名称后加 response 名称，中间使用_拼接

获取响应

推荐

let response: Response = ctx.get_response().await;

通过写锁

let ctx: RwLockWriteContext = ctx.get_write_lock().await;
let response: Response = ctx.get_response().clone();

获取可变响应

推荐

let mut  = ctx.get().await;
let response: &mut Response = inner_ctx.get_mut_response();

通过写锁

let mut ctx: RwLockWriteContext = ctx.get_write_lock().await;
let response: &mut Response = ctx.get_mut_response();

设置响应体

推荐

ctx.set_response_body(vec![]).await;

获取 ctx 克隆

let mut response: Response = ctx.get_response().await;
response.set_body(vec![]);

设置响应头

推荐

ctx.set_response_header("server", "hyperlane").await;

获取 ctx 克隆

let inner_ctx: InnerContext = ctx.get().await;
let mut response: Response = inner_ctx.get_response().clone();
response.set_header("server", "hyperlane");

设置状态码

推荐

ctx.set_response_status_code(200).await;

获取 ctx 克隆

let inner_ctx: InnerContext = ctx.get().await;
let mut response: Response = inner_ctx.get_response().clone();
response.set_status_code(200);

发送完整 HTTP 响应

提示

如果你已经设置了响应信息，可以直接通过 send 或者 send_once 发送。此方法常用于响应中间件用于统一发送。 如果是 websocket 则不会发送，所以可以在响应中间件放心使用

response.send

提示

发送响应后 TCP 连接保留

let mut  = ctx.get().await;
let stream = inner_ctx.get_mut_stream().clone().unwrap();
let mut response = inner_ctx.get_response().clone();
let _ = response.set_body("hello").send(&stream);

ctx.send_response

提示

发送响应后 TCP 连接保留

• 第一个参数: 状态码
• 第二个参数: 内容

let send_res: ResponseResult = ctx.send_response(200, "hello hyperlane");

ctx.send_response_once

提示

发送响应后 TCP 连接立即关闭

• 第一个参数: 状态码
• 第二个参数: 内容

let send_res: ResponseResult = ctx.send_response_once(200, "hello hyperlane");

ctx.send

提示

发送响应后 TCP 连接保留

let send_res: ResponseResult = ctx.send().await;

ctx.send_once

提示

发送响应后 TCP 连接立即关闭

let send_res: ResponseResult = ctx.send_once().await;

仅发送响应体

提示

支持多次主动发送响应

response.send_body

let mut  = ctx.get().await;
let stream = inner_ctx.get_mut_stream().clone().unwrap();
let mut response = inner_ctx.get_response().clone();
let _ = response.set_body("hello").send_body(&stream).await;

ctx.send_response_body

let _ = ctx
    .set_response_header(CONTENT_TYPE, TEXT_EVENT_STREAM)
    .await
    .send_response(200, vec![])
    .await;
for i in 0..6 {
    let _ = ctx
        .send_response_body(format!("hello hyperlane => /index {}", i))
        .await;
}

ctx.send_body

let _ = ctx
    .set_response_header(CONTENT_TYPE, TEXT_EVENT_STREAM)
    .await
    .send_response(200, vec![])
    .await;
for i in 0..6 {
    let _ = ctx
        .send_body()
        .await;
}