🕴🏽 💫 🛌🏻 Goキットを使用したGoのマイクロサービス：はじめに 🐏 👆🏿 👨‍🌾

この記事では、Goでマイクロサービスを作成するためのツールとライブラリのセットであるGoキットの使用について説明します。この記事はGoキットの紹介です。私のブログの最初の部分である例のソースコードは、ここから入手できます。

Goは、最近の分散システムの開発にますます選ばれています。クラウドベースの分散システムを開発している場合、サービスのさまざまな特定の機能をサポートする必要がある場合があります。さまざまなトランスポートプロトコル（ transl。HTTP、gRPCなど ）およびそれらのメッセージエンコーディング形式、RPC信頼性、ロギング、トレース、メトリックとプロファイリング、リクエストの中断、リクエストの数の制限、インフラストラクチャへの統合、さらにはアーキテクチャの説明も含まれます。 Goは、そのシンプルさと「魔法のない」アプローチのために人気のある言語です。したがって、Goのパッケージ（標準ライブラリなど）は、多くの「内部の魔法」を備えた本格的なフレームワークを使用するよりも、分散システムの開発にすでに適しています。個人的に、私[ 約。 あたり Shiju Varghese ]私は本格的なフレームワークの使用をサポートしていません。開発者により多くの自由を与えるライブラリを使用することを好みます。 GoキットはGoエコシステムのギャップを埋め、マイクロサービスの作成時にライブラリとパッケージのセットを使用できるようにしました。これにより、分散システムで個々のサービスを設計するための優れた原則を使用できます。

Goキットの概要

Goキットは、信頼できるサポートされたマイクロサービスを簡単に構築できるGoパッケージのセットです。 Goキットは、製品でマイクロサービスを実行するために必要なロギング、メトリック、トレース、制限、割り込み要求などのレイヤーを使用して、透過的で信頼できるアプリケーションアーキテクチャのさまざまなコンポーネントを実装するためのライブラリを提供します。 Goキットは、さまざまなインフラストラクチャ、メッセージエンコード形式、さまざまなトランスポートレイヤーと対話するためのツールが実装されているため、優れています。

ワールドサービスを開発するためのライブラリセットに加えて、サービスのアーキテクチャを設計するための優れた原則の使用を提供し、奨励しています。 Goキットは、 Alistair Cockburnが提案するSOLID原則、サブジェクト指向アプローチ（DDD）、六角形アーキテクチャ、またはJeffrey Palermoが 「タマネギアーキテクチャ」、 Robert C. Martinが 「クリーンアーキテクチャ」として知られるその他のアーキテクチャアプローチを順守するのに役立ちます。 Goキットは、マイクロサービスを開発するための一連のパッケージとして設計されましたが、エレガントなモノリスの開発にも適しています。

Architecture Goキット

Goキットを使用して開発されたアプリケーションのアーキテクチャの3つの主要なレベルは次のとおりです。

輸送レベル
エンドポイントレベル
サービスレベル

輸送レベル

分散システム用のマイクロサービスを作成する場合、それらのサービスは多くの場合、HTTPやgRPCなどのさまざまなトランスポートプロトコルを使用して相互に通信するか、NATSなどのpub / subシステムを使用する必要があります。 Goキットのトランスポート層は、特定のトランスポートプロトコル（以下、トランスポート）に関連付けられています。 Goキットは、HTTP、gRPC、NATS、AMQP、Thirftなど、サービスのさまざまなトランスポートをサポートします（おおよそ、 プロトコル用に独自のトランスポートを開発することもできます ）。したがって、Goキットを使用して記述されたサービスは、使用されるトランスポートについて何も知らない特定のビジネスロジックの実装に焦点を当てることがよくあり、同じサービスに対して異なるトランスポートを自由に使用できます。たとえば、Goキットで記述された1つのサービスは、HTTPおよびgRPCを介して同時にアクセスできます。

エンドポイント

エンドポイントまたはエンドポイントは、サービスと顧客の基本的な構成要素です。 Goキットの主な通信パターンはRPCです。エンドポイントは、別個のRPCメソッドとして提示されます。 Goキットの各サービスメソッドはエンドポイントに変換されるため、サーバーとクライアント間でRCPスタイルで通信できます。各エンドポイントは、トランスポート層を使用してサービスメソッドを公開します。トランスポート層は、HTTPやgRPCなどのさまざまなトランスポートプロトコルを使用します。個別のエンドポイントは、複数のトランスポート（ 異なるポートで約Per HTTPおよびgRPC ）を使用して、サービスの外部に同時に公開できます。

