メインコンテンツへスキップ
見出し画像

【ソフトウェア設計】状態の名前だけでは見えない、情報が変わる契機と動きのつながり

    「この間に何か起きたら」で場合分けが増える

    設計で難しいと感じるのは、処理そのものよりも、「何かをしている間に、別の何かが起きる」ところです。

    システムが起動して、初期化が終わるまでの期間があります。通常の制御をしている期間もあれば、終了処理をしている期間もあります。その途中で要求を受けたり、割り込みが入ったりすると、「このときはどう動くのか」を考える必要が出てきます。

    なるべく状態を少なくして、場合分けも減らしたいと思います。ただ、初期化には時間がかかりますし、処理を始めてから終えるまでにも時間があります。「この間」が生まれること自体は、簡単にはなくせません。

    例えば、初期化のあるシステムが、表示要求を受ける場面を考えます。これは説明のための仮定です。

    通常動作中なら表示できるとしても、初期化中は表示に必要な準備が整っていないかもしれません。終了中なら、これから停止する画面に対して、新しい表示を始めてよいのか迷います。同じ表示要求でも、届く時期によって考えることが変わります。

    画像

    ここで気になるのは、表示処理が正しいかどうかだけではありません。初期化中に届いた要求を保留するのか、受け付けないのか。保留するなら、いつ実行するのか。終了が始まったとき、保留していた要求はどうなるのか。

    「要求が来たら表示する」という一つの処理だけでは、システム全体の動きを決められません。

    こうした振る舞いは、要件や仕様として決める内容にもつながります。それを実現するために、どこで判断し、どの情報を保持するかを考えるのが設計です。私が整理したいのは、その間にある、状態と出来事の組み合わせです。

    状態を並べる前に、何の状態かをそろえる

    初期化中、通常動作中、終了中、待機中、処理中。思いつく名前を並べていくと、整理できたように見えます。

    ただ、この並べ方には違う種類の状態が混ざっています。

    初期化中・通常動作中・終了中は、システム全体がどの段階にあるかという話です。一方、待機中・処理中は、ある処理が今何をしているかという話です。例えば、システムが通常動作中でも、表示処理は待機中の場合も、処理中の場合もあります。

    この例では、まず「システムの段階」と「表示処理の状態」を別々に整理した方が、何を組み合わせて考えているのかが見えます。

    画像

    分けた後は、それぞれの状態名を決めるだけで終わらせず、その組み合わせが実際に起こり得るかを確認します。終了中でも、すでに始めた表示処理は完了を待つのか。それとも途中で止めるのか。ここが決まっていないと、「終了中かつ処理中」という組み合わせをどう扱うかも決まりません。

    さらに、各組み合わせで表示要求を受けたときの振る舞いを確認します。「受け付ける」「保留する」「受け付けない」のどれにするかは、ここでは実際の仕様として決まっているわけではありません。必要な動きを整理するための選択肢です。

    何でも別の状態にすると、名前が増えて追いにくくなります。逆に、名前を減らしただけで、あちこちに例外条件を残すと、場合分けは見えないところに移るだけです。

    今は、同じ出来事に対する扱いや、その後に進める動きが違うなら、違いを明示することを考えます。扱いが同じ部分は共通にできないかを見る。その順番で、必要な区別まで消さずに整理したいと思っています。

    見ている情報より、その情報が変わる契機を追う

    状態を整理していて、もう一つ気になるのが、「その判断で見ている情報は、いつ変わるのか」という点です。

    例えば、表示できるかどうかを「初期化完了」という情報で判断するとします。条件分岐を見れば、完了しているときに表示することは分かります。ただ、それだけでは、いつから表示できるようになるのかを説明できません。

    初期化のどの処理が終わったら、その情報を更新するのか。更新するのは誰か。表示要求を扱う側は、要求を受けた時点で参照するのか、実際に表示を始める直前に参照するのか。そこまでつながると、動きが見えてきます。

    画像

    特に、情報が更新されることと、別の処理がその更新を見て動くことは、分けて確認したいところです。「初期化完了」を更新しただけでは、保留中の表示要求が自動的に実行されるとは限りません。保留した要求を取り出す処理が、何を契機に動くのかも必要です。

    ここには、順序の問題もあります。表示要求を受けたときは通常動作中だったとしても、保留した要求を実行する前に終了が始まるかもしれません。その場合、受け付けたときの判断を使い続けるのか、実行前にもう一度判断するのかで、振る舞いが変わります。

    もし別のタスクや割り込みが情報を更新するなら、参照との前後関係や、更新途中の情報を見ない仕組みも確認する対象になります。単に条件分岐を追加するだけで済むとは限りません。

    私が追いたいのは、変数の名前だけではなく、「何が起きて情報が変わり、それを誰がいつ見て、どの動きにつながるか」です。この関係をたどると、処理を一つずつ読んでいるだけでは見えなかった確認箇所が出てきます。

    手を加える場所は、動きのつながりから決める

    ここまで考えると、これは設計の話なのか、今あるシステムを把握する話なのか、少し迷います。

    私の中では、まず現状の動きを把握し、その上で、どう変えたいかを決めるというつながりがあります。今どう動いているのかが曖昧なままでは、条件を一つ変えたときの影響も見えにくいからです。

    例えば、「初期化完了」を更新するタイミングを早める変更を考えます。変更箇所は一行で済むかもしれません。でも、その情報を見て表示を始める処理があるなら、表示を始める時期も早まる可能性があります。保留中の要求を実行する条件にも使っていれば、そこも確認対象です。

    画像

    ここで、関係するものを全部調べたつもりにならないようにしたいです。同じ情報の参照先を探すだけでなく、その参照先が変える情報や、後続の処理まで追う必要があります。一方で、すべてを一度に整理しようとすると、どこまで追えばよいか分からなくなる難しさもあります。

    今は、変更する情報を起点に、更新元と参照先を確認し、その先で変わる振る舞いをたどることを判断軸にしたいと思っています。その途中で、初期化の完了や終了の開始など、状態が切り替わる境界をまたぐなら、切り替わる前後の動きも確認します。

    現状の動き、変更後に狙う動き、まだ分からない動きを分けておけば、確認できていない部分を、確認済みとして扱わずに済みます。

    状態が少ない方が考えやすい、という気持ちは変わりません。ただ、今は数を減らす前に、「この期間に何が起き、何の情報が変わり、それを見てどこが動くのか」を説明できることに目を向けています。説明がつながらないところを見つけたら、まずそこを把握する。その上で、状態や判断を整理して減らせるかを考えたいです。

    著書紹介

    画像
    画像
    画像
     
     
    現役の組み込みエンジニアです。現場の設計の難しさと、変化の激しいAI時代に自分が生き残るために必要だと考えている思考法を発信しています。正解のない設計という分野で、より良い最適解を探る楽しさを皆さんと共有できれば嬉しいです。

    あなたへのおすすめ