40 KiB

Raw Blame History

title

author

description

ms.author

ms.date

no-loc

uid

Create a .NET Core gRPC client and server in ASP.NET Core

jamesnk

This tutorial shows how to create a gRPC Service and gRPC client on ASP.NET Core. Learn how to create a gRPC Service project, edit a proto file, and add a duplex streaming call.

jamesnk

09/27/2021

Home

Privacy

Kestrel

appsettings.json

ASP.NET Core Identity

Blazor

Blazor Server

Blazor WebAssembly

Identity

Let's Encrypt

Razor

SignalR

tutorials/grpc/grpc-start

Tutorial: Create a gRPC client and server in ASP.NET Core

::: moniker range=">= aspnetcore-6.0" This tutorial shows how to create a .NET Core gRPC client and an ASP.NET Core gRPC Server. At the end, you'll have a gRPC client that communicates with the gRPC Greeter service.

In this tutorial, you:

[!div class="checklist"]

Create a gRPC Server.

Create a gRPC client.

Test the gRPC client service with the gRPC Greeter service.

Prerequisites

Visual Studio

[!INCLUDE]

Visual Studio Code

[!INCLUDE]

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

Create a gRPC service

Visual Studio

Start Visual Studio 2022 and select Create a new project.
In the Create a new project dialog, search for gRPC. Select ASP.NET Core gRPC Service and select Next.
In the Configure your new project dialog, enter GrpcGreeter for Project name. It's important to name the project GrpcGreeter so the namespaces match when you copy and paste code.
Select Next.
In the Additional information dialog, select .NET 6.0 (Preview) and then select Create.

Visual Studio Code

The tutorial assumes familiarity with VS Code. For more information, see Getting started with VS Code

Open the integrated terminal.
Change to the directory (cd) that will contain the project.
Run the following commands:
```
dotnet new grpc -o GrpcGreeter
code -r GrpcGreeter
```
- The dotnet new command creates a new gRPC service in the GrpcGreeter folder.
- The code command opens the GrpcGreeter folder in a new instance of Visual Studio Code.

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

Run the service

Visual Studio

Press Ctrl+F5 to run without the debugger.

Visual Studio displays the following dialog when a project is not yet configured to use SSL:

Select Yes if you trust the IIS Express SSL certificate.

The following dialog is displayed:

Select Yes if you agree to trust the development certificate.

[!INCLUDEtrust FF]

Visual Studio:

Visual Studio starts Kestrel, launches a browser, and navigates to a port that was randomly assigned for the service, such as http://localhost:7042. The address bar shows localhost:port# and not something like example.com. That's because localhost is the standard hostname for local computer. Localhost only serves web requests from the local computer.

Visual Studio Code

[!INCLUDE]

Press Ctrl-F5 to run without the debugger.

Visual Studio Code starts Kestrel, launches a browser, and navigates to a port that was randomly assigned for the service, such as http://localhost:7042. The address bar shows localhost:port# and not something like example.com. That's because localhost is the standard hostname for local computer. Localhost only serves web requests from the local computer.

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

The logs show the service listening on https://localhost:7042.

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

[!NOTE] The gRPC template is configured to use Transport Layer Security (TLS). gRPC clients need to use HTTPS to call the server. The gRPC service localhost port number is randomly assigned when the project is created and set in the Properties\launchSettings.json file of the gRPC service project.

macOS doesn't support ASP.NET Core gRPC with TLS. Additional configuration is required to successfully run gRPC services on macOS. For more information, see Unable to start ASP.NET Core gRPC app on macOS.

Examine the project files

GrpcGreeter project files:

Protos/greet.proto: defines the Greeter gRPC and is used to generate the gRPC server assets. For more information, see Introduction to gRPC.
Services folder: Contains the implementation of the Greeter service.
appSettings.json: Contains configuration data such as the protocol used by Kestrel. For more information, see xref:fundamentals/configuration/index.
Program.cs, which contains:
- The entry point for the gRPC service. For more information, see xref:fundamentals/host/generic-host.
- Code that configures app behavior. For more information, see App startup.

