Day 9:モジュールでJavaScriptを整理する
モジュールとは、JavaScriptのコードを複数のファイルに分け、必要な機能を別のファイルから使えるようにする仕組みです。コードを機能ごとに整理すると、どこに何があるか分かりやすくなり、修正や再利用もしやすくなります。
この日は、exportで機能を外へ公開し、importで別のファイルから取り込む方法を学びます。最後に、商品データを使う小さなアプリをutils、services、components、dataに分割します。
1. なぜファイルを分けるのか
最初は、JavaScriptを1つのファイルに書いても問題ありません。しかし、機能が増えると、データ、計算、画面表示などが混ざり、目的のコードを探しにくくなります。
たとえば、商品一覧を表示するプログラムには、次のような役割があります。
- data:商品データを置きます。
- utils:金額の表示など、再利用できる小さな処理を置きます。
- services:データの取得や検索など、アプリの処理を置きます。
- components:画面に表示する部分を作ります。
- app.js:各機能をつなぎ、アプリを動かします。
フォルダー名に決まったルールがあるわけではありませんが、役割を分けるとコードの場所を見つけやすくなります。
2. exportとimportの基本
ファイルから機能を外へ公開するときはexport、別のファイルから取り込むときはimportを使います。
名前付きexport
名前付きexportは、関数や値に名前をつけて公開する方法です。ひとつのファイルから複数の値を公開できます。
// add関数を名前付きexportで公開します
export function add(firstNumber, secondNumber) {
// 2つの数値の合計を返します
return firstNumber + secondNumber;
}
// TAX_RATEを名前付きexportで公開します
export const TAX_RATE = 0.1;JavaScript別のファイルから使うときは、{}の中に名前を書きます。
// math.jsからaddとTAX_RATEを取り込みます
import { add, TAX_RATE } from "./math.js";
// 取り込んだ関数を使います
console.log(add(3, 5)); // 8
// 取り込んだ値を使います
console.log(TAX_RATE); // 0.1JavaScript名前付きexportは、exportした名前とimportする名前を一致させる必要があります。
default export
default exportは、ファイルの代表となる機能を1つ公開する方法です。1つのファイルにつき、default exportはひとつだけです。
// greet関数を、このファイルのdefault exportにします
export default function greet(name) {
// 名前を含む挨拶を返します
return `こんにちは、${name}さん`;
}JavaScript取り込むときは{}を使いません。import側では好きな名前をつけられます。
// default exportをGreetingという名前で取り込みます
import Greeting from "./greet.js";
// 取り込んだ関数を呼び出します
console.log(Greeting("さくら"));JavaScript2つの書き方の使い分け
| 形式 | 主な用途 | importの例 |
|---|---|---|
| 名前付きexport | 複数の関数や値を公開する | import { add } from "./math.js" |
| default export | ファイルの代表となる機能を公開する | import greet from "./greet.js" |
default exportは取り込む側で名前を自由につけられるため、名前の対応関係がコードだけでは分かりにくくなることがあります。複数の機能をまとめて公開する場合は名前付きexportが便利です。プロジェクト内で使い方をそろえると、読みやすくなります。
3. ファイルのパスの考え方
importでは、取り込み元のファイルの場所を指定します。パスはimportを書くファイルから見た相対位置です。
./は、現在のフォルダーを表します。../は、ひとつ上のフォルダーを表します。../../は、2つ上のフォルダーを表します。
たとえば、src/app.jsからsrc/data/products.jsを読み込む場合は、./data/products.jsです。src/components/productList.jsからsrc/utils/format.jsを読み込む場合は、../utils/format.jsです。
ブラウザーやNode.jsで使う一般的なESモジュールでは、相対パスに.jsまで書く形が安全です。
4. 実践課題のフォルダー構成
ここでは商品一覧を作り、役割ごとにファイルを分けます。
day9-project/
├── index.html
└── src/
├── app.js
├── components/
│ └── productList.js
├── data/
│ └── products.js
├── services/
│ └── productService.js
└── utils/
└── format.js
それぞれのファイルには、次の役割を持たせます。
data/products.js:商品データを公開します。utils/format.js:価格を表示用の文字列に変換します。services/productService.js:商品一覧を取得したり、検索したりします。components/productList.js:商品一覧をHTML要素として表示します。app.js:各ファイルの機能を取り込み、イベント処理をつなぎます。
5. 商品データをdataに置く
src/data/products.jsを作り、商品データを名前付きexportで公開します。
// 商品データを名前付きexportで公開します
export const products = [
{
id: 1,
name: "ノート",
price: 300,
category: "文房具",
},
{
id: 2,
name: "ペン",
price: 150,
category: "文房具",
},
{
id: 3,
name: "マグカップ",
price: 1200,
category: "キッチン",
},
];JavaScript各商品はオブジェクトで、複数の商品を配列に入れています。idは商品を区別するための値、nameは名前、priceは価格、categoryはカテゴリーです。
6. 共通処理をutilsに置く
src/utils/format.jsを作り、価格を表示用に整える関数を公開します。
// 数値を日本円の表示用文字列に変換する関数を公開します
export function formatYen(price) {
// 円記号と桁区切りを付けた文字列を返します
return new Intl.NumberFormat("ja-JP", {
style: "currency",
currency: "JPY",
}).format(price);
}JavaScriptこの関数は画面表示用の文字列を作ります。たとえばformatYen(1200)は、日本円の表示形式に整えた文字列を返します。
Intl.NumberFormatはJavaScriptに用意された数値の書式設定機能です。表示形式を一か所にまとめておけば、価格表記を変えたいときに修正する場所が分かりやすくなります。
7. データ処理をservicesに置く
src/services/productService.jsを作ります。このファイルでは商品データを読み込み、検索する処理を担当します。
// dataフォルダーから商品一覧を取り込みます
import { products } from "../data/products.js";
// 商品一覧を返す関数を名前付きexportで公開します
export function getProducts() {
// 商品データの配列を返します
return products;
}
// 名前またはカテゴリーで商品を検索する関数を公開します
export function searchProducts(keyword) {
// 前後の空白を除き、小文字に変換します
const normalizedKeyword = keyword.trim().toLowerCase();
// 空欄なら、すべての商品を返します
if (normalizedKeyword === "") {
return products;
}
// 名前またはカテゴリーに検索文字が含まれる商品を返します
return products.filter((product) => {
// 大文字と小文字を区別せずに比較します
return (
product.name.toLowerCase().includes(normalizedKeyword) ||
product.category.toLowerCase().includes(normalizedKeyword)
);
});
}JavaScriptここでは、productService.jsがproducts.jsからデータを取り込み、検索機能を提供しています。商品データの置き場所と、データを使った処理が別々になっているため、検索ロジックを見つけやすくなります。
8. 表示処理をcomponentsに置く
src/components/productList.jsを作り、商品の一覧を画面に表示する関数をdefault exportで公開します。
// 価格表示用の関数を取り込みます
import { formatYen } from "../utils/format.js";
// 商品一覧を表示する関数をdefault exportで公開します
export default function renderProductList(productList, listElement) {
// 以前の表示内容を消します
listElement.replaceChildren();
// 商品が見つからない場合は、案内を表示します
if (productList.length === 0) {
const message = document.createElement("li");
// HTMLではなく文字としてメッセージを設定します
message.textContent = "該当する商品はありません。";
// リストに案内を追加して、関数を終了します
listElement.append(message);
return;
}
// 商品ごとにリスト項目を作ります
productList.forEach((product) => {
// 商品1件分のli要素を作ります
const item = document.createElement("li");
// 商品名、価格、カテゴリーを文字として設定します
item.textContent =
`${product.name} - ${formatYen(product.price)} - ${product.category}`;
// 作成した商品項目を一覧に追加します
listElement.append(item);
});
}JavaScriptこの関数は、表示する商品一覧と、表示先のHTML要素を引数で受け取ります。APIや画面上の入力欄には依存しないため、別の場所からも使いやすい形です。
外部データやユーザー入力を表示するときは、innerHTMLでHTMLとして挿入せず、textContentのようにテキストとして設定する方法を基本にしましょう。
9. 各機能をapp.jsでつなぐ
src/app.jsを作成します。ここでは、フォームの送信を受け取り、検索サービスを呼び出し、表示関数へ結果を渡します。
// 商品を取得・検索する関数を取り込みます
import { getProducts, searchProducts } from "./services/productService.js";
// 商品一覧を表示するdefault exportを取り込みます
import renderProductList from "./components/productList.js";
// HTMLから検索フォーム、入力欄、一覧を取得します
const searchForm = document.querySelector("#search-form");
const searchInput = document.querySelector("#search-input");
const productListElement = document.querySelector("#product-list");
// 最初にすべての商品を表示します
renderProductList(getProducts(), productListElement);
// フォーム送信時に検索を実行します
searchForm.addEventListener("submit", (event) => {
// ページの再読み込みを防ぎます
event.preventDefault();
// 入力された文字で商品を検索します
const matchedProducts = searchProducts(searchInput.value);
// 検索結果を画面に表示します
renderProductList(matchedProducts, productListElement);
});JavaScriptapp.jsは各機能を自分ですべて実装するファイルではなく、取り込んだ機能をつなぐ役割です。処理が増えても、データ・検索・表示をそれぞれのファイルで整理できます。
10. HTMLからモジュールを読み込む
プロジェクトのルートにあるindex.htmlを作ります。
<!doctype html>
<html lang="ja">
<head>
<!-- 日本語を正しく表示するための文字コードです -->
<meta charset="UTF-8" />
<!-- スマートフォンの画面幅に合わせます -->
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!-- ページタイトルを設定します -->
<title>商品検索</title>
<!-- app.jsをESモジュールとして読み込みます -->
<script type="module" src="./src/app.js"></script>
</head>
<body>
<!-- ページ見出しです -->
<h1>商品検索</h1>
<!-- 商品検索フォームです -->
<form id="search-form">
<!-- 検索欄の説明です -->
<label for="search-input">商品名またはカテゴリーで検索</label>
<!-- 検索文字を入力します -->
<input id="search-input" type="search" />
<!-- フォームを送信するボタンです -->
<button type="submit">検索</button>
</form>
<!-- 商品一覧を表示します -->
<ul id="product-list"></ul>
</body>
</html>
ブラウザーでESモジュールを読み込むには、<script type="module">を使います。モジュールは通常、ローカルファイルを直接開くfile://では動作しないことがあります。VS Codeのローカル開発サーバー拡張機能や、Node.jsの簡単な開発サーバーなどを使い、http://localhost/...から 開いてください。
11. Node.jsでESモジュールを実行する場合
ブラウザーでは<script type="module">を指定します。Node.jsで.jsファイルをESモジュールとして実行する場合は、プロジェクトのpackage.jsonに"type": "module"を指定する方法があります。
{
"name": "day9-project",
"version": "1.0.0",
"type": "module"
}JSONこの設定を加えると、Node.jsはプロジェクト内の.jsをESモジュールとして扱います。ブラウザー向けのコードにはdocumentなどのブラウザー機能が含まれているため、Node.jsのターミナルから実行できないものもあります。実行環境に応じてコードを使い分けましょう。
12. よくある間違い
- パスが間違っている:importのパスは、読み込むファイルから見た位置で指定します。
- 拡張子を書き忘れる:ブラウザーのESモジュールでは、相対パスに
.jsまで書く形を使いましょう。 - 名前付きexportに波かっこを忘れる:
import { formatYen } from "./utils/format.js"のように書きます。 - default exportに波かっこをつける:default exportは通常、
import renderProductList from "./components/productList.js"のように波かっこを使いません。 - 名前の大文字・小文字が違う:ファイル名やexportした名前は、正確に合わせます。
- モジュールとして読み込んでいない:ブラウザーでは、HTML側に
type="module"が必要です。 - HTMLを直接開いている:ローカルサーバーから開く必要がある環境では、
file://ではなく開発サーバーを使います。
エラーが出たら、まずファイル名、フォルダーの位置、importの相対パス、exportとimportの名前が一致しているかを確認しましょう。
13. Day 9のチェックリスト
exportで関数や値を別のファイルから使えるようにできます。importで別ファイルの機能を取り込めます。- 名前付きexportは、波かっこを使ってimportすることが分かります。
- default exportは、通常波かっこなしでimportすることが分かります。
- 相対パスが、importを書くファイルから見た位置であると理解しています。
- データ、共通処理、サービス、表示、アプリの起点を別ファイルに整理できます。
- ブラウザーでモジュールを使うとき、
type="module"とローカルサーバーが必要になる場合があると分かります。
モジュールを使うときは、「このコードは何の役割か」「どのファイルで管理するか」「他のファイルへ何を公開するか」を考えます。まずは小さく分け、data、utils、services、componentsの役割を意識して整理しましょう。この考え方は、ReactやNext.jsのアプリを複数のファイルに分けて作るときの土台になります。
