Servisler Arası Yüksek Performanslı İletişim için .Net 6 ile gRPC Örneği

Merhaba arkadaşlar, servisler arasında stream tabanlı yüksek performanslı bir iletişim sağlayan gRPC den bahsedeceğiz.

gRPC, HTTP/2 protokolünde çalışan bir RPC (Remote Procedure Call) frameworküdür.
CNCF (Cloud Native Computing Foundation) tarafından yürütülen popüler bir açık kaynaklı kütüphanedir.
Verileri json yada xml yerine Google tarafından geliştirilen protobuf(.proto) ile binary formatında yüksek performanslı bir şekilde serileştirir.

Proto hakkında daha detaylı bilgi için;

https://developers.google.com/protocol-buffers/docs/proto3

.Net 6 ile beraber gRPC tarafında performans, yük dengeleme, retry patternler ve en önemlisi HTTP/3 protokolünün(MSQUIC) desteklenmesi gibi konularda geliştirmeler yapılmıştır.

İsterseniz örneğimize başlayalım. Yapmak istediğimiz işlem şu olsun verilen öğrenci listesini kaydedelim. Her kayıt işleminde de consol ekranına bilgi verelim. Bunu gRPC client streaming yöntemiyle yapacağız.

Öncelikle gRPC servisimiz ile yani server tarafı ile başlayalım.

dotnet new grpc -n StudentServiceGRPC

1	dotnet new grpc -n StudentServiceGRPC

Şimdi “protos” klasörü altına “student.proto” dosyamızı ekleyelim ve csproj içerisinde bunu belirtelim.

syntax = "proto3";

option csharp_namespace = "StudentServiceGRPC";

package student;

// The service definition.
service StudentGRPCService {
   rpc AddStudentStream(stream StudentRequest) returns (StudentResponse);
}

// The request message
message StudentRequest {
  int32 studentId = 1;
  string name = 2;
}

// The response message
message StudentResponse {
  string message = 1;
}

syntax = "proto3";

option csharp_namespace = "StudentServiceGRPC";

package student;

// The service definition.

service StudentGRPCService {

rpc AddStudentStream(stream StudentRequest) returns (StudentResponse);

}

// The request message

message StudentRequest {

int32 studentId = 1;

string name = 2;

}

// The response message

message StudentResponse {

string message = 1;

}

<ItemGroup>
<Protobuf Include="Protos\student.proto" GrpcServices="Server" />
</ItemGroup>

</ItemGroup>

Artık servisimizi oluşturma zamanı geldi. Servisimizi oluşturmadan önce projemizi build edelim ve belirttiğimiz proto dosyasınıa göre gerekli code generationların yapılmasını sağlayalım.

dotnet build

1	dotnet build

Servisimizi tanımlarken kalıtım aldığımız sınıfa dikkat edelim ve proto da belirttiğimiz RPC methodu override ederek içini dolduralım.

using Grpc.Core;

namespace StudentServiceGRPC.Services;

public class StudentService : StudentGRPCService.StudentGRPCServiceBase
{
    private readonly ILogger<StudentService> _logger;
    public StudentService(ILogger<StudentService> logger)
    {
        _logger = logger;
    }

    public override async Task<StudentResponse> AddStudentStream(IAsyncStreamReader<StudentRequest> requestStream, ServerCallContext context)
    {
        var result = new StudentResponse();
        var count = 0;
        await foreach (var student in requestStream.ReadAllAsync())
        {
            var message = $"{student.StudentId} - {student.Name} added.";
            result.Message += message;
            Console.WriteLine(message);
            count++;
        }
        Console.WriteLine($"Add students stream has been ended. Count : {count}");

        return result;
    }
}

using Grpc.Core;

namespace StudentServiceGRPC.Services;

public class StudentService : StudentGRPCService.StudentGRPCServiceBase

{

private readonly ILogger<StudentService> _logger;

public StudentService(ILogger<StudentService> logger)

{

_logger = logger;

}

public override async Task<StudentResponse> AddStudentStream(IAsyncStreamReader<StudentRequest> requestStream, ServerCallContext context)

{

var result = new StudentResponse();

var count = 0;

await foreach (var student in requestStream.ReadAllAsync())

{

var message = $"{student.StudentId} - {student.Name} added.";

result.Message += message;

Console.WriteLine(message);

count++;

}

Console.WriteLine($"Add students stream has been ended. Count : {count}");

return result;

}

Şimdi program.cs içerisine servisimizi register edelim.

app.MapGrpcService<StudentService>();

1	app.MapGrpcService<StudentService>();

Artık öğrenci listesini alacağımız api projemizi oluşturabiliriz.

dotnet new webapi -n StudentClientApi

1	dotnet new webapi -n StudentClientApi

Öncelikle kullanacağımız nuget paketlerini ekleyelim.

dotnet add package Grpc.Net.Client
dotnet add package Google.Protobuf
dotnet add package Grpc.Tools
dotnet add package Grpc.Net.ClientFactory

dotnet add package Grpc.Net.Client

dotnet add package Google.Protobuf

dotnet add package Grpc.Tools

dotnet add package Grpc.Net.ClientFactory

Oluşturduğumuz proto dosyasını bu projeye kopyalayarak, namespacemizi güncelleyelim.

option csharp_namespace = "StudentClientApi";

1	option csharp_namespace = "StudentClientApi";

Daha sonrasında csproj altında tanımlamamızı yapalım. Bu sefer tanımlama yaparken “GrpcServices” attribute değerinin “Client” olmasına dikkat edelim ve projemizi yine build edelim.

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

</ItemGroup>

dotnet build

1	dotnet build

Gelen isteği karşılayacak endpointimizi, modelimizi ve endpointten gelen istekleri işleyeceğimiz servisimizi yazalım.

namespace StudentClientApi.Models;

public class StudentReq
{
    public IAsyncEnumerable<Student> Students { get; set; }
}

public class Student
{
    public int StudentId { get; set; }
    public string Name { get; set; }
}

namespace StudentClientApi.Models;

public class StudentReq

{

public IAsyncEnumerable<Student> Students { get; set; }

}

public class Student

{

public int StudentId { get; set; }

public string Name { get; set; }

}

using Microsoft.AspNetCore.Mvc;
using StudentClientApi.Models;
using StudentClientApi.Services;

namespace StudentClientApi.Controllers;

[ApiController]
[Route("students")]
public class StudentController : ControllerBase
{
    private readonly IStudentService _studentService;