Create the gRPC client in a .NET console app

Visual Studio

Open a second instance of Visual Studio and select Create a new project.
In the Create a new project dialog, select Console Application, and select Next.
In the Project name text box, enter GrpcGreeterClient and select Next.
In the Additional information dialog, select .NET 6.0 (Preview) and then select Create.

Visual Studio Code

Open the integrated terminal.
Change directories (cd) to a folder for the project.

Run the following commands:

dotnet new console -o GrpcGreeterClient
code -r GrpcGreeterClient

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

Add required NuGet packages

The gRPC client project requires the following NuGet packages:

Grpc.Net.Client, which contains the .NET Core client.
Google.Protobuf, which contains protobuf message APIs for C#.
Grpc.Tools, which contain C# tooling support for protobuf files. The tooling package isn't required at runtime, so the dependency is marked with PrivateAssets="All".

Visual Studio

Install the packages using either the Package Manager Console (PMC) or Manage NuGet Packages.

PMC option to install packages

From Visual Studio, select Tools > NuGet Package Manager > Package Manager Console
From the Package Manager Console window, run cd GrpcGreeterClient to change directories to the folder containing the GrpcGreeterClient.csproj files.

Run the following commands:

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

Manage NuGet Packages option to install packages

Right-click the project in Solution Explorer > Manage NuGet Packages.
Select the Browse tab.
Enter Grpc.Net.Client in the search box.
Select the Grpc.Net.Client package from the Browse tab and select Install.
Repeat for Google.Protobuf and Grpc.Tools.

Visual Studio Code

Run the following commands from the Integrated Terminal:

dotnet add GrpcGreeterClient.csproj package Grpc.Net.Client
dotnet add GrpcGreeterClient.csproj package Google.Protobuf
dotnet add GrpcGreeterClient.csproj package Grpc.Tools

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

Add greet.proto

Create a Protos folder in the gRPC client project.
Copy the Protos\greet.proto file from the gRPC Greeter service to the Protos folder in the gRPC client project.
Update the namespace inside the greet.proto file to the project's namespace:
```
option csharp_namespace = "GrpcGreeterClient";
```
Edit the GrpcGreeterClient.csproj project file:

Visual Studio

Right-click the project and select Edit Project File.

Visual Studio Code

Select the GrpcGreeterClient.csproj file.

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

Add an item group with a <Protobuf> element that refers to the greet.proto file:

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

Create the Greeter client

Build the client project to create the types in the GrpcGreeter namespace. The GrpcGreeter types are generated automatically by the build process.
Update the gRPC client Program.cs file with the following code:

[!code-csharp]

Program.cs contains the entry point and logic for the gRPC client.

The Greeter client is created by:

Instantiating a GrpcChannel containing the information for creating the connection to the gRPC service.
Using the GrpcChannel to construct the Greeter client:

[!code-csharp]

The Greeter client calls the asynchronous SayHello method. The result of the SayHello call is displayed:

[!code-csharp]

Test the gRPC client with the gRPC Greeter service

Visual Studio

In the Greeter service, press Ctrl+F5 to start the server without the debugger.
In the GrpcGreeterClient project, press Ctrl+F5 to start the client without the debugger.

Visual Studio Code

Start the Greeter service.
Start the client.

Visual Studio for Mac

We hope to have Visual Studio for Mac instructions soon.

The client sends a greeting to the service with a message containing its name, GreeterClient. The service sends the message "Hello GreeterClient" as a response. The "Hello GreeterClient" response is displayed in the command prompt:

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

The gRPC service records the details of the successful call in the logs written to the command prompt:

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:7042
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:7042/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

[!NOTE] The code in this article requires the ASP.NET Core HTTPS development certificate to secure the gRPC service. If the .NET gRPC client fails with the message The remote certificate is invalid according to the validation procedure. or The SSL connection could not be established., the development certificate isn't trusted. To fix this issue, see Call a gRPC service with an untrusted/invalid certificate.

[!INCLUDE]

Next steps

