Share
Embed
ディレクトリ構成ベストプラクティス ~ Angularアプリを作り続けてわかったこと / FRONTEND CONFERENCE 2019
FRONTEND CONFERENCE 2019にて発表した資料です。
OKUNOKENTARO
November 02, 2019
Transcript
48 slides
-
୭ w Ԟݡଠ!PLVOPLFOUBSP w ΫϨεΣΞද w ϑϩϯ τΤϯ υ ɾ
όοΫΤϯ υ ɾ ΤϯδχΞ w "OHVMBSຊϢʔβʔձ OHLZPUPΦʔΨφΠβ -
ຊͷ༰ w ϑϩϯ τΤϯ υͷϑ ϨʔϜϫʔΫ͕ग़ἧ͖ͬͯͨ w ֤ϑ ϨʔϜϫʔΫͷσΟ ϨΫ
τ Ϧߏ ʁ w ͦΕΒͷߏΛ͍ଓ͚ΔͷΑ͍͜ͱ͔ ʁ w σΟ ϨΫ τ ϦߏͱΞϓϦέʔγϣϯઃܭີͰ͋Δ w Ͳ͏ͬͯߏΛߟ͑ΔͨΊͷஅྗΛʹ͚ͭΔ͔ -
܈༤ׂڌͷ࣌མͪண͖ʜ w ΣϒΞϓϦέʔγϣϯΛ࡞ΔʜͱͳͬͨΒબΕΔͷ͕ 3FBDU "OHVMBS 7VFKT /VYU w Χόʔൣғ༷ʑ͕ͩɺ
ࠓճ·ͱΊ֤ͯϑ ϨʔϜϫʔΫͱݺͿ w ͍ͣΕຊޠυΩϡϝϯ τॆ࣮ w άάͬͨΒग़ͯ͘ Δࢿྉ๛ w લͱҧ͍ ʮͲΕΛͬͨΒ͍͍Ͱ͔͢ʜ ʁ ʯ ʹର͢Δஅࡐྉ͕ͨ͘ ͞Μ -
ຊʹগͳ͍ͷதʙେنͷϊϋ w ֤ϑ ϨʔϜϫʔΫͷϢʔβʔਓޱ͕૿͖͑ͯͨ w ֤ϑ ϨʔϜϫʔΫ͝ͱʹ༗໊ͳΤϯδχΞଓʑ ͱग़ݱ w ͜͜ͷ֤छେܕΧϯϑΝϨϯεͰɺ
ࢿྉ৭ʑ ͱग़͍ͯΔ w ͦΕ͕ࣗͷҊ݅ɺ ࣗࣾͷۀͰಉ༷ʹద༻Ͱ͖Δ͔ͱ͍͏ ͱʜ ʁ w ࢀߟʹͰ͖ͯɺ શ͘ಉ͡Α ͏ʹద༻Ͱ͖Δέʔεͷ΄͏͕ك -
ԿΛ৴͡Δࢦඪͱ͢Δ͔ ʁ w ొஃࢿྉɺ ϒϩάهࣄɺ 2JJUB 4UBDL0WFSqPXʜ w ړͬͯͦΕ͕ࣗͷ։ൃ͍ͯ͠ΔҊ݅ͱϚον͢Δ͔͕Θ͔Βͳ͍ w
ͦΕ͕৴͡ΔʹΓ Δใͳͷ͔Ͳ͏͔அ͕Ͱ͖ͳ͍ w ެࣜͷ υΩϡϝϯ τʜ w ެ͔ࣜͩΒؒҧͬͨ͜ͱॻ͍ͯͳ͍ͣ w ຊʹͦ͏͔ ʁ -
ެࣜυΩϡϝϯ τͦ͜ϊϋগͳ͍ w ֤ϑ ϨʔϜϫʔΫͷ υΩϡϝϯ τɺ ͋͘ ·Ͱͦͷϑ
ϨʔϜϫʔΫͷ͍ํΛதཱతʹड़ͨ༰ w ͔ͨ͠ʹؒҧͬͨ͜ͱॻ͍ͯͳ͍ w ࣗͷ৫ʹϚονͨ͠ݱঢ়ͷଧ։ࡦ͕ υϯϐγϟʹॻ͔Ε͍ͯΔέʔεগͳ͍ w ࠷ऴతʹ υΩϡϝϯ τΛཔΓʹख୳Γʹؕͬͯ͠· ͏ -
͍͍ײ͡ͷϓϩ τλΠ ϓ͕Ͱ͖·ͨ͠ w Α ͘ݟ͔͚Δྫ w νϡʔ τ ϦΞϧΛͬͯΈͨ
w νϡʔ τ ϦΞϧͷࡐΛࣗࣾͷϏδωεޠኮʹஔ͖͑ͯΈͨ w ػೳΛͯ͠Έͨ w ͍͍ײ͡ʹͳͬͨ w ͍ͭͷؒʹ͔ӡ༻ʹͬͯ͠·͍อक͢Δඞཁ͕Ͱͨ w νϡʔ τ ϦΞϧߏ͔Βม͑ΒΕͳ͍··ͲΜͲΜࣾͰ͕େ͖ ͘ ͳ͍ͬͯͬͨ -
ͼϞϊ Ϧ ε͔Β w ೦ͳ͕Βνϡʔ τ ϦΞϧϕε τͳߏͰͳ͍ wʮ·ͣͬͯΈͯಈ͔ͯ͠ΈΑ ͏ʯ
ͱ ʮؒ҆ఆͯ͠อकՄೳͳΞϓϦΛ࡞Ζ͏ʯ ͱผจ຺ w νϡʔ τ ϦΞϧ௨Γʹ࡞Γɺ νϡʔ τ ϦΞϧ௨Γͷػೳ֦ுΛ܁Γฦ͢ͱ Ϟϊ Ϧε ʢҰຕؠɺ ڊେͳటஂࢠͳͲͱʣ ͕ੜ͢Δ -
֤ϑ ϨʔϜϫʔΫͷಋೖ w 3FBDU w ެࣜυΩϡϝϯ τ্Ͱ ʮࡾฒήʔϜʯ ։ൃͷνϡʔ τ
ϦΞϧΛఏڙ w ΞϓϦͷ։ൃணखʹ ·ͣ$SFBUF3FBDU"QQ͕ਪ͞ΕΔ w 8FCQBDLͳΓ#BCFMͳΓΛΈ߹ΘͤΔ Ϣʔβʔ͕ଟ͘ɺ 3FEVYͷબఆ3PVUFSͷ બఆͳͲࣗ༝͕͔ͳΓߴ͍ src ├── App.css ├── App.js ├── App.test.js ├── index.css ├── index.js ├── logo.svg └── serviceWorker.js -
֤ϑ ϨʔϜϫʔΫͷಋೖ w "OHVMBS w 5PVSPG)FSPFTͱ͍͏ ʮਓࡐݣձ͕ࣾώʔϩʔΛཧ͢Δʯ ΞϓϦΛ࡞Δ w ΞϓϦͷ৽ن։ൃʹ"OHVMBS$-*
$ ng newΛ͏ w $ ng generateίϚϯ υͰϑΝΠϧΛ ࣗಈੜ͢Δ͕σΟ ϨΫ τ Ϧҙ app ├── app-routing.module.ts ├── app.component.html ├── app.component.scss ├── app.component.spec.ts ├── app.component.ts └── app.module.ts -
w /VYU w ๛ͳ υΩϡϝϯ τͱ)FMMP8PSME w νϡʔ τ ϦΞϧࣗମ7VFKTଆͰΔ
w ΞϓϦͷ৽ن։ൃʹ$-*πʔϧ $ create-nuxt-app [app-name]Λ͏ ֤ϑ ϨʔϜϫʔΫͷಋೖ root ├── assets ├── components │ └── Logo.vue ├── layouts │ └── default.vue ├── middleware ├── nuxt.config.js ├── package.json ├── pages │ └── index.vue ├── plugins ├── static ├── store └── test -
w 3FBDU͔ͳΓࣗ༝ɺ ͱ Γ͋͑ͣTSDҎԼʹஔ͘ w https://ja.reactjs.org/docs/faq-structure.html w "OHVMBSٕज़తʹࣗ༝͕ͩɺ ެࣜʹελΠϧΨΠ υΛఏڙ
w https://angular.jp/guide/styleguide w /VYUؚ໋໊ΊߏΛڧ੍͘ݶ w https://ja.nuxtjs.org/guide/directory-structure ͦΕͧΕͲ͏ͳ͍ͬͯΔ͔ -
σΟ ϨΫ τ Ϧߏେൊ common/ Avatar.js Avatar.css APIUtils.js APIUtils.test.js feed/
index.js Feed.js Feed.css FeedStory.js FeedStory.test.js FeedAPI.js profile/ index.js Profile.js ProfileHeader.js ProfileHeader.css ProfileAPI.js api/ APIUtils.js APIUtils.test.js ProfileAPI.js UserAPI.js components/ Avatar.js Avatar.css Feed.js Feed.css FeedStory.js FeedStory.test.js Profile.js ProfileHeader.js ProfileHeader.css υϝΠϯ୯Ґ λΠ ϓ୯Ґ -
λΠ ϓ͕ͭΒ͞ΛݟΔ໘ • containers • usersContainer, issuesContainer, requestsContainer... • components
• buttonComponent, userCardComponent, issueListComponent... • reducers • usersReducer, issuesReducer, requestsReducer... • actions • usersActions, issuesActions, requestsActions... -
λΠ ϓ͕ͭΒ͞ΛݟΔ໘ • containers • usersContainer, issuesContainer, requestsContainer... • components
• buttonComponent, userCardComponent, issueListComponent... • reducers • usersReducer, issuesReducer, requestsReducer... • actions • usersActions, issuesActions, requestsActions... -
%VDLTύλʔϯ • users • usersContainer, usersActions, usersReducer, userCardComponent • issues
• issuesContainer, issuesActions, issuesReducer, issueListComponent • requests • requestsContainer, requestsActions, requestsReducer • components • buttonComponent, modalComponent... -
%VDLTύλʔϯ • users • usersContainer, usersActions, usersReducer, userCardComponent • issues
• issuesContainer, issuesActions, issuesReducer, issueListComponent • requests • requestsContainer, requestsActions, requestsReducer • components • buttonComponent, modalComponent... -
େنͰͭΒ͍ͷѹతϑΝΠϧ w ສߦɺ ը໘ɺ UTϑΝΠϧͷΞϓϦΛ։ൃ࣮ͯ͠ײͨ͜͠ͱ w ίʔ υͷԚ͞Α Γ ϑΝΠϧπϦʔͷࢹೝੑͷѱ͕͞ੜ࢈ੑΛඇৗʹԼ͛Δ
wʮΤσΟ λͷγϣʔ τΧο τͰඈͿ͔ΒϑΝΠϧπϦʔΛݟΔ͜ͱͳ͍ʯ ʁ ʁ w ύεΛҰҙࣝͤͣ(JU)VCͷૢ࡞5ZQF4DSJQUͷϩά͍͕շదʹͰ͖Δ͔ ʁ w ϑΝΠϧπϦʔ(6*ΛݟΔݟͳ͍Ͱͳ͘ɺ ߏͷԚ͕͞ੜ࢈ੑʹޮ͍ͯ ͘ Δ w ͜ͷʹͳΔͱ ʮ%VDLTύλʔϯΛΕεοΩ Ϧ ·ͱ·Δʯ ͱ͍͏࣍ݩΛ͑Δ -
֤ϑ ϨʔϜϫʔΫͷ w 3FBDUࣗ༝͗͢ΔͷͰɺ ͦͦํΛઃܭΛ͠ͳ͍ͱഁ͍͢͠ w "OHVMBSελΠϧΨΠ υ͕͍ͬͯΔ͕ສਓ͚ͳͷͰɺ ܝࡌ༰৫୯Ґͷνϡʔχϯά݁ՌͰͳ͍
w /VYUݫ͍͠ϧʔϧʹΑͬͯQBHFTͷϑΝΠϧߏͱϧʔςΟ ϯάΛ ରͱ͍ͯ͠Δ͕ɺ ίΞ υϝΠϯʹ૬͢Δ෦ͷཧʹ͍ͭͯ৮Εͯͳ͍ -
ڧݻͰεέʔϧ͢ΔσΟ ϨΫ τ Ϧࢦ͕ඞཁ w ϑ ϨʔϜϫʔΫͷࣄͰͳࠜ͘ຊతͳΞϓϦέʔγϣϯͷઃܭֶʹཱͪฦΔ w ϑ ϨʔϜϫʔΫੜΑ
Γݹ͔͘Βଘࡏ͢Δઃܭֶɺ બఆͷஅج४ͱͳΔ w Ͳ͜ΛࣗͰΞϨϯδ͠ɺ Ͳ͜Λม͑ͣʹै͏͖͔ͷஅྗͱͳΔ w "OHVMBSͷελΠϧΨΠ υ"OHVMBSͷ্࣮ͷࣄΛؚ·ͳ͍ ൺֱతֶʹدͬͨ༰ͱͳ͍ͬͯΔͷͰ͝հ -
"OHVMBSϑΝΠϧߏΨΠ υൈਮ w ͙͢ʹίʔ υΛݟ͚ͭΒΕΔΑ ͏ʹ͢Δ w ؔ࿈ϑΝΠϧΛײతͳॴͰۙ͘ʹஔ͍͓ͯ͘ w ҰͰίʔ
υΛࣝผͰ͖ΔΑ ͏ʹ͢Δ w ͍આ໌తͳϑΝΠϧ໊ɺ ͘ ͯᐆດͳॖ໊Α Γ༏Ε͍ͯΔ w Ͱ͖ΔݶΓ ϑϥ ο τͳߏΛҡ࣋͢Δ w ৺ཧֶʹج͖߲͕ͮͭҎ্ʹୡͨ͠ͱ͖ʹαϒσΟ ϨΫ τ ϦΛ࡞͢Δ w %3: ʢॏෳͱ͞ΛऔΓআ͘ʣ Λඪͱ͢Δ w ͘આ໌తͳϑΝΠϧ໊༗ӹ͕ͩɺ ͦΕ͕ʹͳΔͳΒɺ ͔͑ͬͯγϯϓϧʹͨ͠΄͏͕Α͍ -
ϕε τϓϥΫςΟ ε ʁ w ࠓճͷϕε τϓϥΫςΟ εͷޠɺ ੈքதͷਓʹड͚ೖΕΒΕΔ͜ͱΛࢦͨ͠ͷɺ
ͱ͍͏χϡΞϯεͰͳ͍ w ࣗͷɺ ܁Γฦ͠େنΞϓϦέʔγϣϯΛ࡞Γଓ͚͖ͯͨܦݧʹج͍ͮͯ ࢼߦࡨޡͷճ͕ݮ͖ͬͯͨ҆ఆͨ͠σβΠϯύλʔϯͰ͋Δͱ͍͏ҙ w 3FBDU "OHVMBSͰɺ ํͰར༻Մೳ w /VYUϑ ϨʔϜϫʔΫࣗମͷ੍͕ݫ͍ͨ͠Ίࢀߟఔʹ -
σΟ ϨΫ τ ϦߏͱΞϓϦέʔγϣϯઃܭີ w ϨΠϠʔ υΞʔΩςΫνϟ ʮࠓணख͍ͯ͠ΔϑΝΠϧԿΛ͢Δͷ͔ʯ Λఆٛ͢ΔईͱͳΔ w
σΟ ϨΫ τ Ϧߏͱ͜ͷΞʔΩςΫνϟ͕ဃ͍ͯ͠Δͱɺ ͦͷར͕ऑ·Δ w σΟ ϨΫ τ Ϧߏɺ ϨΠϠʔΛҙࣝͨ͠ͷͱ͢Δ -
QBHFT w ͦͷΞϓϦέʔγϣϯʹొ͢Δը໘ؚ͕ͯ͢·ΕΔ w pages/home/ pages/users-list/ pages/user-detail/ͳͲ w ෳͷը໘ͰΘΕΔཁૉpages/shared/ʹஔ͔ΕΔ w
pages/shared/user/user-card pages/shared/gui/drop-down-list ͳͲ w ಛఆͷը໘Ͱ͔͠ΘΕͳ͍ඍࡉͳίϯϙʔωϯ τλΠ ϓผͱ ͯ͠·ͱΊΔ w pages/user-registration/components/serial-number-field.tsͳͲ -
NPEFMT w ͍ΘΏΔ υϝΠϯϞσϧ͕ஔ͔ΕΔ w models/user/ models/issue/ models/article/ͳͲ w pages/shared/user/
pages/shared/issue/ͱ໌֬ʹ۠ผ͞ΕΔ w ج४ϑ ϨʔϜϫʔΫʹؔ͢ΔJNQPSUจؚ͕·ΕΔ͔ɺ ؚ·Εͳ͍͔ w ؚ·ΕΔ߹ҰͰpages/shared/ߦ͖ w MVYPOͷ࣌ؒܭࢉͳͲΛแ͢Δmodels/date-time/ͳͲڐ༰ -
MJC w ΞϓϦࣗͱ֎෦ͷԿΒ͔ͷ࿈ܞ͕ඞཁͳ߹ɺ ͯ͢lib/ w lib/apis/users.api.ts lib/google-map/provider.ts lib/bugsnag.ts lib/firebase/notifications.tsͳͲ
w ͔ࣗࣾଞ͔ࣾؔͳ͘ɺ ΞϓϦࣗͱ֎෦͕࿈ܞ͢Δͷͯ͢MJC w -PDBM4UPSBHF $PPLJF *OEFYFE%#͜ΕΒʹ֘ -
VUJMT w Ұ൪ةݥͳ͍͕͕ͪ͠ͳͷͰҙ͖͢utils/ w ࣗࣾҎ֎ͷ୭͔͕͍ͬͯͯҧײͷͳ͍ॲཧ͕֘ w ͨͱ͑array-flat.ts to-promise.tsͳͲ w গ͠ͰࣗࣾυϝΠϯͷؚ͍͕·ΕͨΒmodels/͔pages/shared/ߦ͖
w MPEBTIΛΠϯε τʔϧ͢Δ΄ͲͰͳ͍͚Ͳɺ ͪΐͬͱ͍͍ͨؔͱ͔͕ೖΔ w ͕͜͜ͲΜͲΜ૿͑Δঢ়گෆ݈શͳͷͰɺ ࠷ऴखஈͱͯ͠ଊ͑Δ -
Ϋ ϦʔϯΞʔΩςΫνϟ σΟ ϨΫ τ Ϧ ͝ͱͷׂΛ໌֬ʹ͢Δͱɺ ґଘํࣗવͱἧ͍Ϋ ϦʔϯΞʔΩςΫνϟͷ࣮ݱͱͳΔ
models/ pages/shared/ pages/ lib/ -
େσΟ ϨΫ τ Ϧ ͱαϒσΟ ϨΫ τ Ϧͷؔ w pages
w ֤ϖʔδ໊͝ͱʹΔ w ֤ϖʔδ໊͝ͱͷαϒσΟ ϨΫ τ ϦͷԼλΠ ϓผ w pages/shared/ҎԼ%VDLTύλʔϯ w models w %VDLTύλʔϯ w lib w %VDLTύλʔϯ w utils w λΠ ϓผ ΞϓϦશମΛ%VDLTύλʔϯʹἧ͑Δ͔ɺ λΠ ϓผʹ͢Δ͔ Ͱͳ͘ɺ େผͨ͠λΠ ϓ͝ͱͷूͷͦΕͧΕʹ υϝΠϯ୯ҐͰ·ͱΊΔ%VDLTύλʔϯద༻͢Δɻ -
ଞਓͷൃද༰ΛऔΓೖΕΔ w ࠓճͷ༰ ʮࣗͷḷΓண͍ͨ࠷ྑͷύλʔϯʯ ͷհ w ͜ΕΛଈ࠲ʹ֤͕ࣗಋೖͰ͖ΔͷͰͳ͍ͱࢥΘΕΔ w ͋·ͨͷൃදࢿྉ͕ ʮԿΛࠜڌʹͦͷબΛͨ͠ͷ͔ʯ
ͱ͍͏ എܠΛ͓͚ͬͯɺ ಉ͡ঢ়گͱͳͬͨͱ͖ͷஅྗͱͳΔ w ࠓճͷ༰ϨΠϠʔ υΞʔΩςΫνϟɺ Ϋ ϦʔϯΞʔΩςΫνϟͱ͍͏ ઃܭख๏Λ౿·͑ɺ "OHVMBSͷελΠϧΨΠ υߟྀͨ͠߹ʹ Ͳ͏அ͔ͨ͠ ʁ ͱ͍͏ܦݧஊ -
ͨ͘ ͞ΜͷࣄྫΛΖ͏ ʂ w νϡʔ τ ϦΞϧߏͷԆͰͳͥऴΘͬͯ͠· ͏ͷ͔ w ϑ
ϨʔϜϫʔΫͷ υΩϡϝϯ τΛख़ಡ͢Δ͚ͩͰͳ͘ɺ ࢹΛ͛ͯΈΔͷ͕Α͍ wʮ͔ͭͯ+BWBͲ͏͍ͬͯͨ ʁ ʯ ʮ࠷ۙͷJ04։ൃͬͯͲ͏ͳͬͯΔͷ ʁ ʯ ͳͲ w ϑ ϨʔϜϫʔΫ͕ఏڙ͢Δใ͕ࠓͷࣗ ɾ ৫ʹ Ϛον͍ͯ͠Δ͔Ͳ͏͔ͷஅྗΛཆ͏ w ελΠϧΨΠ υͷΞϨϯδྗͱͳΓɺ νʔϜ͕Λ๊͑ͨͱ͖ʹ Γӽ͑ΒΕΔΑ ͏ʹͳΔ