Go + grpc-gateway でつくる JSON API 速習会 @ Wantedly / Create JSON API with Go + grpc-gateway

event page: https://wantedly.connpass.com/event/82378/
sample: https://github.com/wantedly/grpc-gateway-study

grpc-gateway: https://github.com/grpc-ecosystem/grpc-gateway
grapi: https://github.com/izumin5210/grapi

Transcript

1. ©2018 Wantedly, Inc. Go + grpc-gateway Ͱͭ͘Δ JSON API αʔό଎शձ How to create microservice with Go in Wantedly 27.Mar.2018 - @izumin5210
2. ©2018 Wantedly, Inc. 1. `git clone https://github.com/wantedly/grpc-gateway-study` 2. `cd grpc-gateway-study` ※ $GOPATH/src/github.com/wantedly/grpc-gateway-study ʹ഑ஔ͢Δ • Go + protobuf ؀ڥ͕͋Δਓ 1. Install izumin5210/grapi: `brew install izumin5210/tools/grapi` 2. `grapi init .` • Docker ؀ڥ͕͋Δͻͱ 3. Install creasty/rid: `brew install creasty/tools/rid` 4. `rid grapi init .` Setup Are you ready?
3. ©2018 Wantedly, Inc. $ whoami a.k.a. usamimi engineer @izumin5210 Engineer at Wantedly, Inc. Wantedly People Tribe: - Web Application Engineer - Profile Data Strategy Group - Developer Productivity Gopher, Rubyist, JavaScripter (and Androider)
4. ©2018 Wantedly, Inc. Agenda ΍͍ͬͯ͘ ͳͥ
   H31$
   ͕ඞཁ͔ͩͬͨ
   ͳͥ
   H31$
   ͚ͩͰ͸μϝ͔ͩͬͨ
   ͳͥ
   HSQDHBUFXBZ
   Λ࢖͏ͷ͔
   ͳͥ
   HSBQJ
   Λ࡞ͬͨͷ͔
   
   ࣮ࡍʹ
   H31$
   
   HSQDHBUFXBZ
   Ͱ༡Ϳ
