[ES2015] Map/Set

JavaScriptでデータの集まり（コレクション）を扱うビルトインオブジェクトは、ObjectやArrayだけではありません。この章では、ES2015で導入されたマップ型のコレクションであるMapと、セット型のコレクションであるSetについて学びます。

Map

Mapはマップ型のコレクションを扱うためのビルトインオブジェクトです。マップとは、キーと値の組み合わせからなる抽象データ型です。他のプログラミング言語の文脈では辞書やハッシュマップ、連想配列などと呼ばれることもあります。

マップの作成と初期化

Mapオブジェクトをnewすることで、新しいマップを作成できます。作成されたばかりのマップは何も持っていません。そのため、マップが持つ要素の数を返すsizeプロパティは0を返します。

const map = new Map();
console.log(map.size); // => 0

Mapオブジェクトをnewで初期化するときに、コンストラクタに初期値を渡せます。コンストラクタ引数として渡せるのはエントリーの配列です。エントリーとは、1つのキーと値の組み合わせを[キー, 値]という形式の配列で表現したものです。

次のコードでは、Mapに初期値となるエントリー（配列）の配列を渡しています。

const map = new Map([["key1", "value1"], ["key2", "value2"]]);
// 2つのエントリーで初期化されている
console.log(map.size); // => 2

要素の追加と取り出し

Mapには新しい要素をsetメソッドで追加でき、追加した要素をgetメソッドで取り出せます。

setメソッドは特定のキーと値を持つ要素をマップに追加します。ただし、同じキーで複数回setメソッドを呼び出した際は、後から追加された値で上書きされます。

getメソッドは特定のキーにひもづいた値を取り出します。また、特定のキーにひもづいた値を持っているかを確認するhasメソッドがあります。

const map = new Map();
// 新しい要素の追加
map.set("key", "value1");
console.log(map.size); // => 1
console.log(map.get("key")); // => "value1"
// 要素の上書き
map.set("key", "value2");
console.log(map.get("key")); // => "value2"
// キーの存在確認
console.log(map.has("key")); // => true
console.log(map.has("foo")); // => false

deleteメソッドはマップから要素を削除します。 deleteメソッドに渡されたキーと、そのキーにひもづいた値がマップから削除されます。また、マップが持つすべての要素を削除するためのclearメソッドがあります。

const map = new Map();
map.set("key1", "value1");
map.set("key2", "value2");
console.log(map.size); // => 2
map.delete("key1");
console.log(map.size); // => 1
map.clear();
console.log(map.size); // => 0

マップの反復処理

マップが持つ要素を列挙するメソッドとして、forEach、keys、values、entriesがあります。

forEachメソッドはマップが持つすべての要素を、マップへの挿入順に反復処理します。コールバック関数には引数として値、キー、マップの3つが渡されます。配列のforEachメソッドと似ていますが、インデックスの代わりにキーが渡されます。配列はインデックスにより要素を特定しますが、マップはキーにより要素を特定するためです。

const map = new Map([["key1", "value1"], ["key2", "value2"]]);
const results = [];
map.forEach((value, key) => {
    results.push(`${key}:${value}`);
});
console.log(results); // => ["key1:value1","key2:value2"]

keysメソッドはマップが持つすべての要素のキーを挿入順に並べたIteratorオブジェクトを返します。同様に、valuesメソッドはマップが持つすべての要素の値を挿入順に並べたIteratorオブジェクトを返します。これらの返り値はIteratorオブジェクトであって配列ではありません。そのため、次の例のようにfor...of文で反復処理を行ったり、Array.fromメソッドに渡して配列に変換して使ったりします。

const map = new Map([["key1", "value1"], ["key2", "value2"]]);
const keys = [];
// keysメソッドの返り値(Iterator)を反復処理する
for (const key of map.keys()) {
    keys.push(key);
}
console.log(keys); // => ["key1","key2"]
// keysメソッドの返り値(Iterator)から配列を作成する
const keysArray = Array.from(map.keys());
console.log(keysArray); // => ["key1","key2"]

