オブジェクト指向でカードゲームのクラスを作るときの設計方法がわからない

Question

概要

オブジェクト指向でカードゲームを作っています。
そのカードゲームでは大きく分けて、

• 1. コスト・攻撃力・体力を持つカード
• 1. コスト・効果を持つカード(攻撃力・体力は持っていない)

のような2種類があります。

このようなカードゲームを作ろうと思ったのですが、クラス設計で悩んでいます。

現在の状態

現在、2つの実装方法を考えました。
(あまりオブジェクト指向では使わないpythonですが、自分が使えてサクッと書ける言語がpythonしかなかったため、ご容赦ください。)

下で出てくるdataというのは辞書を想定しています。

※2019-01-05 09:18 コード修正しました。

1つ目

# 共通部分を定義するクラス
class Card():
    def__init__(self, data):
        self.cost = data['cost']

# Cardを継承した例1のクラス
class Type1(Card):
    def __init__(self, data):
        super().__init__(data)
        self.atk = data['atk']
        self.hp = data['hp']

# Cardを継承した例2のクラス
class Type2(Card):
    def __init__(self, data):
        super().__init__(data)
        self.effect = data['effect']

# カードがどちらのタイプに属するかを判別し、適切なインスタンスを返す関数
def classify_card(data):
    if data.type == 1:
        return Type1(data)
    elif data.type == 2:
        return Type2(data)
    else:
        print('error')

if __name__ == '__main__':
    # dataは事前でもらっているものとする
    card = classify_card(data)

1つ目は、classify_card関数を作成して、事前に与えられているtypeから適切なインスタンスを返す方法です。

考えられるメリットは「管理が楽」で、共通部分、タイプ1、タイプ2とキレイに分かれているため、見た目でどのタイプがどのパラメータを持っているかがわかりやすいです。
また、dataの中身も必要な情報のみを格納すればいいため、スッキリすると考えています。

デメリットが「処理が大変」です。
例えば、全部のカードの攻撃力を参照するといった処理を考えるとき、Type2のカードが1枚でもあったらエラーを起こしてしまいます。

---

2つ目

# 例1も2もこのクラスで作成
class Card():
    def __init__(self, data):
        self.cost = data['cost']
        self.atk = data['atk']
        self.hp = data['hp']
        self.effect = data['effect']

if __name__ == '__main__':
    # dataは事前にもらっているものとする
    card = Card(data)

2つ目は、関数などを作成せずに、すべてのパラメータを1つのクラスで管理する方法です。

考えられるメリットは、「処理が楽」で、1つ目のプログラムのように、いちいちtypeを参照して処理を変更するといったことなく、すべてのカードに同じ処理を適用できると考えています。

デメリットは、「複雑性の向上」です。
1つのインスタンスの中に必要のないパラメータが複数種類存在してしまうことが多くなり、不必要な部分で不必要な参照が行われてしまう可能性が考えられます。

お聞きしたいこと

このような状況下では、どちらの設計がいいでしょうか。
また、今後にパラメータが増える予定があるとしたら、どちらの設計がいいでしょうか。
どちらも良くない・そもそもオブジェクト指向を使うのがよくないなどありましたら、代替案を提案していただけると勉強になります。

Answer 1

前者、つまりクラスを分ける方に一票。

デメリットが「処理が大変」です。

例えば、全部のカードの攻撃力を参照するといった処理を考えるとき、Type2のカードが1枚でもあったらエラーを起こしてしまいます。

二種混ざった状態で一方に依存した処理をするとき、エラーが起きるのはむしろ妥当だと思います。
前以て必要なカードだけ選り分ける処理を噛ませるべきです。

後者は、実質的にはdataをそのまま使う方法からほとんど改善しないはずです。

Comments

[Dozi0116]

回答ありがとうございます。

基は同じでも特徴が違うものは別々に作って、必要な場合に選りすぐりをする、というのが根底の考え方にあるのですね。

参考にさせていただきます。

各処理ごとにエラー処理を書くとのことですが、これはtry-exceptでkeyErrorが起ったら何もしない程度の処理でいいのでしょうか？

[KSwordOfHaste]