サービス

ビジネスロジックは、サービスレイヤーに実装されます。 Goキットで作成されたサービスは、インターフェースとして設計されています。サービスレイヤーのビジネスロジックには、ビジネスロジックのメインコアが含まれます。これには、使用されているエンドポイントや、HTTPやgRPCなどの特定のトランスポートプロトコルについて、またはさまざまな種類のメッセージの要求と応答のエンコードまたはデコードについての知識は必要ありません。これにより、Goキットを使用して記述されたサービスのクリーンなアーキテクチャを順守できます。各サービスメソッドは、アダプターを使用してエンドポイントに変換され、特定のトランスポートを使用して外部に公開されます。クリーンなアーキテクチャを使用することにより、複数のトランスポートを同時に使用して単一のメソッドを設定できます。

例

次に、簡単なアプリケーションの例を使用して、上記のレイヤーを見てみましょう。

サービスのビジネスロジック

サービスのビジネスロジックは、インターフェイスを使用して設計されています。 eコマースでの注文の例を見てみましょう。

// Service describes the Order service. type Service interface { Create(ctx context.Context, order Order) (string, error) GetByID(ctx context.Context, id string) (Order, error) ChangeStatus(ctx context.Context, id string, status string) error }

Orderサービスインターフェイスは、注文ドメインエンティティと連携します。

 // Order represents an order type Order struct { ID string `json:"id,omitempty"` CustomerID string `json:"customer_id"` Status string `json:"status"` CreatedOn int64 `json:"created_on,omitempty"` RestaurantId string `json:"restaurant_id"` OrderItems []OrderItem `json:"order_items,omitempty"` } // OrderItem represents items in an order type OrderItem struct { ProductCode string `json:"product_code"` Name string `json:"name"` UnitPrice float32 `json:"unit_price"` Quantity int32 `json:"quantity"` } // Repository describes the persistence on order model type Repository interface { CreateOrder(ctx context.Context, order Order) error GetOrderByID(ctx context.Context, id string) (Order, error) ChangeOrderStatus(ctx context.Context, id string, status string) error }

ここで、Orderサービスのインターフェイスを実装します。

 package implementation import ( "context" "database/sql" "time" "github.com/go-kit/kit/log" "github.com/go-kit/kit/log/level" "github.com/gofrs/uuid" ordersvc "github.com/shijuvar/gokit-examples/services/order" ) // service implements the Order Service type service struct { repository ordersvc.Repository logger log.Logger } // NewService creates and returns a new Order service instance func NewService(rep ordersvc.Repository, logger log.Logger) ordersvc.Service { return &service{ repository: rep, logger: logger, } } // Create makes an order func (s *service) Create(ctx context.Context, order ordersvc.Order) (string, error) { logger := log.With(s.logger, "method", "Create") uuid, _ := uuid.NewV4() id := uuid.String() order.ID = id order.Status = "Pending" order.CreatedOn = time.Now().Unix() if err := s.repository.CreateOrder(ctx, order); err != nil { level.Error(logger).Log("err", err) return "", ordersvc.ErrCmdRepository } return id, nil } // GetByID returns an order given by id func (s *service) GetByID(ctx context.Context, id string) (ordersvc.Order, error) { logger := log.With(s.logger, "method", "GetByID") order, err := s.repository.GetOrderByID(ctx, id) if err != nil { level.Error(logger).Log("err", err) if err == sql.ErrNoRows { return order, ordersvc.ErrOrderNotFound } return order, ordersvc.ErrQueryRepository } return order, nil } // ChangeStatus changes the status of an order func (s *service) ChangeStatus(ctx context.Context, id string, status string) error { logger := log.With(s.logger, "method", "ChangeStatus") if err := s.repository.ChangeOrderStatus(ctx, id, status); err != nil { level.Error(logger).Log("err", err) return ordersvc.ErrCmdRepository } return nil }

RPCエンドポイントのリクエストと回答

