grpc-aspnetcore-validator - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #golang #go #machine-learning #nodejs #awesome #cli #kubernetes #awesome-list #vue #pytorch #security

grpc-aspnetcore-validator

(★ 95)

Simple request message validator for grpc.aspnetcore

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
  - dotnet.yml
- - Calzolari.Grpc.AspNetCore.Validation.csproj
  - GrpcServiceOptionsHelper.cs
  - InlineValidator.cs
  - IValidatorErrorMessageHandler.cs
  - IValidatorLocator.cs
  - ServiceCollectionHelper.cs
- - appsettings.Development.json
  - appsettings.json
  - Calzolari.Grpc.AspNetCore.Validation.SampleRpc.csproj
  - Program.cs
  - Startup.cs
- - Calzolari.Grpc.AspNetCore.Validation.Test.csproj
  - ServiceCollectionHelperTest.cs
  - WebApplicationFactoryHelper.cs
- - Calzolari.Grpc.Domain.csproj
  - ValidationTrailers.cs
- - Base64Serializer.cs
  - BinarySerializer.cs
  - Calzolari.Grpc.Net.Client.Validation.csproj
  - RpcExceptionExtensions.cs
- Calzolari.Grpc.AspNetCore.Validation.sln
- Calzolari.Grpc.AspNetCore.Validation.sln.DotSettings
.gitignore
calzolari.png
license.txt
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/AnthonyGiretti/grpc-aspnetcore-validator

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd grpc-aspnetcore-validator

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

cd src/Calzolari.Grpc.AspNetCore.Validation.SampleRpc

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# grpc-aspnetcore-validator
Request message validator middleware for [Grpc.AspNetCore](https://github.com/grpc/grpc-dotnet).
Compatible with gRPC and gRPC-web C# clients

![](https://github.com/AnthonyGiretti/grpc-aspnetcore-validator/workflows/Build/badge.svg)
[![Nuget](https://img.shields.io/nuget/v/Calzolari.Grpc.AspNetCore.Validation)](https://www.nuget.org/packages/Calzolari.Grpc.AspNetCore.Validation)

## Features

- Server Side validation
- Client Side detailed errors fetching in RpcException

### Client Side usage

Download the client side package here: [Calzolari.Grpc.Net.Client.Validation](https://www.nuget.org/packages/Calzolari.Grpc.Net.Client.Validation/)

```csharp
try
{

using var channel = GrpcChannel.ForAddress("https://localhost:5001");
    var client =  new Greeter.GreeterClient(channel);
    // Empty value that raises an error validation
    var reply = await client.SayHelloAsync(new HelloRequest { Name = "" });
}
catch (RpcException e) when (ex.StatusCode == StatusCode.InvalidArgument)
{
    var errors = e.GetValidationErrors(); // Gets validation errors list
}
```

If you are using Blazor WebAssembly client-side (or any JavaScript client), don't forget to setup gRPC-web on the server and CORS rules with the following headers server-side:

```csharp
.WithExposedHeaders("Grpc-Status", "Grpc-Message", "Grpc-Encoding", "Grpc-Accept-Encoding", "validation-errors-text");
```

### Server Side usage

Download the server side package here: [Calzolari.Grpc.AspNetCore.Validation](https://www.nuget.org/packages/Calzolari.Grpc.AspNetCore.Validation/)

This package is integrated with [Fluent Validation](https://github.com/JeremySkinner/FluentValidation). 
If you want to know how build your own validation rules, please checkout [Fluent Validation Docs](https://fluentvalidation.net/start)

#### Add custom message validator

```csharp
// Write own message validator
public class HelloRequestValidator : AbstractValidator<HelloRequest>
{
    public HelloRequestValidator()
    {
        RuleFor(request => request.Name).NotEmpty();
    }
}
```

```csharp
public class Startup
{
    // ...
    public void ConfigureServices(IServiceCollection services)
    {
        // 1. Enable message validation feature.
        services.AddGrpc(options => options.EnableMessageValidation());

// 2-1. Add custom validators for messages one by one, default scope is scoped.
        services.AddValidator<HelloRequestValidator>();
        services.AddValidator<HelloRequestValidator>(LifeStyle.Singleton);

// 2-2. Add ALL custom validators for messages, default scope is scoped. 
        services.AddValidators();

// 3. Add Validator locator
        services.AddGrpcValidation();
    }
    // ...
}
```

Then, If the message is invalid, Grpc Validator return with `InvalidArgument` code and empty message object.

#### Add inline custom validator

if you don't want to create many validation class for simple validation rule in your project,
you just use below inline validator feature like below example.

Note that, Inline validator always be registered **singleton** in your service collection.
Because, There are no way for using other dependency.

```csharp
public class Startup
{
    // ...
    public void ConfigureServices(IServiceCollection services)
    {
        // 1. Enable message validation feature.
        services.AddGrpc(options => options.EnableMessageValidation());

// 2. Add inline validators for messages, scope is always singleton
        services.AddInlineValidator<HelloRequest>(rules => rules.RuleFor(request => request.Name).NotEmpty());

// 3. Add Validator locator
        services.AddGrpcValidation();
    }
    // ...
}
```

#### Customize validation failure message.

If you want to custom validation message handler for using your own error message system,
Just implement IValidatorErrorMessageHandler and put it service collection.

```csharp
public class CustomMessageHandler : IValidatorErrorMessageHandler
{
    public Task<string> HandleAsync(IList<ValidationFailure> failures)
    {
        return Task.FromResult("Validation Error!");
    }
}

public class Startup
{
    // ...
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddGrpc(options => options.EnableMessageValidation());
        services.AddInlineValidator<HelloRequest>(rules => rules.RuleFor(request => request.Name).NotEmpty());

// 1. Just put at service collection your own custom message handler that implement IValidatorErrorMessageHandler.
        // This should be placed before calling AddGrpcValidation();
        services.AddSingleton<IValidatorErrorMessageHanlder>(new CustomMessageHandler())

// If you don't reigster any message handler, AddGrpcValidation register default message handler.  
        services.AddGrpcValidation();
    }
    // ...
}
```

#### Catch Server Side validation errors

```csharp
    try
    {
        //...
    }
    catch (ValidationRpcException ex)
    {
        // Handle any validation exceptions that occur during the process
    }
```

## How to test validation

If you want to write integration tests. [This test sample](https://github.com/AnthonyGiretti/grpc-aspnetcore-validator/tree/master/src/Calzolari.Grpc.AspNetCore.Validation.Test/Integration) may help you.