entriesメソッドはマップが持つすべての要素をエントリーとして挿入順に並べたIteratorオブジェクトを返します。先述のとおりエントリーは[キー, 値]の配列です。そのため、配列の分割代入を使うとエントリーからキーと値を簡単に取り出せます。

const map = new Map([["key1", "value1"], ["key2", "value2"]]);
const entries = [];
for (const [key, value] of map.entries()) {
    entries.push(`${key}:${value}`);
}
console.log(entries); // => ["key1:value1","key2:value2"]

また、マップ自身もiterableなオブジェクトなので、for...of文で反復処理できます。マップをfor...of文で反復したときは、すべての要素をエントリーとして挿入順に反復処理します。つまり、entriesメソッドの返り値を反復処理するときと同じ結果が得られます。

const map = new Map([["key1", "value1"], ["key2", "value2"]]);
const results = [];
for (const [key, value] of map) {
    results.push(`${key}:${value}`);
}
console.log(results); // => ["key1:value1","key2:value2"]

マップとしてのObjectとMap

ES2015でMapが導入されるまで、JavaScriptにおいてマップ型を実現するためにObjectが利用されてきました。何かをキーにして値にアクセスするという点で、MapとObjectはよく似ています。ただし、マップとしてのObjectにはいくつかの問題があります。

Objectのprototypeオブジェクトから継承されたプロパティによって、意図しないマッピングを生じる危険性がある
また、プロパティとしてデータを持つため、キーとして使えるのは文字列かSymbolに限られる

Objectにはprototypeオブジェクトがあるため、いくつかのプロパティは初期化されたときから存在します。 Objectをマップとして使うと、そのプロパティと同じ名前のキーを使おうとしたときに問題となります（詳細は「オブジェクト」の章の「プロパティの存在を確認する」を参照）。

たとえばconstructorという文字列はObject.prototype.constructorプロパティと衝突してしまいます。そのためconstructorのような文字列をオブジェクトのキーに使うことで意図しないマッピングを生じる危険性があります。

const map = {};
// マップがキーを持つことを確認する
function has(key) {
    return typeof map[key] !== "undefined";
}
console.log(has("foo")); // => false
// Objectのプロパティが存在する
console.log(has("constructor")); // => true

このマップとして使うオブジェクトの問題は、ObjectのインスタンスをObject.create(null)のように初期化して作ることで回避されてきました（詳細は「プロトタイプオブジェクト」の章の「Object.prototypeを継承しないオブジェクト」を参照）。

ES2015では、これらの問題を根本的に解決するMapが導入されました。 Mapはプロパティとは異なる仕組みでデータを格納します。そのため、Mapのプロトタイプが持つメソッドやプロパティとキーが衝突することはありません。また、Mapではマップのキーとしてあらゆるオブジェクトを使えます。

ほかにもMapには次のような利点があります。

マップのサイズを簡単に知ることができる
マップが持つ要素を簡単に列挙できる
オブジェクトをキーにすると参照ごとに違うマッピングができる

たとえばショッピングカートのような仕組みを作るとき、次のようにMapを使って商品のオブジェクトと注文数をマッピングできます。

// ショッピングカートを表現するクラス
class ShoppingCart {
    constructor() {
        // 商品とその数を持つマップ
        this.items = new Map();
    }
    // カートに商品を追加する
    addItem(item) {
        // `item`がない場合は`undefined`を返すため、Nullish coalescing演算子(`??`)を使いデフォルト値として`0`を設定する
        const count = this.items.get(item) ?? 0;
        this.items.set(item, count + 1);
    }
    // カート内の合計金額を返す
    getTotalPrice() {
        return Array.from(this.items).reduce((total, [item, count]) => {
            return total + item.price * count;
        }, 0);
    }
    // カートの中身を文字列にして返す
    toString() {
        return Array.from(this.items).map(([item, count]) => {
            return `${item.name}:${count}`;
        }).join(",");
    }
}
const shoppingCart = new ShoppingCart();
// 商品一覧
const shopItems = [
    { name: "みかん", price: 100 },
    { name: "リンゴ", price: 200 },
];

