ソフトウェア開発における「7つの設計原理」Part1

ソフトウェア開発において、コードレビューは品質を担保するための重要なプロセスです。しかし、効果的なコードレビューを行うためには、一定の基準や観点が必要です。これが「7つの設計原理」としてまとめられており、コードの妥当性をチェックする際に非常に有効です。本記事では、その7つの設計原理のうち、最初の3つについて詳しく解説します。

7つの設計原理とは？

「7つの設計原理」とは、ソフトウェア障害を未然に防ぐために考慮すべきコード構造上の核心的な観点を指します。これらの原理は、過去に発生した障害の根本原因を分析し、どのようにすれば開発時にそのような障害を防げたかという視点から導かれました。コードレビューにおける観点として使用することで、コードの「漏れない」「ブレない」価値観を維持することが可能です。

パート1で紹介する設計原理

パート1では、以下の3つの設計原理について詳しく解説します。

1. 単純原理（Simplicity Principle）
2. 同型原理（Isomorphism Principle）
3. 対称原理（Symmetry Principle）

これらは、コードのシンプルさ、一貫性、対称性に関連する重要な原理です。

1. 単純原理（Simplicity Principle）

シンプルにこだわる

単純原理は、「シンプルにこだわる」という観点です。この原理に基づくと、プログラミング初心者でも理解できるような、一貫してシンプルなコードを書くことが推奨されます。具体的には、複雑で多面的な関連性を追求するのではなく、局所的な完全性を重視します。

複雑なところにバグは出る

障害は、通常、複雑な箇所に集中します。複雑さが増すと、その分だけ見落としやすく、バグが発生しやすくなります。一方で、シンプルで見通しの良いコードは、障害の発生を防ぎやすくします。シンプルなコードは一見「素人っぽく」見えることがありますが、これを無視し、シンプルさを追求するメンタリティが重要です。

自然なコードを書く

自然なコードとは、特に高級なテクニックを使わず、基本的で直感的な方法で書かれたコードを指します。むやみに複雑化せず、コードをシンプルでコンパクトに保つことが重要です。シンプルなコードは、コードの理解や保守性を高め、結果的に障害を防ぐ助けになります。

# 悪い例：複雑なロジックを使用したコード

def is_even_bad(number):

    return (number & 1) == 0

 

# 良い例：単純かつ明確なロジックを使用したコード

def is_even_good(number):

    return number % 2 == 0

2. 同型原理（Isomorphism Principle）

形にこだわる

同型原理は、「同じことは同じように扱う」という観点です。例えば、あるモジュールで数値の単位が統一されている場合や、公開関数の引数の順序や数が統一されている場合に、この原理が適用されます。異なる要素が一貫して同じように扱われることで、一様性が保たれ、コードの可読性と理解しやすさが向上します。

「異物」が目立つ

コードに一貫性があると、異質な部分が目立ちやすくなります。これは、バグの原因となる部分を特定するのに役立ちます。統一感のあるコードは、コードを理解する際の負担を軽減し、障害の検出を容易にします。

一貫性のあるコードを書く

プログラマは時に、独自のスタイルや複雑さを追求するあまり、コードの一貫性を犠牲にしてしまうことがあります。しかし、コードの品質を高めるためには、一貫性が何よりも重要です。エゴを抑え、コードの統一感を優先することが求められます。

# 悪い例：一貫性のない関数名と引数の順序

def add_user_bad(name, email):

    # ユーザーを追加する処理

    pass

 

def create_product_bad(price, name):

    # 商品を作成する処理

    pass

 

# 良い例：一貫性のある関数名と引数の順序

def add_user_good(username, email):

    # ユーザーを追加する処理

    pass

 

def add_product_good(name, price):

    # 商品を追加する処理

    pass

3. 対称原理（Symmetry Principle）

形の対称性にこだわる

対称原理は、形の対称性にこだわる観点です。例えば、ある条件が満たされた場合の処理があれば、その反対の条件も考慮する必要があります。これにより、コードの理解が容易になり、条件漏れを防ぐことができます。

読む時に予測が付く

対称性があるコードは、予測がしやすく、理解が速くなります。また、視覚的にも美しいコードとなり、開発者がコードを読みやすくなります。対称性を意識することで、設計時に考慮漏れを防ぎ、障害を減らすことができます。

対称性のあるコードを書く

「条件」があれば「反条件」にも注意を払い、制御条件には必ず対になる反条件が存在することを念頭に置いてコードを書くことが重要です。また、例外的なケースが多すぎる場合は、そもそも要求が整理されていない可能性があるため、要求を見直すことも考慮します。

# 悪い例：対称性の欠如

def toggle_flag_bad(flag):

    if flag:

        return False

    # True の場合の処理が欠如

 

# 良い例：対称性を考慮したコード

def toggle_flag_good(flag):

    if flag:

        return False

    else:

        return True

まとめ

本記事では、「7つの設計原理」のうち、単純原理、同型原理、対称原理の3つを紹介しました。これらの原理は、コードのシンプルさ、一貫性、対称性に関わる重要な要素であり、効果的なコードレビューと高品質なコード作成に寄与します。

これらの設計原理を実践することで、障害を未然に防ぎ、ソフトウェアの信頼性を向上させることができます。次回のパート2では、残りの4つの設計原理である「階層原理（Hierarchy Principle）」、「線形原理（Linearity Principle）」、「明証原理（Evidence Principle）」、「安全原理（Safety Principle）」について詳しく解説します。これらの原理を含めて、全体の理解を深めていきましょう。

参考書籍：上田勲(2016). プリンシプルオブプログラミング　3年目までに身に着けたい一生役立つ101の原理原則　秀和システム