5. ©2018 Wantedly, Inc. WHY gRPC ͳͥ gRPC Λ࢖͍͍ͨͷ͔
6. ©2018 Wantedly, Inc. ͋ΘͤͯΑΈ͍ͨ  ͳͥϚΠΫϩαʔϏεʁ
    ͳͥ
   3BJMT
   
   ͳͥ
   (P
   ʁ
   ‣ ͦ΋ͦ΋
   %PDLFS
   ؀ڥ͕ૣ͔͘Β͋ͬͨ
    .JDSPTFSWJDFT
   
   LT
   ͷಋೖোน͕গͳ͍
   ‣ ཉ͍͠΋ͷׂ͕Γͱ໌֬
   
   αʔϏεؒ࿈ܞ
    (P
   ͱͷ૬ੑ
   ˕
   㷉◔ϖ◔㷊
   ˞͔ͳΓ୺ં͍ͬͯΔͷͰɼৄ͘͠͸
   3BJMT%.
   ͷߨԋΛ લఏ https://speakerdeck.com/altech/microservices-on-rails-wantedly-falsemaikurosabisushi-li
7. ©2018 Wantedly, Inc.  ʮΩϛ͸ԿΛ͢Δαʔόͳͷʁʯ໰୊
    ʮͨͩͨͩ࡞Δͷ͕໘౗ʯ໰୊ WHY gRPC .JDSPTFSWJDFT
   ͳ
   "1*
   αʔόΛॻ͘ͱ͖ͷ
   O
   ݸͷ՝୊
   XJUI
   (PMBOH
8. ©2018 Wantedly, Inc.  ʮΩϛ͸ԿΛ͢Δαʔόͳͷʁʯ໰୊
    ʮͨͩͨͩ࡞Δͷ͕໘౗ʯ໰୊ WHY gRPC .JDSPTFSWJDFT
   ͳ
   "1*
   αʔόΛॻ͘ͱ͖ͷ
   O
   ݸͷ՝୊
   XJUI
   (PMBOH
9. ©2018 Wantedly, Inc. ࢓༷ɺ͓΅͑ͯ·͔͢ʁ  Ϣʔβʹૣ͘Ձ஋Λಧ͚͍ͨʂ
    ͦͯ٘͠ਜ਼ʹͳΔυΩϡϝϯτ
    ༨ܭͳίϛϡχέʔγϣϯίετ
    ʮ͜ͷ
   "1*
   ͬͯԿ͕ฦͬͯ͘ΔΜ͚ͩͬʯ
    +40/
   4DIFNB
   ΍
   4XBHHFS
   ΋͍͍͚Ͳʜ
    ʮڧ੍ྗʯ͕ͳ͍ͷͰ༉அ͢Δͱ෗Δ
    Ϩίʔυ͚ͭͩ࡞Δ
   "1*
   ͷςετॻ͖·͢ʁ 8):
   H31$ ʮΩϛ͸ͳʹΛ͢Δαʔόͳͷʁʯ Wantedly People Web൛͸AndroidΞϓϦͷίʔυΛࢀߟʹ࣮૷͞Ε͍ͯ·͢ ͳͥͳΒͦ͜ʹ͸ܕ͕͔͋ͬͨΒ
10. ©2018 Wantedly, Inc. Ϣʔβ͕ͨ͘͞Μ͍Δ  ϞόΠϧΞϓϦ͚ͩͰͳ͘ɼ
 ΄͔ͷϚΠΫϩαʔϏε΋Ϣʔβʢ"1*ར༻ऀʣ
     ͋ΔαʔϏεͷ࣮૷ͷͨΊʹɼ
 ผͷαʔϏεʹ΋खΛೖΕͳ͍͜ͱ͸ଟʑ͋Δ
     ࣗ෼͕ॻ͍ͨ΍ͭͱ͸ݶΒͳ͍
     ʮ͜ͷࢠͲΜͳ
    "1*
    ͚࣋ͬͯͨͬʯ 8):
    H31$ ʮΩϛ͸ͳʹΛ͢Δαʔόͳͷʁʯ ໊ࢗࡱӨͷϑϩʔΛ೺Ѳ͢ΔͨΊͷγʔέϯεਤɼޕલத·Δ·Δ௵ͨ͠ ʢ࣮ࡍͷਤ͸΋͏ͪΐͬͱෳࡶʣ
11. ©2018 Wantedly, Inc.  ʮΩϛ͸ԿΛ͢Δαʔόͳͷʁʯ໰୊
     ʮͨͩͨͩ࡞Δͷ͕໘౗ʯ໰୊ WHY gRPC .JDSPTFSWJDFT
    ͳ
    "1*
    αʔόΛॻ͘ͱ͖ͷ
    O
    ݸͷ՝୊
    XJUI
    (PMBOH
12. ©2018 Wantedly, Inc. 8):
    H31$ ʮͨͩͨͩ࡞Δͷ͕໘౗ʯ data, err := ioutil.ReadAll(req.Body) if err != nil { http.Error(w, err.Error(), http.InternalStatusInternalServerError) return } book := &Book{} err = json.Unmarshal(data, book) if err != nil { http.Error(w, err.Error(), http.InternalStatusInternalServerError) return } // ここから本当にやりたい処理 net/http Λͦͷ··࢖ͬͨ৔߹
13. ©2018 Wantedly, Inc. 8):
    H31$ ʮͨͩͨͩ࡞Δͷ͕໘౗ʯ book := &Book{} err = c.BindJSON(book) if err != nil { c.JSOAbortWithErrorN(http.InternalStatusInternalServerError, err) return } // ここから本当にやりたい処理 github.com/gin-gonic/gin Λ࢖ͬͨ৔߹ ͪΐͬͱϚγ
14. ©2018 Wantedly, Inc. 
    HSBQJ
    H
    TDBGGPMETFSWFS
    CPPL "1*
    ͷఆٛ
    
    ࣮૷εέϧτϯΛੜ੒͢Δ 8):
    H31$ خ͠͞Λମײͯ͠ΈΑ͏
15. ©2018 Wantedly, Inc. *%- *OUFSGBDF
    %FGJOJUJPO
    -BOHVBHF
    ͕௒༏ल BQJQSPUPTCPPLQSPUP
    Λ։͍ͯΈΑ͏  QSPUPCVG
    Ͱ
    "1*
    ఆٛΛॻ͍ͯɼ
     ͔͜͜Β
    (P
    ͷ
    JOUFSGBDF
    ͱ࣮૷Λੜ੒ͯ͠ɼ
    w ϧʔςΟϯάͯ͠ʜVONBSTIBM
    ͯ͠ʜ
    w Λɼউखʹॻ͍ͯ͘ΕΔ
     ࣮૷ʢ΄Μͱʹ΍Γ͍ͨ͜ͱʣ͚ͩ΍Ε͹0, 8):
    H31$ H31$
    ͩͱͳʹ͕͏Ε͍͠ʁ api/protosԿ͍ͬͯΔ͔͍͍ͩͨΘ͔ΔͰ͠ΐʁ service BookService { rpc CreateBook (CreateBookRequest) returns (Book) { } } message Book { string book_id = 1; } message CreateBookRequest { Book book = 1; }
