[Typescript5.0] Decorators

TypeScript 5.0では、Decorators（デコレータ）と呼ばれる新機能が導入されました。デコレータは、クラスやメソッド、プロパティなどに対して付加的なメタデータを提供するための機能です。この記事では、TypeScript 5.0でのデコレータの使い方とその利点について詳しく解説します。

公式のドキュメントはこちら。 $card

デコレータの基本

デコレータは、@シンボルを使用して定義されます。デコレータは、クラス、メソッド、プロパティ、パラメータなど、さまざまな場所に適用することができます。デコレータは関数として定義され、デコレートされる対象に追加の機能や振る舞いを提供します。

以下は、簡単なデコレータの例です。@logデコレータは、クラスのメソッドが呼び出されるたびにログを出力する機能を追加します。

function log(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
  const originalMethod = descriptor.value;
  descriptor.value = function (...args: any[]) {
    console.log(`Calling ${propertyKey} with arguments: ${JSON.stringify(args)}`);
    const result = originalMethod.apply(this, args);
    console.log(`Method ${propertyKey} returned: ${JSON.stringify(result)}`);
    return result;
  };
}

class Calculator {
  @log
  add(x: number, y: number) {
    return x + y;
  }
}

const calc = new Calculator();
console.log(calc.add(2, 3)); // Calling add with arguments: [2, 3], Method add returned: 5

この例では、@logデコレータがaddメソッドに適用されています。デコレータは、PropertyDescriptorを使用してメソッドの実装を変更します。メソッドが呼び出されるたびにログが表示され、元のメソッドの実行結果も返されます。

デコレータの利点

デコレータは、以下のようなさまざまな利点を提供します。

コードの再利用とメタプログラミング

デコレータを使用すると、同じ機能を複数のクラスやメソッドに簡単に適用することができます。これにより、コードの再利用性が向上し、重複を排除することができます。また、デコレータを使用してメタデータを付加することで、ランタイムでオブジェクトの振る舞いを制御したり、特定の条件に基づいて動的に振る舞いを変更したりすることも可能です。

柔軟なアーキテクチャとフレームワークの拡張

デコレータは、アーキテクチャやフレームワークの拡張性を向上させるための強力なツールです。例えば、WebフレームワークであるExpress.jsでは、ルートハンドラにデコレータを使用して認証やバリデーションのロジックを追加することができます。デコレータを使用することで、フレームワークに依存しない再利用可能なコンポーネントを作成することも可能です。

コードの可読性と保守性の向上

デコレータを使用することで、コードの意図や目的が明確になります。デコレータは付加的な機能や振る舞いを提供するため、クラスやメソッドの定義を読むだけで、そのコンポーネントがどのような機能を持っているかを理解することができます。また、デコレータを使用することで、コードの修正や保守が容易になります。特定の機能を持つデコレータの実装を変更するだけで、複数のコンポーネントに対して一括で変更を適用することができます。

デコレータの応用例

デコレータはさまざまな応用例で使用することができます。以下にいくつかの一般的な応用例を紹介します。

ログ出力

デコレータを使用して、メソッドの呼び出しやパラメータ、戻り値などをログに出力することができます。これにより、デバッグやパフォーマンス解析が容易になります。

認証と権限管理

デコレータを使用して、特定のメソッドやルートにアクセスする前に認証や権限のチェックを行うことができます。これにより、セキュリティを強化し、不正なアクセスを防ぐことができます。

キャッシュとメモ化

デコレータを使用して、メソッドの結果をキャッシュしたり、メモ化したりすることができます。再計算を避けることでパフォーマンスを向上させることができます。

バリデーション

デコレータを使用して、入力値のバリデーションや制約のチェックを行うことができます。不正なデータを防ぐことで、信頼性の高いコードを作成することができます。

キャンセルとリトライ

デコレータを使用して、非同期メソッドの実行をキャンセルしたり、エラー時にリトライするなどの制御を行うことができます。信頼性や耐障害性を向上させることができます。

まとめ

TypeScript 5.0のデコレータは、クラスやメソッド、プロパティなどに対して付加的なメタデータを提供する強力な機能です。デコレータを使用することで、コードの再利用性や可読性、保守性が向上し、柔軟なアーキテクチャやフレームワークの拡張が可能になります。さまざまな応用例でデコレータを活用することで、より効率的で信頼性の高いコードを作成することができます。