ASP.NET Core: Hướng dẫn tạo máy khách và máy chủ gRPC trong ASP.NET Core

Bài hướng dẫn này chỉ ra cách tạo máy khách gRPC .NET Core và máy chủ gRPC ASP.NET Core. Cuối cùng, bạn sẽ có một ứng dụng khách gRPC giao tiếp với dịch vụ gRPC Greeter.

Trong hướng dẫn này, bạn:

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:<port>
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development

Các tệp dự án GrpcGreeter:

• Protos/greet.proto: Định nghĩa gRPC Greeter và được sử dụng để tạo nội dung máy chủ gRPC. Để biết thêm thông tin, hãy xem Giới thiệu về gRPC.
• Thư mục Services: Chứa việc triển khai dịch vụ Greeter.
• appSettings.json: Chứa dữ liệu cấu hình như giao thức được Kestrel sử dụng. Để biết thêm thông tin, hãy xem Cấu hình trong ASP.NET Core.
• Program.cs, trong đó có:
  • Điểm truy cập cho dịch vụ gRPC. Để biết thêm thông tin, hãy xem Máy chủ chung .NET trong ASP.NET Core.
  • Mã cấu hình hành vi ứng dụng. Để biết thêm thông tin, hãy xem Khởi động ứng dụng.

• Mở phiên bản thứ hai của Visual Studio và chọn Create a new project.
• Trong hộp thoại Create a new project, chọn Console Application và chọn Next.
• Trong hộp văn bản Project name, nhập GrpcGreeterClient và chọn Next.
• Trong hộp thoại Additional information, chọn .NET 6.0 (Long-term support) rồi chọn Create.

Dự án máy khách gRPC yêu cầu các gói NuGet sau:

• Grpc.Net.Client, chứa ứng dụng khách .NET Core.
• Google.Protobuf, chứa các API thông báo protobuf cho C#.
• Grpc.Tools, chứa công cụ hỗ trợ C# cho các tệp protobuf. Gói công cụ này không bắt buộc trong thời gian chạy, vì vậy phần phụ thuộc được đánh dấu bằng PrivateAssets="All".

Cài đặt các gói bằng Bảng điều khiển quản lý gói (PMC) hoặc Quản lý gói NuGet.

• Từ Visual Studio, chọn Tools > NuGet Package Manager > Package Manager Console

• Từ cửa sổ Package Manager Console, hãy chạy cd GrpcGreeterClient để thay đổi thư mục sang thư mục chứa các file GrpcGreeterClient.csproj.

• Chạy các lệnh sau:

Install-Package Grpc.Net.Client
Install-Package Google.Protobuf
Install-Package Grpc.Tools

• Nhấp chuột phải vào dự án trong Solution Explorer > Manage NuGet Packages.
• Chọn tab Browse.
• Nhập Grpc.Net.Client vào hộp tìm kiếm.
• Chọn gói Grpc.Net.Client từ tab Browse và chọn Install.
• Lặp lại các bước trên với Google.Protobuf và Grpc.Tools.

• Tạo thư mục Protos trong dự án máy khách gRPC.
• Sao chép tệp Protos\greet.proto từ dịch vụ gRPC Greeter vào thư mục Protos trong dự án máy khách gRPC.
• Cập nhật namespace bên trong file greet.proto vào namespace của dự án:

option csharp_namespace = "GrpcGreeterClient";

• Chỉnh sửa file dự án GrpcGreeterClient.csproj: Nhấp chuột phải vào dự án và chọn Edit Project File.
• Thêm nhóm mục có phần tử <Protobuf> mà tham chiếu đến file greet.proto:

<ItemGroup>
  <Protobuf Include="Protos\greet.proto" GrpcServices="Client" />
</ItemGroup>

• Xây dựng dự án máy khách để tạo các kiểu trong namespace GrpcGreeterClient.

Lưu ý

Các kiểu GrpcGreeterClient được tạo tự động bởi quá trình dựng. Gói công cụ Grpc.Tools tạo các tệp sau dựa trên tệp hello.proto:

• GrpcGreeterClient\obj\Debug\[TARGET_FRAMEWORK]\Protos\Greet.cs: Mã vùng đệm giao thức điền, tuần tự hóa và truy xuất các loại thông báo yêu cầu và phản hồi.
• GrpcGreeterClient\obj\Debug\[TARGET_FRAMEWORK]\Protos\GreetGrpc.cs: Chứa các lớp client được tạo ra.

Để biết thêm thông tin về nội dung C# được Grpc.Tools tự động tạo, hãy xem các dịch vụ gRPC với C#: Nội dung C# được tạo.

• Cập nhật file máy khách gRPC Program.cs bằng mã sau.

