TypeScript宣言ファイルでC#クラスの型情報を活用

2024-05-09

TypeScriptプロジェクトで既存のC#クラス定義を再利用する方法

概要

C#とTypeScriptは、どちらもオブジェクト指向プログラミング言語ですが、異なるプラットフォームをターゲットとしています。C#は主に.NET FrameworkとWindows向けに開発されていますが、TypeScriptは主にWeb開発向けに開発されています。

プロジェクトで既にC#クラスを定義済みの場合、そのクラスをTypeScriptプロジェクトで再利用したい場合があります。これを実現するには、いくつかの方法があります。

方法

.NET互換ライブラリを使用する

Telerik Prism、TypeLiteなどの.NET互換ライブラリを使用すると、C#クラスをTypeScriptでシームレスに呼び出すことができます。これらのライブラリは、C#クラスをメタデータに変換し、それをTypeScriptが理解できる形式に変換します。

手動で宣言する

.NET互換ライブラリを使用しない場合は、C#クラスを手動でTypeScriptに宣言できます。これには、C#クラスのプロパティ、メソッド、およびインターフェースをTypeScriptに対応する構文で宣言する必要があります。

TypeScript宣言ファイル（*.d.ts）を使用する

C#クラスの宣言を含むTypeScript宣言ファイル（*.d.ts）を作成することもできます。このファイルにより、TypeScriptコンパイラはC#クラスの存在を認識し、それらのクラスに対して型安全なコードを書くことができます。

例

以下の例では、Personという名前のC#クラスをTypeScriptプロジェクトで再利用する方法を示します。

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }

    public Person(string name, int age)
    {
        Name = name;
        Age = age;
    }
}

TypeScript

// .NET互換ライブラリを使用する場合

import { Person } from 'my-net-compatible-library';

const person = new Person('John Doe', 30);
console.log(person.name); // 'John Doe'
console.log(person.age); // 30

// 手動で宣言する場合

class Person {
    name: string;
    age: number;

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

const person = new Person('John Doe', 30);
console.log(person.name); // 'John Doe'
console.log(person.age); // 30

// TypeScript宣言ファイルを使用する場合

// person.d.ts

declare class Person {
    name: string;
    age: number;

    constructor(name: string, age: number);
}

// main.ts

const person = new Person('John Doe', 30);
console.log(person.name); // 'John Doe'
console.log(person.age); // 30

C#クラスをTypeScriptプロジェクトで再利用するには、.NET互換ライブラリ、手動宣言、またはTypeScript宣言ファイルのいずれかを使用できます。使用する方法は、プロジェクトの要件に応じて異なります。

補足

上記の例は単純化されています。実際のプロジェクトでは、より複雑なクラスと関係を扱う必要がある場合があります。
C#とTypeScriptは異なる言語であることに注意することが重要です。そのため、C#コードをTypeScriptに完全に移植できない場合があります。
TypeScriptプロジェクトでC#クラスを再利用する場合は、互換性とパフォーマンスの問題に注意する必要があります。

// .NET互換ライブラリを使用する場合

import { Person } from 'my-net-compatible-library';

const person = new Person('John Doe', 30);
console.log(person.name); // 'John Doe'
console.log(person.age); // 30

// 手動で宣言する場合

class Person {
    name: string;
    age: number;

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

const person = new Person('John Doe', 30);
console.log(person.name); // 'John Doe'
console.log(person.age); // 30

// TypeScript宣言ファイルを使用する場合

// person.d.ts

declare class Person {
    name: string;
    age: number;

    constructor(name: string, age: number);
}

// main.ts

const person = new Person('John Doe', 30);
console.log(person.name); // 'John Doe'
console.log(person.age); // 30

説明

このサンプルコードは、"How to reuse existing C# class definitions in TypeScript projects" の記事で説明した3つの方法すべてを示しています。

この例では、my-net-compatible-libraryという架空の.NET互換ライブラリを使用しています。このライブラリは、Personという名前のC#クラスをTypeScriptで公開します。

この例では、Personという名前のC#クラスを手動でTypeScriptに宣言します。このクラスは、C#クラスの構造と機能を忠実に再現します。

この例では、person.d.tsという名前のTypeScript宣言ファイルを作成します。このファイルは、C#クラスの存在と型情報をTypeScriptコンパイラに提供します。

TypeScriptプロジェクトでC#クラスを再利用するその他の方法

上記で説明した方法は、C#クラスをTypeScriptプロジェクトで再利用する一般的な方法ですが、他にもいくつかの方法があります。

JavaScriptインターフェースを使用する

C#クラスのインターフェースをJavaScriptで定義し、そのインターフェースを実装するTypeScriptクラスを作成することができます。これにより、C#クラスの型情報と構造をTypeScriptで利用することができます。

// JavaScriptインターフェース
interface Person {
    name: string;
    age: number;

    constructor(name: string, age: number);
}

// TypeScriptクラス
class PersonImpl implements Person {
    name: string;
    age: number;

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