「現場で役立つシステム設計の原則」読書会レポート vol.10

株式会社リゾーム システム企画・開発部 第4グループの平松です。
今回は、読書会の第10回目のレポートになります。
前回のレポートは、こちらになります。

tech.rhizome-e.com

10回目レポート

今回は、第10章「オブジェクト指向設計の学び方と教え方」で参加者は6名でした。

それぞれの感想・意見交換

  • ドメインオブジェクトを設計していくという考え方にはあまりなってなかった
  • 受託開発をしているときはリファクタリングをする機会があまり与えられないため、良さがよくわかってなかった
  • オブジェクト指向は言葉で説明するのは難しい
  • オブジェクト指向を学ぶにはリファクタリングがいいと思う
  • 手を動かして覚える
    • 仕事のタスクだけだと覚えるのに時間がかかりそう
    • オブジェクト指向を意識して作業してもらわないと意味がない
    • コードレビューで言及して意識してもらうとか
  • 実際の実装を読んで理解する
    • 一番手っ取り早い気がする
    • 長くメンテされているライブラリ等は綺麗に実装されているものが多い
    • ついでにPRも出せば、手も動かせて良い勉強方法になりそう
  • 極端なコーディング規則を作ると、1人ならいいのかもしれないけれど、チームでやるとイライラしそう
    • 仕事で実践していくのは厳しい
    • プライベートで勉強がてら取り組むのには良さそう
    • Todoリストとかのサンプルアプリを作って試すなど
    • 一部、簡単に実践できる内容もあったので、今後、機能開発する際はチェックするようにしたい
  • ドメイン駆動設計の本は先輩社員にもオススメされた
    • 書かれたのが2000年代初頭なので、それを念頭に置いて読まなければならない
    • 書かれてる実装方法が現代においては冗長だったりするらしい
  • 「モノ」にフォーカスした「データクラス」がアンチパターンであることを理解する
    • データクラスは複数箇所で参照されるため、修正の影響範囲が大きくなるということを理解する
    • モノにフォーカスしたテーブルを作るとこれが出来上がる
    • モノにフォーカスしたテーブルを作っていいのは業務ロジックを持たないマスタデータだけ?

まとめ

この章では、オブジェクト指向の学び方について意見交換を行いました。
リファクタリングで学ぶという意見やライブラリ等の実装を読んで理解するという意見など、それぞれが思うオブジェクト指向の学び方が出てきました。

第10章で「現場で役立つシステム設計の原則」の読書会は終わりです。
この本を読んできて、ドメインオブジェクトの視点からオブジェクト指向とはどのようなものか、オブジェクト指向の開発とは何かを知ることができたのではないかと思います。 また、この本の内容が自社製品のリファクタリングをする上で基準の参考になりました。

次の読書会は入門 監視 ―モダンなモニタリングのためのデザインパターンを読んでいきます。

「現場で役立つシステム設計の原則」読書会レポート vol.9

株式会社リゾーム システム企画・開発部 第3グループの渡辺です。
今回は、読書会の第9回目のレポートになります。
前回のレポートは、こちらです。
tech.rhizome-e.com

9回目レポート

今回は、第9章「オブジェクト指向開発プロセス」を読み進めました。

それぞれの感想・意見交換

開発の進め方
  • 分析・設計にほとんど時間をかけずにとにかくプログラミングするという流れはある。
    • 特に、Railsでは顕著ではないかと思う。ちょっと規模が大きくなるとコードの見通しが急速に悪化するというのは、身に覚えがある。
    • コードの見通しが悪い
    • 手がつけられないほど難解
  • もう少し分析や設計に時間をかけるのが良いのかもしれない..。