16. ©2018 Wantedly, Inc. $PEF
    HFOFSBUPS
    ΋௒༏ल BQJCPPLQCHP
    Λ։͍ͯΈΑ͏ 8):
    H31$ H31$
    ͩͱͳʹ͕͏Ε͍͠ʁ type BookServiceServer interface { CreateBook(context.Context, *CreateBookRequest) (*Book, error) } type Book struct { BookId string `protobuf:"..." json:"book_id,omitempty"` } type CreateBookRequest struct { Book *Book `protobuf:"..." json:"book,omitempty"` }
    ։ൃऀ͸͜ͷ
    JOUFSGBDF
    Λຬͨ͢Α͏ʹ࣮૷͢Δ͚ͩ
17. ©2018 Wantedly, Inc. *OUFSGBDF
    %SJWFO
    %FWFMPQNFOU ࠷ॳʹ
    JOUFSGBDF
    ΛܾΊ͔ͯΒ։ൃɼมߋ͢Δͱ͖͸
    JOUFSGBDF
    Λ࠷ॳʹมߋ
    AJOUFSGBDF
    
    ׬શͳυΩϡϝϯτʢͨͿΜʣA
    ͜ΕΛເ͡Όͳ࣮͘ݱͰ͖Δͷ͕
    H31$
    ͷڧΈ 8):
    H31$ ͳΜ͔ΤϞ͍͜ͱΛݴ͍͍ͨ
18. ©2018 Wantedly, Inc. WHY not gRPC ͳͥ gRPC "͚ͩ" ͩͱμϝͩͬͨͷ͔
19. ©2018 Wantedly, Inc.  ίϛϡχέʔγϣϯίετ
    w QSPUPCVG
    
    όΠφϦ
    w ϞόΠϧΞϓϦ΍
    3BJMT
    αʔόʹڧཁ͢Δͷʁ
    w ૉͷ··ͩͱ
    DVSM
    ΋Ͱ͖ͳ͍ͥ
     Πϯϑϥίετ
    w H31$
    ͸
    )551
    ͷίωΫγϣϯΛӬଓԽ͢Δ
    w NPOJUPSJOH
    ͸ʁɼ
    MPBE
    CBMBODJOH
    ͸ʁʜߟ͑Δ͜ͱ͸ଟ͍
    
    ϝϦοτ͕ଟ͍൓໘ɼٻΊΒΕΔ஌ࣝͱલఏ΋ଟ͍ WHY not gRPC gRPC ͸ϜζΧγΠ
20. ©2018 Wantedly, Inc. WHY grpc-gateway ͳͥ grpc-gateway ΛڬΉͷ͔
21. ©2018 Wantedly, Inc. 8):
    HSQDHBUFXBZ ͳͥ
    HSQDHBUFXBZ
    ΛڬΉʁ https://github.com/grpc-ecosystem/grpc-gateway
22. ©2018 Wantedly, Inc. 8):
    HSQDHBUFXBZ ͳͥ
    HSQDHBUFXBZ
    ΛڬΉʁ https://github.com/grpc-ecosystem/grpc-gateway H31$
    αʔόͷલஈʹཱͭ
    3FWFSTF
    1SPYZ
    Λੜ੒ͯ͘͠ΕΔ
23. ©2018 Wantedly, Inc. 8):
    HSQDHBUFXBZ ͳͥ
    HSQDHBUFXBZ
    ΛڬΉʁ https://github.com/grpc-ecosystem/grpc-gateway Ϣʔβʢ"1*
    ୟ͘ਓʣ͔Β͸
    )551
    
    ܦ༝Ͱ
    +40/
    Λ஻͍ͬͯΔΑ͏ʹΈ͑Δ
    
    ैདྷ௨Γͷ஌ࣝɾલఏͰ
    "1*
    Λར༻Ͱ͖Δʂʂ
24. ©2018 Wantedly, Inc. 8):
    HSQDHBUFXBZ ͳͥ
    HSQDHBUFXBZ
    ΛڬΉʁ service BookService { rpc CreateBook (CreateBookRequest) returns (Book) { option (google.api.http) = { post: "/books" body: "book" }; } } gRPC -> HTTP ͷϚοϐϯά͸ ϝιου͝ͱʹ option ͻͱͭॻ͚ͩ͘
