基本的な使用例

以下のプログラムは、Proxy.defineProperty() を使用してオブジェクトにプロパティを定義する基本的な例です。

const obj = {};

// データプロパティを定義
const result = Reflect.defineProperty(obj, 'name', {
  value: 'John',
  writable: true,
  enumerable: true,
  configurable: true
});

console.log(result); // true
console.log(obj.name); // "John"

このプログラムでは、Proxy.defineProperty() を使用して obj オブジェクトに name プロパティを定義しています。メソッドは操作が成功したことを示す true を返します。

アクセサプロパティの定義例

以下のプログラムは、Proxy.defineProperty() を使用してアクセサプロパティ（getter と setter）を定義する例です。

const person = {
  firstName: 'John',
  lastName: 'Doe'
};

// アクセサプロパティを定義
Reflect.defineProperty(person, 'fullName', {
  get() {
    return <code>${this.firstName} ${this.lastName}</code>;
  },
  set(value) {
    const parts = value.split(' ');
    this.firstName = parts[0];
    this.lastName = parts[1];
  },
  enumerable: true,
  configurable: true
});

console.log(person.fullName); // "John Doe"

person.fullName = 'Jane Smith';
console.log(person.firstName); // "Jane"
console.log(person.lastName); // "Smith"

このプログラムでは、Proxy.defineProperty() を使用して person オブジェクトに fullName アクセサプロパティを定義しています。このプロパティには、firstName と lastName を組み合わせて返す getter と、値を分割して firstName と lastName に設定する setter が含まれています。

操作が失敗する例

以下のプログラムは、Proxy.defineProperty() が失敗するケースを示す例です。

const obj = {};

// まず、configurable: false の不変プロパティを定義
const defineResult = Reflect.defineProperty(obj, 'constant', {
  value: 42,
  writable: false,
  enumerable: true,
  configurable: false
});

console.log(defineResult); // true
console.log(obj.constant); // 42

// 既存の設定不可能なプロパティを再定義しようとする
const redefineResult = Reflect.defineProperty(obj, 'constant', {
  value: 100
});

console.log(redefineResult); // false
console.log(obj.constant); // 42 (変更されていない)

// Object.defineProperty() では例外が発生する
try {
  Object.defineProperty(obj, 'constant', { value: 100 });
} catch (e) {
  console.log('エラー:', e.message);
  // エラー: Cannot redefine property: constant
}

このプログラムでは、最初に configurable: false のプロパティを定義し、その後そのプロパティを変更しようとしています。Proxy.defineProperty() は操作が失敗したことを示す false を返します。対照的に、Object.defineProperty() は同じケースで例外をスローします。

Object.defineProperty との比較例

以下のプログラムは、Proxy.defineProperty() と Object.defineProperty() の違いを示す例です。

function definePropertySafely(obj, prop, attributes) {
  // Object.defineProperty の場合
  try {
    Object.defineProperty(obj, prop, attributes);
    return true;
  } catch (e) {
    console.log('Object.defineProperty エラー:', e.message);
    return false;
  }
}

function definePropertyWithReflect(obj, prop, attributes) {
  // Reflect.defineProperty の場合
  const result = Reflect.defineProperty(obj, prop, attributes);
  if (!result) {
    console.log('Reflect.defineProperty 失敗');
  }
  return result;
}

const obj = {};
const frozen = Object.freeze({});

// 通常のオブジェクトでは両方成功
console.log(definePropertySafely(obj, 'a', { value: 1 })); // true
console.log(definePropertyWithReflect(obj, 'b', { value: 2 })); // true

// 凍結されたオブジェクトでは両方失敗するが、Reflect.defineProperty はエラーをスローしない
console.log(definePropertySafely(frozen, 'c', { value: 3 })); // false
console.log(definePropertyWithReflect(frozen, 'd', { value: 4 })); // false

このプログラムでは、通常のオブジェクトと凍結されたオブジェクトに対して Object.defineProperty() と Proxy.defineProperty() を使用しています。凍結されたオブジェクトでは、Object.defineProperty() は例外をスローしますが、Proxy.defineProperty() は単に false を返します。

注意点

• 戻り値: Proxy.defineProperty() は操作が成功した場合は true、失敗した場合は false を返します。
• 例外処理: Object.defineProperty() とは異なり、操作が失敗しても例外をスローしません。
• 属性オブジェクト: attributes パラメータは、データディスクリプタまたはアクセサディスクリプタの形式を持つオブジェクトでなければなりません。
• プロキシ連携: Proxy.defineProperty() は roxy の defineProperty トラップと連携するために設計されています。
• ES2015+: このメソッドは ECMAScript 2015 (ES6) で導入されました。