View or download the completed sample code for this tutorial (how to download).
xref:grpc/index
xref:grpc/basics
xref:grpc/migration

::: moniker-end

::: moniker range=">= aspnetcore-5.0 < aspnetcore-6.0" This tutorial shows how to create a .NET Core gRPC client and an ASP.NET Core gRPC Server.

At the end, you'll have a gRPC client that communicates with the gRPC Greeter service.

View or download sample code (how to download).

In this tutorial, you:

[!div class="checklist"]

Create a gRPC Server.

Create a gRPC client.

Test the gRPC client service with the gRPC Greeter service.

Prerequisites

Visual Studio

[!INCLUDE]

Visual Studio Code

[!INCLUDE]

Visual Studio for Mac

Visual Studio for Mac version 8.7 or later
[!INCLUDE .NET Core 3.1 SDK]

Create a gRPC service

Visual Studio

Start Visual Studio and select Create a new project.
In the Create a new project dialog, select gRPC Service and select Next.
In the Configure your new project dialog, enter GrpcGreeter for Project name. It's important to name the project GrpcGreeter so the namespaces match when you copy and paste code.
Select Next.
In the Additional information dialog, select .NET 5.0 in the Target Framework dropdown.
Select Create.

Visual Studio Code

The tutorial assumes familiarity with VS Code. For more information, see Getting started with VS Code

Open the integrated terminal.
Change to the directory (cd) that will contain the project.
Run the following commands:
```
dotnet new grpc -o GrpcGreeter
code -r GrpcGreeter
```
- The dotnet new command creates a new gRPC service in the GrpcGreeter folder.
- The code command opens the GrpcGreeter folder in a new instance of Visual Studio Code.

Visual Studio for Mac

Start Visual Studio for Mac and select New. Alternatively, from the Visual Studio File menu, select New Solution.
In the Choose a template for your new project dialog, select Web and Console > App > gRPC Service and select Next.
Select .NET 5.0 for the target framework and select Next.
Name the project GrpcGreeter. It's important to name the project GrpcGreeter so the namespaces match when you copy and paste code.
Select Create.

Run the service

[!INCLUDE]

The logs show the service listening on https://localhost:5001.

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

[!NOTE] The gRPC template is configured to use Transport Layer Security (TLS). gRPC clients need to use HTTPS to call the server.

macOS doesn't support ASP.NET Core gRPC with TLS. Additional configuration is required to successfully run gRPC services on macOS. For more information, see Unable to start ASP.NET Core gRPC app on macOS.

Examine the project files

GrpcGreeter project files:

greet.proto: The Protos/greet.proto file defines the Greeter gRPC and is used to generate the gRPC server assets. For more information, see Introduction to gRPC.
Services folder: Contains the implementation of the Greeter service.
appSettings.json: Contains configuration data, such as protocol used by Kestrel. For more information, see xref:fundamentals/configuration/index.
Program.cs: Contains the entry point for the gRPC service. For more information, see xref:fundamentals/host/generic-host.
Startup.cs: Contains code that configures app behavior. For more information, see App startup.

Create the gRPC client in a .NET console app

Visual Studio

Open a second instance of Visual Studio and select Create a new project.
In the Create a new project dialog, select Console App (.NET Core) and select Next.
In the Project name text box, enter GrpcGreeterClient and select Create.

Visual Studio Code

Open the integrated terminal.
Change directories (cd) to a folder for the project.

Run the following commands:

dotnet new console -o GrpcGreeterClient
code -r GrpcGreeterClient

Visual Studio for Mac

Follow the instructions in Building a complete .NET Core solution on macOS using Visual Studio for Mac to create a console app with the name GrpcGreeterClient.

Add required packages

The gRPC client project requires the following packages:

Grpc.Net.Client, which contains the .NET Core client.
Google.Protobuf, which contains protobuf message APIs for C#.
Grpc.Tools, which contains C# tooling support for protobuf files. The tooling package isn't required at runtime, so the dependency is marked with PrivateAssets="All".

Visual Studio

Install the packages using either the Package Manager Console (PMC) or Manage NuGet Packages.

