[gRPC] Simple gRPC calls with Golang and Flutter

grpc, flutter, golang, protobuf · 22 Apr 2022

Post Series _{(click to expand)}

Implementing gRPC server with Protobuf, Golang, Flutter

👉 Part 1 - [gRPC] Making gRPC API with Protocol buffers
👉 Part 2 - [gRPC] Simple gRPC calls with Golang and Flutter

gRPC Server

이전 포스트에서 컴파일된 코드를 이용하여 Golang 으로 gRPC 서버를 만들어보자.

Go Modules

프로젝트 루트의 go.mod 파일에 아래 내용을 추가한다.

require (
  ...
  protocols v1.0.0
)
...

replace (
  protocols => ../protocols
)

go.mod

아직은 Github 등의 git repository 에 올리지 않고, 로컬에서 임포트할 것이기 때문에 replace 구문을 이용하여 상대경로를 지정해준다. 로컬 상대 경로로 replace 할 경우 버전 스트링은 vX.Y.Z 의 포맷만 지켜서 임의로 넣어주면 된다.

전체 Project 의 root 디렉토리에 server, client, protocols 의 디렉토리를 만들고 그 안에 각각의 프로젝트를 생성하면 상대 경로로 참조하기가 편하다.
example
├── client
├── protocols
└── server

API server

RPC API 의 로직을 실행하는 부분. 데이터를 저장하고, 찾아오고, 수정하는 등 API 호출에 따른 business logic 이 들어갈 부분이다. 먼저 앞에서 protobuf 를 이용해 생성한 코드를 살펴보면,

...
// UserApiServer is the server API for UserApi service.
// All implementations must embed UnimplementedUserApiServer
// for forward compatibility
type UserApiServer interface {
	GetUser(context.Context, *GetUserRequest) (*GetUserReply, error)
	AddUser(context.Context, *AddUserRequest) (*AddUserReply, error)
	mustEmbedUnimplementedUserApiServer()
}

// UnimplementedUserApiServer must be embedded to have forward compatible implementations.
type UnimplementedUserApiServer struct {
}

func (UnimplementedUserApiServer) GetUser(context.Context, *GetUserRequest) (*GetUserReply, error) {
	return nil, status.Errorf(codes.Unimplemented, "method GetUser not implemented")
}
func (UnimplementedUserApiServer) AddUser(context.Context, *AddUserRequest) (*AddUserReply, error) {
	return nil, status.Errorf(codes.Unimplemented, "method AddUser not implemented")
}
func (UnimplementedUserApiServer) mustEmbedUnimplementedUserApiServer() {}
...

api_user_grpc.pb.go

‘service UserApi’ 로 설정한 rpc 호출을 받을 수 있는 interface 가 정의되어 있다. 주석의 설명대로 UnimplementedUserApiServer interface 를 임베드하여 API server 구조체를 정의하고, 필요한 API handler function 들을 구현한다.

import(
  ...
  "google.golang.org/grpc/codes"
  "google.golang.org/grpc/status"
  "protocols/goapi"
)

// API server struct.
type UserApi struct {
  goapi.UnimplementedUserApiServer
}

func (u *UserApi) GetUser(ctx context.Context, request *goapi.GetUserRequest) (*goapi.GetUserReply, error) {
  // rpc GetUser(GetUserRequest) returns (GetUserReply) {}
  ...
  // example success return
  return &goapi.GetUserReply{
    Users: []*goapi.User{user},
  }, nil

  // example error return
  return nil, status.Errorf(codes.NotFound, "email: %s", email)
}

func (u *UserApi) AddUser(ctx context.Context, request *goapi.AddUserRequest) (*goapi.AddUserReply, error) {
  // rpc AddUser(AddUserRequest) returns (AddUserReply) {}
}

user_api.go

grpc Server

API server 를 정의하고 구현한 뒤, 객체를 생성하여 grpc server 객체에 등록해주면 해당하는 rpc call 이 라우팅되어 handler function 이 실행된다.

import (
	...
	"google.golang.org/grpc"
	"protocols/goapi"
)

func main() {
  // grpc server 객체를 생성
  grpcServer := grpc.NewServer()
  // UserApi 객체를 생성하여 grpc server 에 등록
  goapi.RegisterUserApiServer(grpcServer, &UserApi{})

  lis, err := net.Listen("tcp", ":8080")
  if err != nil {
    log.Fatal(err)
  }
  if err := grpcServer.Serve(lis); err != nil {
    log.Fatal(err)
  }
}

main.go

gRPC Client

Flutter 에서 grpc client 를 만들고, rpc call 을 통해 데이터를 받아 출력해보자.

Import protocols

Protocol Buffer compiler 가 생성한 파일을 임포트한다. pubspec.yaml 의 dependencies 섹션에 아래 내용을 추가.

  grpc: ^3.0.2
  dartapi:
    path: ../protocols/dartapi

pubspec.yaml

gRPC Client

Future<List<User>> getUser() async {
  final channel = ClientChannel('localhost',
    port: 8080,
    options: ChannelOptions(
      credentials: const ChannelCredentials.insecure(),
    )
  );

  UserApiClient userApiClient = UserApiClient(channel);
  final resp = await userApiClient.getUser(
    GetUserRequest()..email="user@email.com"
  );
  return resp.users;
}

서버 쪽에 비하면 상당히 단순한다. 로컬 테스트 단계에서 암호화를 사용하지 않을 것이므로, ChannelCredentials.insecure() 옵션을 지정하고 grpc.ClientChannel 을 생성한다. 이 채널을 이용하는 UserApiClient 를 생성하고, 클라이언트 객체의 member function 을 호출하면 rpc 가 호출된다.