TypeScript でオブジェクトがインターフェースを実装しているかどうかをランタイムで確認する方法

2024-05-07

TypeScript でオブジェクトがインターフェースを実装しているかどうかをランタイムで確認する方法

TypeScript では、インターフェースを使用してオブジェクトの構造を定義できます。インターフェースは、オブジェクトが持つべきプロパティとメソッドを定義しますが、実装は規定しません。オブジェクトがインターフェースを実装しているかどうかをランタイムで確認するには、いくつかの方法があります。

instanceof 演算子は、オブジェクトが特定のクラスのインスタンスかどうかを確認するために使用されます。TypeScript では、インターフェースもクラスとして扱われるため、instanceof 演算子を使用して、オブジェクトがインターフェースを実装しているかどうかを確認できます。

interface Person {
  name: string;
  age: number;
}

function isPerson(obj: any): obj is Person {
  return obj instanceof Person;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const notPerson: object = {};

console.log(isPerson(person)); // true
console.log(isPerson(notPerson)); // false

型ガードは、特定の条件を満たすかどうかによって、変数の型を絞り込むために使用されます。インターフェースを実装しているかどうかを確認するために型ガードを使用することもできます。

interface Person {
  name: string;
  age: number;
}

function isPerson(obj: any): obj is Person {
  return typeof obj === 'object' && 'name' in obj && 'age' in obj;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const notPerson: object = {};

console.log(isPerson(person)); // true
console.log(isPerson(notPerson)); // false

ライブラリを使用する

class-transformer や ts-util などのライブラリは、オブジェクトがインターフェースを実装しているかどうかを確認するためのユーティリティ関数を提供しています。

import { isObject, isClassInstance } from 'class-transformer';

interface Person {
  name: string;
  age: number;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const notPerson: object = {};

console.log(isObject(person) && isClassInstance(person, Person)); // true
console.log(isObject(notPerson) && isClassInstance(notPerson, Person)); // false

これらの方法はそれぞれ異なる利点と欠点があります。

instanceof 演算子は最もシンプルですが、コンパイル時に型チェックが行われないため、ランタイムエラーが発生する可能性があります。
型ガードはコンパイル時に型チェックが行われますが、より複雑なロジックが必要になる場合があります。
ライブラリは、複雑なロジックを処理するのに役立ちますが、追加の依存関係が必要になります。

状況に応じて適切な方法を選択することが重要です。

以下のサンプルコードは、TypeScript でオブジェクトがインターフェースを実装しているかどうかを確認する方法の 3 つの例を示しています。

instanceof 演算子

interface Person {
  name: string;
  age: number;
}

function isPerson(obj: any): obj is Person {
  return obj instanceof Person;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const notPerson: object = {};

console.log(isPerson(person)); // true
console.log(isPerson(notPerson)); // false

型ガード

interface Person {
  name: string;
  age: number;
}

function isPerson(obj: any): obj is Person {
  return typeof obj === 'object' && 'name' in obj && 'age' in obj;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const notPerson: object = {};

console.log(isPerson(person)); // true
console.log(isPerson(notPerson)); // false

ライブラリを使用する

import { isObject, isClassInstance } from 'class-transformer';

interface Person {
  name: string;
  age: number;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const notPerson: object = {};

console.log(isObject(person) && isClassInstance(person, Person)); // true
console.log(isObject(notPerson) && isClassInstance(notPerson, Person)); // false

これらの例は、基本的な使用方法を示すものです。実際の使用例では、より複雑なロジックが必要になる場合があります。

以下の例は、より複雑なインターフェースとオブジェクトを使用して、各方法がどのように動作するかを示しています。

例 1: 継承

interface Animal {
  name: string;
}

interface Person extends Animal {
  age: number;
}

function isPerson(obj: any): obj is Person {
  return isObject(obj) && 'name' in obj && 'age' in obj;
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

const animal: Animal = {
  name: 'Fido'
};

console.log(isPerson(person)); // true
console.log(isPerson(animal)); // false

例 2: オプションプロパティ

interface User {
  name: string;
  email?: string;
}

function isUser(obj: any): obj is User {
  return isObject(obj) && 'name' in obj;
}

const user: User = {
  name: 'John Doe'
};

const notUser: object = {
  age: 30
};

console.log(isUser(user)); // true
console.log(isUser(notUser)); // false

これらの例は、instanceof 演算子、型ガード、ライブラリを使用して、オブジェクトがインターフェースを実装しているかどうかをランタイムで確認する方法を示しています。状況に応じて適切な方法を選択することが重要です。

TypeScript でオブジェクトがインターフェースを実装しているかどうかを確認するその他の方法

構造的型システム

TypeScript の構造的型システムを使用して、オブジェクトのプロパティとメソッドがインターフェースで定義されているものと一致しているかどうかを確認できます。これは、特に複雑なインターフェースを持つオブジェクトを検証する場合に役立ちます。

interface Person {
  name: string;
  age: number;
  [key: string]: any; // 任意のプロパティ
}

function isPerson(obj: any): obj is Person {
  return typeof obj === 'object' &&
    'name' in obj &&
    'age' in obj &&
    Object.keys(obj).every(key => typeof obj[key] === 'string' || typeof obj[key] === 'number');
}

const person: Person = {
  name: 'John Doe',
  age: 30,
  hobbies: ['読書', '映画鑑賞']
};

const notPerson: object = {
  age: 30
};

console.log(isPerson(person)); // true
console.log(isPerson(notPerson)); // false

アサーションを使用して、コンパイラにオブジェクトが特定の型であることを明示的に伝えることができます。これは、オブジェクトがインターフェースを実装していることをコンパイラに保証するのに役立ちます。

interface Person {
  name: string;
  age: number;
}

function greetPerson(person: Person) {
  console.log(`Hello, ${person.name}!`);
}

const person: Person = {
  name: 'John Doe',
  age: 30
};

greetPerson(person); // エラーなし

const notPerson: object = {
  age: 30
};

greetPerson(notPerson); // コンパイルエラー

カスタム型ガードを作成して、オブジェクトがインターフェースを実装しているかどうかを独自のロジックで判断できます。これは、複雑な検証ロジックが必要な場合に役立ちます。

interface Person {
  name: string;
  age: number;
  validate(): boolean;
}

function isPerson(obj: any): obj is Person {
  return typeof obj === 'object' &&
    'name' in obj &&
    'age' in obj &&
    typeof obj.validate === 'function' &&
    obj.validate();
}

class MyPerson implements Person {
  name: string;
  age: number;

  constructor(name: string, age: number) {
    this.name = name;
    this.age = age;
  }

  validate(): boolean {
    return this.name.length > 0 && this.age > 0;
  }
}

const person: Person = new MyPerson('John Doe', 30);
const notPerson: object = {
  name: 'John Doe',
  age: 0
};

console.log(isPerson(person)); // true
console.log(isPerson(notPerson)); // false