PMC option to install packages

From Visual Studio, select Tools > NuGet Package Manager > Package Manager Console
From the Package Manager Console window, run cd GrpcGreeterClient to change directories to the folder containing the GrpcGreeterClient.csproj files.

Run the following commands:

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

Manage NuGet Packages option to install packages

Right-click the project in Solution Explorer > Manage NuGet Packages.
Select the Browse tab.
Enter Grpc.Net.Client in the search box.
Select the Grpc.Net.Client package from the Browse tab and select Install.
Repeat for Google.Protobuf and Grpc.Tools.

Visual Studio Code

Run the following commands from the Integrated Terminal:

dotnet add GrpcGreeterClient.csproj package Grpc.Net.Client
dotnet add GrpcGreeterClient.csproj package Google.Protobuf
dotnet add GrpcGreeterClient.csproj package Grpc.Tools

Visual Studio for Mac

Right-click GrpcGreeterClient project in the Solution Pad and select Manage NuGet Packages.
Enter Grpc.Net.Client in the search box.
Select the Grpc.Net.Client package from the results pane and select Add Package.
Select the Accept button on the Accept License dialog.
Repeat for Google.Protobuf and Grpc.Tools.

Add greet.proto

Create a Protos folder in the gRPC client project.
Copy the Protos\greet.proto file from the gRPC Greeter service to the Protos folder in the gRPC client project.
Update the namespace inside the greet.proto file to the project's namespace:
```
option csharp_namespace = "GrpcGreeterClient";
```
Edit the GrpcGreeterClient.csproj project file:

Visual Studio

Right-click the project and select Edit Project File.

Visual Studio Code

Select the GrpcGreeterClient.csproj file.

Visual Studio for Mac

Right-click the project and select Edit Project File.

Add an item group with a <Protobuf> element that refers to the greet.proto file:

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

Create the Greeter client

Build the client project to create the types in the GrpcGreeter namespace. The GrpcGreeter types are generated automatically by the build process.

Update the gRPC client Program.cs file with the following code:

[!code-csharp]

Program.cs contains the entry point and logic for the gRPC client.

The Greeter client is created by:

Instantiating a GrpcChannel containing the information for creating the connection to the gRPC service.
Using the GrpcChannel to construct the Greeter client:

[!code-csharp]

The Greeter client calls the asynchronous SayHello method. The result of the SayHello call is displayed:

[!code-csharp]

Test the gRPC client with the gRPC Greeter service

Visual Studio

In the Greeter service, press Ctrl+F5 to start the server without the debugger.
In the GrpcGreeterClient project, press Ctrl+F5 to start the client without the debugger.

Visual Studio Code

Start the Greeter service.
Start the client.

Visual Studio for Mac

Due to the previously mentioned HTTP/2 TLS issue on macOS workaround, you'll need to update the channel address in the client to "http://localhost:5000". Update line 13 of GrpcGreeterClient/Program.cs to read:
```
using var channel = GrpcChannel.ForAddress("http://localhost:5000");
```
Start the Greeter service.
Start the client.

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

The gRPC service records the details of the successful call in the logs written to the command prompt:

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:5001
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:5001/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

[!NOTE] The code in this article requires the ASP.NET Core HTTPS development certificate to secure the gRPC service. If the .NET gRPC client fails with the message The remote certificate is invalid according to the validation procedure. or The SSL connection could not be established., the development certificate isn't trusted. To fix this issue, see Call a gRPC service with an untrusted/invalid certificate.

[!INCLUDE]

Next steps

::: moniker-end

::: moniker range=">= aspnetcore-3.0 < aspnetcore-5.0"

This tutorial shows how to create a .NET Core gRPC client and an ASP.NET Core gRPC Server.

At the end, you'll have a gRPC client that communicates with the gRPC Greeter service.

View or download sample code (how to download).

In this tutorial, you:

[!div class="checklist"]

Create a gRPC Server.

Create a gRPC client.

Test the gRPC client service with the gRPC Greeter service.

Prerequisites

Visual Studio

