JavaScript

【express】Viewの共通パーツの別ファイル化と読み込み方

どうも、つよぽんです!

今回は、expressでViewを作成するときに「メニュー・ヘッダー・フッター」などの共通パーツを部品化する方法、そして部品化したファイルを読み込む方法を解説します。

今回の記事は、前回記事「【express】テンプレートファイルを使ってViewを作成する」の続きとなる記事なので、テンプレートエンジンにはEJSを使います。

テンプレートエンジンが何かわからない方は、先に前回記事から読み始めると今回の内容が理解しやすくなります。

今回の記事内容は、以下のリンク先で使っているスライドの一部を補足した記事になります。

実際に手を動かしながら覚えたい方は、以下のスライドも参考にすると良いでしょう。

あわせて読みたい
【express】Viewの共通パーツを作成して各ページで読み込む今回はexpressのView作成時に、共通パーツを使う方法を学習します。共通パーツのことを「パーシャルファイル」とも呼びますが、パーシャルファイルを使うことで、ページの共通部分の修正作業が必要になったときに、修正コストが下がります。...

今回の記事は次のような方に向けて書きました。

想定読者
  1. Viewの共通パーツを部品化したい方 (メニュー・ヘッダー・フッターなど)
  2. Viewの修正コストを小さくする方法を知りたい

この記事を読み終えた後のあなたは次のことがわかるようになっています。

この記事を読み終えた後のあなた
  • EJSを使って共通パーツを別ファイルに分ける方法
  • 別ファイルに分けた共通パーツをテンプレートファイルから読み込む方法

それでは以下の内容で話を進めていきます。

今回の内容
  1. 共通パーツを別ファイル化する理由
  2. 共通パーツを別ファイル化する方法
  3. 別ファイル化した共通パーツをテンプレートファイルから読み込む

共通パーツを別ファイル化する理由

前回作成したページはhtml, head, body要素が無い

前回記事「【express】テンプレートファイルを使ってViewを作成する」でテンプレートファイルを使って、2ページ分のWebページを作成しました。

しかし、2ページ分のWebページは、それぞれh1要素しか持たないHTMLで、一般的に必要とされる「html要素」「head要素」「body要素」が存在しない状態となっています。

以下の画像の右側は、前回作成したWebページのソースを表示したものですが、「html・head・body」が存在せず、h1要素しか無いのがわかります。(※画像をクリックすると別タブで画像が開きます)

前回作成したWebページはh1要素しかない前回作成したWebページはh1要素しかない

html, head, body要素は全ページで共通に使われる

「html, head, body」要素が無いのであれば、前回作成した2つのテンプレートファイルに直接「html, head, body」要素を埋め込むのが簡単な解決策となります。

しかし、「html, head, body」要素、もっと詳しく言うと、Webページのヘッダー部分やフッター部分は、全ページで共通であることが一般的です。

全ページで共通なパーツを、全テンプレートファイルで実装すると、後々の修正作業が大変になります。

例: 全ページ10ページからなるWebサイトの修正例

例えば、全部で10ページからなるWebサイトがあり、全ページ共通でヘッダー部分にメニューがあったとします。

そして、メニュー部分の修正が必要になったとします。

このとき、10個のファイルにそれぞれ同じメニューの実装をしていると、10個のファイルを修正する必要が出てきます。

しかし、メニュー部分を部品化して、10個のテンプレートファイルに読み込ませるような実装をしていた場合、

実質修正が必要なファイルは、「メニュー部分を部品化したファイル1個」のみとなり、先ほどの場合と比べて、修正作業の量が「10分の1」になります。

今回は10ページ分のWebサイトを例にしましたが、ページ量が増えれば増えるほど、共通パーツの部品化の恩恵を受けることができます。

共通パーツを別ファイル化する方法

共通パーツをファイル化する方法は、前回と同じようにテンプレートファイルを「views」ディレクトリの中に作成すれば良いです。

今回は、Webページのメインで使うテンプレートファイルと区別を付きやすくするために、「views」ディレクトリ内に「partials」ディレクトリを作成して、その中に共通部品を作成していきます。

「partial」は「部分的な」という意味がある英単語です。

他のWebフレームワークでも部品化したファイルを「パーシャルファイル」と呼ぶこともあります。

