【TypeScript】any を厳重に扱う #TypeScript

はじめに

この記事では、TypeScriptにおける any型 をなぜ厳重に扱う必要があるのかについて、まとめています。

まずは TypeScript と静的型付けについて

TypeScriptは、JavaScript のスーパーセットとして静的型付けを提供するプログラミング言語です。

静的型付けとは、変数や関数などの値に対して、コンパイル時または実行前に型を指定することです。この静的型付けによって、開発者はコードの品質を向上させ、バグを予防することができます。また、IDEの補完機能やドキュメント生成などの恩恵も受けることができます。

any型をなぜ使ってはいけないか

any型は 型を明示的に宣言しない場合 に割り当てられるデフォルトの型です。
any型を使用すると、次のような問題が発生します。

1. 型安全性の低下

any型を使用すると、型の厳密なチェックを無効にします。
これにより、コンパイル時に型の不整合を検出できなくなり、ランタイムエラーのリスクが高まってしまいます。

2. ドキュメントの不足

any型を使用すると、関数やメソッドの引数や戻り値の型情報が失われます。
これにより、コードの読みやすさやメンテナンス性が低下してしまいます。

3. チーム開発の障害

any型を使用すると、コードの品質が一貫しなくなります。
これにより、チームメンバー間でのコードの理解や協力が困難になってしまいます。

要するに

any型を使用すると、型の恩恵を受けられなくなり、TypeScriptの静的型付けの利点であるコードの安全性や保守性を失うことになってしまいます。

そのため、any型の使用はできるだけ避け、厳重に扱うべきです。

let data: any;

// 以下は、すべてコンパイルエラーにならない。。
data = 111;
data = "string";
data = { name: "あああ" };

Strictモードを有効にする

TypeScriptのStrictモードを有効にすると、any型の使用が制限され、型安全性が向上します。以下のように、コンパイラオプション strict を true に設定することで有効化できます。

// tsconfig.json
{
    "compilerOptions": {
        "strict": true
    }
}

それでも any型を使う場面

一方で、any型を使用すべき場面もあります。
以下は、any型を使用する妥当なケースです。

1. 既存のJavaScriptコードの移行

TypeScriptプロジェクトで JavaScriptコードを使用している場合、一度に全ての型を明示的に定義することは現実的ではありません。
このような場合、any型を一時的に使用してコードを移行することができます。

2. 外部ライブラリとの統合

外部ライブラリや API が型定義ファイルを提供していない場合、any型を使用してそのライブラリと統合することができます。
ただし、可能な限り、型定義ファイルを作成するか、型安全な方法でライブラリを使用することが望ましいです。

as演算子（型アサーション）を代わりに使うのはどうか？

any型を避けるための方法の1つに、as演算子(型アサーション)の使用があります。
型アサーションは、コンパイラに対して「私はこの値が指定した型であることを保証します」と伝える手段です。
as を使用すると、変数や式に 明示的な型を付与することができます。

let userInput: any; // any の使用
let userName: string;

userInput = 5; // any なのでなんでもアリ
// userInput は string ではなく any なので エラーが出る。
userName = userInput as string; // No error, but potential runtime error if userInput is not a string

userInput = 'Max'; // any なのでなんでもアリ
// 明示的に string を指定すると エラーが出なくなる。
userName = userInput as string; // No error

ただしこれは、型の不整合を回避するための手段であり、型安全性を保証するものではありません。そのため、as演算子(型アサーション) もまた、使用を避けるべきです。

any も as も最終手段。 unknown型を積極的に使おう

TypeScriptでは、any型や as演算子を使用して型解決を回避できますが、最適な回避策としては、unknown型の使用が推奨されます。

unknown型とは

TypeScript 3.0 から導入された型であり、不特定の値 を表します。

unknown型のメリット

1. 型安全性の維持

unknown型を使用すると、型情報を失うことなく型安全性を維持できます。
コンパイラは unknown型の値に対しては型チェックを強制し、適切な型の操作を行うことを要求します。

2. 型の明示的な宣言

unknown型を使用すると、明示的に「これは未知の型です」と宣言できます。
これにより、コードの他の部分で型が確定するまで、安全に操作を行うことができます。

3. 安全な型の変換

unknown型を使用すると、unknown型から別の型に変換する場合、型ガードを使用して安全に変換できます。
これにより、ランタイムエラーを防ぎながら型の安全な変換が可能となります。

unknown型の注意点

unknown型は安全で柔軟な型であり、any型や as演算子よりも型安全性を維持するための効果的な方法です。ただし、unknown型からの型の変換や操作を行う際には注意が必要です。
明示的な型の確認や型の変換が必要な場合は、型ガードを使用して安全に行うようにしましょう。これにより、コードの安全性と保守性を高めることができます。

let userInput: unknown; // unknown型 を使用
let userName: string;

userInput = 5;
userName = userInput; // Error: Type 'unknown' is not assignable to type 'string'.

// userInput は string型 として安全に扱える
if (typeof userInput === 'string') { // 型ガード で、userInput が string型 かどうかを確認する
    userName = userInput; // No error
}

まとめ

いかがだったでしょうか？

TypeScriptでは、型安全性が重要です。
any型を使用すると、型の恩恵を受けづらくなってしまうため、できる限り型を明示的に定義し、any型の使用を避けるよう努めるべきです。

any型の代わりに、as演算子（型アサーション）を使用する方法もありますが、その場合は unknown型を積極的に使用しましょう。

以上、適切な型を使用し、コードの品質とメンテナンス性を高めていきましょう。

【TypeScript】any を厳重に扱う

はじめに

まずは TypeScript と 静的型付け について

any型 を なぜ使ってはいけないか

1. 型安全性 の低下

2. ドキュメント の不足

3. チーム開発 の障害