[!INCLUDE]

Visual Studio Code

[!INCLUDE]

Visual Studio for Mac

Visual Studio for Mac version 8.7 or later
[!INCLUDE .NET Core 3.1 SDK]

Create a gRPC service

Visual Studio

Start Visual Studio and select Create a new project. Alternatively, from the Visual Studio File menu, select New > Project.
In the Create a new project dialog, select gRPC Service and select Next:
Name the project GrpcGreeter. It's important to name the project GrpcGreeter so the namespaces match when you copy and paste code.
Select Create.
In the Create a new gRPC service dialog:
- The gRPC Service template is selected.
- Select Create.

Visual Studio Code

Open the integrated terminal.
Change directories (cd) to a folder for the project.
Run the following commands:
```
dotnet new grpc -o GrpcGreeter
code -r GrpcGreeter
```
- The dotnet new command creates a new gRPC service in the GrpcGreeter folder.
- The code command opens the GrpcGreeter folder in a new instance of Visual Studio Code.
A dialog box appears with Required assets to build and debug are missing from 'GrpcGreeter'. Add them?
Select Yes.

Visual Studio for Mac

Start Visual Studio for Mac and select Create a new project. Alternatively, from the Visual Studio File menu, select New > Project.
In the Create a new project dialog, select Web and Console > App > gRPC Service and select Next:
Select .NET Core 3.1 for the target framework and select Next.
Name the project GrpcGreeter. It's important to name the project GrpcGreeter so the namespaces match when you copy and paste code.
Select Create.

Run the service

[!INCLUDE]

The logs show the service listening on https://localhost:5001.

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

[!NOTE] The gRPC template is configured to use Transport Layer Security (TLS). gRPC clients need to use HTTPS to call the server.

macOS doesn't support ASP.NET Core gRPC with TLS. Additional configuration is required to successfully run gRPC services on macOS. For more information, see Unable to start ASP.NET Core gRPC app on macOS.

Examine the project files

GrpcGreeter project files:

greet.proto: The Protos/greet.proto file defines the Greeter gRPC and is used to generate the gRPC server assets. For more information, see Introduction to gRPC.
Services folder: Contains the implementation of the Greeter service.
appSettings.json: Contains configuration data, such as protocol used by Kestrel. For more information, see xref:fundamentals/configuration/index.
Program.cs: Contains the entry point for the gRPC service. For more information, see xref:fundamentals/host/generic-host.
Startup.cs: Contains code that configures app behavior. For more information, see App startup.

Create the gRPC client in a .NET console app

Visual Studio

Open a second instance of Visual Studio and select Create a new project.
In the Create a new project dialog, select Console App (.NET Core) and select Next.
In the Project name text box, enter GrpcGreeterClient and select Create.

Visual Studio Code

Open the integrated terminal.
Change directories (cd) to a folder for the project.

Run the following commands:

dotnet new console -o GrpcGreeterClient
code -r GrpcGreeterClient

Visual Studio for Mac

Follow the instructions in Building a complete .NET Core solution on macOS using Visual Studio for Mac to create a console app with the name GrpcGreeterClient.

Add required packages

The gRPC client project requires the following packages:

Grpc.Net.Client, which contains the .NET Core client.
Google.Protobuf, which contains protobuf message APIs for C#.
Grpc.Tools, which contains C# tooling support for protobuf files. The tooling package isn't required at runtime, so the dependency is marked with PrivateAssets="All".

Visual Studio

Install the packages using either the Package Manager Console (PMC) or Manage NuGet Packages.

PMC option to install packages

From Visual Studio, select Tools > NuGet Package Manager > Package Manager Console
From the Package Manager Console window, run cd GrpcGreeterClient to change directories to the folder containing the GrpcGreeterClient.csproj files.

Run the following commands:

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

Manage NuGet Packages option to install packages

Right-click the project in Solution Explorer > Manage NuGet Packages.
Select the Browse tab.
Enter Grpc.Net.Client in the search box.
Select the Grpc.Net.Client package from the Browse tab and select Install.
Repeat for Google.Protobuf and Grpc.Tools.