「views」ディレクトリ内に「partials」ディレクトリを作成したら、ヘッダー部分の共通ファイルとして「header.ejs」、フッター部分の共通ファイルとして「footer.ejs」を作成します。(※画像をクリックすると別タブで画像が開きます)

partialsディレクトリ内にheader.ejsとfooter.ejsを作成するpartialsディレクトリ内にheader.ejsとfooter.ejsを作成する

header.ejs」と「footer.ejs」の中身は以下のようになります。

  • header.ejsに記述する内容
    • 「html要素」の開始タグ
    • 「head要素」の開始タグと閉じタグ
    • 「title, meta要素」
    • 「body要素」の開始タグ
  • footer.ejs
    • 「body要素」の閉じタグ
    • 「html要素」の閉じタグ

上記に挙げたものを実装したものは以下の画像にまとめているので、そちらも参考にしていただけたらと思います。(※画像をクリックすると別タブで画像が開きます)

header.ejsの中身(画像)

header.ejsの中身header.ejsの中身

footer.ejsの中身(画像)

footer.ejsの中身footer.ejsの中身

別ファイル化した共通パーツをテンプレートファイルから読み込む

テンプレートファイルから、共通パーツを読み込むには、EJSが提供している「include」を使って実装できます。

使い方は以下の画像を確認していただくとわかるかと思いますが、「include」の第1引数に、読み込みたいテンプレートファイルのパスを指定するだけです。

EJSのincludeを使って、テンプレートファイル内から別のテンプレートファイルを読み込むEJSのincludeを使って、テンプレートファイル内から別のテンプレートファイルを読み込む

上の画像では、h1要素の前に「header.ejs」を読み込んで、h1要素の後に「footer.ejs」を読み込んでいます。

その結果、以下の画像の赤枠内が示すように、h1要素の前後に「html, head, body」要素が追加されました。(※画像をクリックすると別タブで画像が開きます)

h1要素の前後にhtml, head, bodyが追加されたh1要素の前後にhtml, head, bodyが追加された

まとめ

今回の話をまとめると次のとおりです。

今回のまとめ
  • 共通パーツを別ファイル化することで修正コストが下がる
  • 共通パーツの作り方は、テンプレートファイルを作成する方法と同じ
  • テンプレートファイルから共通パーツを読み込むには、EJSの「include」を使う

今回の内容は以下の記事内のスライドの補足資料として作成しました。スライドの全部を確認したい方は以下の記事も参照して頂けたらと思います。

あわせて読みたい
【express】Viewの共通パーツを作成して各ページで読み込む今回はexpressのView作成時に、共通パーツを使う方法を学習します。共通パーツのことを「パーシャルファイル」とも呼びますが、パーシャルファイルを使うことで、ページの共通部分の修正作業が必要になったときに、修正コストが下がります。...
【やる気満々な方向け】学習サポートとオンライン講義やってます!

Webエンジニアになりたい人向けに、MENTA にて『【やる気満々な方向け】未経験からのWebエンジニア育成コース』というプランを用意しております。

このプランでは、主に「【学習コンテンツ】Web開発」を使って学習を進めていただきます。

あわせて読みたい
Web開発Webエンジニアになるために必要な知識・スキルを学習できるコンテンツを用意しました。未経験者でも、①開発環境の準備、②Webの基本的な仕組み、③HTML、④CSS、⑤JavaScriptと順を追って学習することでスキルが身につくことを目的に教材を作成しています。...

誰向けのプラン?

こちらのプランは次のような方に向けて作られています。

プラン対象者
  1. Progateやドットインストールで一通り学習したけど、次に何をすればよいかわからない
  2. Webエンジニアになるまでの学習プランがあると助かる
  3. 学習していてわからないところが出てきたときに質問したい
  4. コードレビューして欲しい
  5. オンライン講義に参加したい
  6. 学習した内容をアウトプットした際に、フィードバックがもらえたら嬉しい
  7. おすすめの学習教材を知りたい
  8. Webフロントエンド・バックエンドを学習したい
  9. フルスタックエンジニアになりたい
  10. 文系出身で今までプログラミングをしてこなかったけど、将来Webエンジニアになりたい
  11. 将来フリーランスになることを目指している

