JavaScript における単一責任の原則

JavaScript の単一責任原則を理解する
クリーンで保守しやすいコードを作成する場合、従うべき最も重要な原則の 1 つは単一責任原則 (SRP) です。これはソフトウェア開発における 5 つの SOLID 原則の 1 つであり、コードの読み取り、テスト、変更が容易になります。

単一責任原則とは何ですか?

ロバート・C・マーティンによる単一責任原則では次のように述べられています。

クラスまたは関数には、変更する理由が 1 つだけある必要があります。

もっと簡単に言うと、コードの各単位 (関数、クラス、モジュールなど) は、1 つのことを実行し、それを適切に実行する責任を負う必要があります。責任が分離されると、コードの 1 つの領域の変更が他の領域に予期せず影響を与えることがなくなり、バグのリスクが軽減され、アプリケーションの保守とテストが容易になります。

SRP が重要な理由

SRP がないと、次のような問題に直面する可能性があります。

1. もつれた依存関係: 関数またはクラスに複数の責任がある場合、1 つに変更を加えると、誤って別の責任が壊れてしまう可能性があります。
2. テスト容易性の低下: コード単位で実行しすぎると、無関係な依存関係を模擬する必要があるため、テストが困難になります。 可読性が低い: 大規模で多目的な関数やクラスは、特にプロジェクトに参加する新しい開発者にとっては理解しにくくなります。
3. 難しいメンテナンス: 部門の責任が増えるほど、バグの切り分けと修正、または新機能の追加に多くの労力がかかります。

JavaScript での SRP の適用

JavaScript で SRP を適用する実際の例をいくつか見てみましょう。

例 1: 関数のリファクタリング

希望小売価格なし

function handleUserLogin(userData) {
    // Validate user data
    if (!userData.email || !userData.password) {
        logger.error("Invalid user data");
        return "Invalid input";
    }

    // Authenticate user
    const user = authenticate(userData.email, userData.password);
    if (!user) {
        console.error("Authentication failed");
        return "Authentication failed";
    }

    // Log success
    console.info("User logged in successfully");
    return user;
}

この関数は、検証、認証、ログ記録など、多くのことを行います。これらにはそれぞれ明確な責任があります。

希望小売価格あり

より小さな単一目的の関数に分割することで、リファクタリングできます。

function validateUserData(userData) {
    if (!userData.email || !userData.password) {
        throw new Error("Invalid user data");
    }
}

function authenticateUser(email, password) {
    const user = authenticate(email, password); // Assume authenticate is defined elsewhere
    if (!user) {
        throw new Error("Authentication failed");
    }
    return user;
}

function handleUserLogin(userData, logger) {
    try {
        validateUserData(userData);
        const user = authenticateUser(userData.email, userData.password);
        logger.info("User logged in successfully");
        return user;
    } catch (error) {
        logger.error(error.message);
        return error.message;
    }
}

各関数が単一の責任を持つようになり、テストと変更が容易になりました。

例 2: クラスのリファクタリング

希望小売価格なし

複数の懸念事項を管理するクラス:

class UserManager {
    constructor(db, logger) {
        this.db = db;
        this.logger = logger;
    }

    createUser(user) {
        // Save user to DB
        this.db.save(user);
        this.logger.info("User created");
    }

    sendNotification(user) {
        // Send email
        emailService.send(`Welcome, ${user.name}!`);
        this.logger.info("Welcome email sent");
    } 
}

ここでは、UserManager がユーザーの作成、ログ記録、電子メールの送信を処理します。責任が多すぎます。

希望小売価格あり

他のクラスまたはモジュールに責任を委任してリファクタリングします:

class UserService {
    constructor(db) {
        this.db = db;
    }

    createUser(user) {
        this.db.save(user);
    }
}

class NotificationService {
    sendWelcomeEmail(user) {
        emailService.send(`Welcome, ${user.name}!`);
    }
}

class UserManager {
    constructor(userService, notificationService, logger) {
        this.userService = userService;
        this.notificationService = notificationService;
        this.logger = logger;
    }

    createUser(user) {
        this.userService.createUser(user);
        this.notificationService.sendWelcomeEmail(user);
        this.logger.info("User created and welcome email sent");
    }
}

各クラスは、永続性、通知、またはログという単一の関心事に焦点を当てています。

SRP に従うためのヒント

1. 関数は短くする: 関数の長さは 5 ～ 20 行で、目的が 1 つになるようにします。
2. わかりやすい名前を使用します: 適切な関数名またはクラス名は、その責任を反映しています。
3. 頻繁にリファクタリングを行う: 関数が大きすぎる、またはテストが難しいと感じる場合は、より小さな関数に分割します。
4. 関連ロジックのグループ化: モジュールまたはクラスを使用して、関連する責任をグループ化しますが、無関係な責任を混在させないでください。

結論

単一責任の原則は、クリーンなコードの基礎です。すべての関数、クラス、またはモジュールを変更する理由が 1 つだけになるようにすることで、JavaScript コードがよりモジュール化され、テストと保守が容易になります。

小規模から始めてください。現在のプロジェクトから複雑な関数またはクラスを 1 つ選択し、SRP を使用してリファクタリングします。時間が経つにつれて、これらの小さな変更はコードベースの大幅な改善につながります。

以上がJavaScript における単一責任の原則の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。