使用Tonic构建gRPC服务的完整指南：从HelloWorld开始

尚榕芯Noelle

于 2025-06-03 09:12:59 发布

阅读量248

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/gitblog_01006/article/details/148394389

使用Tonic构建gRPC服务的完整指南：从HelloWorld开始

tonic A native gRPC client & server implementation with async/await support. 项目地址: https://gitcode.com/gh_mirrors/to/tonic

前言

在现代分布式系统开发中，gRPC作为一种高性能、跨语言的远程过程调用框架越来越受到开发者青睐。本文将基于Tonic项目，详细介绍如何使用Rust构建一个完整的gRPC服务，从最基础的HelloWorld示例入手，逐步讲解服务端和客户端的实现过程。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

Rust编程语言（1.39或更高版本）
Cargo包管理工具
基本的Rust异步编程知识

建议使用最新稳定版的Rust工具链，以获得最佳的开发体验。

项目初始化

首先创建一个新的Rust项目：

cargo new helloworld-tonic
cd helloworld-tonic

定义gRPC服务

gRPC使用Protocol Buffers（简称protobuf）作为接口定义语言（IDL）。我们需要先定义服务接口：

创建proto目录存放协议定义文件
定义helloworld.proto文件

syntax = "proto3";
package helloworld;

service Greeter {
    rpc SayHello (HelloRequest) returns (HelloReply);
}

message HelloRequest {
    string name = 1;
}

message HelloReply {
    string message = 1;
}

这个定义包含：

一个Greeter服务
一个SayHello方法
对应的请求和响应消息类型

项目配置

在Cargo.toml中添加必要的依赖：

[dependencies]
tonic = "*"
prost = "0.13"
tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }

[build-dependencies]
tonic-build = "*"

同时配置两个可执行文件：

[[bin]]
name = "helloworld-server"
path = "src/server.rs"

[[bin]]
name = "helloworld-client"
path = "src/client.rs"

构建配置

创建build.rs文件来自动编译proto文件：

fn main() -> Result<(), Box<dyn std::error::Error>> {
    tonic_build::compile_protos("proto/helloworld.proto")?;
    Ok(())
}

这个构建脚本会在编译项目时自动将proto文件转换为Rust代码。

服务端实现

服务端实现主要分为三个部分：

导入生成的代码和必要依赖
实现Greeter trait
启动gRPC服务器

完整实现如下：

use tonic::{transport::Server, Request, Response, Status};
use hello_world::greeter_server::{Greeter, GreeterServer};
use hello_world::{HelloReply, HelloRequest};

pub mod hello_world {
    tonic::include_proto!("helloworld");
}

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

#[tonic::async_trait]
impl Greeter for MyGreeter {
    async fn say_hello(
        &self,
        request: Request<HelloRequest>,
    ) -> Result<Response<HelloReply>, Status> {
        println!("收到请求: {:?}", request);

        let reply = HelloReply {
            message: format!("你好, {}!", request.into_inner().name),
        };

        Ok(Response::new(reply))
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let addr = "[::1]:50051".parse()?;
    let greeter = MyGreeter::default();

    println!("服务端启动在 {}", addr);

    Server::builder()
        .add_service(GreeterServer::new(greeter))
        .serve(addr)
        .await?;

    Ok(())
}

关键点说明：

#[tonic::async_trait]宏使我们可以为trait实现异步方法
Request<T>和Response<T>是Tonic提供的包装类型
into_inner()用于访问请求的内部数据

客户端实现

客户端实现相对简单，主要步骤：

导入生成的客户端代码
连接到服务端
发送请求并处理响应

完整实现：

use hello_world::greeter_client::GreeterClient;
use hello_world::HelloRequest;

pub mod hello_world {
    tonic::include_proto!("helloworld");
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = GreeterClient::connect("http://[::1]:50051").await?;

    let request = tonic::Request::new(HelloRequest {
        name: "Tonic".into(),
    });

    let response = client.say_hello(request).await?;

    println!("收到响应: {:?}", response);

    Ok(())
}