ドキュメントについて
  • 開発の初期から利用規約・ユーザーガイドのアウトラインを作成しておき、開発が進むにつれ内容を充実させる、というのはいい考えだと思う。
  • データベースのテーブル名/カラム名とコメントは書くようにしている。I18nのデータを元にコメントにしていく仕組みを準備している。gemにしてもいいかもしれない。
    • 何のためのカラムか、制約か、わかりやすくなる
  • 技術方式のドキュメントもソースコードで表現できる(Infrastructure as Code)
    • 現代においては、この辺りはもう全てコード化しておくべきもの。学ばなければならないものが多い反面、自動化できることの恩恵は大きい。
  • ソースコードがドキュメントの代わりになる
    • ドメインオブジェクトのクラス名等と業務の関心事が一致してれば可能
    • とても魅力的だが、テスターの人にもある程度の知識が必要になる(IDE使えたりとか)
    • 技術者ではない人向けには別途ユーザーガイドなどを用意すると良い
    • ドメインモデルで設計ができれば、コードがドキュメントみたいなことが実現できる
情報共有の方法について
  • 口頭でのやりとりをラフスケッチとしてホワイトボードに起こしていくというのは、写真を撮るだけでいいしよくやっていた。
    • リモートワークが主流になった現在だと、MiroやMS Whiteboard等を活用するのもいいかもしれない。
  • ラフスケッチ良さそう
    • 今は口頭とかテキストベース
      • イメージしにくかったり見落としがあったりとか
ドメイン知識について
  • オブジェクト指向の開発を進めていく上で業務の理解は必須になっている
  • 分からないことは聞く。分かったふりはしないこと。
    • どのようにしてドメイン知識をつけたか、同じチームのメンバーに確認する
  • 他の章にも書いてあったが、プログラミングスキルとドメイン知識の両方を備えていかないと、優秀なエンジニアとは言えないと思う。業務知識の勉強会を行うことも大事と思われるので、そういうことも計画していったほうがよいかもしれない。

まとめ

本章では特に「ドキュメント」「情報共有」について、今までの経験でどうした方がいいのか答えが出ていなかったのですが、答えを見つける手がかりを得ることができました。
技術者向けには、ドメインモデルでの設計やInfrastructure as Codeにより、ソースコード自体をドキュメントとし、技術者以外の関係者との情報共有は、「利用者向けのドキュメント」や「画面・帳票」をメインに利用できるようしていきたいです。

現在実施している「現場で役立つシステム設計の原則」読書会は、ついに次回の第10章で最後となりました。
改めて今までを振り返り、今回得た知識を業務で活用して行こうと思います。

「現場で役立つシステム設計の原則」読書会レポート vol.8

株式会社リゾーム システム企画・開発部 第3グループの鳥井です。

読書会の第8回目のレポートです。

前回のレポートは、こちらになります。

tech.rhizome-e.com

8回目レポート

今回は、第8章「アプリケーション間の連携」で参加者は4名でした。

それぞれの感想・意見交換

アプリケーション間の連携方式
  • 代表的なものは以下の4つ
    • ファイル転送
    • データベース共有
    • Web API
    • メッセージング
  • 弊社でよくやる方式なのはファイル転送、WebAPI連携も多少やっている。
Web API設計
  • 更新も削除もPOSTにする
    • アプリケーションの独立性が高くなり、修正の影響を小さくできる
    • 更新や削除もPOSTで行うのはRESTに反するので、どうだろう..。
  • 大は小を兼ねるAPI
    • 必要のないパラメータまで理解しなければならなくなる
    • 受け取ったデータから必要なデータを取り出す処理が必要になる
  • 計算ロジックの置き場所
    • 以下の理由から、単純なものも含めてクライアント側を基本とするのが良い気がする。ただし、DBで集計できるものなどはWeb API側で処理する。
      • どちらに書くべきか判断に迷わなくなる
      • ロジックを書いてある箇所が特定しやすい
  • 登録と参照を分ける
    • 例えば指定席を予約するAPIの場合、POSTのレスポンスは予約番号だけを返し、予約内容はその予約番号を使って別途GETする
      • この例だとPOSTした際に予約内容の詳細を返す場合と比べて1回リクエストが増えるが、シンプルな設計になることのメリットのほうが大きいと思う
  • リソース単位を分ける
    • Web API側はシンプルになるが、これはリクエスト数がかなり増えそう
      • 例えば名前、生年月日、性別の3項目を1つの画面に表示したい場合、3回リクエストする必要がある。リソースの数だけリクエストが増えてしまう。
    • クライアント側はリソースの数だけリクエストする処理や受け取ったデータを管理する処理が必要になるので煩雑になりそう
      • URLを叩く処理などをSDKなどにまとめていけば再利用しやすくなり、クライアント側の負担を減らすことができるかも