// カートに商品を追加する
shoppingCart.addItem(shopItems[0]);
shoppingCart.addItem(shopItems[0]);
shoppingCart.addItem(shopItems[1]);

// 合計金額を表示する
console.log(shoppingCart.getTotalPrice()); // => 400
// カートの中身を表示する
console.log(shoppingCart.toString()); // => "みかん:2,リンゴ:1"

Objectをマップとして使うときに起きる多くの問題は、Mapオブジェクトを使うことで解決しますが、常にMapがObjectの代わりになるわけではありません。マップとしてのObjectには次のような利点があります。

リテラル表現があるため作成しやすい
規定のJSON表現があるため、JSON.stringify関数を使ってJSONに変換するのが簡単である
ネイティブAPI・外部ライブラリを問わず、多くの関数がマップとしてObjectを渡される設計になっている

次の例では、ログインフォームのsubmitイベントを受け取ったあと、サーバーにPOSTリクエストを送信しています。サーバーにJSON文字列を送るために、JSON.stringify関数を使います。そのため、Objectのマップを作ってフォームの入力内容を持たせています。このような簡易なマップにおいては、Objectを使うほうが適切でしょう。

// URLとObjectのマップを受け取ってPOSTリクエストを送る関数
function sendPOSTRequest(url, data) {
    // fetchを使ってPOSTリクエストを送る
    fetch(url, {
        method: "POST",
        headers: { "Content-Type": "application/json" },
        body: JSON.stringify(data),
    }).catch((error) => {
        console.error(error);
    });
}

// formのsubmitイベントを受け取る関数
function onLoginFormSubmit(event) {
    const form = event.target;
    const data = {
        userName: form.elements.userName,
        password: form.elements.password,
    };
    sendPOSTRequest("/api/login", data);
}

WeakMap

WeakMapは、Mapと同じくマップを扱うためのビルトインオブジェクトです。 Mapと違う点は、キーを弱い参照（Weak Reference）で持つことです。

弱い参照とは、ガベージコレクション（GC）によるオブジェクトの解放を妨げないための特殊な参照です。本来、GCによりメモリから解放できるオブジェクトは、どこからも参照されていないものだけです。弱い参照は例外的に、該当するオブジェクトへの弱い参照があったとしても、GCはそのオブジェクトを解放できます。

そのため、弱い参照は不要になったオブジェクトを参照し続けて発生してしまうメモリリークを防ぐために使われます。 WeakMapでは不要になったキーとそれにひもづいた値が自動的に削除されるため、メモリリークを引き起こす心配がありません。

次のコードでは、最初にobjには{}を設定し、WeakMapではそのobjをキーにして値（"value"）を設定しています。次にobjに別の値（ここではnull）を代入すると、objが元々参照していた{}という値はどこからも参照されなくなります。このときWeakMapは{}への弱い参照を持っていますが、弱い参照はGCを妨げないため、{}は不要になった値としてGCによりメモリから解放されます。

同時に、WeakMapは解放されたオブジェクト（{}）をキーにしてひもづいていた値（"value"）を破棄できます。ただし、どのタイミングで実際にメモリから解放するかは、JavaScriptエンジンの実装に依存します。

const map = new WeakMap();
// キーとなるオブジェクト
let obj = {};
// {} への参照をキーに値をセットする
map.set(obj, "value");
// {} への参照を破棄する
obj = null;
// GCが発生するタイミングでWeakMapから値が破棄される

WeakMapはMapと似ていますがiterableではありません。そのため、キーを列挙するkeysメソッドや、データの数を返すsizeプロパティなどは存在しません。また、キーを弱い参照で持つ特性上、キーとして使えるのは参照型のオブジェクトだけです。

