デフォルト値の適切な使用: コードの再利用性と変更への対応力を高める

ソフトウェア開発において、デフォルト値の適切な使用は非常に重要です。
しかし、デフォルト値の実装場所によっては、コードの再利用性や変更への対応力に悪影響を与える可能性があります。

本記事では、ワークスペース設定を例に、デフォルト値の適切な使用方法とその利点について解説します。

デフォルト値の重要性

開発環境やIDEなどのツールを使用する際、適切なデフォルト設定が用意されていることは非常に重要です。
例えば、新しいワークスペースを作成したときを考えてみましょう。

以下の基本的な設定がすでに行われていれば、開発者はすぐにコーディングを始めることができます。

エディタのテーマ
フォントサイズ

下位レイヤーでのデフォルト値設定の問題点

しかし、デフォルト値を下位レイヤーのコードで設定すると、再利用性や変更への対応力に問題が生じる可能性があります。
以下に具体例を示します。

class WorkspaceSettings:
    def __init__(self, theme=None, font_size=None):
        self.theme = theme
        self.font_size = font_size

    def get_theme(self):
        return self.theme if self.theme else "Dark"

    def get_font_size(self):
        return self.font_size if self.font_size else 14

このWorkspaceSettingsクラスでは、ユーザーがテーマやフォントサイズを指定しない場合にデフォルト値を返しています。
しかし、この実装には以下の問題があります。

“Dark”テーマや14ポイント以外のデフォルト値を使用したい場合、このクラスの再利用が難しくなります。
ユーザーが明示的にデフォルト値と同じ設定を選択した場合と、デフォルト値が使用された場合を区別できません。
プロジェクトやチームごとに異なるデフォルト設定を適用したい場合、この実装では対応が困難です。

解決策：上位レイヤーでのデフォルト値提供

これらの問題を解決するには、デフォルト値の提供を上位レイヤーで行うべきです。
以下に改善例を示します。

class WorkspaceSettings:
    def __init__(self, theme=None, font_size=None):
        self.theme = theme
        self.font_size = font_size

    def get_theme(self):
        return self.theme

    def get_font_size(self):
        return self.font_size

class DefaultWorkspaceSettings:
    @staticmethod
    def get_default_theme():
        return "Dark"

    @staticmethod
    def get_default_font_size():
        return 14

class WorkspaceManager:
    def __init__(self, workspace_settings, default_settings):
        self.workspace_settings = workspace_settings
        self.default_settings = default_settings

    def get_theme(self):
        return self.workspace_settings.get_theme() or self.default_settings.get_default_theme()

    def get_font_size(self):
        return self.workspace_settings.get_font_size() or self.default_settings.get_default_font_size()

この実装では以下の利点があります。

WorkspaceSettingsクラスはユーザー設定の管理のみを行い、デフォルト値の提供は行いません。
デフォルト値の提供はDefaultWorkspaceSettingsクラスで行います。これにより、デフォルト値の変更が容易になります。
WorkspaceManagerクラスが、ユーザー設定とデフォルト値の選択ロジックを管理します。

この構造により、以下のような柔軟性が得られます。

異なるデフォルト値を使用したい場合、DefaultWorkspaceSettingsクラスを変更または差し替えるだけで対応できます。
ユーザーが明示的に選択した値とデフォルト値を明確に区別できます。
プロジェクトやチームごとに異なるデフォルト設定を適用したい場合、DefaultWorkspaceSettingsクラスを拡張または差し替えることで対応できます。

使用例

以下は、この実装を使用する例です。

# ユーザー設定なし
user_settings = WorkspaceSettings()
default_settings = DefaultWorkspaceSettings()
workspace = WorkspaceManager(user_settings, default_settings)

print(workspace.get_theme())  # 出力: Dark
print(workspace.get_font_size())  # 出力: 14

# ユーザーがテーマのみ設定
user_settings = WorkspaceSettings(theme="Light")
workspace = WorkspaceManager(user_settings, default_settings)

print(workspace.get_theme())  # 出力: Light
print(workspace.get_font_size())  # 出力: 14

# プロジェクト固有のデフォルト設定
class ProjectDefaultSettings(DefaultWorkspaceSettings):
    @staticmethod
    def get_default_theme():
        return "Blue"

    @staticmethod
    def get_default_font_size():
        return 16

project_settings = ProjectDefaultSettings()
workspace = WorkspaceManager(user_settings, project_settings)

print(workspace.get_theme())  # 出力: Light (ユーザー設定)
print(workspace.get_font_size())  # 出力: 16 (プロジェクトのデフォルト設定)