csharp-grpc

What problem does it solve?

Provide a consistent, production-oriented set of conventions and best practices for building gRPC services in C#, reducing integration errors and improving maintainability across proto management, service implementation, interceptors, error handling, and client usage.

Core Features & Use Cases

• Proto organization & naming: Centralize .proto files under a Protos/ directory, require csharp_namespace and versioned package names, and follow Protobuf naming conventions to avoid generated code collisions.
• Server implementation patterns: Derive services from generated base classes, name gRPC service classes with a GrpcService suffix, and always propagate ServerCallContext.CancellationToken to async operations.
• Error handling & interceptors: Use RpcException with appropriate StatusCode mapping, register global interceptors for logging and error translation, and avoid throwing raw exceptions that map to Unknown.
• Client factory & streaming: Use AddGrpcClient with HttpClientFactory for managed channels and retries, prefer streaming for large data flows, and check cancellation tokens in stream processing.

Quick Start

Add proto files to Protos/, implement the generated service base classes with CancellationToken-aware async calls, register interceptors and AddGrpcClient for clients, and use RpcException with mapped StatusCodes for error responses.