非同期メッセージング
  • 非同期メッセージングをアプリケーション間で使ったことはない気がする..。
  • dRubyを使えばできる?
マイクロサービス化
  • 試行錯誤がしづらそうだと思った。サービス単位の分離を上手にやらないといけない。
  • 対象業務への理解が不十分な場合はモノリスで作っておき、後々分けていくのが良いかも
  • サーバーレス&マイクロサービスが今後の主流になっていくとは思うが、それはある程度サービスが枯れてからが良さそう

まとめ

今までWeb APIを利用することがあまりありませんでしたが、本章を読み進めることでWeb API自体やシンプルでより良い設計の方法について理解を深めることができたと思います。

ただし、Web API側のシンプルさを追求する一方でリクエストの頻度やクライアント側の負担についても考慮する必要があると感じました。

本章を通じて得た知見を活かしてシンプルで保守しやすいWeb API設計を意識しつつ、サービス全体としても最適な設計を模索していきたいと思います。

「現場で役立つシステム設計の原則」読書会レポート vol.7

株式会社リゾーム システム企画・開発部 第4グループの尾古(@patorash)です。

読書会の第7回目のレポートです。

前回のレポートはこちらです。

tech.rhizome-e.com

7回目レポート

それぞれの感想

画面にロジックを書いてしまうこと
  • 画面に表示するロジックと業務ロジックが混在してしまう
    • 1章で言われていた、ちょっとした条件分岐を追加したら複雑になってしまう件が頻発する
    • ビューにif文が入ると見辛くなる
      • 特に、slim*1で書いていると、閉じタグがないため、インデントが重要になるが、if文が入るとかなり見辛い
    • 複数画面にコードが重複してしまう
  • 表示のロジックと業務ロジックを分ける意味では、Railsでいえばビューヘルパーを使ったり、デコレーターを使っていくのがいいとは思う。ビューヘルパーのメソッドはオブジェクトをレシーバにできないのであまり好みではないけれど、契約による設計を重視した形にすれば、あまり散らからないのではないか?
論理的なビューと物理的なビュー
  • どこに画面用ロジックを集めるか問題
  • 論理的なビューに関してはドメインオブジェクトでいい、というのはわかるのだが、結局苦しんでいるところは物理的なビューだったりする。
  • Railsだとデコレーター層でやりがちだが、ビュー専用オブジェクトは極力作るべきではない
  • 画面に依存したドメインモデルもアンチパターン
  • class属性をドメインオブジェクトが持つべきという話
    • オブジェクトの状態によってclassを書き分けるif文がView上に出るたびに薄々感じていた
タスクベースのインターフェース
  • 関心事毎に画面を分割する発想はあまりなかった
  • ユーザーの入力負担軽減につながるので良さそう
  • 画面をタスクベースにできなくても、設計をタスクベースにしたり、画面の方も4原則を使って整えたらかなり見やすくなるのではないかと思う
  • 画面デザインの考え方をドメインオブジェクトのコードに当てはめるのは面白いと思った
  • 要件定義をする際に、お客様側は画面ありきで要件を考えるため、それがそのまま設計に繋がってしまうことがあった。
  • 今作っているサービスだとなんでも入力画面になっている。後で入力すればいいものまで、必須にする必要はないので、ドメインオブジェクトで整理していきたい。
  • 画面とオブジェクトを一致させることが、次第に画面に依存したオブジェクトを生み出すことに変わってしまいそうなのが一番懸念される
    • つまりレビュワーはこの点を特に注意深くレビューする必要がある
  • 画面もドメインオブジェクトで管理したいとなると、MVVMを使うようになってくるのは必然。しかし、この辺りをよくわかっていない人がやっているコードを見ると、「画面を値が連動していて便利」止まりになっている気がする。
利用者向けの情報もソフトウェアと整合させる
  • そうあるべきだが、これが難しい…
  • 開発者とプレスリリース/リリースノート/利用者ガイドを作成する人が異なるので…。
  • ドキュメント系のメンテナンスのためにはもうちょい開発者増やしたい。

意見交換

