ページ内リンク:

• Symbolとは
• 基本的な使い方
• ユニークな識別子としての活用
• オブジェクトの隠しプロパティ
• 組み込みのSymbol
• 実用例

Symbolとは

Symbolは、ES6（ECMAScript 2015）で導入されたプリミティブなデータ型の1つです。Symbol()関数を使って生成され、ユニークな識別子を作成するために使用されます。生成されたシンボルは、他のどのシンボルとも異なるため、キーとしての衝突を防ぎます。

基本的な使い方

Symbolの基本的な使い方は、以下のようにSymbol()を呼び出して作成します。

const sym1 = Symbol();
const sym2 = Symbol();
console.log(sym1 === sym2); // false: シンボルは常にユニーク

オプションで、説明（description）を追加することができます。この説明は、デバッグ時に役立つだけで、シンボル自体のユニーク性には影響しません。

const symWithDesc = Symbol('説明用シンボル');
console.log(symWithDesc.description); // '説明用シンボル'

ユニークな識別子としての活用

シンボルは、オブジェクトのプロパティキーとして使用できます。この場合、他のキーと衝突しないため、安全にプロパティを追加できます。

const obj = {};
const key1 = Symbol('key1');
const key2 = Symbol('key2');

obj[key1] = '値1';
obj[key2] = '値2';

console.log(obj[key1]); // '値1'
console.log(obj[key2]); // '値2'

通常の文字列キーと異なり、シンボルキーはfor...inやObject.keys()では列挙されません。

console.log(Object.keys(obj)); // []
console.log(Object.getOwnPropertySymbols(obj)); // [Symbol(key1), Symbol(key2)]

オブジェクトの隠しプロパティ

シンボルを使用すると、オブジェクトに「隠しプロパティ」を追加できます。これらのプロパティは、意図しない操作や名前の衝突を防ぎつつ、必要に応じてアクセスできます。

const hiddenKey = Symbol('hidden');
const myObject = {
    visible: '見えるプロパティ',
    [hiddenKey]: '隠れたプロパティ'
};

console.log(myObject.visible); // '見えるプロパティ'
console.log(myObject[hiddenKey]); // '隠れたプロパティ'

組み込みのSymbol

JavaScriptにはいくつかの組み込みシンボルが存在します。これらは、オブジェクトのカスタマイズや特殊な動作の定義に使われます。

• Symbol.iterator: オブジェクトを反復可能にする。
• Symbol.toStringTag: オブジェクトのtoString()メソッドで返される文字列をカスタマイズする。
• Symbol.species: サブクラス化されたオブジェクトのコンストラクタを指定する。

例えば、Symbol.iteratorを使って独自の反復処理を実装できます。

const myIterable = {
    *[Symbol.iterator]() {
        yield 1;
        yield 2;
        yield 3;
    }
};

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

実用例

以下は、Symbolを使用したいくつかの実用的な例です。

ライブラリ間のプロパティ衝突を回避

const libraryKey = Symbol('ライブラリ専用キー');
const obj = {};

obj[libraryKey] = 'ライブラリのデータ';

console.log(obj[libraryKey]); // 'ライブラリのデータ'

デバッグ用の識別子

const debugKey = Symbol('デバッグ用');
const appConfig = {
    [debugKey]: 'デバッグモード有効'
};

console.log(appConfig[debugKey]); // 'デバッグモード有効'

独自のtoString()実装

const customObj = {
    [Symbol.toStringTag]: 'CustomObject'
};

console.log(Object.prototype.toString.call(customObj)); // [object CustomObject]

これらの例を通じて、Symbolの用途の広さと、プログラムの安全性を向上させるための有用性を理解できたのではないでしょうか。