中途半端なモノの状態や動作をなくす〜ソフトウェア設計のきほん〜

この記事ではソフトウェア設計において

中途半端なモノの状態や動作を許容するとどうなるか
中途半端なモノの状態や動作をなくすためにどうするか
中途半端なモノの状態や動作をなくすことで得られるもの

についてまとめました。

短い動画でも解説してるのでぜひご覧ください。

中途半端なモノの状態や動作とは？？何が悪いのか？？

中途半端なものの状態や動作とは、

(自分が勝手にそう呼んでいるだけですが、)

例えば、

インスタンス化する際の引数が足りなくてもインスタンス化できる。

そのメソッドも実行できる。

ただ、そのメソッドを実行するとセットアップが足りていないため正常に動かない。

設定ファイルや設定用のデータベースが間違っている。

しかしアプリケーションは正常に起動し、

設定が関連する処理が呼ばれると正常に動かない。

このような状態に陥っているものをここでは指しています。

ここで、少し身の回りのモノに目を向けてみましょう。

例えば、フードプロセッサーやノンフライヤーなどは

電源を入れても蓋がきちんと閉められなければ

起動しないようになっています。

そのお陰で我々利用者は

使い方がよく分かってなくても、

誤用して怪我したり火傷したりするのを防げています。

このように

利用する側があまり使い方を深く理解していなくても、

誤用を防げるように、

中途半端な状態や動作を許容しないように、

することがソフトウェア設計においても重要になります。

中途半端なモノの状態や動作をなくすためにどうするか？？

ここからは中途半端な状態のインスタンスの悪い例と

それを改善した良い例をコードで比較しながら見ていきます。

❌中途半端な状態でインスタンス化される可能性のあるクラス

class Campaign(
    var campaignStartDate: LocalDate?,
    var campaignEndDate: LocalDate?,
    var pointRate: Double?
) {

    fun calculateCampaignPoint(purchaseAmount: Int): Int {
        if (!isValidCampaign()) return 0
        return floor(pointRate!! * purchaseAmount).toInt() // ここではpointRateが必ず入る想定

    }

    private fun isValidCampaign(): Boolean {
        val today = LocalDate.now()
        return !today.isBefore(campaignStartDate) && !today.isAfter(campaignEndDate)
    }
}

中途半端なインスタンスを使う側

        @Test
        fun `有効なキャンペーンの付与ポイントが算出できる`() {
            val campaign = Campaign(
                campaignStartDate = LocalDate.of(2023, 1, 1),
                campaignEndDate = LocalDate.of(2023, 12, 31),
                pointRate = 0.1
            )
            val actual = campaign.calculateCampaignPoint(1000)
            Assertions.assertEquals(100, actual)
        }


        @Test
        fun `中途半端な状態のキャンペーンが作れてしまってバグの危険がある`() {
            val campaign = Campaign(
                campaignStartDate = null,
                campaignEndDate = null,
                pointRate = null
            )

            // この間ではcampaignの初期化が完了していないため、NullPointerExceptionが発生する
            // val actual = campaign.calculateCampaignPoint(1000)

            campaign.campaignStartDate = LocalDate.of(2023, 1, 1)
            campaign.campaignEndDate = LocalDate.of(2023, 12, 31)
            campaign.pointRate = 0.1
            val actual = campaign.calculateCampaignPoint(1000)

            Assertions.assertEquals(100, actual)

        }

Campaignクラスを使う側は、

インスタンス生成時に初期セットアップが任意のため、

もしセットアップを忘れると

その後、キャンペーンポイントを算出しようとしても

NullPointerExceptionが発生してしまいます。

誤用してしまう可能性があるということですね。

では改善した例を見ていきます。

⭕️セットアップが正しく行われなければインスタンス化できないクラス

class Campaign private constructor(
    private val campaignStartDate: LocalDate,
    private val campaignEndDate: LocalDate,
    private val pointRate: Double
) {
    companion object {
        fun create(
            campaignStartDate: LocalDate,
            campaignEndDate: LocalDate,
            pointRate: Double
        ): Campaign {
            if (!campaignStartDate.isBefore(campaignEndDate)) throw IllegalArgumentException("キャンペーンの開始日は終了日より前である必要があります")

            return Campaign(
                campaignStartDate = campaignStartDate,
                campaignEndDate = campaignEndDate,
                pointRate = pointRate
            )

        }
    }
・・・

使う側

        @Test
        fun `有効なキャンペーンの付与ポイントが算出できる`() {
            val campaign = Campaign.create(
                campaignStartDate = LocalDate.of(2023, 1, 1),
                campaignEndDate = LocalDate.of(2023, 12, 31),
                pointRate = 0.1
            )
            val actual = campaign.calculateCampaignPoint(1000)
            Assertions.assertEquals(100, actual)
        }

        @Test
        fun `有効期限が不正なキャンペーンは作れない`() {
            assertThrows<IllegalArgumentException> {
                Campaign.create(
                    campaignStartDate = LocalDate.of(2023, 12, 31),
                    campaignEndDate = LocalDate.of(2023, 1, 1),
                    pointRate = 0.1
                )
            }
        }

使う側はCampaign.create()経由でのインスタンス生成が強制され、

不正な状態でのインスタンス生成ができなくなりました。

使う側が誤用する余地がなくなりましたね。

ちょっとおまけ

改善後のCampaignクラスも、

pointRateがマイナスで初期化されたら

おかしな挙動になります。

業務で扱う値を正確に表現してやる必要があるでしょう。