コードが想定外の事態を起こすパターン: nullオブジェクトパターンを適切に使用する

コードが想定外の事態を起こすことは、ソフトウェアのバグにつながります。
本記事では、nullオブジェクトパターンを適切に使用することで、想定外の事態を避ける方法について解説します。

サンプルコードを交えながら、nullオブジェクトパターンの適切な使用シナリオと注意点を見ていきましょう。

nullの代わりに空のコレクションを返す

関数がリスト、セット、配列などのコレクションを返す場合、コレクション内から値を取得できないことがあります。
これに対する一つのアプローチはnullを返すことです。

これ以外には、nullオブジェクトパターンを使用して空のコレクションを返すことがあります。
このことにより、コードの品質を向上させることができます。

以下は、ユーザーの役割に基づいて権限のリストを返す関数の例です。

def get_user_permissions(user):
    if user.role == "admin":
        return ["read", "write", "delete"]
    elif user.role == "editor":
        return ["read", "write"]
    else:
        return None

permissions = get_user_permissions(user)
if permissions is None:
    print("User has no permissions.")
else:
    print(f"User permissions: {', '.join(permissions)}")

この例では、ユーザーの役割が “admin” や “editor” 以外の場合、get_user_permissions 関数は None を返します。
呼び出し元は、permissions が None かどうかを確認する必要があります。

nullオブジェクトパターンを使用して、空のリストを返すように改善できます。

def get_user_permissions(user):
    if user.role == "admin":
        return ["read", "write", "delete"]
    elif user.role == "editor":
        return ["read", "write"]
    else:
        return []

permissions = get_user_permissions(user)
print(f"User permissions: {', '.join(permissions)}")

この変更により、呼び出し元は None をチェックする必要がなくなり、コードがシンプルになります。

文字列に重要な意味がある場合は注意が必要

文字列が単なる文字の集合ではなく、コード上で重要な意味を持つことがあります。
この場合、nullオブジェクトパターンを使用すると想定外の事態を引き起こす可能性があります。

以下は、ユーザーのIDを表す文字列を返す関数の例です。

def get_user_id(user):
    if user.id:
        return user.id
    else:
        return ""

user_id = get_user_id(user)
print(f"User ID: {user_id}")

この例では、ユーザーIDが存在しない場合、get_user_id 関数は空の文字列を返します。
しかし、空の文字列はユーザーIDとして有効ではないため、呼び出し元が適切に処理できない可能性があります。

この場合、Noneを返すことで、ユーザーIDが存在しないことを明示的に示す方が適切です。

def get_user_id(user):
    if user.id:
        return user.id
    else:
        return None

user_id = get_user_id(user)
if user_id is None:
    print("User ID not found.")
else:
    print(f"User ID: {user_id}")

この変更により、呼び出し元はユーザーIDが存在しない可能性を認識し、適切に処理できます。

複雑なnullオブジェクトは想定外の事態を起こす可能性がある

より複雑なnullオブジェクトを実装すると、呼び出し元に誤った印象を与える可能性があります。
そのような場合は、想定外の事態を引き起こしかねません。

以下は、商品の在庫を管理するクラスの例です。

class Product:
    def __init__(self, name, price, quantity):
        self.name = name
        self.price = price
        self.quantity = quantity

class NullProduct(Product):
    def __init__(self):
        super().__init__("", 0, 0)

class Inventory:
    def __init__(self):
        self.products = []

    def get_product(self, name):
        for product in self.products:
            if product.name == name:
                return product
        return NullProduct()

inventory = Inventory()
inventory.products.append(Product("Apple", 1.0, 10))
inventory.products.append(Product("Banana", 0.5, 20))

product = inventory.get_product("Orange")
print(f"Product name: {product.name}")
print(f"Product price: {product.price}")
print(f"Product quantity: {product.quantity}")

この例では、Inventory クラスの get_product 関数は、指定された名前の商品が見つからない場合、NullProduct インスタンスを返します。
NullProduct は Product クラスを継承し、name、price、quantity に無効な値を設定しています。

しかし、この実装では、呼び出し元が NullProduct インスタンスを受け取っても、有効な商品であると誤解する可能性があります。
その結果、在庫にない商品を処理するなど、想定外の事態を引き起こすリスクがあります。

この場合、NullProduct を返すのではなく、None を返すことで、商品が存在しないことを明示的に示すべきです。

class Inventory:
    def __init__(self):
        self.products = []

    def get_product(self, name):
        for product in self.products:
            if product.name == name:
                return product
        return None

inventory = Inventory()
inventory.products.append(Product("Apple", 1.0, 10))
inventory.products.append(Product("Banana", 0.5, 20))

product = inventory.get_product("Orange")
if product is None:
    print("Product not found.")
else:
    print(f"Product name: {product.name}")
    print(f"Product price: {product.price}")
    print(f"Product quantity: {product.quantity}")

この変更により、呼び出し元は商品が存在しない可能性を認識し、適切に処理できます。