> try-exceptでkeyErrorが起ったら何もしない程度でよいか

そのあたり「全く違うクラスにたまたま名前が同じで意味が違う属性があったときそれを明確に区別すべきかどうか」は設計によると思います。

攻撃用カードの攻撃力の属性名を「attack_of_attack_card」なんて名前にするのは普通オブジェクト指向ではしないと思います。単に「attack」とするでしょう。
さて効果カードの攻撃力への加算の属性名を「attack_bonus」とするか「attack」とするかは設計次第と思います。もし「attack」にしたなら...

Pythonのような動的型付け言語では「変数には型がない」ので変数にどういう型の値が入っているかはプログラマーがあり得る可能性を把握した上で論理を作る必要がありますので、attackが複数の型の属性にありえるなら try-exeptでkeyErrorがでるかどうかで判断するというのは大雑把すぎるということになるでしょうし、「着目している型にそのような属性名の重複がないように設計する」ならKeyErrorを頼りにするという方針もあり得るかも知れません。

自分は、どちらかというと「KeyErrorを頼りにする」ために「属性名に重複がないような設計にする」方に神経を使うぐらいなら素直に「今見ている値の型はなんなのか」を事前にチェックする方が安心だと思います。
---
と、書きましたが・・・少なくともattackのような基本的な属性については「少なくとも全てのカードでこういう意味にする」みたいな方針で考えた方がよいかも知れません。「今見ている値の型はなんなのかを事前にチェック」は静的型付け言語よりすぎる場合もあるかも知れません。

[LouiS0616]

@KSwordOfHaste さん
非常に有用なコメントありがとうございます。概ね同意です。

---
> 基本的な属性については...みたいな方針で考えた方がよいかも知れません。

attackが0のType1カードが存在する場合は考慮しなくていいのかな、という点だけ少し気になりました。
プロトタイプ段階での制約というか要請としては影響が大き過ぎるような。

型ヒントの導入も進んでおり、静的型付け言語に寄せた方が結局作りやすいという合意がコミュニティ内でもあったんじゃないかと想像します。

[KSwordOfHaste]

> 型ヒントの導入も進んでおり、静的型付け言語に寄せた方が結局作りやすいという合意
自分もそう感じます。充分に小さく全体の見通しがよいモジュールを作る際にはボイラープレート的な構文がうるさく感じ、それをはしょれる動的型付け言語が生きるけど、ある程度大きなものを作る記述能力をLLが備えてくると「動的型付け」「静的型付け」の両方のいいとこどりをしたいということなのだろうと思います。
自分は「静的型付けで設計しよう！」とまで思わなくても、型ヒントを入れとくとIDEが有用なコード補完をしてくれるため静的型付け的な利点を享受したい動機でちょっとだけ使うなんてことがよくあります。

[Dozi0116]

@KSwordOfHaste さん
新たなコメントありがとうございます。

> 「KeyErrorを頼りにする」ために「属性名に重複がないような設計にする」方に神経を使うぐらいなら素直に「今見ている値の型はなんなのか」を事前にチェックする方が安心だと思います。

今まで属性名がかぶってしまうというほど大規模な開発をしたことがないので、考えたこともありませんでした。

このような考え方は、今後プログラムを書く上での新たな考え方として吸収できました。ありがとうございます。

---

@LouiS0616 さん

>attackが0のType1カードが存在する場合は考慮しなくていいのかな、という点だけ少し気になりました。
プロトタイプ段階での制約というか要請としては影響が大き過ぎるような。

現時点ではattackが0のType1カードも作成する予定です。
この場合、どんな影響が出ることが考えられるのでしょうか？
重ね重ねの質問、申し訳ありません。

[LouiS0616]

> 現時点ではattackが0のType1カードも作成する予定です。
この場合、どんな影響が出ることが考えられるのでしょうか？

例えば『全Type1の攻撃力を100up』みたいな効果を実装するときに面倒です。
事前にタイプを判定しなければType2のattackも100になってしまいますし、それにどうせ判定するならば最初から区別が自明についている方が楽です。

Answer 2

dataってなんですか。とりあえずJavaScriptの連想配列風の記法になっている辞書だとみなすことにしますけど。

---