WeakMapの主な使い方のひとつは、クラスにプライベートの値を格納することです。 this （クラスインスタンス）を WeakMap のキーにすることで、インスタンスの外からはアクセスできない値を保持できます。また、クラスインスタンスが参照されなくなったときには自動的に解放されます。

次のコードでは、オブジェクトが発火するイベントのリスナー関数（イベントリスナー）を WeakMap で管理しています。イベントリスナーとは、イベントが発生したときに呼び出される関数のことです。このマップをMapで実装してしまうと、明示的に削除されるまでイベントリスナーはメモリ上に残り続けます。ここでWeakMapを使うと、addListener メソッドに渡されたlistenerは EventEmitter インスタンスが参照されなくなった際、自動的に解放されます。

// イベントリスナーを管理するマップ
const listenersMap = new WeakMap();

class EventEmitter {
    addListener(listener) {
        // this(インスタンス)にひもづいたリスナーの配列を取得する
        const listeners = listenersMap.get(this) ?? [];
        const newListeners = listeners.concat(listener);
        // this をキーにして、新しいリスナーの配列をセットする
        listenersMap.set(this, newListeners);
    }
    // ...EventEmitterには他にもメソッドがあるが省略...
}

// `event`は`EventEmitter`のインスタンスへの参照をもつ
let event = new EventEmitter();
// `EventEmitter`のインスタンスへイベントリスナーを追加する
event.addListener(() => {
    // `EventEmitter`のインスタンスに紐づくイベントリスナーの処理
});
// `event`へ`null`を代入することで、`EventEmitter`のインスタンスへの参照がなくなる
// インスタンスがどこからも参照されなくなったため、紐づいていたイベントリスナーが自動的に解放される
event = null;

また、あるオブジェクトから計算した結果を一時的に保存する用途でもよく使われます。次の例ではHTML要素の高さを計算した結果を保存して、2回目以降に同じ計算をしないようにしています。

const cache = new WeakMap();

function getHeight(element) {
    if (cache.has(element)) {
        return cache.get(element);
    }
    const height = element.getBoundingClientRect().height;
    // elementオブジェクトに対して高さをひもづけて保存している
    cache.set(element, height);
    return height;
}

[コラム] キーの等価性とNaN

Mapに値をセットする際のキーにはあらゆるオブジェクトが使えます。このときのマップが特定のキーをすでに持っているか、つまり挿入と上書きの判定は基本的に===演算子と同じです。

ただし、キーがNaNの扱いだけが例外的に違います。Mapにおけるキーの比較では、NaN同士は常に等価であるとみなされます。この挙動はSame-value-zeroアルゴリズムと呼ばれます。

次のコードでは、NaN同士の===の比較結果がfalseになるのに対して、MapのキーではNaN同士の比較結果が一致していることがわかります。

const map = new Map();
map.set(NaN, "value");
// NaNは===で比較した場合は常にfalse
console.log(NaN === NaN); // => false
// MapはNaN同士を比較できる
console.log(map.has(NaN)); // => true
console.log(map.get(NaN)); // => "value"

Set

Setはセット型のコレクションを扱うためのビルトインオブジェクトです。セットとは、重複する値がないことを保証したコレクションのことを言います。 Setは追加した値を列挙できるので、値が重複しないことを保証する配列のようなものとしてよく使われます。ただし、配列と違って要素は順序を持たず、インデックスによるアクセスはできません。

セットの作成と初期化

Setオブジェクトをnewすることで、新しいセットを作れます。作成されたばかりのセットは何も持っていません。そのため、セットが持つ要素の数を返すsizeプロパティは0を返します。

const set = new Set();
console.log(set.size); // => 0

Setオブジェクトをnewで初期化するときに、コンストラクタに初期値を渡せます。コンストラクタ引数として渡せるのはiterableオブジェクトです。