25. ©2018 Wantedly, Inc. ࣮ࡍʹಈ͔ͯ͠ΈΑ͏ 8):
    HSQDHBUFXBZ
26. ©2018 Wantedly, Inc. 
    HSBQJ
    TFSWFS αʔόΛىಈͯ͠ΈΔ
    
    Acurl http://localhost:3000/booksA 8):
    HSQDHBUFXBZ ͓΋ΉΖʹ࿩͔͚ͯ͠ΈΑ͏
27. ©2018 Wantedly, Inc. 8):
    HSQDHBUFXBZ ͓΋ΉΖʹ࿩͔͚ͯ͠ΈΑ͏ // app/run.go func Run() error { s := grapiserver.New( grapiserver.WithDefaultLogger(), grapiserver.WithServers( server.NewBookServiceServer(), // <- 追加 ), ) return s.Serve() } ※ goimport ࢖ͬͯͳ͍ਓ͸ import Λࣗ෼Ͱॻ͔ͳ͍ͱ͍͚ͳ͍͔΋
28. ©2018 Wantedly, Inc. ✏
    ࣮ࡍʹϞοΫͳ
    "1*
    Λॻ͍ͯΈΑ͏
     ABookA
    ʹॻ໊Λ௥Ճͯ͠ΈΑ͏
    w )*/5
    Agrapi protocA
    Λ࣮ߦ͢Δͱίʔυ͕࠶ੜ੒͞ΕΔ
     AGET /booksA
    Ͱద౰ͳຊΛฦͯ͠ΈΑ͏
     APOST /booksA
    ͰύϥϝʔλΛड͚औͬͯΈΑ͏ 8):
    HSQDHBUFXBZ H31$
    
    HSQDHBUFXBZ
    Ͱ༡΅͏
29. ©2018 Wantedly, Inc. WHY grapi ͳͥ grapi ͕ඞཁͩͬͨͷ͔
30. ©2018 Wantedly, Inc. 8):
    HSBQJ H31$
    
    HSQDHBUFXBZ
    ͷऑ఺
    ͦͷᶃ # ↓これは grapi protoc # ↓こいつらをラップしている protoc \ -I ./vendor/github.com/grpc-ecosystem-grpc-gateway \ -I ./vendor/github.com/grpc-ecosystem-grpc-gateway/thrid_party/googleapis \ --go_out=plugins=grpc:. protoc \ -I ./vendor/github.com/grpc-ecosystem-grpc-gateway \ -I ./vendor/github.com/grpc-ecosystem-grpc-gateway/thrid_party/googleapis \ --grpc-gateway_out=logtostderr=true:grpc:. ίʔυੜ੒ͷίϚϯυ͕௒೉͘͠ɼຖճ Makefile ॻ͘ͷ΋͠ΜͲ͍… ͜ΕΛ `grapi protoc` ͱ͍͏ίϚϯυʹ Ӆṭ (protoc-grpc-* ʹύεΛ௨͢ͷ΋΍Δ)
31. ©2018 Wantedly, Inc. αʔόΛىಈ͢Δίʔυ͕௕͍
    
     Anet.ListenerA
    ͕গͳ͘ͱ΋ͭඞཁ
    w H31$
    
    HSQDHBUFXBZ
    Λͭͳ͙΍ͭɼHSQDHBUFXBZ
    ͕֎ͱ௨৴͢Δ΍ͭ
    w H31$
    ͱ
    )551
    ྆ํ֎͔Β࢖͑ΔΑ͏ʹ͠Α͏ͱ͢Δͱߋʹ໽հ
    w ͜Ε͕ಉ͡ϙʔτͩͱߋʹ
    
     H31$
    TFSWFS
    ͱ
    HBUFXBZ
    ྆ํʹ࣮૷Λొ࿥͢Δඞཁ͕͋Δ
    w ยํͰ΋࿙ΕΔͱαʔό͕ฦࣄͯ͘͠Εͳ͍ 8):
    HSBQJ H31$
    
    HSQDHBUFXBZ
    ͷऑ఺
    ͦͷᶄ
