Designing libraries in Go way

at Gopherಓ৔ ಉ૭ձ2021 Go Β͍͠ϥΠϒϥϦΛ  ͭ͘ΔͨΊʹߟ͑Δ͜ͱ

LUS !LUS@!LUS .FSQBZ$PEFQBZNFOU5FBN #BDLFOE XIPBNJ

at Gopherಓ৔ ಉ૭ձ2021 Go Β͍͠ϥΠϒϥϦΛ  ͭ͘ΔͨΊʹߟ͑Δ͜ͱ

w Ͱ΋Ͳ͏͢Ε͹ʜʁ w (PΒ͍͠ॻ͖ํɺϦϙδτϦͷઃఆɺ഑෍ͷ࢓ํʜ w ϦϙδτϦʹΑͬͯ͞·͟· (P੡ϥΠϒϥϦΛެ։͍ͨ͠ʂ

(PQIFS͔Βݟͯɺ  ͲΜͳϥΠϒϥϦͩͱخ͍͠ͷ͔ΛΫϦΞʹ͢Δ ͜ͷτʔΫͰ఻͍͑ͨ͜ͱ

(PQIFS͔Βݟͯɺ  ͲΜͳ044ͩͱخ͍͠ͷ͔ΛΫϦΞʹ͢Δ ͜ͷτʔΫͰ఻͍͑ͨ͜ͱ ࣮ࡍʹ044Λग़͢ࡍͷ໎͍Λখ͘͢͞Δʂ

w $-*πʔϧݻ༗ͷϓϥΫςΟε w ಛఆͷϥΠϒϥϦ΍ϑϨʔϜϫʔΫͷ۷ΓԼ͛ ͜ͷτʔΫͰѻΘͳ͍͜ͱ

ϥΠϒϥϦઃܭͰؾΛ͚͍ͭͯΔ͜ͱ 044ͱͯ͠ެ։͢ΔͨΊʹ ·ͱΊ ໨࣍

ϥΠϒϥϦઃܭͰؾΛ͚͍ͭͯΔ͜ͱ

Τϥʔ

w αʔυύʔςΟͷΤϥʔϥΠϒϥϦ΍YFSSPST͸ ͔ͭΘͳ͍ w ϥΠϒϥϦͷϢʔβʹͦͷΤϥʔϥΠϒϥϦͷ  ࢖༻Λڧ੍ͤͯ͞͠·͏ͨΊ Ͱ͖ΔݶΓඪ४ΤϥʔͷΈΛ͔ͭ͏

w Ͱ͖ΔݶΓerrorsύοέʔδͷ"1*ͱޓ׵ੑ Λ࣋ͭ΋ͷΛબͿ w errors.Asɺerrors.Isɺerrors.Unwrap ඪ४ΤϥʔҎ֎Λ͔ͭ͏৔߹

$POUFYU

w DPOUFYUΩϟϯηϧػߏΛந৅Խͨ͠΋ͷ w ࣮ߦʹ௕͍͕͔͔࣌ؒΔՄೳੑͷ͋Δ΋ͷ͸ DPOUFYUΛαϙʔτ͢΂͖ $POUFYUBXBSF

ྫLUSBQJHFO

w (P੡ϥΠϒϥϦ w DVSMίϚϯυΛ࣮ߦͨ݁͠Ռ͔Β(P"1*ΫϥΠΞϯτ Λࣗಈੜ੒͢Δ LUSBQJHFO

$ curl https://api.github.com/repos/ktr0731/apigen { "id": 312020626, "node_id": "MDEwOlJlcG9zaXRvcnkzMTIwMjA2MjY=", "name": "apigen",
"full_name": "ktr0731/apigen", "private": false, "owner": { "login": "ktr0731", "id": 12953836, "node_id": "MDQ6VXNlcjEyOTUzODM2", …

w ಺෦Ͱ"1*ϦΫΤετΛߦ͍ͬͯΔͨΊ w ͙͢ʹ݁Ռ͕ฦͬͯ͘Δͱ͸ݶΒͳ͍ w DPOUFYUΛड͚औΔ͜ͱͰ্ҐϨΠϠʔʹΩϟϯηϧɾ λΠϜΞ΢τͷ࢓૊ΈΛఏڙͰ͖Δ ͳͥDPOUFYUBXBSFͳؔ਺ͳͷ͔ʁ

Φϓγϣϯ

w ߏ଄ମ w GVODUJPOBMPQUJPOQBUUFSO Φϓγϣϯ

w $PNNBOEܕͷϑΟʔϧυͰΦϓγϣϯ஋Λड͚Δ w TQGDPCSB

w ؔ਺ͱՄม௕Ҿ਺ͷ૊Έ߹ΘͤͰΦϓγϣϯΛදݱ w ΦϓγϣϯܕΛΤΫεϙʔτ͢Δඞཁ͕ͳ͍ w ؆ܿͰ໌շͳهड़ʹͳΔ GVODUJPOBMPQUJPOQBUUFSO

LUSBQJHFO

w Ұ௕Ұ୹ w Φϓγϣϯ͕ଟ͍৔߹ɺߏ଄ମͷ΄͏͕ݟ௨͕͠ྑ͍ w (PGNU͕ϑΟʔϧυΛଗ͑ͯ͘ΕΔ w ͦΕҎ֎͸GVODUJPOBMPQUJPOQBUUFSO͕ྑͦ͞͏ ߏ଄ମWTGVODUJPOBMPQUJPOQBUUFSO

w Φϓγϣϯ΋࢓༷ͷҰ෦ w ૿΍ͨ͢ͼʹϥΠϒϥϦͷෳࡶੑ͕૿͢ w ඞཁ࠷௿ݶʹอͭ ΦϓγϣϯΛ૿΍͗͢͠ͳ͍

ྫ"1*ΫϥΠΞϯτͷϦτϥΠ

ϦτϥΠʹؔ͢ΔΦϓγϣϯ͕  ͨ͘͞Μ͋ͬͯෳࡶʜ🤔

Φϓγϣϯ͕Ұ͚ͭͩʹͳͬͯ  Θ͔Γ΍͘͢ͳͬͨ☺

DFOLBMUJCBDLP⒎ʹґଘͯ͠͠·͍ͬͯΔ😨

w )551ϦΫΤετʹࣦഊͨ͠ͱ͖ʹҰఆ࣌ؒ଴ͪɺ  ࠶౓ϦΫΤετΛ౤͛Δ ϦτϥΠʹ͍ͭͯ΋͏Ұ૚ਂ͘ߟ͑Δ

w )551ϦΫΤετʹࣦഊͨ͠ͱ͖ʹҰఆ࣌ؒ଴ͪɺ  ࠶౓ϦΫΤετΛ౤͛Δ w ϦτϥΠ͸)551ϦΫΤετͷͨΊʹ͔͠࢖ΘΕͳ͍ ϦτϥΠʹ͍ͭͯ΋͏Ұ૚ਂ͘ߟ͑Δ

w )551ϦΫΤετʹࣦഊͨ͠ͱ͖ʹҰఆ࣌ؒ଴ͪɺ  ࠶౓ϦΫΤετΛ౤͛Δ w ϦτϥΠ͸)551ϦΫΤετͷͨΊʹ͔͠࢖ΘΕͳ͍ w )551ΫϥΠΞϯτͰ࣮૷Ͱ͖ΔͷͰ͸ʜʁ ϦτϥΠʹ͍ͭͯ΋͏Ұ૚ਂ͘ߟ͑Δ

w )551ϦΫΤετʹࣦഊͨ͠ͱ͖ʹҰఆ࣌ؒ଴ͪɺ  ࠶౓ϦΫΤετΛ౤͛Δ w ϦτϥΠ͸)551ϦΫΤετͷͨΊʹ͔͠࢖ΘΕͳ͍ w )551ΫϥΠΞϯτͰ࣮૷Ͱ͖ΔͷͰ͸ʜʁ w ͦ΋ͦ΋ϦτϥΠʹؔͯ͜͠ͷϥΠϒϥϦͰߟ͑Δඞཁ͋Δʜʁ ϦτϥΠʹ͍ͭͯ΋͏Ұ૚ਂ͘ߟ͑Δ