次のコードではiterableオブジェクトである配列を初期値として渡しています。また、Setでは重複する同じ値を持たないことを保証するため、同じ値は1つのみ格納されます。

// "value2"が重複するため、片方は無視される
const set = new Set(["value1", "value2", "value2"]);
// セットのサイズは2になる
console.log(set.size); // => 2

値の追加と取り出し

作成したセットに値を追加するには、addメソッドを使います。先述のとおり、セットは重複する値を持たないことが保証されます。そのため、すでにセットが持っている値をaddメソッドに渡した際は無視されます。

また、セットが特定の値を持っているかどうかを確認するhasメソッドがあります。

const set = new Set();
// 値の追加
set.add("a");
console.log(set.size); // => 1
// 重複する値は追加されない
set.add("a");
console.log(set.size); // => 1
// 値の存在確認
console.log(set.has("a")); // => true
console.log(set.has("b")); // => false

セットから値を削除するには、deleteメソッドを使います。 deleteメソッドに渡された値がセットから削除されます。また、セットが持つすべての値を削除するためのclearメソッドがあります。

const set = new Set();
set.add("a");
set.add("b");
console.log(set.size); // => 2
set.delete("a");
console.log(set.size); // => 1
set.clear();
console.log(set.size); // => 0

セットの反復処理

セットが持つ値を反復処理するには、forEachメソッドが利用できます。 forEachメソッドではセットが持つすべての要素を、セットへの挿入順に反復します。

const set = new Set(["a", "b"]);
const results = [];
set.forEach((value) => {
    results.push(value);
});
console.log(results); // => ["a","b"]

セットからIteratorオブジェクトを作成するメソッドとしてkeys、values、entriesがあります。これらはMapとの類似性のために存在しますが、セットにはマップにおけるキー相当のものがありません。そのため、keysメソッドはvaluesメソッドのエイリアスになっており、セットが持つすべての値を挿入順に列挙するIteratorオブジェクトを返します。また、entriesメソッドは[値, 値]という形のエントリーを挿入順に列挙するIteratorオブジェクトを返します。

const set = new Set(["a", "b"]);
// keysで列挙
const keysResults = [];
for (const value of set.keys()) {
    keysResults.push(value);
}
console.log(keysResults); // => ["a","b"]
// entriesで列挙
const entryResults = [];
for (const entry of set.entries()) {
    // entryは[値, 値]という配列
    entryResults.push(entry);
}
console.log(entryResults); // => [["a","a"], ["b", "b"]]

Setオブジェクト自身もiterableなオブジェクトであるためfor...of文で反復処理できます。 for...of文でSetオブジェクトを反復処理したときも、セットへの挿入順に値が取り出されます。 keys、values、entriesメソッドはどれも取得できる情報は同じであるため、基本的にはSetオブジェクト自体を反復処理することで代用できます。

const set = new Set(["a", "b"]);
const results = [];
for (const value of set) {
    results.push(value);
}
console.log(results); // => ["a","b"]

WeakSet

WeakSetは弱い参照で値を持つセットです。 WeakSetはSetと似ていますが、iterableではないので追加した値を反復処理できません。つまり、WeakSetは値の追加と削除、存在確認以外のことができません。データの格納ではなく、データの一意性を確認することに特化したセットと言えるでしょう。

また、弱い参照で値を持つ特性上、WeakSetの値として使えるのは参照型のオブジェクトだけです。

まとめ

この章ではMapとSetについて学びました。

Mapはキーと値の組み合わせからなるコレクションを扱うビルトインオブジェクト
Mapのキーはプロトタイプオブジェクトのプロパティと名前が衝突しないため意図しないマッピングを避けられる
WeakMapはキーを弱い参照で持つMapと同様のビルトインオブジェクト
Setは重複する値がないことを保証した順序を持たないコレクションを扱うビルトインオブジェクト
WeakSetは値を弱い参照で持つSetと同様のビルトインオブジェクト