the case of microservice design using go

C101832d230db74f754e50126903b991?s=47 Imamura
September 23, 2020

the case of microservice design using go

C101832d230db74f754e50126903b991?s=128

Imamura

September 23, 2020
Tweet

Transcript

  1. 1
 freee 株式会社
 【シューマイ】Tech Lead Engineerから最新技術を学べ!Go編 
 Goを使ったマイクロサービス構築事例


  2. 2
 Shoichi Imamura 今村 翔一
 freee株式会社
 2 • 金融事業部のリードエンジニア
 


    • 2017年4月にfreeeに新卒で入社(エンジニア1期目)
 
 • 入社以来アプリケーションエンジニアとして、フロントエンド、バックエンドの 開発に携わる
 
 • 2018年頃に会計freeeにある機能を別アプリケーションとして切り出す際に 設計を見直しながらGoで書き直した経験からGoが好きに
 
 • 2019年頃に金融事業部に配属され、Goでマイクロサービスを開発する
 
 • 現在は福利厚生freeeというサービス(これはRailsアプリケーション)の開 発に従事している

  3. 3
 freeeのGoを使った
 マイクロサービスの取り組みと、実際の開発事例
 今回話したいこと


  4. 4
 4 アジェンダ
 
 1. サービス概要
 2. システム構成と設計
 3. 社外システム向けのAPIの実装


  5. 5
 5
 サービス概要
 01 Section

  6. freee 株式会社


  7. 7 創業からIPOまで、中小企業活性化のためのサービスを一気通貫で提供
 freee会社概要
 161億603万円 (資本準備金等含む) 従業員数 事業内容 クラウド型バックオフィスサービスの開発・販売 資本金 設立年月日

    2012年7月 506名(2019年6月末時点) 「働きがいのある会社」 2017年 ランキング3位 2018年 ランキング8位 2019年 ランキング4位
  8. 8 About Products
 ❂ 納税する
 ↗ 育てる
 ↻ 運営する 


    ✩ はじめる
 会社設立 freee
 開業 freee
 クラウド会計ソフト freee 
 人事労務 freee
 (マイナンバー管理 freee 含む) 
 クラウド申告 freee
 
 * 2017年8月より、クラウド給与計算ソフト freeeは、機能を強化し、「人事労務 freee」というサービス名に変更しました。
 スモールビジネスの創業からIPOまで一気通貫でサポートする7つのプロダクト
 2013.3リリース
 2014.5リリース
 2015.6リリース
 中小企業の経理業務を効率 化。帳簿や決算書作成、請求 業務に対応。
 給与計算や年末調整、入社手 続きから勤怠管理まで労務労 務管理を大幅に効率化。
 会社設立に必要な書類を5分 で作成できる無料サービス。
 2016.10リリース 2015.9リリース 2017.1リリース 低コストでマイナンバーの収集、管 理、破棄までクラウド上で完結。
 個人事業の開業手続きが無料、簡 単、最速で完了する。
 税務申告書作成業務を効率化。 法人税・消費税・法定調書・申請 届出や電子申告にも対応。
 Webで申し込みでき、最短4営業日で発 行。創業時でも本人確認書類だけで審査 可能。

  9. 9
 資金繰りの課題
 アパレル繊維業 ・外注先でのサンプル製作、商品撮影の先払いが発生 ・受注できる案件は多いが、手元の現金不足のため、見 送りをしている 建設業 ・工事自体が遅れてしまって予定通りの売上が入らない場 合など、期待通りに入金されないときは苦労する ・担保がないため銀行融資を受けることが出来ない

    広告代理業 ・プロジェクトは平均して3か月から6か月はかかるが、制 作会社には先に払わなければいけない ・融資は審査に時間がかかり、手続きも煩雑 売り上げの見込みがたってもすぐに入金されるわけではない

  10. 10
 入金予定の請求書を連携企業が買取
 
 今回紹介するサービス
 連携企業での現金化 買取可能債権のオファー freeeでの請求書発行 (特許出願済み)

  11. 11
 11
 システム構成と設計
 02 Section

  12. 12
 • デプロイ時間がかかる
 ◦ 一 回のリリースあたりに含まれるコミット量が 多い
 ◦ それらの動作が全て保証されるまで待つ必要 がある


    
 • 機能の責任の境界が不明瞭
 ◦ 本来意図しない箇所から参照
 ◦ 障害の影響調査が困難
 業務ドメインが増え続け、機能同士の癒着や関わる開発者の増加
 freeeでのマイクロサービス化の流れ
 • 財務会計 • 確定申告 • 請求書 • 口座連携 • ワークフロー • etc. 会計
 人事労務
 • 管理画面 • Public API • etc... ビジネス
 ロジック
 共通基盤
 • 認証 • 課金 • etc...
  13. 13
 サービス構成
 社外のシステム 会計freee 新サービス 会計データ 債権データ • 社外システムとのステータス連携用のAPIと社内のシ ステムにオファー可能な債権を返すAPIを提供する


    
 • 社外のシステムからアクセスされるデータを別のDBで 管理したい
 
 • 社外のシステムから債権の審査状況などの同期が行 われるので、既存プロダクトの障害などに巻き込まれ たくない
 
 • さらに連携していく構想があったので個別でデプロイ し、技術選定の自由度を確保したい
 マイクロサービスとして独立させることに

  14. 14
 利用した主な技術・ツール
 • アプリケーション
 ◦ go
 ◦ gRPC
 ◦ grpc-gateway


    ◦ wire(この記事で詳しく説明)
 • インフラ
 ◦ terraform
 ◦ helm/helmfile
 ◦ kubernetes
 アプリケーションエンジニアがコード化されたインフラの設定も行う

  15. 15
 なぜ今回のサービスでGoを利用したのか?
 • 静的型付け
 ◦ 事前に型の整合性が検証されているのでプログラムを堅牢にできる
 ◦ コードが表現する情報量が増え、何が入力されて出力されるのか理解しやすい
 
 •

    学習のしやすさ
 ◦ シンプルで理解しやすい言語設計
 ◦ gofmtなどのツールで統一的なコードフォーマットが実現
 ◦ 社内のマイクロサービスで利用されており知見を得やすい
 
 • 社内のマイクロサービス向けのGoで書かれた共通パッケージ
 ◦ いくつかのマイクロサービスで微妙に構成が異なった実装への対処
 ◦ 車輪の再発明を防ぎ、ドメインロジックに集中できる
 ◦ エラー通知、ロギング、SQLの実行 etc.
 他にもGoの魅力はあるが、今回の開発で得られた大きなメリットは以下

  16. 16
 社内の共通パッケージの存在
 gRPCサービスの呼び出し後のロギング
 package interceptor ... // ActivityLogUnaryServerInterceptor returns a

    new unary server interceptor that send activity log by logger. func ActivityLogUnaryServerInterceptor(actLogger *logger.Logger) grpc.UnaryServerInterceptor { return func(ctx ..., req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp ..., err error) { ... defer func() { ... printActivityLog(ctx, actLogger, startTime.Format(time.RFC3339), processTime, err, resp, req) }() return handler(ctx, req) } }
  17. 17
 社内の共通パッケージの存在
 // Mapper is a generalized interface to map

    between a Go struct and a SQL line. type Mapper interface { // Table returns metadata of a table that the struct corresponds to. Table() *Table // Values returns column values except for the PK. The order is as same as the Column() result. Values() []interface{} ... } // InsertStruct inserts a new entity. func InsertStruct(ctx context.Context, db Execer, mapper orm.Mapper) error { ... res, err := db.ExecContext(ctx, buf.String(), vals...) ... }
 構造体からのSQLの組み立てと実行

  18. 18
 18
 社外システム向けのAPIの実装
 03 Section

  19. 19
 • システム内部ではgRPCを利用
 ◦ Protocol Buffers のようなインターフェース定義語(IDL)で通信内容を定義できる
 ◦ HTTP/2で通信することができ、リクエストとレスポンスを一つのTCPコネクション上で 多重化できる


    ◦ 複数言語に対応している
 
 • システム外部用にはRESTfulでJSONをペイロードとするAPIを利用
 ◦ 連携先が使っている言語やフレームワークに依存したくない
 ▪ より一般的
 ▪ gRPCのクライアント側のコードを配布するのは現実的ではない
 gRPCとJSON APIの共存

  20. 20
 • システム内部(gRPC)からもシステム外部(JSON API) からも同じ処理をする場合、それを呼び出す別々のAPI を用意をする必要
 ◦ コントローラー層の実装量が増える
 
 •

    開発者はAPIの実装方法を切り替える必要がある
 ◦ JSON APIはURIとJSONの構造を決め、それに応じ て実装
 ◦ gRPCの場合は、Protocol Buffersを定義し、インター フェースを生成し、それに応じて実装
 それぞれgRPCとJSON API用のコントローラーを用意する必要がある
 単純に実装した場合の課題
 port A port B gRPC用のコントローラー JSON API用のコントローラー 共通の処理 Proto Request
 JSON Request

  21. 21
 単純に実装した場合の課題
 import ( ... ) type Message struct {

    ... } func echo(w http.ResponseWriter, r *http.Request) { var m Message err := json.NewDecoder(r.Body).Decode(&m) ... fmt.Fprintf(w, “%+v”, m) } func main() { mux := http.NewServeMux() // http.ServMux構造体にパスとhandlerを登録する mux.HandleFunc("/echo", echo) ... }
 JSON APIの場合は、JSONのデシリアライズをするHTTPハンドラーの実装が必要

  22. 22
 単純に実装した場合の課題
 gRPCの場合は、Protocol Buffersからインターフェースの生成と実装が必要
 // proto/echo.proto message Message { ...

    } service EchoService { rpc Echo(Message) return (Message) {} } // proto/echo.pb.go package proto type EchoService interface { Echo(context.Context, *Message) (*Message, error) } // rpc/echo.go type echoServer struct { ... } // Protocol Buffersが生成したgRPC serviceのインターフェースの実装 func (s *echoServer) Echo(ctx context.Context, msg *proto.Message) (*propto.Message, error) { return msg, nil }
  23. 23
 grpc-gatewayの導入
 • JSON API を受け取ってgRPCメ ソッドの呼び出しをするリバースプ ロキシを生成する
 
 •

    具体的には、Protocol Buffersに パスやパラメータなどの注釈を追 加すると、対応するgRPC呼び出し をするHTTPハンドラのコードを生 成する
 画像は公式ドキュメントより https://grpc-ecosystem.github.io/grpc-gateway/ 

  24. 24
 grpc-gatewayの導入
 syntax = 'proto3'; package proto; option go_package =

    "proto"; import "google/api/annotations.proto"; service EchoService { rpc Echo(...) returns (...) { // Protocol Buffersにannotationを追加 option (google.api.http) = { get: "/echo" }; } rpc UpdateMessage(...) returns (...) { option (google.api.http) = { put: "/echo/{id}" // query string でのパラメータ body: "*" // request body でのパラメータ }; } }
  25. 25
 grpc-gatewayの導入
 // 対応するパスとHTTPハンドラが生成される package proto func RegisterEchoServiceHandlerServer(ctx context.Context, mux

    *runtime.ServeMux, server EchoServiceServer) error { mux.Handle("GET", pattern_EchoService_Echo_1, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) { ... // 対応するgRPC Serviceのメソッドが呼び出される resp, md, err := local_request_EchoService_Echo_1(rctx, inboundMarshaler, server, req, pathParams) ... // gRPC Serviceのメソッド呼び出しの結果をリクエストとして返す forward_EchoService_Echo_1(ctx, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...) }) }
  26. 26
 grpc-gatewayの導入
 webサーバーを起動する
 func Run(...) error { // grpc-gatewayのruntime.ServeMux構造体を生成する mux

    := runtime.NewServeMux(opts...) // 先ほどのパスとHTTPハンドラを登録する関数にgRPC Serviceの実装を渡す proto.RegisterEchoServiceHandlerServer(ctx, mux, newEchoService()) // runtime.ServeMux構造体(http.Handlerインターフェースを実装)をhttp.Server構造体に渡す s := &http.Server{ Addr: addr, Handler: mux, } // サーバーの起動 return s.ListenAndServe() }
  27. 27
 全てのAPIはgRPC経由で通信される
 コントローラー層の共通化
 • システム内部(gRPC)からもシステム外部(JSON API)からも同じ役割のAPIは一つのコ ントローラーで実装できる
 
 • 全てのリクエストとレスポンスのスキーマをProtocol

    Buffersで定義できる
 
 • 開発はProtocol Buffersの定義、それが生成したインターフェースの実装という流れに統 一できる

  28. 28
 28
 まとめ
 04 Section

  29. 29
 まとめ
 • freeeではGoを使ってマイクロサービスを開発
 ◦ 開発者と機能の増加に伴いマイクロサービス化
 ◦ 車輪の再発明を防ぐために共通パッケージの整備
 
 •

    金融サービスのGoを使った開発
 ◦ gRPCとJSON APIの共存を目指した
 
 • 課題
 ◦ 画面の表示や買取可能性の高い債権をオファーするロジックは会計側のデータを用 いるので完全にマイクロサービス化できていない

  30. 30
  
  
 スモールビジネスを、世界の主役に。
 アイデアやパッションやスキルがあればだれでも、
 ビジネスを強くスマートに育てられるプラットフォーム 161億603万円 (資本準備金等含む) 従業員数 事業内容

    クラウド型バックオフィスサービスの開発・販売 資本金 設立年月日 2012年7月 505名(2019年1月末時点)