using System.Threading.Tasks;
using Grpc.Net.Client;
using GrpcGreeterClient;

// The port number must match the port of the gRPC server.
using var channel = GrpcChannel.ForAddress("https://localhost:7042");
var client = new Greeter.GreeterClient(channel);
var reply = await client.SayHelloAsync(
                  new HelloRequest { Name = "GreeterClient" });
Console.WriteLine("Greeting: " + reply.Message);
Console.WriteLine("Press any key to exit...");
Console.ReadKey();

• Trong mã được đánh dấu trước đó, hãy thay thế số cổng localhost 7042 bằng số cổng HTTPS được chỉ định trong Properties/launchSettings.json bằng dự án dịch vụ GrpcGreeter.

Program.cs chứa điểm vào và logic cho máy khách gRPC.

Ứng dụng khách Greeter được tạo bởi:

• Khởi tạo một GrpcChannel chứa thông tin để tạo kết nối với dịch vụ gRPC.
• Sử dụng GrpcChannel để xây dựng ứng dụng khách Greeter:

// The port number must match the port of the gRPC server.
using var channel = GrpcChannel.ForAddress("https://localhost:7042");
var client = new Greeter.GreeterClient(channel);
var reply = await client.SayHelloAsync(
                  new HelloRequest { Name = "GreeterClient" });
Console.WriteLine("Greeting: " + reply.Message);
Console.WriteLine("Press any key to exit...");
Console.ReadKey();

Máy khách Greeter gọi phương thức không đồng bộ SayHello. Kết quả lời gọi SayHello được hiển thị:

// The port number must match the port of the gRPC server.
using var channel = GrpcChannel.ForAddress("https://localhost:7042");
var client = new Greeter.GreeterClient(channel);
var reply = await client.SayHelloAsync(
                  new HelloRequest { Name = "GreeterClient" });
Console.WriteLine("Greeting: " + reply.Message);
Console.WriteLine("Press any key to exit...");
Console.ReadKey();

Cập nhật file appsettings.Development.json bằng cách thêm các dòng được đánh dấu sau:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
      ,"Microsoft.AspNetCore.Hosting": "Information",
      "Microsoft.AspNetCore.Routing.EndpointMiddleware": "Information"
    }
  }
}

• Trong dịch vụ GrpcGreeter, nhấn Ctrl+F5 để khởi động máy chủ mà không cần trình gỡ lỗi.
• Trong dự án GrpcGreeterClient, nhấn Ctrl+F5 để khởi động máy khách mà không cần trình gỡ lỗi.

Máy khách gửi lời chào đến dịch vụ bằng tin nhắn chứa tên của nó, GreeterClient. Dịch vụ sẽ gửi tin nhắn "Hello GreeterClient" dưới dạng phản hồi. Phản hồi "Hello GreeterClient" được hiển thị trong dấu nhắc lệnh:

Greeting: Hello GreeterClient
Press any key to exit...

Dịch vụ gRPC ghi lại chi tiết lời gọi thành công trong nhật ký được ghi vào dấu nhắc lệnh:

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:<port>
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: C:\GH\aspnet\docs\4\Docs\aspnetcore\tutorials\grpc\grpc-start\sample\GrpcGreeter
info: Microsoft.AspNetCore.Hosting.Diagnostics[1]
      Request starting HTTP/2 POST https://localhost:<port>/Greet.Greeter/SayHello application/grpc
info: Microsoft.AspNetCore.Routing.EndpointMiddleware[0]
      Executing endpoint 'gRPC - /Greet.Greeter/SayHello'
info: Microsoft.AspNetCore.Routing.EndpointMiddleware[1]
      Executed endpoint 'gRPC - /Greet.Greeter/SayHello'
info: Microsoft.AspNetCore.Hosting.Diagnostics[2]
      Request finished in 78.32260000000001ms 200 application/grpc

Lưu ý

Code trong bài viết này yêu cầu chứng chỉ phát triển ASP.NET Core HTTPS để bảo mật dịch vụ gRPC. Nếu ứng dụng khách .NET gRPC không thành công với thông báo The remote certificate is invalid according to the validation procedure. hoặc The SSL connection could not be established., thì chứng chỉ phát triển không đáng tin cậy. Để khắc phục sự cố này, hãy xem Gọi dịch vụ gRPC bằng chứng chỉ không đáng tin cậy/không hợp lệ.

• Xem hoặc tải xuống code mẫu đã hoàn chỉnh cho hướng dẫn này ( cách tải xuống ).
• Tổng quan về gRPC trên .NET
• Dịch vụ gRPC với C#
• Di chuyển gRPC từ C-core sang gRPC cho .NET