Zenn
🙌

AtomicDesignを活用する「コンポーネント駆動開発」のススメ

2023/05/17に公開
React
Storybook
Atomic Design
コンポーネント
コンポーネント駆動開発
tech

こんにちは！Magic Momentのフロントエンドエンジニアの石田です！

Magic MomentのフロントエンドではReactを採用しており、 コンポーネント設計にはAtomicDesignを採用しています。

みなさんはコンポーネントを使い回せていますか？

今回は僕がMagic Momentで実施しているコンポーネントを使い回すための開発手法をご紹介します。

コンポーネント駆動開発

コンポーネント駆動開発とは、画面を作る際に小さなコンポーネントから作成していき、小さなコンポーネントを組み合わせて画面を作る「ボトムアップ」の開発プロセスになります。

この手法を使用すると、小さなコンポーネントとして再利用できる部品を設計できます。そのため、コードの重複を減らし、保守性を向上させることができます。また、コンポーネントを組み合わせて画面を作成するため、開発の効率性も向上します。

Magic Momentでは、Atomic Designにもとづいてコンポーネントを分割しています。
アトミックデザインとは？

実際にやってみる

サンプルの画面を用意しました。

news.jpg

この画面を実際に分解してみます。

1. とにかくAtomsにわける

atoms.jpg

見える部分をすべてAtomsのレベルで見ていきます。

この時に大切なことは、どんなに小さいパーツでも「小さいパーツだからMoleculesやOrganismsで最初からまとめて作ってしまったほうが楽では？」のように考えないことです。

愚直にすべての細かい部品をAtomsとして分けていきます。

分けることができたら、既存のコンポーネントから作成済みのAtomsがないかを確認します。

作成済みならそのAtomsを利用するようにし、新規作成が必要なら新規のAtomsを作成するようにします。

シンプルに分けることができているので、この時点でPropsを考えることができます。下記は一例です。

  • atoms/Logo
    • Props
      • ※固定のロゴ画像でいけそうなのでpropsはなし
  • atoms/Heading
    • Props
      • children: React.ReactNode
      • level: number
  • atoms/Link
    • Props
      • children: React.ReactNode
      • href: string
      • target?: string
  • atoms/InputText
    • Props
      • placeHolder: string
      • defaultValue: string
      • onChange: (val: string) ⇒ void
  • atoms/InputSubmit
    • Props
      • text: string
      • onSubmit: () ⇒ void
  • atoms/CoverImage
    • Props
      • src: string
      • alt: string
  • atoms/Text
    • Props
      • children: React.ReactNode
  • atoms/Button
    • Props
      • children: React.ReactNode
      • href: string
      • target?: string

上記をイメージしながら見た目を実装します。

開発・運用していくと足りないPropsはかならず出てくるので、そうなったときにAtomsを更新します。

開発を進めていく中で設計が間違っていた場合でも、細かいAtomsとして分かれているので大幅な手戻りは発生しにくくなります。

2. AtomsをMoleculesにまとめる

molecules.jpg

次にMoleculesにまとめていきます。

Moleculesにするかどうかは、抽象的で使い回せるかで判断していますが、Moleculesとして取り扱うべきかについては解釈が分かれるところなのでここでは議論しません。

Moleculesとしても分けることができたら、既存のコンポーネントから作成済みのMoleculesがないかを確認します。

ここの時点でAtomsとしてコンポーネントがあるはずなので、Atomsを利用したMoleculesの実装方針も見えてきます。

  • molecules/Menu
    • Props
      • items: { text: string; href: string; }[]
    • Components
      • atoms/Link
  • molecules/InputTextSearch
    • Props
      • onChange: (val: string) ⇒ void
      • onSubmit: () ⇒ void
    • Components
      • atoms/InputText
      • atoms/InputSubmit
  • molecules/Card
    • Props
      • imgUrl: string
      • href: string
      • title: string
      • summary: string
    • Components
      • atoms/Image
      • atoms/Heading
      • atoms/Text
      • atoms/Button

この時点ではMoleculesとして抽象的なコンポーネントになるので、ロジックは入れないようにして見た目だけを作っていきます。

3. Organismsにまとめる

organisms.jpg

次にOrganismsにまとめます。

Organismsでも使い回せるかを意識してまとめていきますが、セマンティックなコンポーネントとして作成します。

この部分の分け方はサービスにもよりますが、機能別でOrganismsを分けるとうまくいくケースが多いと思います。

今回の例だと「人気の記事リスト」としてOrganismsを分けましたが、この他に「新着の記事リスト」も増えていくかと思います。

その場合、「人気の記事リスト」はorganisms/articleList/HotEntry として作成して、「新着の記事リスト」は organisms/articleList/NewArrivalとして作成します。

Organismsレベルになるとドメインも含まれるようになってくるので、コンポーネントを使い回すというよりも機能を使い回すイメージで作成すると「他の機能に依存されて直しにくい」ということも起こりにくくなり、テストも機能のテストとして分離したほうが作成しやすくなります。

  • organisms/Header
    • Props
      • なし
    • Components
      • atoms/Logo
      • molecules/Menu
  • organisms/Hero/SearchHero
    • Props
      • imgUrl: string
      • title: string
    • Components
      • atoms/CoverImage
      • atoms/Heading
      • molecules/InputTextSearch
  • organisms/ArticleList/HotEntry
    • Props
      • items: { imgUrl: string; href: string; title: string; summary: string; }[]
    • Components
      • molecules/Card

とはいえ、ここでも意識したいのは、最初からロジックを入れたコンポーネントとして作らないことです。

開発にはStorybookが便利！

コンポーネント駆動開発には、Storybookを使用することがオススメです。Storybookは、コンポーネントのデザインと動作を確認できるツールで、開発の効率性をさらに向上させることができます。
Storybook

Storybookを使うと、見た目だけのコンポーネントを作るように意識するため、見た目とロジックの責務の分離ができ、開発がしやすくなります。

ロジックはContainer ComponentやCustom Hookに寄せるなどして、コンポーネントと実装を分離することで見た目とロジックのそれぞれのテストのしやすさが向上します。

まとめ

いかがでしたか？

コンポーネント駆動開発をうまく利用すると、コンポーネントの再利用性があがり、見た目とロジックの分離も意識しやすくなります。

コンポーネントの再利用がうまくいってない場合はコンポーネント駆動開発を検討してはいかがでしょうか！

最後に

弊社Magic Momentでは、フロントエンド・バックエンドにかかわらず全方位的にエンジニアを募集中です！Magic Momentに少しでも興味を持っていただけたら是非エントリーください！

8/30にはFindy様主催のイベントにMagic Momentから石田さんが登壇されます！
よろしければぜひご視聴ください！

さらに、こちらのイベントも8/29開催予定です！こちらはオンラインイベントです。Magic Momentの開発がどんなものか興味を持っていただいた方は是非ご参加ください！

Discussion