プラン内容は?

【やる気満々な方向け】未経験からのWebエンジニア育成コース』では次のことを行っております。

プラン内容
  1. Web白熱教室の学習コンテンツをメインに、指定した教材を使って学習する (学習プランに沿って学習を進めていただきます。)
  2. 学習コンテンツの課題をこなしたあとは、僕にコードレビュー依頼を投げていただくことで、コードを添削する(課題クリア後は、引き続き学習プランの内容を続けていただきます。)
  3. プラン契約者が参加するSlackグループにて質問し放題
  4. Slack内にある「アウトプットの場」チャンネルにて、学習したことをアウトプットをしていただくことで、それに対しフィードバックをする (学習内容のアウトプットは復習にもなるため、アウトプットすることを強く推奨します。)
  5. 画面共有を使ったオンライン講義 (オンライン講義は録画して、いつでもふり返れるようにしています。(オンライン講義動画(ウェビナー動画)))
  6. 学習プラン以外の内容に対しての質疑応答 (内容によっては回答できないものもありますが、まずは気軽に質問していただけたらと思います。)
  7. 不定期で行うオフラインでの勉強会に参加(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)

1日1回カフェでコーヒー1杯頼むくらいの金額で参加できます

1日1回、カフェでコーヒー1杯分くらいの値段(約330円)」で以下の環境が手に入るとイメージして頂けたらと思います。

  1. コードを添削してもらえる
  2. 学習したことのアウトプットに対してフィードバックしてもらえる
  3. いつでも質問出来る
  4. 週1のオンライン講義に参加できる
  5. 過去のオンライン講義動画を好きな時間に復習できる(いつでも閲覧可能)
  6. 不定期で行うオフラインでの勉強会に参加できる(僕自身が東京住みのため、東京・もしくは東京近郊で開催します)
  7. 自分の住まいの近場のメンティーさん同士で集まって、オフラインで勉強会を開くのも可能(初めて開催する場合は事前に僕に連絡をいただけたらと思います)

学習教材には、このサイトで用意している「【学習コンテンツ】Web開発」を使います。

【学習コンテンツ】Web開発」を使って学習を進めることで、Webのフロントエンドとバックエンドのスキルを身につけていくことができます。

プログラミングスクールとの比較

プログラミングスクールに通う場合は1ヶ月で10万円以上するところも多いですし、3ヶ月で50万円、更には100万円するところもあります。

プログラミングスクールの値段が高い理由は、「プログラミングスクールで働いている人の人件費」「就職のサポート」なども含まれているからです。

10万円50万円100万円」のいずれの場合も、自己投資とはいえ、支払うのにはだいぶ勇気がいる金額かと思います。

オススメの学習方法

個人的にオススメするのは、プログラミングのできるメンター(師匠)を見つけて、まずは1ヶ月プログラミング学習をしてみて、自分にプログラミングが向いているかどうか確かめてみることです。

10万円50万円100万円」を払って、学習していく中で「やっぱり自分にはプログラミングは向いてない」と判断した場合、その金額はかなりの痛手となります。

そのため、まずは「これくらいの金額なら最悪失っても痛くないな」の値段で教えてくれるメンターを見つけて、そのメンターに色々と質問をしてみましょう。

それで、「良さそうだな」と思ったら教えてもらうといった流れで学習を始めると、金額もだいぶ節約できます。

注意点

ただし、参加者が増えてきたら、1人1人へのサポートの質を維持するのが難しくなるので、値上げする可能性もあります。

値上げする理由は次の以下の理由となります。

  • 値段を上げて参加ハードルをあげることで、自己解決スキルも身につけたいと考えている学習意欲の高い人だけが参加するようになる
    • 調べたらすぐにわかることを、自分で調べずに何でもかんでも質問すると、自己解決スキルも身につかない
    • 更に、他のメンティーさんの対応する時間が取れなくなりサポートの質の低下にも繋がる

詳しく話を聞いてみたい方は

以下のいずれかでメッセージをいただけたらと思います^^

 

プラン内容については以下のリンク先からも確認することが出来ます^^

【やる気満々な方向け】未経験からのWebエンジニア育成コース

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です