出た意見として、「全てのアンチパターンはモノに注目するが故に起きる。コトに注目することで細分化できたり解決するように見える」というのがありました。今まで読んできた中で、ドメインオブジェクトを作るにしても、テーブル設計をするにしても、コトに注目して整理することで、随分良くなるように感じています。

また、論理ビューと物理ビューをどうするべきか?について、時間をかけて話し合いました。最終的には、「物理ビューに依存したドメインオブジェクトにするべきではない」ということになりました。 最初は私は「論理ビュー用のロジックはドメインオブジェクトに持たせて、デコレーターには責務を割り切って物理ビューを担わせてしまえばいいのではないか?」という意見を展開していたのですが、ビュー専用オブジェクトになるし物理ビューと密結合になるのでよくないのでは?という意見もあり、考えを改めました。

Railsで論理ビューと物理ビューをどう管理するか?

読書会の後、ビューヘルパーに物理ビューを出力するメソッドを定義し、その引数に論理ビューを渡すという方式が一番しっくりくるのではないか?と考えました。

例えば、順番なしリストを作る場合は以下のような形になります。

まず、unordered_listヘルパーメソッドを定義します。

module ListHelper

  # ulタグのリストを表示する
  # @param [Array<String>] items リスト表示したい文字列の配列
  def unordered_list(items)
    render 'shared/ul' do
      render partial: 'shared/li', collection: items, as: :item
    end
  end

end

次に、上記のメソッドでレンダリングするViewを書いていきます。 views/shared/_ul.html.erbをこのようにします。

<ul>
<%= yield %>
</ul>

そして、views/shared/_li.html.erbをこのようにします。

<li><%= item %></li>

利用する場合は、例えば記事にタグがある場合はこのようにできます。

<h3>タグ一覧</h3>
<%= unorderd_list(@article.tags) %>

この形であれば、

  • ドメインオブジェクトは論理ビューに徹する
  • ヘルパーメソッドは論理ビューと物理ビューの繋ぎに徹する(ロジック含む)
  • 部分テンプレートは物理ビューに徹する(ロジック含まない)
  • 物理ビューにループ等のロジックを書かないで済む
  • 再利用性が高い
  • メソッドなのでIDEで補完が効く

と、良いこと尽しな気がしています。

まとめ

本章を通じて、普段から業務用ロジックと画面用ロジックのところで悩んでいたため、活発な議論ができたのではないかと思います。私自身もメンバーとの議論を通じて、考えを改めたほうがいいなと思えましたし、その中でより良い解決策を見出せたと感じています。

やはり本を読むだけでなく、意見交換を行える場があるほうがいいなと感じました。

「現場で役立つシステム設計の原則」読書会レポート vol.6

株式会社リゾーム システム企画・開発部 第1グループの小田です。

読書会の第6回目のレポートです。

前回のレポートはこちらです。

tech.rhizome-e.com

6回目レポート

今回は、第6章「データベースの設計とドメインオブジェクト」で参加者は5名でした。

それぞれの感想・意見交換

制約について
  • NOT NULL制約、一意性制約、外部キー制約を徹底すると自然と正規化が進む。
    • 適切なDB設計をするための指標としてわかりやすい
  • ここに書いてあるNOT NULL制約、ユニーク制約、外部キー制約などは基本的なものなので、出来る限り使う。データベース側の機能のチェック制約やenumなどを使うと、更にデータを守ることができる。
  • 原則としてNULLを許容しない。
    • もしNULL値がどうしても必要なカラムを見つけたら別のテーブルに分ける。
  • NOT NULL制約を使っていないカラムだとプログラム側でnullが来ることを考慮しなければならない。
  • 以前の勉強会で「データベースには事実を記録する。事実にはNULLなどない。基本的にNOT NULL制約を付けなければならない。」と言われて納得した。それ以降はNOT NULL制約を必ず付けるようにしている。レビューのときにも「NOT NULL制約を付けろおじさん」になっている。
  • (NOT NULL制約、普段はほとんど使ってない...)
