コードの可読性を高めるテクニック: 関連データをカプセル化する

コードの可読性と保守性を向上させるために、関連するデータをまとめてカプセル化することは非常に重要です。
本記事では、カプセル化のメリットと、それを実現するための方法について解説します。

サンプルコードを交えながら、関連データのカプセル化によってコードがどのように改善されるかを見ていきましょう。

カプセル化していないデータがもたらす問題

以下のコードは、ユーザーの情報を管理するための関数の例です。

def create_user(name, email, age, address, phone):
    # ユーザーをデータベースに登録する処理
    pass

def send_welcome_email(name, email):
    # ウェルカムメールを送信する処理
    pass

def update_user_profile(name, email, age, address, phone):
    # ユーザープロフィールをデータベースで更新する処理
    pass

これらの関数では、ユーザーの情報を個別の引数として受け取っています。

しかし、これには以下のような問題があります。

関数の引数が多くなり、可読性が低下する
関連するデータが分散し、一貫性を保つのが難しい
データの変更が複数の関数に影響を与える

特に、ユーザーのメールアドレスを更新する場合、send_welcome_email関数とupdate_user_profile関数の両方を変更する必要があります。
これは、データの管理を複雑にし、ミスを引き起こしやすくなります。

これらの問題により、コードの可読性と保守性が低下します。

解決策: 関連データをクラスにカプセル化する

上記の問題を解決するために、関連するデータをクラスにカプセル化することが有効です。

以下のように、ユーザー情報を表す User クラスを定義します。

class User:
    def __init__(self, name, email, age, address, phone):
        self.name = name
        self.email = email
        self.age = age
        self.address = address
        self.phone = phone
    
    def update_email(self, new_email):
        # メールアドレスを更新する処理
        self.email = new_email
    
    def display_info(self):
        # ユーザー情報を表示する処理
        print(f"Name: {self.name}")
        print(f"Email: {self.email}")
        print(f"Age: {self.age}")
        print(f"Address: {self.address}")
        print(f"Phone: {self.phone}")

User クラスには、ユーザーの情報を保持するためのプロパティと、それらを操作するためのメソッドが定義されています。

update_emailメソッドは、ユーザーのメールアドレスを更新するために使用されます。
そして、display_infoメソッドは、ユーザーの情報を表示するために用います。

User クラスを使用することで、先ほどの関数を次のように改善できます。

def create_user(user):
    # ユーザーをデータベースに登録する処理
    user.display_info()

def send_welcome_email(user):
    # ウェルカムメールを送信する処理
    print(f"Sending welcome email to {user.email}")

def update_user_profile(user, new_email):
    # ユーザープロフィールをデータベースで更新する処理
    user.update_email(new_email)
    user.display_info()