0Pricing
Learn Rust Coding · 课时

实现 gRPC 服务器

提供一元 RPC 方法。

实现 gRPC 服务器 是 CoddyKit 上的免费 Learn Rust Coding 课时。 这是第 3 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Learn Rust Coding 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Learn Rust Coding 课程共包含 4 节课。

生成的服务器特征

对于名为 Greeter 的服务,tonic 会在 greeter_server 中生成一个特征。您需要在自己的结构体上实现它,以提供具体行为。

该特征通过 #[tonic::async_trait] 支持异步,因此每个方法都是返回 Result 的异步函数。

use greeter::v1::greeter_server::{Greeter, GreeterServer};
use greeter::v1::{HelloRequest, HelloReply};

请求和响应包装器

方法接收 tonic::Request<T>,并返回 tonic::Response<T>。这些包装器携带元数据、扩展信息和内部消息。

调用 .into_inner() 获取解码后的消息,并使用 Response::new(..) 构建响应。

let req: HelloRequest = request.into_inner();
let reply = HelloReply { message: format!("Hi {}", req.name) };
Ok(Response::new(reply))

服务器结构体

定义一个结构体来保存共享状态,例如数据库连接池。无状态时,通常可以为它派生 Default。

您将在这个结构体上实现生成的特征。

#[derive(Default)]
pub struct MyGreeter {}

实现一元方法

使用 #[tonic::async_trait] 注解 impl 代码块,并按照生成的签名,将每个 rpc 实现为异步函数。

成功时返回 Ok(Response::new(reply))。

#[tonic::async_trait]
impl Greeter for MyGreeter {
    async fn say_hello(&self, request: Request<HelloRequest>)
        -> Result<Response<HelloReply>, Status> {
        let name = request.into_inner().name;
        Ok(Response::new(HelloReply { message: format!("Hello {name}") }))
    }
}

使用 Status 返回错误

错误会以 tonic::Status 的形式返回,并映射到 gRPC 状态码。请使用 Status::invalid_argument 或 Status::not_found 等构造方法。

消息字符串会与状态码一起发送给客户端。

if name.is_empty() {
    return Err(Status::invalid_argument("name must not be empty"));
}

构建并提供服务

在异步 main 中使用 tonic::transport::Server。将包装在生成的 ...Server 类型中的服务添加进去,然后使用套接字地址调用 serve。

#[tokio::main] 宏会提供运行时。

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let addr = "[::1]:50051".parse()?;
    Server::builder()
        .add_service(GreeterServer::new(MyGreeter::default()))
        .serve(addr)
        .await?;
    Ok(())
}

服务器流式响应

服务器流式方法会返回流类型。tonic 使用关联类型和装箱流;mpsc 通道是传递消息的常用方式。

您需要返回一个包装在 Response 中的 ReceiverStream。

use tokio_stream::wrappers::ReceiverStream;
let (tx, rx) = tokio::sync::mpsc::channel(8);
tokio::spawn(async move { tx.send(Ok(reply)).await.ok(); });
Ok(Response::new(ReceiverStream::new(rx)))

读取元数据

请求元数据包含身份验证令牌等标头。请在使用请求正文之前,通过 request.metadata() 访问它。

键使用 ASCII 且不区分大小写;值会以 MetadataValue 的形式返回。

if let Some(token) = request.metadata().get("authorization") {
    // validate token
} else {
    return Err(Status::unauthenticated("missing token"));
}

拦截器

拦截器会在每个请求之前运行,非常适合进行身份验证或日志记录。它接收 Request,并返回该请求或一个 Status 错误。

添加服务时,请使用 with_interceptor 附加拦截器。

fn auth(req: Request<()>) -> Result<Request<()>, Status> {
    match req.metadata().get("authorization") {
        Some(_) => Ok(req),
        None => Err(Status::unauthenticated("no token")),
    }
}
// .add_service(GreeterServer::with_interceptor(svc, auth))

平滑关闭

使用 serve_with_shutdown,在某个 future 完成时停止接受连接,例如在收到 Ctrl-C 信号时。

正在处理的请求会在服务器退出前完成,从而避免被突然中断。

Server::builder()
    .add_service(GreeterServer::new(MyGreeter::default()))
    .serve_with_shutdown(addr, async {
        tokio::signal::ctrl_c().await.ok();
    })
    .await?;

共享状态

如需在请求之间共享可变状态,请将其存放在 Arc 后面,并在服务器结构体中使用类似 tokio::sync::Mutex 的同步原语。

tonic 会为每个连接克隆服务,因此,使用易于克隆的共享句柄是正确的模式。

use std::sync::Arc;
use tokio::sync::Mutex;

#[derive(Default)]
pub struct MyGreeter {
    hits: Arc<Mutex<u64>>,
}

快速检查

gRPC 方法在 tonic 中如何报告失败?

回顾

您实现了生成的服务器特征:解包请求,返回响应和 Status 错误,使用 tokio 提供服务,处理流式响应,读取元数据,添加拦截器,实现平滑关闭,并通过 Arc 共享状态。

接下来,您将构建一个客户端来调用此服务器。

常见问题解答

「实现 gRPC 服务器」课时是免费的吗?

是的 — 「实现 gRPC 服务器」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Learn Rust Coding 课程的其余内容,请升级到 CoddyKit PRO。 Learn Rust Coding 课程共包含 4 节课。

「实现 gRPC 服务器」这节课中我会学到什么?

提供一元 RPC 方法。 你通过在浏览器中直接运行的动手代码来练习 Learn Rust Coding,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Learn Rust Coding 需要有经验吗?

无需任何先前经验。CoddyKit 上的 Learn Rust Coding 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 3 节课,共 4 节。

「实现 gRPC 服务器」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 Learn Rust Coding 课中编写并运行代码吗?

能。每节 Learn Rust Coding 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. Protobuf 与服务定义
  2. 使用 tonic-build 生成代码
  3. 实现 gRPC 服务器
  4. 从 gRPC 客户端调用
← 返回 Learn Rust Coding