twirp 시작하기 🦜

Twirp는 gRPC의 모든 엄격한 유형의 기능을 가지고 있지만 통신을 위한 HTTP/JSON의 유연성을 유지하는 라이브러리입니다.

하나의 protobuf 파일*.proto에서 경로, 요청 및 응답을 정의합니다.

그런 다음 API의 모든 소비자는 protobuf 파일을 가져오고 선택한 언어로 자체 클라이언트 라이브러리를 생성할 수 있습니다.

빠르고 예제를 설정해 봅시다.

먼저 protobuf를 설치해야 하므로 Mac에서는

brew install protobuf

이를 설치했으면 golang 설정과 GOBIN가 정의되어 있는지 확인해야 합니다. 다음은 .zshrc에 추가할 합리적인 기본값입니다.

GOBIN="~/go/bin"
PATH="$PATH:~/go/bin"

다음으로 protobuf 바이너리 플러그인을 설치하여 twirp 및 golang용 파일을 생성해야 합니다.

go install github.com/twitchtv/twirp/protoc-gen-twirp@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest

"ProxyMe"라는 프로젝트를 만들고 있으므로 이를 예로 사용하겠습니다. 시작할 경로를 정의하기 위해 간단한 protobuf 파일부터 시작하겠습니다.

syntax = "proto3";
package reaz.io.proxyme;
option go_package = "reaz.io/proxyme";

service ProxyMe {
  rpc ListProxies(ListReq) returns (ListRes);
}

message ListReq {
  string subject = 1;
}

message ListRes {
  string text = 1;
}

주목해야 할 중요한 것은;

# We'll need this later, this is just a namespace for my projects, yours might be more like '{username}.com.{project_name}'
package reaz.io.proxyme;

그런 다음 나머지 파일은 ListProxies (목록 요청)을 수락하고 ListReq 목록 응답을 반환하는 단일ListReq 엔드포인트를 설명합니다.

이제 twirp와 protobuf를 사용하여 일부 코드를 자동으로 스캐폴딩해 보겠습니다.

protoc --go_out=. --twirp_out=. ProxyMe.proto

이 시점에서 우리는 다음과 같은 것을 갖게 될 것입니다.

├── ProxyMe.proto
└── reaz.io
    └── proxyme
        ├── ProxyMe.pb.go
        └── ProxyMe.twirp.go

2 directories, 3 files

우리가 작성한 원본 파일 ProxyMe.proto 과 go 생성 부분인 .pb.go 와 HTTP 서비스를 포함하는 twirp 매직인 *.twirp.go 를 가리키는 데 사용한 네임스페이스입니다.

이를 통해 엔드포인트를 실제로 구현하기 위해 server.go를 만들어 보겠습니다.

package main

import (
    "context"
    "log"
    "net/http"

    pb "proxyme/reaz.io/proxyme"
)

type ProxyMeServer struct{}

func (s *ProxyMeServer) ListProxies(ctx context.Context, req *pb.ListReq) (*pb.ListRes, error) {
    return &pb.ListRes{Text: "Hello " + req.Subject}, nil
}

const PORT = "8011"

// Run the implementation in a local server
func main() {
    twirpHandler := pb.NewProxyMeServer(&ProxyMeServer{})
    // You can use any mux you like - NewHelloWorldServer gives you an http.Handler.
    mux := http.NewServeMux()
    // The generated code includes a method, PathPrefix(), which
    // can be used to mount your service on a mux.
    mux.Handle(twirpHandler.PathPrefix(), twirpHandler)
    log.Println("Listening on http://0.0.0.0:" + PORT + twirpHandler.PathPrefix())
    err := http.ListenAndServe(":"+PORT, mux)
    if err != nil {
        log.Fatal(err)
        return
    }
}

그게 전부입니다. 우리는 대부분 생성된 코드를 가져오고 ListProxies , ListReq 를 사용하는 ListRes 를 추가합니다.

이제 다음과 같이 실행합니다.

$ go run server.go
2022/04/18 07:07:16 Listening on http://0.0.0.0:8011/twirp/reaz.io.proxyme.ProxyMe/

실행 중인 상태에서 다음을 사용하여 테스트할 수 있습니다.

curl --request POST \
  --url http://0.0.0.0:8011/twirp/reaz.io.proxyme.ProxyMe/ListProxies \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "mike"
}'

# Should see the following for a response
{
  "text": "Hello mike"
}

이제 다른 언어로 클라이언트 코드를 생성하고 새 서비스를 사용할 수 있습니다!

Clients in other languages can also be generated by using the respective protoc plugins defined by their languages, for example --twirp_ruby_out.

그리고 하나의 protobuf 파일에서 생성된 protobuf 또는 json을 사용할 수 있습니다!

how to generate client code here에 대해 자세히 알아보세요.