JavaScriptのシンボルを使って一意なオブジェクトプロパティを定義

作成日 2024.12.19
javascript
javascript

シンボルは、JavaScriptにおけるユニークな識別子を作成するためのプリミティブ型です。本記事では、シンボルを使った一意なオブジェクトプロパティの定義とその活用方法について掘り下げます。

1. シンボルの基本
2. シンボルをオブジェクトプロパティに使用
3. シンボルプロパティのアクセス
4. シンボルの説明
5. グローバルシンボル
6. グローバルシンボルの検索
7. シンボルを使ったクラスのカプセル化
8. シンボルを使ったメタデータの付加
9. 組み込みのシンボル
10. シンボルを用いたマジックメソッド
11. 注意点とベストプラクティス
12. まとめ

シンボルの基本

シンボルは、Symbol()を使用して作成され、一意な値を持ちます。

const sym1 = Symbol();
const sym2 = Symbol();
console.log(sym1 === sym2); // false

シンボルをオブジェクトプロパティに使用

シンボルはプロパティの衝突を防ぎます。

const uniqueKey = Symbol();
const obj = {
  [uniqueKey]: 'This is unique'
};
console.log(obj[uniqueKey]); // This is unique

シンボルプロパティのアクセス

シンボルプロパティは通常のfor...inでは列挙されません。

const symKey = Symbol('key');
const obj = { [symKey]: 'value', normalKey: 'normalValue' };

for (let key in obj) {
  console.log(key); // normalKey
}

console.log(Object.getOwnPropertySymbols(obj)); // [ Symbol(key) ]

シンボルの説明

シンボルには説明（description）を付けることができます。

const sym = Symbol('description');
console.log(sym.description); // description

グローバルシンボル

Symbol.for()でグローバルレジストリにシンボルを登録します。

const globalSym = Symbol.for('globalKey');
const anotherGlobalSym = Symbol.for('globalKey');
console.log(globalSym === anotherGlobalSym); // true

グローバルシンボルの検索

Symbol.keyFor()を使うと、登録済みシンボルのキーを取得できます。

const sym = Symbol.for('sharedKey');
console.log(Symbol.keyFor(sym)); // sharedKey

シンボルを使ったクラスのカプセル化

プライベートプロパティとしてシンボルを使用できます。

const privateKey = Symbol();
class MyClass {
  constructor(value) {
    this[privateKey] = value;
  }
  getPrivateValue() {
    return this[privateKey];
  }
}

const instance = new MyClass('secret');
console.log(instance.getPrivateValue()); // secret
console.log(instance.privateKey); // undefined

シンボルを使ったメタデータの付加

シンボルを利用してメタデータを追加します。

const metadataKey = Symbol('metadata');
const obj = {
  [metadataKey]: { author: 'Alice', version: 1 }
};

console.log(obj[metadataKey]); // { author: 'Alice', version: 1 }

組み込みのシンボル

JavaScriptには特別な目的を持つ組み込みシンボルが用意されています。

class MyArray extends Array {
  static get [Symbol.species]() {
    return Array;
  }
}

const arr = new MyArray(1, 2, 3);
const filtered = arr.filter(x => x > 1);
console.log(filtered instanceof MyArray); // false
console.log(filtered instanceof Array); // true

シンボルを用いたマジックメソッド

Symbol.iteratorを使用して反復可能なオブジェクトを作成します。

const iterable = {
  [Symbol.iterator]() {
    let count = 0;
    return {
      next() {
        count++;
        return count <= 3
          ? { value: count, done: false }
          : { done: true };
      }
    };
  }
};

for (const value of iterable) {
  console.log(value); // 1, 2, 3
}