サービスメソッドはRPCエンドポイントとして公開されます。そのため、RPCエンドポイントを介してメッセージを送受信するために使用されるメッセージのタイプ（ およそDTO-データ転送オブジェクト ）を決定する必要があります。次に、OrderサービスでRPCエンドポイントの要求および応答タイプの構造を定義しましょう。

 // CreateRequest holds the request parameters for the Create method. type CreateRequest struct { Order order.Order } // CreateResponse holds the response values for the Create method. type CreateResponse struct { ID string `json:"id"` Err error `json:"error,omitempty"` } // GetByIDRequest holds the request parameters for the GetByID method. type GetByIDRequest struct { ID string } // GetByIDResponse holds the response values for the GetByID method. type GetByIDResponse struct { Order order.Order `json:"order"` Err error `json:"error,omitempty"` } // ChangeStatusRequest holds the request parameters for the ChangeStatus method. type ChangeStatusRequest struct { ID string `json:"id"` Status string `json:"status"` } // ChangeStatusResponse holds the response values for the ChangeStatus method. type ChangeStatusResponse struct { Err error `json:"error,omitempty"` }

RPCエンドポイントなどのサービスメソッド用のGoキットエンドポイント

ビジネスロジックのコアは、残りのコードから分離され、サービスレイヤーに配置されます。サービスレイヤーは、RPCエンドポイントを使用して公開され、エンドポイントと呼ばれるGoキットアブストラクションを使用します。

Goキットのエンドポイントは次のようになります。

 type Endpoint func(ctx context.Context, request interface{}) (response interface{}, err error)

前述したように、エンドポイントは別のRPCメソッドを表します。各サービスメソッドは、アダプターを使用してendpoint.Endpoint

変換されendpoint.Endpoint

。 OrderサービスメソッドのGoキットエンドポイントを作成しましょう。

 import ( "context" "github.com/go-kit/kit/endpoint" "github.com/shijuvar/gokit-examples/services/order" ) // Endpoints holds all Go kit endpoints for the Order service. type Endpoints struct { Create endpoint.Endpoint GetByID endpoint.Endpoint ChangeStatus endpoint.Endpoint } // MakeEndpoints initializes all Go kit endpoints for the Order service. func MakeEndpoints(s order.Service) Endpoints { return Endpoints{ Create: makeCreateEndpoint(s), GetByID: makeGetByIDEndpoint(s), ChangeStatus: makeChangeStatusEndpoint(s), } } func makeCreateEndpoint(s order.Service) endpoint.Endpoint { return func(ctx context.Context, request interface{}) (interface{}, error) { req := request.(CreateRequest) id, err := s.Create(ctx, req.Order) return CreateResponse{ID: id, Err: err}, nil } } func makeGetByIDEndpoint(s order.Service) endpoint.Endpoint { return func(ctx context.Context, request interface{}) (interface{}, error) { req := request.(GetByIDRequest) orderRes, err := s.GetByID(ctx, req.ID) return GetByIDResponse{Order: orderRes, Err: err}, nil } } func makeChangeStatusEndpoint(s order.Service) endpoint.Endpoint { return func(ctx context.Context, request interface{}) (interface{}, error) { req := request.(ChangeStatusRequest) err := s.ChangeStatus(ctx, req.ID, req.Status) return ChangeStatusResponse{Err: err}, nil } }

エンドポイントアダプターは、入力へのパラメーターとしてインターフェイスを受け入れ、Goキットendpoint.Enpoint

抽象化に変換します。個々のサービスメソッドをエンドポイントにするEnpoint。このアダプター関数は、要求の比較と型変換を行い、サービスメソッドを呼び出し、応答メッセージを返します。

 func makeCreateEndpoint(s order.Service) endpoint.Endpoint { return func(ctx context.Context, request interface{}) (interface{}, error) { req := request.(CreateRequest) id, err := s.Create(ctx, req.Order) return CreateResponse{ID: id, Err: err}, nil } }

HTTPを使用したサービスの公開

サービスを作成し、サービスメソッドを公開するためのRPCエンドポイントについて説明しました。次に、他のサービスがRCPエンドポイントを呼び出すことができるように、サービスを外部に公開する必要があります。サービスを公開するには、リクエストを受け入れるサービスのトランスポートプロトコルを決定する必要があります。 Goキットは、HTTP、gRPC、NATS、AMQP、Thriftなどのさまざまなトランスポートをすぐにサポートします。