質問文に示された範囲だと、メソッドを定義しないでコンテナもどきとして使っているだけなので、それなら要らないです。クラスにするなら、方針はどんなメソッドを書くのか次第です。

どっちでも良いので作り始めてしまった方があるべき姿に早く気付ける気もします。

Comments

[Dozi0116]

回答ありがとうございます。

dataは辞書型を想定していました。
そのため、質問文と一部ソースを変更いたしました。ご指摘ありがとうございます。

現時点では、showメソッドを作成して、各Typeごとに見た目を変化させることを考えております。その他のメソッド追加は未定です。

一度作ってしまって問題にぶつかったときにまた考え直すというのも手なのですね。
他の回答者の意見とも合わせて、今回は前者のパターンで実装していこうと思います。

[hayataka2049]

＞現時点では、showメソッドを作成して、各Typeごとに見た目を変化させることを考えております。その他のメソッド追加は未定です。
質問に示されている範囲のコードはあくまでも内部ロジックの表現だと思いますが、内部ロジックは内部ロジックで作っておいて、表示周りは別のレイヤで作るほうが綺麗な設計にしやすいとは思います。
内部ロジックの面では、まあ質問文の要件でも「攻撃する」「攻撃された」「効果発動」「効果を食らった」みたいなメソッドは少なくとも必要になりそうな気がしますから（ゲームのルール次第ですが）、それらをどう定義するかによるんじゃないでしょうか。

[Dozi0116]

内部は内部で完結させ、表示部分はまた別で作るのが綺麗なのですね。勉強になります。

返信遅くなってしまいすいません。大変参考になりました。ありがとうございます。

[Dozi0116]

内部は内部で完結させ、表示部分はまた別で作るのが綺麗なのですね。勉強になります。

返信遅くなってしまいすいません。大変参考になりました。ありがとうございます。

Answer 3

クラス定義する方法で作業を進めてみてはいかがでしょう。
全部のカードの攻撃力を参照する例を３つ書いてみました。

この例では classify_card 関数は廃止しています。
代わりに type メソッドか、attrs() メソッドを使って 攻撃属性の有無を判定しています。

３つめの方法は、 card クラスに get_atk メソッド (0 を返す) を定義し、 Type1 では get_atk() をオーバーライドします。
get_atk() はすべてのクラスが持っているので、カード種類を区別せず get_atk() を使って合計計算できます。

cards.py

# 共通部分を定義するクラス
class Card():
    def __init__(self, data):
        self.cost = data['cost']
    def attrs(self):
        return ['cost']
    def get_atk(self):
        return 0

# Cardを継承した例1のクラス
class Type1(Card):
    def __init__(self, data):
        super().__init__(data)
        self.atk = data['atk']
        self.hp = data['hp']
    def attrs(self):
        return ['cost', 'atk', 'hp']
    def get_atk(self):
        return self.atk

# Cardを継承した例2のクラス
class Type2(Card):
    def __init__(self, data):
        super().__init__(data)
        self.effect = data['effect']
    def attrs(self):
        return ['cost', 'effect']

if __name__ == '__main__':
    cards = [
        Type1({'cost': 50, 'atk': 10, 'hp': 100}),
        Type2({'cost': 60, 'effect': 10}),
        Type1({'cost': 100, 'atk': 20, 'hp': 100})
    ]

    # cardの種類を判定しながら計算
    sum = 0
    for card in cards:
        if type(card) == Type1:
            sum += card.atk
    print(sum)

    # cardが持つ属性を判定しながら計算
    sum = 0
    for card in cards:
        if 'atk' in card.attrs():
            sum += card.atk
    print(sum)

    # 全てのクラスがもつ get_atk() を使って計算
    sum = 0
    for card in cards:
        sum += card.get_atk()
    print(sum)

実行例

Comments

[Dozi0116]

回答ありがとうございます。

3種類の方法と例示、とてもわかり易かったです。

今回の設計方針では、card.attrs()メソッドを実装するのが一番うまく行きそうな雰囲気がするので、一度その方法をお借りして実装してみようと思います。

他の例も綺麗な書き方なので、今後の別プロジェクトでの設計に活かせそうです。