Goでのチーム開発に途中参画した私が納得して実装を進めるためにやったこと ~ 命名編 ~

オンボーディング時に抱いた疑問から、Goの思想を再度振り返った上でチーム内で改めてコーディングルールのすり合わせを行った結果の一例の紹介です。

Transcript

1. GoͰͷνʔϜ։ൃʹ్தࢀըͨ͠ࢲ͕ ೲಘ࣮ͯ͠૷ΛਐΊΔͨΊʹ΍ͬͨ͜ͱ ~ ໋໊ฤ ~ 2024/06/07@(Unofficial) Go Conference 2024 Pre Party
2. ࣗݾ঺հ 2 Kaoru Muta ໂా ܆ (ϝϯτε) ੜ·ΕҭͪେࡕͰࠓ΋େࡕʹ͍·͢ 2024೥2݄ʹגࣜձࣾBuySell Technologies join. ങऔج൫/๚໰ങऔʹಛԽͨ͠αʔϏεͷ৽ن։ൃʹैࣄ ങऔɾࠪఆ ങऔछผʹԠͨ͡࠷దͳγεςϜߏங Visit -๚໰ങऔ- Store -ళฮങऔ- ങऔ ϦϢʔεϓϥοτϑΥʔϜCosmos ࣗࣾ։ൃͷϦϢʔεಛԽۀ຿جװγεςϜͰ͋ΓαʔϏε܈ͷू߹ମ @m_t_tion1
3. ຊൃදͷཁ఺ͱϞνϕʔγϣϯ 3 ʮڷ (=Go)ʹೖΒ͹ڷʹै͑ʯΛνʔϜͰୡ੒͢ΔͨΊʹ ίʔσΟϯάʹؔ͢Δҙࢥ౷ҰΛνʔϜ಺ͰߦͬͨΒɺ ίʔυʹҰ؏ੑ͕ग़ͨ & ϨϏϡʔίετͱ೰ΈϙΠϯτ͕গͳ͘ ͳͬͨ࿩ ཁ఺ Ϟνϕ ҎԼͷ఺Λօʹฉ͍ͯΧδϡΞϧʹσΟεΧογϣϯ͍ͨ͠ • ౰ൃදͰऔΓ্͛Δࣄ৅ʹࣅͨૺ۰ͨ͜͠ͱ͕͋Δ͔ ◦ ૺ۰ͨ͠৔߹͸ɺͲ͏ରॲ͔ͨ͠ ◦ ͠ͳ͔ͬͨ৔߹͸ɺެࣜͷϧʔϧʹै͏ͷΈͰ े෼ͩͬͨͷ͔
4. ΦϯϘʔσΟϯά࣌ͷܦݧ 4 • ࠓ·ͰJavaϝΠϯͰॻ͍͍ͯͨΤϯδχΞ • GoͰ࡞͍ͬͯΔ0 → 1ͷ৽ن։ൃͷ్தͰJOIN • طଘίʔυΛ֬ೝ͠ΩϟονΞοϓ ঢ়گ ײ૝ • Go͸දݱੑ͕௿͘ɺॻ͖ํͷ͹Β͖ͭ͸গͳ͍͸ͣ (গͳ͘ͱ΋JavaΑΓ͸) ͔͠͠ɺҎԼͷ఺Ͱ͹Β͖͕ͭɾɾ ◦ ม਺໊ͷলུͷ࢓ํ ◦ ϙΠϯλͷ࢖͍ॴ...etc ίʔυϨϏϡʔͷίετ૿Ճ, ॻ͖ํʹ໎͍͕ੜ͡ΔՄೳੑ
5. ΦϯϘʔσΟϯά࣌ͷܦݧ 5 • ࠓ·ͰJavaϝΠϯͰॻ͍͍ͯͨΤϯδχΞ • GoͰ࡞͍ͬͯΔ0 → 1ͷ৽ن։ൃͷ్தͰJOIN • طଘίʔυΛ֬ೝ͠ΩϟονΞοϓ ঢ়گ ײ૝ • Go͸දݱੑ͕௿͘ɺॻ͖ํͷ͹Β͖ͭ͸গͳ͍͸ͣ (গͳ͘ͱ΋JavaΑΓ͸) ͔͠͠ɺҎԼͷ఺Ͱ͹Β͖͕ͭɾɾ ◦ ม਺໊ͷলུͷ࢓ํ ◦ ϙΠϯλͷ࢖͍ॴ...etc ίʔυϨϏϡʔͷίετ૿Ճ, ॻ͖ํʹ໎͍͕ੜ͡ΔՄೳੑ ຊൃදͷτϐοΫ
6. 6 Έͳ͞Μಉ͡Α͏ͳײ૝Λ ࣋ͬͨ͜ͱ͸͋Γ·͔͢ʁ
7. 7 ౰࣌ͷࢲͷ৔߹
8. 8 Goͷࢥ૝Λ஌ΔͨΊʹ Ұ୴ެࣜdocͱؔ࿈ࢿྉΛړΖ͏
9. 9 Effective GoͱGo styleguideͰͷߟ͑ํ ~ʮաෆ଍ͳ͍ʯ໋໊ʹ͍ͭͯ ~
10. Effective Go - #names • ৑௕ͳ໋໊͸ආ͚Δ΂͖ 10 ref: https://go.dev/doc/effective_go#names Good :+1: Bad :-1:
11. Go styleguide - #variable-names • ʮաෆ଍ͳ͍ʯ (= Clarity / Concision) ໋໊Λ͢΂͖ ◦ ม਺͕ࢀর͞ΕΔൣғ (= Scope)ʹԠͯ͡ҟͳΔ ◦ লུͯ͠΋୹͍είʔϓͰม਺ͷ໾ׂ͕ࣗ໌ͳΒOK ◦ লུͨ͠ม਺Λ௕͍είʔϓͰ࢖͍ճ͢ͱՄಡੑ͕མͪΔͨΊNG 11 *ߦ਺͸ݫ֨ͳ΋ͷͰͳ͘ɺGo styleguideهࡌͷࢀߟͰ঺հ͞Ε͍ͯΔ਺ࣈ ref: https://google.github.io/styleguide/go/decisions#variable-names ୹͍είʔϓͷྫ (*1~7ߦ) ௕͍είʔϓͷྫ (*25ߦ~)
12. ݸਓͷݟղ • େલఏͱͯ͠GoެࣜͰఏএ͍ͯ͠Δࢥ૝ʹै͏ • ݸਓ͓ΑͼνʔϜͰʮաෆ଍ͳ໋໊͍ʯͱ͸ΛࡲΓ߹Θͤͨํ͕ ࣮૷ऀɾϨϏϡϫʔͱ΋ʹ޾ͤʹͳΕΔͷͰ͸ʁ ◦ ୹͍είʔϓ ▪ Ұ࣌తͳม਺ ▪ ؔ਺ͷ໊લ΍ฦΓ஋͔Β΋Β͏஋͕ࣗ໌ͳ৔߹ ◦ ௕͍είʔϓ ▪ ೝ஌ෛՙ্͕͕Γͦ͏ͳ৔߹͸লུ͠ͳ͍ ▪ (ͦ΋ͦ΋௕͗͢Δείʔϓ͸ϝιουͱͯ͠ͷ෼ׂΛ ݕ౼͢Δ৔߹΋͋Δ) 12
13. 13 νʔϜͰࡲΓ߹ΘͤΔ
14. νʔϜͰͷ߹ҙܗ੒ • ฐνʔϜͰͷʮաෆ଍ͳ͍ʯͬͯʁ ◦ جຊ͸লུ͠ͳ͍ํ਑Ͱɺܕ΍είʔϓ͔Βࣗ໌ͩͱ൑அͨ͠Βলུ͢Δ ◦ Defined Type࢖͏৔߹͸ม਺ͷ໾ׂ͕ࣗ໌Ͱ͋ΔͨΊলུͯ͠΋Α͍ (ল໊ུͨ͠લ͸Ұ؏ͯ͠࢖͏͜ͱ) ▪ ex. salesContractID → scID bailmentReceiptID → brID ◦ ໨҆ͱͯ͠লུ͸࠷େ2୯ޠ·Ͱ ex. salesContractDocumentDetail → scdd ͱ͔͸ආ͚͍ͨ 14
15. ӡ༻ޙͷνʔϜ಺֎͔ΒͷϑΟʔυόοΫ 15 • νʔϜͰվΊͯGoͷࢥ૝Λ৮ΕֶͯͿ͜ͱ͕Ͱ͖ͨ • ίʔυʹҰ؏ੑ͕ग़࣮ͯ૷Λ͢Δ্Ͱ໎͍͕ͳ͘ͳͬͨ • (͜͜͸ݸਓͷײ૝Ͱ͕͢) ίʔυϨϏϡʔͰGoͷࢥ૝ʹؔ࿈ ͢Δ໋໊ʹؔͯ͠ࢦఠ͢Δ͜ͱ͸ݮͬͨ Good More • ৽نࢀೖऀ͕͖ͨ࣌ʹಉ༷ͷٞ࿦͕ੜ·ΕΔՄೳੑ͕͋Δ ͦͷͨΊఆظతʹݟ௚͢͜ͱ͕ඞཁ͔΋ ◦ ຖ౓ม͑Δͷ͸ӡ༻ίετ͕ߴͦ͏ ◦ Goͷࢥ૝ʹै͏ͷ͸ม͑ͳ͍͍ͯ͘ ◦ ʮաෆ଍ͳ͍ʯΛೝ஌ෛՙɾՄಡੑͷ؍఺Ͱ ఆظతʹ࿩͢ͷ͸Αͦ͞͏
16. ຊൃදͷཁ఺ͱϞνϕʔγϣϯ 16 ʮڷ (=Go)ʹೖΒ͹ڷʹै͑ʯΛνʔϜͰୡ੒͢ΔͨΊʹ ίʔσΟϯάʹؔ͢Δҙࢥ౷ҰΛνʔϜ಺ͰߦͬͨΒɺ ίʔυʹҰ؏ੑ͕ग़ͨ & ϨϏϡʔίετͱ೰ΈϙΠϯτ͕গͳ͘ ͳͬͨ࿩ ཁ఺ Ϟνϕ ҎԼͷ఺Λօʹฉ͍ͯΧδϡΞϧʹσΟεΧογϣϯ͍ͨ͠ • ౰ൃදͰऔΓ্͛Δࣄ৅ʹࣅͨૺ۰ͨ͜͠ͱ͕͋Δ͔ ◦ ૺ۰ͨ͠৔߹͸ɺͲ͏ରॲ͔ͨ͠ ◦ ͠ͳ͔ͬͨ৔߹͸ɺެࣜͷϧʔϧʹै͏ͷΈͰ े෼ͩͬͨͷ͔
17. 17 Έͳ͞ΜͲ͏ͯ͠·͔͢ʁ
18. Thank You!