1. 소개
이 Codelab에서는 gRPC-Rust를 사용하여 Rust로 작성된 경로 매핑 애플리케이션의 기반을 형성하는 클라이언트와 서버를 만듭니다.
튜토리얼이 끝나면 gRPC를 사용하여 원격 서버에 연결하여 지도에서 특정 좌표에 있는 항목의 이름이나 우편 주소를 가져오는 클라이언트가 있습니다. 완전한 애플리케이션은 이 클라이언트-서버 설계를 사용하여 경로를 따라 관심 장소를 열거하거나 요약할 수 있습니다.
서비스는 프로토콜 버퍼 파일에 정의되며, 이 파일은 클라이언트와 서버가 서로 통신할 수 있도록 상용구 코드를 생성하는 데 사용되므로 이 기능을 구현하는 데 드는 시간과 노력을 절약할 수 있습니다.
이 생성된 코드는 서버와 클라이언트 간의 복잡한 통신뿐만 아니라 데이터 직렬화 및 역직렬화도 처리합니다.
학습할 내용
- 프로토콜 버퍼를 사용하여 서비스 API를 정의하는 방법
- 자동 코드 생성을 사용하여 프로토콜 버퍼 정의에서 gRPC 기반 클라이언트와 서버를 빌드하는 방법
- gRPC를 사용한 클라이언트-서버 통신에 대한 이해
이 Codelab은 gRPC를 처음 접하거나 gRPC를 다시 살펴보고 싶은 Rust 개발자 또는 분산 시스템을 빌드하는 데 관심이 있는 모든 사용자를 대상으로 합니다. 이전 gRPC 경험은 필요하지 않습니다.
2. 시작하기 전에
기본 요건
다음이 설치되어 있는지 확인합니다.
코드 가져오기
처음부터 완전히 시작하지 않아도 되도록 이 Codelab에서는 애플리케이션 소스 코드의 스캐폴드를 제공하여 이를 완성할 수 있습니다. 다음 단계에서는 프로토콜 버퍼 컴파일러 플러그인을 사용하여 상용구 gRPC 코드를 생성하는 등 애플리케이션을 완료하는 방법을 보여줍니다.
먼저 Codelab 작업 디렉터리를 만들고 해당 디렉터리로 이동합니다.
mkdir grpc-rust-getting-started && cd grpc-rust-getting-started
Codelab을 다운로드하고 압축을 풉니다.
curl -sL https://github.com/grpc-ecosystem/grpc-codelabs/archive/refs/heads/v1.tar.gz \
| tar xvz --strip-components=4 \
grpc-codelabs-1/codelabs/grpc-rust-getting-started/start_here
또는 codelab 디렉터리만 포함된 .zip 파일을 다운로드하고 직접 압축을 해제할 수 있습니다.
구현을 입력하는 것을 건너뛰려면 완료된 소스 코드를 GitHub에서 확인하세요.
3. 서비스 정의
첫 번째 단계는 프로토콜 버퍼를 사용하여 애플리케이션의 gRPC 서비스, RPC 메서드, 요청 및 응답 메시지 유형을 정의하는 것입니다. 서비스에서 제공하는 기능:
- 서버가 구현하고 클라이언트가 호출하는 RPC 메서드
GetFeature GetFeature메서드를 사용할 때 클라이언트와 서버 간에 교환되는 데이터 구조인 메시지 유형Point및Feature클라이언트는 서버에 대한GetFeature요청에서 지도 좌표를Point로 제공하고 서버는 해당 좌표에 있는 항목을 설명하는 해당Feature로 응답합니다.
이 RPC 메서드와 메시지 유형은 모두 제공된 소스 코드의 proto/route_guide.proto 파일에 정의됩니다.
프로토콜 버퍼는 일반적으로 protobufs로 알려져 있습니다. gRPC 용어에 대한 자세한 내용은 gRPC의 핵심 개념, 아키텍처, 수명 주기를 참고하세요.
서비스 메서드
먼저 서비스 메서드를 정의한 다음 메시지 유형 Point 및 Feature을 정의해 보겠습니다. proto/routeguide.proto 파일에는 애플리케이션 서비스에서 제공하는 하나 이상의 메서드를 정의하는 RouteGuide라는 service 구조가 있습니다.
RouteGuide 정의 내에 rpc 메서드 GetFeature를 추가합니다. 앞서 설명한 것처럼 이 메서드는 지정된 좌표 집합에서 위치의 이름이나 주소를 조회하므로 GetFeature가 지정된 Point에 대해 Feature를 반환하도록 합니다.
service RouteGuide {
// Definition of the service goes here
// Obtains the feature at a given position.
rpc GetFeature(Point) returns (Feature) {}
}
이는 단항 RPC 메서드입니다. 클라이언트가 서버에 요청을 보내고 로컬 함수 호출과 마찬가지로 응답이 돌아오기를 기다리는 간단한 RPC입니다.
메시지 유형
소스 코드의 proto/route_guide.proto 파일에서 먼저 Point 메시지 유형을 정의합니다. Point는 지도상의 위도-경도 좌표 쌍을 나타냅니다. 이 Codelab에서는 좌표에 정수를 사용합니다.
message Point {
int32 latitude = 1;
int32 longitude = 2;
}
1 및 2은 message 구조의 각 필드에 대한 고유 ID 번호입니다.
다음으로 Feature 메시지 유형을 정의합니다. Feature는 Point로 지정된 위치에 있는 항목의 이름이나 우편 주소에 string 필드를 사용합니다.
message Feature {
// The name or address of the feature.
string name = 1;
// The point where the feature is located.
Point location = 2;
}
4. 클라이언트 및 서버 코드 생성
생성된 디렉터리의 .proto 파일에서 생성된 코드는 이미 제공되었습니다.
모든 프로젝트와 마찬가지로 코드에 필요한 종속 항목을 고려해야 합니다. Rust 프로젝트의 경우 종속 항목이 Cargo.toml에 있습니다. 필요한 종속 항목은 이미 Cargo.toml 파일에 나열되어 있습니다.
.proto 파일에서 직접 코드를 생성하는 방법을 알아보려면 이 안내를 참고하세요.
생성된 코드에는 다음이 포함됩니다.
- 메시지 유형
Point및Feature의 구조체 정의 - 구현해야 하는 서비스 트레이트:
route_guide_server::RouteGuide - 서버를 호출하는 데 사용할 클라이언트 유형:
route_guide_client::RouteGuideClient<T>
다음으로 클라이언트가 요청을 보낼 때 서버가 답변으로 응답할 수 있도록 서버 측에서 GetFeature 메서드를 구현합니다.
5. 서비스 구현
src/server/server.rs에서 gRPC의 include_generated_proto! 매크로를 통해 생성된 코드를 범위로 가져오고 RouteGuide 트레이트와 Point를 가져올 수 있습니다.
mod grpc_pb {
grpc::include_generated_proto!("generated", "routeguide");
}
pub use grpc_pb::{
route_guide_server::{RouteGuideServer, RouteGuide},
Point, Feature,
};
먼저 서비스를 나타내는 구조체를 정의합니다. 지금은 src/server/server.rs에서 정의할 수 있습니다.
#[derive(Debug)]
pub struct RouteGuideService {
features: Vec<Feature>,
}
이제 생성된 코드에서 route_guide_server::RouteGuide 트레이트를 구현해야 합니다.
단항 RPC
RouteGuideService는 모든 서비스 메서드를 구현합니다. 서버 측의 get_feature 함수는 주요 작업이 이루어지는 곳입니다. 이 함수는 클라이언트로부터 Point 메시지를 가져와 알려진 장소 목록에서 해당하는 위치 정보를 Feature 메시지로 반환합니다. 다음은 src/server/server.rs의 함수 구현입니다.
#[tonic::async_trait]
impl RouteGuide for RouteGuideService {
async fn get_feature(&self, request: Request<Point>) -> Result<Response<Feature>, Status> {
println!("GetFeature = {:?}", request);
let requested_point = request.get_ref();
for feature in self.features.iter() {
if feature.location().latitude() == requested_point.latitude() {
if feature.location().longitude() == requested_point.longitude(){
return Ok(Response::new(feature.clone()))
};
};
}
Ok(Response::new(Feature::default()))
}
}
메서드에서 지정된 Point에 적합한 정보로 Feature 객체를 채운 다음 반환합니다.
이 메서드를 구현한 후에는 클라이언트가 실제로 서비스를 사용할 수 있도록 gRPC 서버도 시작해야 합니다. main()을 다음으로 바꿉니다.
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let addr = "[::1]:10000".parse().unwrap();
println!("RouteGuideServer listening on: {addr}");
let route_guide = RouteGuideService {
features: load(),
};
let svc = RouteGuideServer::new(route_guide);
Server::builder().add_service(svc).serve(addr).await?;
Ok(())
}
main()에서 이루어지는 작업은 다음과 같습니다.
- 클라이언트 요청을 수신하는 데 사용할 포트를 지정합니다.
- 도우미 함수
load()을 호출하여 로드된 기능으로RouteGuideService만들기 - 생성한 서비스를 사용하여
RouteGuideServer::new()를 사용하여 gRPC 서버의 인스턴스를 만듭니다. - gRPC 서버에 서비스 구현을 등록합니다.
- 프로세스가 종료될 때까지 차단 대기를 실행하기 위해 포트 세부정보와 함께 서버에서
serve()를 호출합니다.
6. 클라이언트 만들기
이 섹션에서는 src/client/client.rs에서 RouteGuide 서비스의 Rust 클라이언트를 만드는 방법을 살펴봅니다.
src/server/server.rs에서와 마찬가지로 gRPC의 include_generated_code! 매크로를 통해 생성된 코드를 범위로 가져오고 RouteGuideClient 유형을 가져올 수 있습니다.
mod grpc_pb {
grpc::include_generated_proto!("generated", "routeguide");
}
use grpc_pb::{
route_guide_client::RouteGuideClient,
Point,
};
서비스 메서드 호출
gRPC-Rust에서 RPC는 차단/동기 모드로 작동합니다. 즉, RPC 호출은 서버가 응답할 때까지 기다리며 응답이나 오류를 반환합니다.
서비스 메서드를 호출하려면 먼저 서버와 통신할 채널을 만들어야 합니다. 엔드포인트를 먼저 만들고 해당 엔드포인트에 연결한 다음 연결 시 생성된 채널을 RouteGuideClient::new()에 전달하여 이를 만듭니다.
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// Create endpoint to connect to
let endpoint = Endpoint::new("http://[::1]:10000")?;
let channel = endpoint.connect().await?;
// Create a new client
let mut client = RouteGuideClient::new(channel);
Ok(())
}
이 함수에서 클라이언트를 만들 때 위에서 만든 일반 채널을 .proto 서비스에 정의된 특정 메서드를 구현하는 생성된 코드 스텁으로 래핑합니다.
Simple RPC
간단한 RPC GetFeature를 호출하는 것은 로컬 메서드를 호출하는 것만큼 간단합니다. main()에 다음을 추가합니다.
println!("*** SIMPLE RPC ***");
let point = proto!(Point{
latitude: 409_146_138,
longitude: -746_188_906
});
let response = client
.get_feature(Request::new(point))
.await?.into_inner();
Ok(())
앞서 가져온 스텁에서 메서드를 호출하는 것을 확인할 수 있습니다. 메서드 매개변수에서 요청 프로토콜 버퍼 객체 (이 경우 Point)를 만들고 채웁니다. 호출에서 오류가 반환되지 않으면 첫 번째 반환 값에서 서버의 응답 정보를 읽을 수 있습니다.
println!("Response = Name = \"{}\", Latitude = {}, Longitude = {}",
response.name(),
response.location().latitude(),
response.location().longitude());
전체적으로 클라이언트의 main() 함수는 다음과 같습니다.
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
//Create endpoint to connect to
let endpoint = Endpoint::new("http://[::1]:10000")?;
let channel = endpoint.connect().await?;
// Create a new client
let mut client = RouteGuideClient::new(channel);
println!("*** SIMPLE RPC ***");
let point = proto!(Point{
latitude: 409_146_138,
longitude: -746_188_906
});
let response = client
.get_feature(Request::new(point))
.await?.into_inner();
println!("Response = Name = \"{}\", Latitude = {}, Longitude = {}",
response.name(),
response.location().latitude(),
response.location().longitude());
Ok(())
}
7. 사용해 보기
먼저 클라이언트와 서버를 실행하기 위해 크레이트에 바이너리 타겟으로 추가해 보겠습니다. 이에 따라 Cargo.toml을 수정하고 다음을 추가해야 합니다.
[[bin]]
name = "routeguide-server"
path = "src/server/server.rs"
[[bin]]
name = "routeguide-client"
path = "src/client/client.rs"
그런 다음 작업 디렉터리에서 다음 명령어를 실행합니다.
- 한 터미널에서 서버를 실행합니다.
RUSTFLAGS="-Awarnings" cargo run --bin routeguide-server
- 다른 터미널에서 클라이언트를 실행합니다.
RUSTFLAGS="-Awarnings" cargo run --bin routeguide-client
다음과 같은 출력이 표시됩니다. 명확성을 위해 타임스탬프는 생략했습니다.
*** SIMPLE RPC *** FEATURE: Name = "Berkshire Valley Management Area Trail, Jefferson, NJ, USA", Lat = 409146138, Lon = -746188906