Share
Embed
Transcript
28 slides
-
About me - id: @Quramy (GitHub, X) - ৬छ: Web
ϑϩϯτΤϯυΤϯδχΞ - Quramy ͱ GraphQL: - GraphQL Tokyo ͱ͍͏ Meet up Λෆఆظ։࠵͍ͯ͠·͢ - ͜͜5 ~ 6Կ͔͠Βͷ GraphQL ͳҊ݅Λ͍ͬͯ·͢ (ຊۀ/෭ۀ) Client Side: @apollo/client + React or Vue Server Side: @apollo/server or graphql-ruby + Rails - ts-graphql-plugin ͱ͍͏ϑϩϯτΤϯυ͚ͷπʔϧΛϝϯςφϯε͍ͯ͠·͢ https://github.com/Quramy/ts-graphql-plugin -
ϑϩϯτΤϯυͱσʔλ ϑΣον GraphQL ʹ͍ͭͯߟ͑ΔલʹɺΫϥΠΞϯτ(e.g. Web ϒ ϥβ) ͔ΒͷσʔλϑΣονʹ͍ͭͯɺ2௨Γߟ͑ͯΈΔ - ίϯϙʔωϯτͷ
(Root) ͰσʔλΛऔಘ͢Δ - ίϯϙʔωϯτͷ (Leaf) ͰσʔλΛऔಘ͢Δ Root Component Leaf Leaf Leaf -
ϑϩϯτΤϯυͱσʔλ ϑΣον ίϯϙʔωϯτͷ(Root) ͰͷσʔλϑΣον - ✅ ΠϯλʔωοτΛލ͍ͩ௨৴ճ͕ҰͰࡁΉͨ ΊɺύϑΥʔϚϯε͕ྑ͍ - 🤮
औಘͨ͠σʔλΛ Leaf ·Ͱ͢ඞཁ͕͋Δɻίϯ ϙʔωϯτՃɾআ࣌ͷվमൣғ͕େ͖͍ Root Component Leaf Leaf Leaf -
ϑϩϯτΤϯυͱσʔλ ϑΣον ίϯϙʔωϯτͷ(Leaf) ͰͷσʔλϑΣον - 🤮 ݸผͷίϯϙʔωϯτ͝ͱʹΠϯλʔωοτӽ͠ ௨৴͕ൃੜ͢ΔɻΥʔλϑΥʔϧ N +
1 Ͱύ ϑΥʔϚϯε͕ྼԽ͍ͯ͘͠ - ✅ ίϯϙʔωϯτͦΕ͕ࣗϑΣον͖͢σʔλ Λཧ͍ͯ͠ΔͨΊɺվम࣌ͷӨڹൣғہॴԽ͞Ε ͍ͯΔ Root Component Leaf Leaf Leaf -
ϑϩϯτΤϯυͱσʔλ ϑΣον GraphQL ͜ͷτϨʔυΦϑΛղফͰ͖Δ (͕ɺGraphQL ΛೖΕ͚ͨͩͰղফ͞ΕΔΘ͚Ͱͳ͍) τϨʔυΦϑղফʹ Fragment Colocation
͕ඞཁෆՄܽ 3PPUͰσʔλϑΣον -FBGͰσʔλϑΣον 1FSGPSNBODF ✅ 🤮 %FWFMPQFS&YQFSJFODF 🤮 ✅ -
GraphQL ͷਅ GraphQL σʔλϑΣονϓϩηεΛ એݴͱ࣮ߦʹׂ ͢Δ͜ͱͰͦͷ ਅՁΛൃش͢Δ - ඞཁͱ͢Δσʔλ Leaf
ίϯϙʔωϯτʹએݴ͢Δ - ࣮ࡍͷσʔλऔಘ Root ίϯϙʔωϯτͰ࣮ߦ͢Δ Leaf Ͱએݴ͞Εͨใ (Fragment) ͕ Root ʹू͞Εͯ query ͱͳΔ -
Fragment Colocation Fragment Colocation ͕ͲͷΑ͏ʹػೳ͢Δ͔ΛྫͰߟ͑ͯΈΔ GraphQL ͷαϯϓϧͰ͓ೃછΈͷϒϩάߘαʔϏεͰ͢ type Post
{ id: ID! title: String! body: String! author: User! createdAt: String! updatedAt: String! } type User { id: ID! name: String! avatarURL: String! createdAt: String! updatedAt: String! } type Query { popularPosts: [Post!]! } PopularPosts (Root) PostSummary UserAvatar PostSummary UserAvatar -
Fragment Colocation Example UserAvatar Component import { graphql, useFragment, type
FragmentType } from './gql'; const fragment = graphql(` fragment UserAvatar_User on User { name avatarURL } `); export function UserAvatar(props: { user: FragmentType<typeof fragment> }) { const user = useFragment(fragment, props.user); return <img src={user.avatarURL} alt={user.name} />; } PopularPosts (Root) PostSummary UserAvatar PostSummary UserAvatar -
Fragment Colocation Example UserAvatar Component import { graphql, useFragment, type
FragmentType } from './gql'; const fragment = graphql(` fragment UserAvatar_User on User { name avatarURL } `); export function UserAvatar(props: { user: FragmentType<typeof fragment> }) { const user = useFragment(fragment, props.user); return <img src={user.avatarURL} alt={user.name} />; } ඞཁͱ͢ΔσʔλࣗࣗͰએݴ͢Δ PopularPosts (Root) PostSummary UserAvatar PostSummary UserAvatar -
Fragment Colocation Example PostSummary Component import { graphql, useFragment, type
FragmentType } from './gql'; import { UserAvatar } from './UserAvatar'; const fragment = graphql(` fragment PostSummary_Post on Post { id title author { name ...UserAvatar_User } } `); export function PostSummary(props: { post: FragmentType<typeof fragment> }) { const post = useFragment(fragment, props.post); return ( <> <a href={`/posts/${post.id}`}>{post.title}</a> written by <span>{post.author.name}</span> <UserAvatar user={post.author} /> </> ); } PopularPosts (Root) PostSummary PostSummary -
Fragment Colocation Example PostSummary Component import { graphql, useFragment, type
FragmentType } from './gql'; import { UserAvatar } from './UserAvatar'; const fragment = graphql(` fragment PostSummary_Post on Post { id title author { name ...UserAvatar_User } } `); export function PostSummary(props: { post: FragmentType<typeof fragment> }) { const post = useFragment(fragment, props.post); return ( <> <a href={`/posts/${post.id}`}>{post.title}</a> written by <span>{post.author.name}</span> <UserAvatar user={post.author} /> </> ); } PopularPosts (Root) PostSummary PostSummary ඞཁͱ͢ΔσʔλࣗࣗͰએݴ͢Δ -
Fragment Colocation Example PostSummary Component import { graphql, useFragment, type
FragmentType } from './gql'; import { UserAvatar } from './UserAvatar'; const fragment = graphql(` fragment PostSummary_Post on Post { id title author { name ...UserAvatar_User } } `); export function PostSummary(props: { post: FragmentType<typeof fragment> }) { const post = useFragment(fragment, props.post); return ( <> <a href={`/posts/${post.id}`}>{post.title}</a> written by <span>{post.author.name}</span> <UserAvatar user={post.author} /> </> ); } PopularPosts (Root) PostSummary PostSummary ࢠίϯϙʔωϯτ͕ඞཁͱ͢Δσʔλ 'SBHNFOUΛ௨͚ͯͩ͢͡ ͦͷৄࡉʹ͍ͭͯෆՄ -
Fragment Colocation Example PopularPosts Component - ίʔυ import { useSuspenseQuery
} from '@apollo/client'; import { graphql } from './gql'; import { PostSummary } from './PostSummary'; const query = graphql(` query PopularPosts_Query { popularPosts { id ...PostSummary_Post } } `); export function PopularPosts() { const { data } = useSuspenseQuery(query); return ( <ul> {data.popularPosts.map(post => ( <li key={post.id}> <PostSummary post={post} /> </li> ))} </ul> ); } PopularPosts (Root) -
fragment UserAvatar_User on User { name avatarURL } fragment PostSummary_Post
on Post { id title author { name ...UserAvatar_User } } query PopularPosts_Query { popularPosts { id ...PostSummary_Post } } PopularPosts Component (Root Component) PostSummary Component UserAvatar Component Component Tree Query Composition Colocate Colocate Colocate -
fragment UserAvatar_User on User { name avatarURL } fragment PostSummary_Post
on Post { id title author { name ...UserAvatar_User } } query PopularPosts_Query { popularPosts { id ...PostSummary_Post } } PopularPosts Component (Root Component) PostSummary Component UserAvatar Component Component Tree Query Composition Operation for Root Component Colocate Colocate Colocate -
Fragment Colocation Example Note: ্ड़ͷྫ React, Apollo Client, graphql-codegen ͷελοΫΛఆ
͕ͨ͠ɺͲͷϥΠϒϥϦΛར༻͢Δ͔ຊ࣭Ͱͳ͍ - GraphQL Client Λ urql Relay ʹཱͯ͢͠Δ - graphql-codegen ͕ແ͘ͱಉ͡Α͏ͳίʔυ͕هड़Մೳ (Apollo Client Relay ͷ useFragment Ͱେ͖͘มΘΓ·ͤΜ) - React.js Ҏ֎ͷ Component ࢤͳ UI ϑϨʔϜϫʔΫ(e.g. Vue, Qwik, etc...) ͰҰॹ -
νΣοΫ؍ ίϯϙʔωϯτΛ Colocated ʹอͭͨΊͷݪଇ: ✓ Fragment (·ͨ query / mutation)
ͷఆٛίϯϙʔωϯτίʔυ ্ʹهड़͞Ε͍ͯΔʁ ✓ ࣗͷࢠίϯϙʔωϯτ͕ඞཁͱ͢Δσʔλ Fragment Spread Ͱ هड़͍ͯ͠Δʁ ✓ Fragment ʹొͨ͠ϑΟʔϧυΛͦͷίϯϙʔωϯτࣗͰফඅ͠ ͍ͯΔʁ -
όουεϝϧୡ - Fragment Colocation Λߦ͍͑ͯͳ͍ GraphQL ϑϩϯτΤϯυɺ ύϑΥʔϚϯε /
อकੑͷ͍ͣΕ͔ΛଛͶΔϦεΫ͕͋Δ - Quramy ͕ࠓ·Ͱݟ͖ͯͨ GraphQL Prjs Λ௨ͯ͠ɺʮո͍͠ͳɻɻɻʯ Λײ͡ΔϙΠϯτΛൈਮͯ͠հ͠·͢ -
όουεϝϧ1 src/queries σΟϨΫτϦ src/queries ͷΑ͏ͳσΟϨΫτϦʹ query mutation Λஔ͓ͯ͠Γɺ ίϯϙʔωϯτͱಠཱͯ͠ཧ͍ͯ͠Δύλʔϯ
- ࣮ࡍʹσʔλΛར༻͍ͯ͠ΔՕॴͱ query ͕Ε͍ͯΔͨΊɺDX ͕ ͍ -
όουεϝϧ1 src/queries σΟϨΫτϦ ͬͱ࣭͕ѱ͍߹ͷ 1ͭͷ query (fragment) Λෳͷίϯϙʔωϯτ ͔Βڞ༗ͯ͠͠·͏έʔε -
ͲͪΒ͔ͷίϯϙʔωϯτͰෆཁͳϑΟʔϧυΛऔಘ͍ͯ͠ΔՄೳੑ ͕ඇৗʹߴ͍ - ͢ͳΘͪɺαʔόʔαΠυͰෆཁͳॲཧΛߦΘ͍ͤͯΔ͜ͱʹͳΔ -
όουεϝϧ2 Output Type Λ import ͍ͯ͠Δ import type { User
} from "@gql/graphql" ͷΑ͏ͳ TypeScript ίʔυ͕ϑ ϩϯτΤϯυͰଟ༻͞Ε͍ͯΔέʔε - ίʔυδΣωϨʔλ͕ग़ྗ͢Δ Schema ͷ Output Type Λࢀরͯ͠Α͍ ͷαʔόʔαΠυ͚ͩ - ʮίϯϙʔωϯτ͕ඞཁͱͳΔσʔλΛએݴ͢Δʯͱ͍͏ߟ͑ํͷਅٯ ͱͳͬͯ͠·͏ - ίϯϙʔωϯτ͕ඞཁͱ͢ΔͷɺFragment ʹ૬͢ΔܕͰ͋ͬ ͯɺSchema ͕ఏڙ͢ΔܕͰͳ͍ -
όουεϝϧ3 useQuery ͕ଟ༻͞Ε͍ͯΔ Root (Page) ίϯϙʔωϯτͰͳ͍ՕॴͰ useQuery ͕ͻΐͬ͜Γొ͢Δ Α͏ͳέʔε -
ʮ Colocation ͍ͬͯΔ͕ɺࣗͷ Schema Ͱ͏·͘Ͱ͖ͳ͘ ͯɻɻɻʯͱͳ͍ͬͯΔ͜ͱ͕ଟ͍ - ϑϩϯτΤϯυઢͰѻ͍ʹ͍͘ Schema ઃܭͱͳ͍ͬͯΔՄೳੑ͕ ߴ͍ - GraphQL ͷྑ͞Λ࠷େݶڗड͢Δ্ͰɺSchema ઃܭͱίϯϙʔωϯτ ͷઃܭͬͯΓͤͳ͍. Schema ઃܭϑϩʔΛݟͨ͠ํ͕Α͍ ͔ʁ -
·ͱΊ - GraphQL ͷ Fragment Colocation UX ͱ DX
Λཱ྆͢Δखஈ - Colocation ͞Ε͍ͯͳ͚ΕɺͲͪΒ͔Λ٘ਜ਼ʹ͍ͯ͠Δͱ͍͏͜ͱ - Colocate ͠Α͏ʂ -
ࢀߟϦϯΫ Fragment Colocation ͷॏཁੑʹ͍ͭͯ: - Relay ͷهࣄ (UX / DX
ͷτϨʔυΦϑ͕؆ܿʹهࡌ͞Ε͍ͯΔ) https://relay.dev/blog/2023/10/24/how-relay-enables-optimal-data- fetching/ - GraphQL Code Generator ͷهࣄ (Fragment Composition ʹ͍ͭͯ) https://the-guild.dev/blog/unleash-the-power-of-fragments-with- graphql-codegen ্هҎ֎Ͱ "graphql colocation" ͰάάΔͱ৭ʑग़͖ͯ·͢