コトに注目するデータベース設計
  • コトを記録するという発想がないと、モノに関連するもので一緒くたに詰め込んでしまおうと考えてしまいがち。
  • コトに注目するデータベース設計は楽々ERDレッスンでも言われていた。
    • 導出項目の排除につながる。
    • 導出項目はSQLのビューで状態を表現する。
  • 記録のタイミングが異なるデータはテーブルを分ける、というところ。マジでそれ!と思った。今の仕様がそうなっていなくてかなり辛い。
  • カラムを追加するのではなくテーブルを追加する。
    • そのカラムには過去データが存在しないので、NULLを許容するか偽データを登録するかの二択になるから、別テーブルに分けたほうが良い。
    • 確かに副作用がないけれど、テーブルが増えるしJOINが大変になりそうな気もする…。プログラムへの影響は少ないし、事実を記録する観点だとそっちのほうがいいのかな。
    • JOINが増えると性能面が不安
      • コト(口座への入出金データなど)を記録するテーブルとは別に、集計結果(口座残高など)を格納しておくテーブルを用意してあらかじめ集計しておくと良いらしい。
  • コトの記録の変更を禁止する(updateではなく、取り消しデータをinsert→修正後の新データをinsert)
    • 記録をupdateするのはupdate前の記録を削除することと同じ。updateせず「記録を修正した」というコトを記録する。
    • なるほどと思った。取り消しを記録する。元データ、取り消しデータ、新データ。INSERTだけで実現可能。
参照をわかりやすくする工夫
  • 状態の参照。コトの記録を徹底すれば、状態の算出は可能。動的に出力するのはパフォーマンス的に辛い場合もあるので、この辺りはRailsだとカウンターキャッシュを使ったり、DBのマテビューを使ったりしている。
  • 残高更新は同時でなくてもいい、一か所でなくてもいいという考え方は、柔軟性が生まれる。事実はDBに保存し、状態はKVSに持たせるようにすると良さそう。状態の参照は頻繁に行われると想定すると、KVSのほうが向いている。
  • モノの記録を行うからそこに状態を持つ必要が出てくるのであって、コトの記録に徹底するからこそ状態の更新をコトの記録と分離することが可能になるのだろうか
オブジェクトの設計とテーブルの設計
  • コトを記録するテーブルとドメインオブジェクトがほぼ1対1に対応することがある。しかし、似て非なるものという意識を持っておくべき。ドメインオブジェクトとデータベースのアクセスは、基本的に疎結合にしておいたほうがいい。そうでないと、互いに引っ張られ過ぎる。ドメインオブジェクトには業務ロジックを、データベースには事実の記録を。関心事が異なる。しかしそうなるとやはりRailsだと難しい。RailsActiveRecordドメインオブジェクトでもあり、データベースへのアクセス手段でもあるからだ。

まとめ

本章を通じて、コトに注目したデータベース設計を行うことで柔軟性が生まれ、データの管理やプログラムの修正が容易になることを理解することができました。 本章で書かれている内容と自身のプロダクトのデータベース設計を見比べ、どの辺りに改善の余地があるかを参加者全員が意識することができたと思います。

私は「原則として全てのカラムでNULLを許容しない」「カラム追加時は既存テーブルに追加するのではなく、新規テーブルを作成する」といった内容は想像したこともなかったのですが、そのように設計されたデータベースはデータの整合性や信頼性が高まり、定義の変更時にプログラムへの影響を最小限に抑えられることを理解できました。

また、読書会の中で「楽々ERDレッスン」という書籍を紹介頂きました。本章の内容についてはもう少し深掘りしてみたいと思ってるので、そちらも今後読んでみようと思います。

「現場で役立つシステム設計の原則」読書会レポート vol.5

株式会社リゾーム システム企画・開発部 第3グループの鳥井です。

読書会の第5回目のレポートです。

前回のレポートは、こちらです。

tech.rhizome-e.com

5回目レポート

今回は、第5章「アプリケーション機能を組み立てる」で参加者は5名でした。

それぞれの感想・意見交換

三層+ドメインモデル

  • 三層とRailsにおける処理の対応関係は以下のように捉えることができそう
    • プレゼンテーション層
      • ルーティングとコントローラーの不正パラメーターのフィルタリング
    • アプリケーション層
      • コントローラーの各アクションでの処理やサービスクラス、モデル
    • データソース層
      • モデル
  • 複数のモデルにまたがるような複雑なビジネスロジックをサービスクラスにするものだと考えていたが、そうでないことに気付かされた