Visual Studio Code

Run the following commands from the Integrated Terminal:

dotnet add GrpcGreeterClient.csproj package Grpc.Net.Client
dotnet add GrpcGreeterClient.csproj package Google.Protobuf
dotnet add GrpcGreeterClient.csproj package Grpc.Tools

Visual Studio for Mac

Right-click GrpcGreeterClient project in the Solution Pad and select Manage NuGet Packages.
Enter Grpc.Net.Client in the search box.
Select the Grpc.Net.Client package from the results pane and select Add Package.
Select the Accept button on the Accept License dialog.
Repeat for Google.Protobuf and Grpc.Tools.

Add greet.proto

Create a Protos folder in the gRPC client project.
Copy the Protos\greet.proto file from the gRPC Greeter service to the Protos folder in the gRPC client project.
Update the namespace inside the greet.proto file to the project's namespace:
```
option csharp_namespace = "GrpcGreeterClient";
```
Edit the GrpcGreeterClient.csproj project file:

Visual Studio

Right-click the project and select Edit Project File.

Visual Studio Code

Select the GrpcGreeterClient.csproj file.

Visual Studio for Mac

Right-click the project and select Edit Project File.

Add an item group with a <Protobuf> element that refers to the greet.proto file:

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

Create the Greeter client

Build the client project to create the types in the GrpcGreeter namespace. The GrpcGreeter types are generated automatically by the build process.

Update the gRPC client Program.cs file with the following code:

[!code-csharp]

Program.cs contains the entry point and logic for the gRPC client.

The Greeter client is created by:

Instantiating a GrpcChannel containing the information for creating the connection to the gRPC service.
Using the GrpcChannel to construct the Greeter client:

[!code-csharp]

The Greeter client calls the asynchronous SayHello method. The result of the SayHello call is displayed:

[!code-csharp]

Test the gRPC client with the gRPC Greeter service

Visual Studio

In the Greeter service, press Ctrl+F5 to start the server without the debugger.
In the GrpcGreeterClient project, press Ctrl+F5 to start the client without the debugger.

Visual Studio Code

Start the Greeter service.
Start the client.

Visual Studio for Mac

Due to the previously mentioned HTTP/2 TLS issue on macOS workaround, you'll need to update the channel address in the client to "http://localhost:5000". Update line 13 of GrpcGreeterClient/Program.cs to read:
```
using var channel = GrpcChannel.ForAddress("http://localhost:5000");
```
Start the Greeter service.
Start the client.

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

The gRPC service records the details of the successful call in the logs written to the command prompt:

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:5001
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:5001/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

[!NOTE] The code in this article requires the ASP.NET Core HTTPS development certificate to secure the gRPC service. If the .NET gRPC client fails with the message The remote certificate is invalid according to the validation procedure. or The SSL connection could not be established., the development certificate isn't trusted. To fix this issue, see Call a gRPC service with an untrusted/invalid certificate.

[!INCLUDE]

Next steps

::: moniker-end

40 KiB Raw Blame History

Tutorial: Create a gRPC client and server in ASP.NET Core

Prerequisites

Create a gRPC service

Run the service

Examine the project files

Create the gRPC client in a .NET console app

Add required NuGet packages

PMC option to install packages

Manage NuGet Packages option to install packages

Add greet.proto

Create the Greeter client

Test the gRPC client with the gRPC Greeter service

Next steps

Prerequisites

Create a gRPC service

Run the service

Examine the project files

Create the gRPC client in a .NET console app

Add required packages

PMC option to install packages

Manage NuGet Packages option to install packages

Add greet.proto

Create the Greeter client

Test the gRPC client with the gRPC Greeter service

Next steps

Prerequisites

Create a gRPC service

Run the service

Examine the project files

Create the gRPC client in a .NET console app

Add required packages

PMC option to install packages

Manage NuGet Packages option to install packages

Add greet.proto

Create the Greeter client

Test the gRPC client with the gRPC Greeter service

Next steps

40 KiB

Raw Blame History