TypeScriptにおけるプライベート関数のその他のリソース
2024-07-27
TypeScriptにおけるプライベート関数
プライベート関数の利点
- **デバッ
- コードの変更の容易化
プライベート関数はクラス外部から呼び出すことができないため、内部実装を変更しても、外部コードに影響を与えることなく変更できます。これは、コードの保守性を向上させるのに役立ちます。 - カプセル化の強化
プライベート関数を使用すると、クラス内部の実装詳細を隠すことができ、コードをより読みやすく、理解しやすくすることができます。これは、特に大規模で複雑なクラスの場合に重要です。
プライベート関数の使用方法
プライベート関数は、private キーワードを使用して宣言されます。次に、関数の名前と引数リスト、およびオプションの戻り値型を指定します。
class MyClass {
private _data: number[];
constructor(data: number[]) {
this._data = data;
}
public getData(): number[] {
return this._data;
}
private _processData(): number {
// この関数はクラス外部から呼び出すことができません
let sum = 0;
for (let i = 0; i < this._data.length; i++) {
sum += this._data[i];
}
return sum;
}
public getAverage(): number {
const sum = this._processData();
const average = sum / this._data.length;
return average;
}
}
上記の例では、_processData 関数はプライベート関数として宣言されています。この関数は getData 関数で使用されていますが、クラス外部からは呼び出すことができません。
プライベートクラスフィールド
TypeScript 4.3 では、プライベートクラスフィールドと呼ばれる新しい機能が導入されました。これは、クラスのプロパティをプライベートにするためのより簡潔な方法です。
class MyClass {
#data: number[];
constructor(data: number[]) {
this.#data = data;
}
public getData(): number[] {
return this.#data;
}
private _processData(): number {
// この関数はクラス外部から呼び出すことができません
let sum = 0;
for (let i = 0; i < this.#data.length; i++) {
sum += this.#data[i];
}
return sum;
}
public getAverage(): number {
const sum = this._processData();
const average = sum / this.#data.length;
return average;
}
}
上記の例では、#data プロパティはプライベートクラスフィールドとして宣言されています。これは、_data プロパティと同じように動作しますが、より簡潔な構文を使用しています。
注意事項
プライベート関数は、コンパイルされた JavaScript コードでは依然としてパブリックに公開されます。これは、TypeScript が型チェックとコードの理解可能性を向上させるためにのみプライベート関数をを使用するためです。機密情報を保護する必要がある場合は、他の方法 (暗号化など) を使用する必要があります。
class Person {
#name: string;
#age: number;
constructor(name: string, age: number) {
this.#name = name;
this.#age = age;
}
getName(): string {
return this.#name;
}
getAge(): number {
return this.#age;
}
#introduceSelf(): void {
console.log(`私の名前は ${this.#name} で、年齢は ${this.#age} 歳です。`);
}
greet() {
console.log(`こんにちは！`);
this.#introduceSelf();
}
}
const person = new Person('田中 太郎', 30);
console.log(person.getName()); // 田中 太郎
console.log(person.getAge()); // 30
person.greet(); // こんにちは！ 私の名前は 田中 太郎 で、年齢は 30 歳です。
// プライベート関数 `#introduceSelf` はクラス外部から呼び出すことができません
// person.#introduceSelf(); // エラー: 'Property '#introduceSelf' is private and cannot be accessed outside of its containing class.'
この例では、Person クラスには、#name と #age という 2 つのプライベートプロパティと、getName、getAge、greet の 3 つのメソッドがあります。
greetメソッドは、#introduceSelf関数を内部で呼び出して、自分自身を紹介するメッセージを出力します。#introduceSelf関数はプライベート関数であり、クラス外部からは呼び出すことはできません。
プロパティアクセサーを使用して、プライベートプロパティにアクセスし、その値を変更することができます。ただし、これはプライベート関数のカプセル化の利点を損なう可能性があるため、注意が必要です。
class Person {
#name: string;
#age: number;
constructor(name: string, age: number) {
this.#name = name;
this.#age = age;
}
get name(): string {
return this.#name;
}
set name(newName: string) {
this.#name = newName;
}
getAge(): number {
return this.#age;
}
#introduceSelf(): void {
console.log(`私の名前は ${this.#name} で、年齢は ${this.#age} 歳です。`);
}
greet() {
console.log(`こんにちは！`);
this.#introduceSelf();
}
}
const person = new Person('田中 太郎', 30);
console.log(person.name); // 田中 太郎
person.name = '佐藤 花子';
console.log(person.name); // 佐藤 花子
// プライベート関数 `#introduceSelf` はクラス外部から呼び出すことができません
// person.#introduceSelf(); // エラー: 'Property '#introduceSelf' is private and cannot be accessed outside of its containing class.'
保護されたメンバー
保護されたメンバーは、同じクラスまたはそのサブクラスからのみアクセスできるメンバーです。これは、プライベート関数よりも柔軟性がありますが、カプセル化の利点も提供します。
class Person {
protected #name: string;
protected #age: number;
constructor(name: string, age: number) {
this.#name = name;
this.#age = age;
}
getName(): string {
return this.#name;
}
getAge(): number {
return this.#age;
}
protected #introduceSelf(): void {
console.log(`私の名前は ${this.#name} で、年齢は ${this.#age} 歳です。`);
}
greet() {
console.log(`こんにちは！`);
this.#introduceSelf();
}
}
class Student extends Person {
constructor(name: string, age: number, studentId: number) {
super(name, age);
// this.#name はアクセスできません (プライベート)
// this.#age はアクセス可能 (保護済み)
}
getStudentId(): number {
// ...
}
introduceMyself(): void {
super.greet(); // 親クラスの `greet` メソッドを呼び出す
console.log(`私は学生です。`);
}
}
const student = new Student('山田 太郎', 20, 12345);
student.getName(); // 田中 太郎 (継承によりアクセス可能)
student.getAge(); // 20 (継承によりアクセス可能)
student.introduceMyself(); // こんにちは！ 私の名前は 山田 太郎 で、年齢は 20 歳です。 私は学生です。
// プライベート関数 `#introduceSelf` はクラス外部から呼び出すことができません
// student.#introduceSelf(); // エラー: 'Property '#introduceSelf' is protected and only accessible within the class 'Person' and its subclasses.'
ミックスイン
ミックスインを使用して、プライベート関数を他のクラスに提供することができます。ただし、これはコードをより複雑にする可能性があるため、注意が必要です。
class Logger {
private log(message: string): void {
console.log(message);
}
info(message: string): void {
this.log(`[INFO] ${message}`);
}
warn(message: string): void {
this.log(`[WARN] ${message}`);
}
error(message: string): void {
this.log(`[ERROR] ${message}`);
}
}
class Person {
#name: string;
#age: number;
constructor(name: string, age: number) {
this.#name = name;
this.#age = age;
}
getName(): string {
return this.#name;
}
getAge(): number {
return this.#age;
}
#
typescript