例として、サービスにHTTPトランスポートを使用します。 goキットパッケージgithub.com/go-kit/kit/transport/httpは、HTTPリクエストを処理する機能を提供します。 transport/http

パッケージのNewServer

関数は、 NewServer

を実装し、提供されたエンドポイントをラップする新しいhttpサーバーを作成します。

以下は、GoキットのエンドポイントをHTTPリクエストを処理するHTTPトランスポートに変換するコードです。

 package http import ( "context" "encoding/json" "errors" "github.com/shijuvar/gokit-examples/services/order" "net/http" "github.com/go-kit/kit/log" kithttp "github.com/go-kit/kit/transport/http" "github.com/gorilla/mux" "github.com/shijuvar/gokit-examples/services/order/transport" ) var ( ErrBadRouting = errors.New("bad routing") ) // NewService wires Go kit endpoints to the HTTP transport. func NewService( svcEndpoints transport.Endpoints, logger log.Logger, ) http.Handler { // set-up router and initialize http endpoints r := mux.NewRouter() options := []kithttp.ServerOption{ kithttp.ServerErrorLogger(logger), kithttp.ServerErrorEncoder(encodeError), } // HTTP Post - /orders r.Methods("POST").Path("/orders").Handler(kithttp.NewServer( svcEndpoints.Create, decodeCreateRequest, encodeResponse, options..., )) // HTTP Post - /orders/{id} r.Methods("GET").Path("/orders/{id}").Handler(kithttp.NewServer( svcEndpoints.GetByID, decodeGetByIDRequest, encodeResponse, options..., )) // HTTP Post - /orders/status r.Methods("POST").Path("/orders/status").Handler(kithttp.NewServer( svcEndpoints.ChangeStatus, decodeChangeStausRequest, encodeResponse, options..., )) return r } func decodeCreateRequest(_ context.Context, r *http.Request) (request interface{}, err error) { var req transport.CreateRequest if e := json.NewDecoder(r.Body).Decode(&req.Order); e != nil { return nil, e } return req, nil } func decodeGetByIDRequest(_ context.Context, r *http.Request) (request interface{}, err error) { vars := mux.Vars(r) id, ok := vars["id"] if !ok { return nil, ErrBadRouting } return transport.GetByIDRequest{ID: id}, nil } func decodeChangeStausRequest(_ context.Context, r *http.Request) (request interface{}, err error) { var req transport.ChangeStatusRequest if e := json.NewDecoder(r.Body).Decode(&req); e != nil { return nil, e } return req, nil } func encodeResponse(ctx context.Context, w http.ResponseWriter, response interface{}) error { if e, ok := response.(errorer); ok && e.error() != nil { // Not a Go kit transport error, but a business-logic error. // Provide those as HTTP errors. encodeError(ctx, e.error(), w) return nil } w.Header().Set("Content-Type", "application/json; charset=utf-8") return json.NewEncoder(w).Encode(response) }

transport/http

パッケージのNewServer

関数を使用してNewServer

を作成します。これにより、エンドポイントとリクエストデコード関数（ type DecodeRequestFunc func

の値を返す）およびレスポンスエンコーディング（ type EncodeReponseFunc func

）が提供されます。

以下は、 DecodeRequestFunc

とEncodeResponseFunc

例です。

 // For decoding request type DecodeRequestFunc func(context.Context, *http.Request) (request interface{}, err error)

 // For encoding response type EncodeResponseFunc func(context.Context, http.ResponseWriter, interface{}) error

HTTPサーバーの開始

最後に、HTTPサーバーを実行してリクエストを処理できます。上記のNewService

関数は、HTTPサーバーとして実行できるhttp.Handler

