睡眠指標計算ロジック設計：４つの指針

睡眠指標計算ロジック設計：４つの指針株式会社ニューロスペース平岡尚

発表者プロフィール平岡尚（ひらおかたかし） Sler, WEB開発会社, フリーランスを経て、2019年3月入社バックエンドエンジニア２つの協業プロジェクトを担当時差ボケ調整アプリ睡眠可視化アプリ
Laravel 5.x Rails 5.x

睡眠指標とは・睡眠時間・深い睡眠の割合・途中で起きる（中途覚醒）回数・毎日どれくらい規則的に寝て、おきているか？（起床規則性）・眠気 ...etc これら指標を計算する際に気をつけたことをお話しします！

大切にしている要件・計算ロジックのメンテナンス性・プロジェクト間での移植性・可読性これらをできるだけ担保できるような設計を目指した。変更があるからこそ、場当たり的でなく、都度しっかりと設計（モデリングを行う）し、ブラッシュアップできる状態を維持する

４つの指針 1. メソッドは入力に対して出力が決まるように設計する 2. 引数には値オブジェクトを活用する 3. 計算と永続化は分割する 4. プロジェクト間でのロジックの流用を想定するあくまで指針で、前述の「大切にしている要件」を満たせるかどうかが判断軸に
なる

メソッドは入力に対して出力が決まるように設計する

メソッドは入力に対して出力が決まるように設計する class SleepCalculator def self.adjusted_sleep_time (sleep_time, adjusted_minutes) sleep_time + adjusted_minutes
end end [なぜ意識するのか] 複雑な計算ロジックに進化する未来があった時、大体は複数のモデルのデータに依存する事になる引数で丸ごとActiveRecordを渡して、そのオブジェクトがリレーションを張っていて、さらにそれらを参照するコードが書かれてしまうと、「引数からなんのデータに依存しているのか読み取りにくく」なる。

引数に値オブジェクトを活用する

引数に値オブジェクトを活用する値オブジェクト：ドメイン駆動設計において登場する。値と振る舞いを持つモノをモデルと呼んでいる。モデルには「エンティティ」と「値オブジェクト」があるエンティティ値オブジェクト同一性識別子供が同一であれば同一保持する属性が全て同一であれば同一
可変性可変生成されてから、変異するというライフスパンを持つ不変生成されたら、あとは破棄されるのみ入力値が多くなるような場合に、引数に活用した

引数に値オブジェクトを活用する例）時差ボケ調整アプリには、眠気予報という、トラベルの予定と実績に基づいて将来の眠気を予想してくれる機能があります。入力には就寝時刻、起床時刻、食事の時刻、時差情報など多数の入力情報を必要とする予定：[ [ 就寝時刻,　起床時刻, 食事時刻, 時差情報,....] ,
[就寝時刻,　起床時刻, 食事時刻, 時差情報,....] ,...] 実績：[ [ 就寝時刻,　起床時刻, 食事時刻, 時差情報,....] , [ 就寝時刻,　起床時刻, 食事時刻, 時差情報,....] ,...] 眠気予報計算 Input Output Processing... 多量の時系列のデータ

引数に値オブジェクトを活用するエンティティ（ex. ActiveRecord）値オブジェクト Forecast 睡眠時間食事時刻 Achievement 睡眠時間
食事時刻睡眠実績睡眠予定食事実績食事予定 <<interface>> TravelActionBase エンティティを値オブジェクトに変換し使用値オブジェクト用のクラスを定義することで比較や分岐を直感的に表現できた

計算と永続化は分割する

計算と永続化は分割する class SleepCalculator FACTOR = 0.5 def self.adjust_sleep_time! (user, adjusted_minutes)
user.sleep_time += adjusted_minutes * FACTOR user.save! end end

計算と永続化は分割する class SleepCalculator FACTOR = 0.5 def self.adjust_sleep_time! (user, adjusted_minutes
) result = calc_adjusted_sleep_time (sleep_time, adjusted_minutes) user.update!(sleep_time: result) end def self.calc_adjusted_sleep_time (sleep_time, adjusted_minutes ) sleep_time + adjusted_minutes * FACTOR end end

計算と永続化は分割する計算過程を含めた戻り値を値オブジェクト（または単純なデータ型）として返すように計算メソッドを実装して、管理画面で計算結果を CSV出力などしてトレースできる public static function createPredictions($trip, $now) {
list($_, $sleepinessForecasts) = TravelPrediction::calculate($trip, $now); SleepinessForecast::create($trip, $sleepinessForecasts); } API呼び出し箇所 $response = new StreamedResponse (function() use ($travel, $calculateDatetime){ $stream = fopen('php://output', 'w'); stream_filter_prepend($stream,'convert.iconv.utf-8/cp932//TRANSLIT'); fputcsv($stream, ['datetime','base', 'hour','score', ....]); list($calcProcess, $_) = TravelPrediction::calculate($travel, $calculateDat 計算過程CSVDL箇所

プロジェクト間でのロジックの流用を想定する

プロジェクト間でのロジックの流用を想定するロジック実装の設計段階において、検討段階ではロジック部分だけ単独のRubyプロジェクトとしてリポジトリ管理しモデルの検証を行った

まとめ

まとめ複雑なロジックの可読性や保守性を維持するには、責務分担の設計であったり抽象度の高いモデリングを行うことが有効な場合がある。

まとめニューロスペースではその計算ロジック自体が重要な財産であるため、リリーススピードは意識しつつも腰を据えた設計プロセスが事業の長期的な成長に必要（と考えてる）。

ご静聴ありがとうございました！睡眠だけでなくとも、良いソフトウェアを作るプロセスにも興味ある方、懇親会でぜひお話しましょう！！！

睡眠指標計算ロジック設計：４つの指針

睡眠指標計算ロジック設計：４つの指針

Takashi

Other Decks in Programming

Featured

Transcript