[gRPC] Visual Studio 에서 proto 파일 컴파일 하기

개발환경 : Visual Studio 2022

사용 언어 : C#

 

gRPC를 사용하기 위해서는 proto 파일을 컴파일하여 생성되는,

xx.cs, xxGrpc.cs 파일 2가지가 필요하다.

 

 

1. Grpc.Tool 설치하기

proto 파일을 컴파일 하기 위해서는 Grpc.Tool이 필요하다.

솔루션 패키지 관리에서 Grpc.Tool을 설치한다.

(Visual Studio 메뉴바에서 도구>NuGet 패키지 관리자>솔루션용 NuGet 패키지 관리..)

 

나중에 쓰일 Grpc또한 설치해준다.

 

2개를 설치했지만, 설치항목에 보면 총 4개가 설치되어있는것을 알수 있다.

 

 

2. 경로 복사하기

자신이 만든 프로젝트 경로에서 packages 폴더로 이동한다.

packages > Grpc.Tools.x.xx.x > tools > windows_x64 폴더에 가면

protoc.exe와 grpc_csharp_plugin.exe 가 있다.

해당 경로를 잘 복사해서 별도 메모장에 붙여놓는다.

경로가 전부 필요 하지 않고, packages 이부분부터 끝까지 필요합니다.

 

 

3. .proto 파일 경로

proto 파일을 자신이 원하는 경로에 넣어 준다.

 

 

4. 명령어 입력하기

Visual Studio 2022에서 개발자 명령 프롬포트를 연다

 

개발자 명령 프롬포트에 다음 명령어를 넣는다.

// 1번 방법 하나씩 생성 
packages\Grpc.Tools.2.48.1\tools\windows_x64\protoc.exe -I Test_gRPC/proto --csharp_out Test_gRPC/proto test.proto
packages\Grpc.Tools.2.48.1\tools\windows_x64\protoc.exe -I Test_gRPC/proto --grpc_out Test_gRPC/proto test.proto --plugin=protoc-gen-grpc=packages/Grpc.Tools.2.48.1/tools/windows_x64/grpc_csharp_plugin.exe

// 2번 방법 한번에 생성
packages\Grpc.Tools.2.48.1\tools\windows_x64\protoc.exe -I Test_gRPC/proto --csharp_out Test_gRPC/proto --grpc_out Test_gRPC/proto test.proto --plugin=protoc-gen-grpc=packages/Grpc.Tools.2.48.1/tools/windows_x64/grpc_csharp_plugin.exe

2가지 방법중에 1개를 선택해서 입력하면 된다.

 

1번 방법 사용

2번 방법 사용

성공적으로 적용되면, 아무런 메시지가 뜨지 않는다.

 

*명령어 해석

2번 방법은 1번 방법을 합쳐서 간략하게 사용한것이기 때문에 1번 방법 기준으로 설명하겠다.

packages\Grpc.Tools.2.48.1\tools\windows_x64\protoc.exe // protoc.exe가 있는 경로 (위에서 메모장에 적어둔 경로)

-I Test_gRPC/proto 	// proto 파일이 있는 곳에 경로를 설정지정 (대문자 i임)

--csharp_out 		// xx.cs 파일을 c#언어로 생성함, java, go 등 다른 언어가능

Test_gRPC/proto		// xx.cs 파일을 생성시킬 경로

test.proto			// proto 파일의 이름. (경로는 위에서 지정했음)

packages\Grpc.Tools.2.48.1\tools\windows_x64\protoc.exe // protoc.exe가 있는 경로 (위에서 메모장에 적어둔 경로)
-I Test_gRPC/proto 	// .proto 파일이 있는 곳 경로명시 (대문자 i임)
--grpc_out 			// xxGrpc.cs 파일을 생성한다.
Test_gRPC/proto 	// xxGrpc.cs 파일을 생성시킬 경로
test.proto 			// .proto 파일의 이름
--plugin=protoc-gen-grpc=	// xx.Grpc.cs를 만들기 위한 플러그인 설정
packages/Grpc.Tools.2.48.1/tools/windows_x64/grpc_csharp_plugin.exe // grpc_csharp_plugin.exe가 있는 경로 (위에서 메모장에 적어둔 경로)

 

 

5. 정상 생성 확인

명령어에 지정한 경로에  xx.cs 파일과 xxGrpc.cs 파일이 생성된다.