インターフェイスを実装します。

 func main() { var ( httpAddr = flag.String("http.addr", ":8080", "HTTP listen address") ) flag.Parse() var logger log.Logger { logger = log.NewLogfmtLogger(os.Stderr) logger = log.NewSyncLogger(logger) logger = level.NewFilter(logger, level.AllowDebug()) logger = log.With(logger, "svc", "order", "ts", log.DefaultTimestampUTC, "caller", log.DefaultCaller, ) } level.Info(logger).Log("msg", "service started") defer level.Info(logger).Log("msg", "service ended") var db *sql.DB { var err error // Connect to the "ordersdb" database db, err = sql.Open("postgres", "postgresql://shijuvar@localhost:26257/ordersdb?sslmode=disable") if err != nil { level.Error(logger).Log("exit", err) os.Exit(-1) } } // Create Order Service var svc order.Service { repository, err := cockroachdb.New(db, logger) if err != nil { level.Error(logger).Log("exit", err) os.Exit(-1) } svc = ordersvc.NewService(repository, logger) } var h http.Handler { endpoints := transport.MakeEndpoints(svc) h = httptransport.NewService(endpoints, logger) } errs := make(chan error) go func() { c := make(chan os.Signal) signal.Notify(c, syscall.SIGINT, syscall.SIGTERM) errs <- fmt.Errorf("%s", <-c) }() go func() { level.Info(logger).Log("transport", "HTTP", "addr", *httpAddr) server := &http.Server{ Addr: *httpAddr, Handler: h, } errs <- server.ListenAndServe() }() level.Error(logger).Log("exit", <-errs) }

これで、サービスが開始され、トランスポートレベルでHTTPプロトコルが使用されます。別のトランスポートを使用して同じサービスを開始できます（たとえば、gRPCまたはApache Thriftを使用してサービスを公開できます）。

入門記事では、Goキットプリミティブを既に十分に使用していますが、透過的で信頼性の高いパターンのシステムを作成するためのより多くの機能、サービス検出、負荷分散なども提供します。 Goキットのこれらおよびその他の事項については、次の記事で説明します。

ソースコード

サンプルのソースコード全体は、GitHubでここで表示できます。

Goキットのミドルウェア

Goキットは、階層化などのシステム設計の優れた原則を使用する傾向があります。ミドルウェアを使用して、サービスコンポーネントとエンドポイントの分離が可能です（ 約レーンメディエーターパターン ）。 Goキットのミドルウェアは、ロギング、リクエストの中断、リクエスト数の制限、ロードバランシングまたは分散トレースなど、サービスとエンドポイントをラップし、機能（分離コンポーネント）を追加できる強力なメカニズムを提供します。

以下は、 Goキットの Webサイトの写真です。Goキットのミドルウェアを使用した典型的な「オニオンアーキテクチャ」として描かれています。

Spring Boot Microservices Syndromeに注意してください

Goキットと同様に、Spring BootはJavaの世界におけるマイクロサービスツールキットです。ただし、Goキットとは異なり、Spring Bootは非常に成熟したフレームワークです。また、多くのJava開発者は、Spring Bootを使用して、使用からの肯定的なフィードバックを伴うJavaスタックを使用してワールドサービスを作成します。マイクロサービスの使用を誤って解釈する多くの開発チームがいます。それらはSpring BootとOSS Netflixを使用してのみ開発でき、分散システムを開発する際のパターンとしてマイクロサービスを認識しません。

したがって、Goキットや何らかのフレームワークなどのツールセットを使用すると、設計テンプレートとして開発をマイクロセキュリティに向けることができます。マイクロサービスは、コマンドとシステムの両方のスケーリングの問題を多く解決しますが、マイクロサービスベースのシステムのデータはさまざまなデータベースに散在しているため、多くの問題も発生します。それはすべて、サブジェクト領域の問題とシステムのコンテキストに依存します。クールなのは、マイクロサービスを作成するためのツールとして設計されたGoキットが、システムの優れたアーキテクチャ設計で作成されたエレガントなモノリスの作成にも適していることです。

また、要求の中断や制限などのGoキットの機能は、Istioなどのサービスメッシュプラットフォームでも利用できます。したがって、Istioのようなものを使用してマイクロセキュリティを実行する場合、Goキットの一部は必要ないかもしれませんが、サービスメッシュを使用してサービス間通信を作成するのに十分なチャンネル幅があるとは限りません1つのレベルと追加の複雑さ。

PS

翻訳の著者は、原文の著者の意見を共有することはできません。この記事は、ロシア語コミュニティGoのみを対象とした教育目的で翻訳されています。

UPD

これは翻訳セクションの最初の記事でもあり、翻訳に関するフィードバックに感謝します。

Goキットを使用したGoのマイクロサービス：はじめに