    public StudentController(IStudentService studentService)
    {
        _studentService = studentService;
    }

    [HttpPost]
    public async Task<IActionResult> AddStudents(StudentReq request)
    {         
        return Ok(await _studentService.InsertStudentsAsync(request));
    }
}

using Microsoft.AspNetCore.Mvc;

using StudentClientApi.Models;

using StudentClientApi.Services;

namespace StudentClientApi.Controllers;

[ApiController]

[Route("students")]

public class StudentController : ControllerBase

{

private readonly IStudentService _studentService;

public StudentController(IStudentService studentService)

{

_studentService = studentService;

}

[HttpPost]

public async Task<IActionResult> AddStudents(StudentReq request)

{

return Ok(await _studentService.InsertStudentsAsync(request));

}

using StudentClientApi.Models;

namespace StudentClientApi.Services;

public interface IStudentService
{
    Task<string> InsertStudentsAsync(StudentReq request);
}

public class StudentService : IStudentService
{
    private readonly StudentGRPCService.StudentGRPCServiceClient _studentGRPCServiceClient;
    public StudentService(StudentGRPCService.StudentGRPCServiceClient studentGRPCServiceClient)
    {
        _studentGRPCServiceClient = studentGRPCServiceClient;
    }
    public async Task<string> InsertStudentsAsync(StudentReq request)
    {
        using var addStudentStream = _studentGRPCServiceClient.AddStudentStream();
        await foreach (Student student in request.Students)
        {
            StudentRequest studentRequest = new()
            {
                StudentId = student.StudentId,
                Name = student.Name
            };

            await addStudentStream.RequestStream.WriteAsync(studentRequest);
        }

        await addStudentStream.RequestStream.CompleteAsync();

        StudentResponse response = await addStudentStream;

        return response.Message;
    }
}

using StudentClientApi.Models;

namespace StudentClientApi.Services;

public interface IStudentService

{

Task<string> InsertStudentsAsync(StudentReq request);

}

public class StudentService : IStudentService

{

private readonly StudentGRPCService.StudentGRPCServiceClient _studentGRPCServiceClient;

public StudentService(StudentGRPCService.StudentGRPCServiceClient studentGRPCServiceClient)

{

_studentGRPCServiceClient = studentGRPCServiceClient;

}

public async Task<string> InsertStudentsAsync(StudentReq request)

{

using var addStudentStream = _studentGRPCServiceClient.AddStudentStream();

await foreach (Student student in request.Students)

{

StudentRequest studentRequest = new()

{

StudentId = student.StudentId,

Name = student.Name

};

await addStudentStream.RequestStream.WriteAsync(studentRequest);

}

await addStudentStream.RequestStream.CompleteAsync();

StudentResponse response = await addStudentStream;

return response.Message;

}

Servislerimizi program.cs içerisine register etmeyi unutmayalım.

builder.Services.AddScoped<IStudentService, StudentService>();
builder.Services.AddGrpcClient<StudentGRPCService.StudentGRPCServiceClient>(o =>
{
    o.Address = new Uri("https://localhost:7026"); //StudentServiceGRPC port
});

builder.Services.AddScoped<IStudentService, StudentService>();

builder.Services.AddGrpcClient<StudentGRPCService.StudentGRPCServiceClient>(o =>

{

o.Address = new Uri("https://localhost:7026"); //StudentServiceGRPC port

});

gRPC kendi içerisinde Resiliency için farklı konfigurasyonlar ve retry patternler barındırır. Örnek bir config;

var retryMethodConfig = new MethodConfig
{
    Names = { MethodName.Default },
    RetryPolicy = new RetryPolicy
    {
        MaxAttempts = 3,
        InitialBackoff = TimeSpan.FromSeconds(1),
        MaxBackoff = TimeSpan.FromSeconds(4),
        BackoffMultiplier = 1.5,
        RetryableStatusCodes = { StatusCode.Unavailable }
    }
};
builder.Services.AddGrpcClient<StudentGRPCService.StudentGRPCServiceClient>(o =>
{
    o.Address = new Uri("https://localhost:7026");
    o.ChannelOptionsActions.Add(opt => opt.ServiceConfig = new ServiceConfig { MethodConfigs = { retryMethodConfig } });
});