32. ©2018 Wantedly, Inc. HSBQJ
    TFSWFS
    ͷىಈ BQQSVOHP
    ΛݟͯΈΑ͏  Կ΋͠ͳ͚Ε͹
     H31$
    VOJY
    UNQTFSWFSTPDL
     (BUFXBZ
    UDQ
    
     Ұߦॻ͚ͩ͘ͰʮͲͪΒ΋
    UDQ
    Ͱ
    ʯͱ͔ ΋Մೳ
     TFSWFSIBOEMFS
    ΁ͷ࣮૷ͷొ࿥
     Agrapiserver.ServerA
    ౉͚ͩ͢
     ͸
    Agrapi g (scaffold-)serverA
    Ͱੜ੒ࡁΈ 8):
    HSBQJ HSBQJ
    ͷىಈγʔέϯε func Run() error { s := grapiserver.New( grapiserver.WithDefaultLogger(), grapiserver.WithServers( server.NewBookServiceServer(), ), ) return s.Serve() } ͖ͬ͢Γ
33. ©2018 Wantedly, Inc. QSPUP
    ͱ
    HP
    ͷࣗಈੜ੒ खΛൈ͚Δͱ͜Ζ͸ൈ͖͍ͨ  Agrapi g service bookA
    ͰҎԼ͕ੜ੒͞ΕΔ
     ABookServiceA
    ͷ਽ܗ
     ͷ࣮૷
    ABookServiceServerA
    ͷ਽ܗ
     Agrapi g scaffold-service bookA
    ΋͋Δ
     ʮ(PPHMF
    "1*
    ઃܭΨΠυʯͷඪ४ϝιου͕
 ͍͍ײ͡ʹੜ͑Δ 8):
    HSBQJ ASBJMT
    OFXA
    ͱ͔
    ASBJMT
    HA
    ͍ͬͯ͢͝ΑͶ 3BJMTʢͱ͍͏͔3&45
    ʹ׳Ε͍ͯΔਓͳΒೃછΈ΍͍͢
    https://cloud.google.com/apis/design/standard_methods
34. ©2018 Wantedly, Inc. TFSWJDFY ઈରඞཁͳύοέʔδΛॳظԽ͢Δ܅  αʔϏεΛ࡞Δͨͼʹ΍Δ͜ͱ
     .POJUPSJOH
    /FX
    3FMJD
     &SSPS
    SFQPSUJOH
    )POFZCBEHFS
     "DDFTT
    MPHHJOH
     ͜ΕΒͷઃఆΛ؀ڥม਺ݟ͍͍ͯײ͡ʹ΍Δ
     HJUIVCDPNXBOUFEMZTFSWJDFY
    QSJWBUF
     ͍·ͷͱ͜Ζ
    (P
    ޲͚ͷΈଘࡏ
     1ZUIPO
    ͱ
    /PEFKT
    ͸Ͳ͔͜Ͱݕূத ิ଍ 'PS
    8BOUFEMZ
    &OHJOFFST ͍ͭ͜Β
    
    نఆ͞Εͨ؀ڥม਺Ληοτ͢Δ͚ͩ func Run() error { defer servicex.Close() // <- 追加 s := grapiserver.New( grpcx.WithDefault() // <- 追加 grapiserver.WithServers( server.NewBookServiceServer(), ), ) return s.Serve() }
35. ©2018 Wantedly, Inc. ิ଍ %#
    ͱ͔ʹͭͳ͍͗ͨ
    AfooServiceServerImplA
    ʹ
    %#
    ΦϒδΣΫτ౉͢ͱ͍͍Α
    IUUQTHJUIVCDPNXBOUFEMZHSQDHBUFXBZTUVEZUSFFEFWFMPQ // NewBookServiceServer creates a new BookServiceServer instance. func NewBookServiceServer( db *sqlx.DB, ) interface { api_pb.BookServiceServer grapiserver.Server } { return &bookServiceServerImpl{ db: db, } }
36. ©2018 Wantedly, Inc. w H31$
    ʹΑΓ
    *OUFSGBDF
    %SJWFO
    %FWFMPQNFOU
    ͕࣮ݱՄೳ
    w յΕ͍ͯͳ͍׬શͳυΩϡϝϯτ
    w H31$
    ಋೖʹΑΔίετʢΠϯϑϥίετɾલఏ஌ࣝʣ͸
 HSQDHBUFXBZ
    Λ࢖͏͜ͱͰ௿ݮͰ͖Δ
    w ϘΠϥϓϨʔτͷଟ͞ɼQSPUPD
    ͷ೉͠͞͸
    HSBQJ
    ʹΑΓΧόʔ ·ͱΊ
37. ©2018 Wantedly, Inc. 8BOUFEMZ
    5FDI
    #PPL
    
    !
    ٕज़ॻయ 50%0
    ͳΜ͔ॻ͘ ࣍ճ༧ࠂ