w ґଘ͕ඪ४ύοέʔδ͚ͩʹͳΔ w ϦτϥΠʹ·ͭΘΔؔ৺ࣄΛ෼཭Ͱ͖Δ w Ϣʔβ͸೚ҙͷϦτϥΠ࣮૷Λબ΂Δ w τϨʔε΍ϩΨʔͳͲΛ࢓ࠐΈ͍ͨ৔߹Ͱ΋ϥΠϒϥϦͷ  Φϓγϣϯ͕૿͑ͳ͍ʂ )551ΫϥΠΞϯτΛड͚औΔϝϦοτ

)551ΫϥΠΞϯτΛड͚औΔΑ͏ʹͯ͠ΈΔ

Ϣʔβ͸IBTIJDPSQHPSFUSZBCMFIUUQͰϦτϥΠΛߦ͏

(PΒ͍͠ΠϯλʔϑΣʔεΛ  ఏڙ͢Δ

w ඪ४ɾ४ඪ४ύοέʔδ͕͓खຊ w ޙํޓ׵ੑͷͨΊʹ࿪ʹͳ͍ͬͯΔՕॴ΋  ΋ͪΖΜ͋ΔͷͰ஫ҙ (PΒ͍͠ΠϯλʔϑΣʔεΛఏڙ͢Δ

ྫLUSBQJHFO

w DVSMίϚϯυ w ੜ੒͢ΔϑΝΠϧͷύοέʔδ໊ w ੜ੒͢Δϝιου໊ w ϝιουͷύϥϝʔλ໊ w FUD
BQJHFOͷೖྗ

ίϚϯυϥΠϯʜʁ $ apigen --package api --out api_gen.go \ "curl example.com/post"
"GetPost" \ "curl -d "{...}" example.com/posts" "CreatePost"

ίϚϯυϥΠϯʜʁ $ apigen --package api --out api_gen.go \ "curl example.com/post"
"GetPost" \ "curl -d "{...}" example.com/posts" "CreatePost" ੜ੒ର৅"1*͕૿͑ΔͨͼʹҾ਺͕૿͑Δ🤔 ҉໧తʹʮDVSMίϚϯυʯʮϝιου໊ʯͷϖΞΛཁٻ͍ͯͯ͠௚ײతͰ͸ͳ͍ʜ

֎෦ϑΝΠϧʜʁ $ apigen --package api --out api_gen.go definition.yaml

֎෦ϑΝΠϧʜʁ $ apigen --package api --out api_gen.go definition.yaml ࣮ߦ࣌ʹ͔͠ଥ౰ੑ͕ݕূͰ͖ͳ͍ͷͰ࢖͍ͮΒ͍🤔

w DVSMίϚϯυΛ࣮ߦͨ݁͠Ռ͔Β(P"1*ΫϥΠΞϯτ Λࣗಈੜ੒͢Δ BQJHFOͷ૝ఆϢʔβΛࢥ͍ग़͢

w DVSMίϚϯυΛ࣮ߦͨ݁͠Ռ͔Β(P"1*ΫϥΠΞϯτ Λࣗಈੜ੒͢Δ w Ϣʔβ͸(PͰ։ൃΛ͍ͯ͠Δ͜ͱΛલఏʹͰ͖Δ w (PΛ͏·͘࢖ͬͨྑ͍ղܾࡦ͕͋Γͦ͏ʜ BQJHFOͷ૝ఆϢʔβΛࢥ͍ग़͢

w ४ඪ४ύοέʔδͷBOBMZTJTΛར༻ w BOBMZTJT"OBMZ[FSΛड͚औ͍ͬͯΔ HPWFUͷ࣮૷

w ϑΟʔϧυͰ͞·͟·ͳઃఆΛ  ߦ͍ͬͯΔ BOBMZTJT"OBMZ[FS

w BOBMZTJTύοέʔδͷΑ͏ʹઃఆΛߦ͏ܕΛ  ఆٛ͠ɺΤϯτϦϙΠϯτؔ਺΁౉͢ ྑͦ͞͏ͳղܾࡦ

"1*ఆٛΛߦ͏

ίʔυੜ੒ʂ

w ੩తܕ෇͚͞ΕͨίʔυδΣωϨʔλ w "1*ఆٛΛॻ͍ͯapigen.Generate΁౉͚ͩ͢ w ΦϓγϣϯͰio.WriterΛड͚औͬͨΓ͢Δ͜ͱ΋Մೳʂ ސ٬͕ຊ౰ʹཉ͔ͬͨ͠΋ͷ

ྫLUSHPGV[[ZpOEFS

w (P੡ϥΠϒϥϦ w G[GͷΑ͏ͳGV[[ZpOEFSΛ(P੡$-*πʔϧ ʹ૊ΈࠐΊΔ LUSHPGV[[ZpOEFS

֤ީิΛදࣔ͢ΔͨΊʹ͸ʜ🤔

ಠࣗܕͰީิΛ౉ͯ͠΋Β͏ʁ

Ϣʔβ͸ຖճ[]*CandidateΛͭ͘Βͳ͍ͱ ͍͚ͳ͍ͷͰ͋·Γ࢖͍উख͕ྑ͘ͳ͍ʜ

w δΣωϦΫε͸ ·ͩ ͳ͍ ೚ҙͷܕͷεϥΠεΛѻ͏ʹ͸ʜʁ

w δΣωϦΫε͸ ·ͩ ͳ͍ w ඪ४ύοέʔδʹ೚ҙͷܕͷεϥΠεΛѻ͍ͬͯ Δؔ਺͕͋ͬͨΑ͏ͳʜʁ ೚ҙͷܕͷεϥΠεΛѻ͏ʹ͸ʜʁ

TPSU4MJDF

εϥΠεͷܕʹ͸ؔ༩ͤͣɺީิJͷλΠτϧΛ ܾఆ͢ΔͨΊͷؔ਺Λड͚औΔΑ͏ʹ

εϥΠεͰ͋Ε͹ͳΜͰ΋౉ͤΔΑ͏ʹʂ

044ͱͯ͠ެ։͢ΔͨΊʹ

w (JU)VC͕ެ։͍ͯ͠Δ044ͷΨΠυ w 044ͷ8)"58):ɺߩݙํ๏ɺϓϩδΣΫτͷ  ্ཱͪ͛ํͳͲΛ໢ཏ͍ͯ͠Δ w ୯७ʹಡΈ෺ͱͯ͠΋͓΋͠Ζ͍ 0QFO4PVSDF(VJEFTΛಡΉ

https://opensource.guide/ja/starting-a-project/

w ϓϩδΣΫτͷґଘ؅ཧͷͨΊ w όʔδϣϯ؅ཧ͞ΕͨϞδϡʔϧͱͯ͠ఏڙ͢ΔͨΊ (PNPEVMFTʹରԠ͢Δ

$ go mod init && go mod tidy (PNPEVMFTʹରԠ͢Δ

$ go mod init && go mod tidy (PNPEVMFTʹରԠ͢Δ ˞λά෇͚ʹ͍ͭͯ͸ޙड़

w ࣗ෼ͷ044͕ґଘ͍ͯ͠ΔϞδϡʔϧͷ  ϥΠηϯε΋දه͢΂͖ w 4POHNVHPDSFEJUT͕΂ΜΓ ґଘϞδϡʔϧͷϥΠηϯεදه

$ gocredits -w . ґଘϞδϡʔϧͷϥΠηϯεදه

w (PNPEVMFTͰMJOUFSͳͲͷπʔϧ܈΋؅ཧ͢Δ w Ϗϧυ΍ςετͷ࠶ݱੑΛ΋ͨͤΔͨΊ (Pπʔϧͷґଘ؅ཧ

https://github.com/golang/go/wiki/Modules#how-can-i-track-tool-dependencies-for-a-module

w (JUλάΛ੾ͬͯQVTI͢Ε͹৽͍͠Ϟδϡʔϧ ͱͯ͠ೝࣝ͞ΕΔ ϥΠϒϥϦͷ഑෍

w (P3FMFBTFSΛ͔ͭ͏ͱΑΓྑ͍͔΋ w (JU)VC3FMFBTFTͷ࡞੒ɺ$IBOHFMPHͷ࡞੒Λ Α͠ͳʹ΍ͬͯ͘ΕΔ ϥΠϒϥϦͷ഑෍

$ cat .goreleaser.yaml builds: - skip: true $ git tag
v0.1.0 main $ goreleaser ϥΠϒϥϦͷ഑෍

w 044ͱͯ͠ग़͢ϥΠϒϥϦ͸ϢʔβͷͨΊʹ  υΩϡϝϯτΛॻ͘΂͖ υΩϡϝϯτ

w Ϣʔβͷࢹ఺ͰυΩϡϝϯτΛಡΊΔ w (P%PD͚ͩͰ࢖͍ํ͕ཧղͰ͖Δ͔ʁ w ެ։͢Δඞཁͷͳ͍΋ͷͳ͍͔ʁ w ࢓༷ͷ࿙Ε͸ͳ͍͔ʁ (P%PDΛ࢖ͬͨυΩϡϝϯτͷચ࿅

w ਓʑ͸υΩϡϝϯτΛಡ·ͳ͍ w &YBNQMFςετ͕͋Ε͹ɺͦͷϥΠϒϥϦͷ࣭ ͕͋Δఔ౓Θ͔Δ &YBNQMFςετΛ༻ҙ͢Δ

w &YBNQMFςετΑΓෳࡶͳ࢖༻ྫΛஔ͍͓ͯ͘ @FYBNQMFσΟϨΫτϦ

w @΍͔Β࢝·ΔϑΝΠϧɾσΟϨΫτϦ  ͓ΑͼUFTUEBUBͱ͍͏σΟϨΫτϦ͸  (Pπʔϧ͔Βແࢹ͞ΕΔ w @FYBNQMFͱ͍͏໋໊͸׳श ಛघͳϑΝΠϧ໊ɾσΟϨΫτϦ໊ https://golang.org/cmd/go/#hdr-Package_lists_and_patterns

·ͱΊ

w αʔυύʔςΟ΁ͷґଘΛগͳ͘ɾখ͘͞อͭ w ࢓༷Λগͳ͘ɾখ͘͞อͭ w DPOUFYUΛͪΌΜͱαϙʔτ͢Δ w (PΒ͍͠ΠϯλʔϑΣʔεΛఏڙ͢Δ w ඪ४ɾ४ඪ४ύοέʔδ͕ͱͯ΋ࢀߟʹͳΔ
ϥΠϒϥϦઃܭͰؾΛ͚͍ͭͯΔ͜ͱ

w 0QFO4PVSDF(VJEFTΛಡΜͰ͓͘ͱྑ͍͔΋ w (PNPEVMFTͰϥΠϒϥϦͷόʔδϣϯ؅ཧΛ͠Α͏ w υΩϡϝϯτ͸͕Μ͹ͬͯॻ͜͏ w ࣗ෼͸ϒϥογϡΞοϓલʹॻ͘͜ͱ͕ଟ͍ 044ͱͯ͠ެ։͢ΔͨΊʹ

Designing libraries in Go way

Designing libraries in Go way

More Decks by ktr

Other Decks in Programming

Featured

Transcript