シナリオクラス

  • サービスクラスを組み合わせたシナリオクラスを作ることで、業務の視点で必要とする機能単位を表現できる
  • 小さいサービスクラスをサービスクラスでまとめるという発想はなかった

メソッド

  • メソッドの処理が複雑になってきたら小さいメソッドに分けることでシンプルにできる
    • 小さく分ける基本の形として登録系と参照系で分けるのはわかりやすい

DB操作と業務ロジック

  • CRUD指向のフレームワークではDB操作と業務ロジックが混在しがちになる
    • 業務の関心事をDB操作に置き換えてコードを書くことによってプログラムから業務の意図が見えづらくなる
  • Railsでは分離しづらそう
  • メソッドにして対応する?

防御的プログラミングと契約による設計

  • 防御的プログラミングではメソッドを呼び出す側が何をしてくるかわからないという前提であらゆる防御的なロジックを書くため、コードが複雑になる。それによりテストも増える。
  • 契約による設計ではメソッドを呼び出す側と呼び出される側で約束事を決めることでコードをシンプルに保てる
  • 実際に業務の中で契約による設計を意識し、メソッドを呼び出す側に責任をもたせて、渡す引数の型情報などをyardで書くようにしている

まとめ

本書で説明されている三層+ドメインモデルの構造や用語をRailsに置き換えて読み進める際、用語の定義の違いに混乱することがありましたが、両者を比較することで新しい設計パターンを知ることができたと思います。それぞれのメリットとデメリットを踏まえて最適な設計を模索し、業務に取り入れていければと思います。

また、読書会全体を通して経験のあるエンジニアの会話の内容を聞いているだけでも勉強になると感じます。

特にリモートワークでは個人で作業する時間が多くなりがちです。その中で、読書会はエンジニア同士の会話の中から新しい知見を得られる貴重な場となるため、今後も継続して参加していきたいと思います。

「現場で役立つシステム設計の原則」読書会レポート vol.4

株式会社リゾーム システム企画・開発部 第3グループの渡辺です。

今回は、読書会の第4回目のレポートになります。

前回のレポートは、こちらです。

tech.rhizome-e.com

第4回目レポート

今回は、第4章「ドメインモデルの考え方で設計する」を読み進めました。

それぞれの感想・意見交換

ドメインモデルについて
  • ドメインモデルで設計することで、業務の流れや用語がプログラムにそのまま反映され、プログラム自体が業務の説明書になる。
    • 抽象度を高めることが汎用的なプログラミングには大事だが、それとは対照的。
  • ロジックを変更する際、変更による影響範囲が把握できないので、検索して洗い出した箇所を1つ1つ見ていくこともある。そういった事態が発生しにくいドメインモデルでの設計は非常に魅力的に見えた。
ドメインオブジェクトの見つけ方・作り方
  • 「関心事」の粒度を正しく理解しないと正しいドメインモデルを作れない。
    • 関心事をヒト/コト/モノで分類するのはわかりやすかった。
  • パッケージ図や業務フロー図を活用し、全体の俯瞰・各部分に着目を行ったり来たりする必要があるようだ。

業務への理解を深めることについて

  • 業務の用語を正しく理解して、それをクラスやメソッドに落とし込む必要がある。
    • そのためには要望の聞き取りから仕様の決定まで、開発者が関わる必要があるが、なかなか難しい。
  • その業務分野について興味をもって学ぶというのが大事。プログラムだけ上手くなろうとしても片手落ちで、我々は業務知識を学ばなければならない。

まとめ

第4章では、ドメインモデルでの設計について理解を深めて行きました。私の頭の中では、今までの手続き型での設計に慣れ親しんでいるため、なかなか理解が追いつかない箇所もありましたが、具体的な例や実際の業務に当てはめることで、ドメインモデルのメリット等を知ることができました。

ドメインモデルでの設計に限った話ではありませんが、自身が携わる業界知識について深く知っていくことは重要です。関係部署を巻き込んだ勉強会も実施していきたいと思います。