Share
Embed
コード分割から始める複雑さの解消に向けたkintoneのアーキテクチャ改善 / アーキテクチャConference 2025
hirokuni-maeta
November 20, 2025
Transcript
47 slides
-
自己紹介 ▌前田 浩邦 / Hirokuni Maeta ▌2014年4月 サイボウズ入社 ▌kintone開発チーム /
プロダクトエンジニア ▌サーバーサイドとフロントエンド、最近はサーバーサイドの改善を担当 2 -
コード分割の背景 ▌長年開発を続ける中でコードが肥大化、複雑化してしまったこと ⚫ src/main/java下の総行数 ≧ 350,000 ⚫ クラスの役割が曖昧で、一つのクラスを把握するためには、呼び出し元 や呼び出し先をたくさん追っていく必要がある ▌開発が非効率に
⚫ 妥当な修正箇所が探しづらい、想定外の箇所に影響が出る ⚫ 新メンバーがキャッチアップしづらい 6 -
コード分割の背景 ▌要因: ⚫ ローコード・ノーコードツールという柔軟性を持ち、複雑化しやすい ⚫ 初期のモノリシックな作りが見直されず、開発が継続 ▌ボトムアップな改善活動にも限界を感じていた ⚫ 目についたコードをリファクタリングしたところで、残りは膨大 ⚫
このようなリファクタリングを、あと何回やればいいのか? ▌抜本的な改善として、コード分割という取り組みを開始 7 -
機能についての考え方: PdMのメンタルモデル ▌メンタルモデル: どのような部分から構成され、どう関係し合ってるかという捉え方 ▌PdMが持つメンタルモデルが、コード分割にも適用できるものだった ⚫ アプリを使う人と作る人のように、異なる属性のユーザーが存在している ⚫ それぞれの属性で違った使い方をしている ⚫
属性に合わせてアプリ機能、アプリ設定機能と分けて考えると、見通しがよい 12 アプリ機能 アプリ設定機能 レコードを 閲覧する フィールドを 設定する アプリを使う人 (現場で業務をする人) アプリを作る人 (情シス・業務リーダー) -
コード分割で目指す構成 13 com.cybozu.kintone.appsettings アプリ機能 アプリ設定機能 com.cybozu.kintone.app FieldSetting Controller FieldSetting Service
Field Repository RecordController RecordService RecordData RecordRepository .export FieldSetting ServiceExport -
コード分割で目指す構成 14 com.cybozu.kintone.appsettings アプリ機能 アプリ設定機能 com.cybozu.kintone.app FieldSetting Controller FieldSetting Service
Field Repository RecordController RecordService RecordData RecordRepository .export FieldSetting ServiceExport 機能に対応するパッケージを作成し、 機能に属する全コードをパッケージに配置 -
コード分割で目指す構成 15 com.cybozu.kintone.appsettings アプリ機能 アプリ設定機能 com.cybozu.kintone.app FieldSetting Controller FieldSetting Service
Field Repository RecordController RecordService RecordData RecordRepository .export FieldSetting ServiceExport 必要なら専用インターフェイスを 外部に公開 -
コード分割で目指す構成 16 com.cybozu.kintone.appsettings アプリ機能 アプリ設定機能 com.cybozu.kintone.app FieldSetting Controller FieldSetting Service
Field Repository RecordController RecordService RecordData RecordRepository .export FieldSetting ServiceExport 内部実装への依存はNG exportへの依存はOK -
外部には専用インターフェイスを公開し、内部実装を隠ぺい public interface FieldSettingServiceExport { FieldSettingDto get(long appId); record FieldSettingDto(List<Field>
fields, …) {} record Field(long fieldId, FieldType type, …) {} } 17 アプリ側が機能実装する際、 アプリ設定側の情報についてはこれらにのみ依存 -
機能の特徴を捉えた上で分割する ▌既存のコードを基に分割しても、複雑さを解消できるとは考えづらい ▌例えば、複数のgetメソッドがあって、同じクラスを返している場合を考える ⚫ そのようなgetメソッド群を切り出し、共通化されるかもしれない ⚫ それでも動くからというだけで、偶然そのクラスを返すようにした可能性もある ⚫ 既存のコードを基にした分割は、偶然を基にした分割にもなりうる ▌機能に沿った分割では、複雑さの解消を期待することができる
⚫ コードは機能を実現するためにあるので、コードと機能は対応付けが可能 ⚫ 機能の分類に沿うことで、独立したパッケージに実装を分割、複雑さを隠ぺい ⚫ kintoneの全体の複雑さを、個々の機能の複雑さに分解 20 -
コード分割をしてみて ▌機能ごとの開発が容易になった ⚫ 機能に対応するパッケージのコードを読めばよいので、範囲が明確 ⚫ 他機能には影響が出るのか、どのような影響が出るのか、出さないようにするにはど うすればいいか、検討しやすくなった ▌複雑さの要因が一つ見つかった ⚫ 要因:
複数のアクター (アプリを使う人、作る人) の処理が、一つのクラスに混在 ⚫ 詳しくは「複雑性に立ち向かうためのサーバーサイドコード分割」として発表 ⚫ https://blog.cybozu.io/entry/2023/03/14/110000 ⚫ https://speakerdeck.com/hirokunimaeta/jjug-ccc-2023-spring 22 -
webアプリケーションとしての設計 ▌Service ⚫ ビジネスロジック ⚫ 例: ブックマークの追加、取得 ▌Data ⚫ 主要な情報
⚫ 例: ブックマーク ▌Controller (SpringのController) ⚫ リクエストを受け取り、Serviceを呼び出し、DataをResponseに変換 24 Bookmark Service Bookmark Controller Bookmark Data List Response -
背景 ▌Controllerでの、DataからResponseへの変換処理が曖昧だった ⚫ 基本的には単純なメンバ変数のマッピングで、機能の知識を必要としない ⚫ 実際は、単純なマッピングを超えた機能寄りな処理も混ざっていた ⚫ 例: DBを参照してアプリIDからアプリ名を引く、アクセス権が無ければ除去 ⚫
機能寄りの処理はどこまで書いていいのか? ▌曖昧なまま開発を続けることで、開発が非効率に ⚫ どこに書くか迷いながら開発 ⚫ 書き手のさじ加減で決まることで、可読性の低下 ⚫ どこでアプリ名を引いているのかなかなか見つからない 25 -
Controllerも”外部”とみなし、分割 26 ブックマーク機能 他機能 Service Bookmark ServiceExport .export Bookmark ApiService
.web Bookmark Controller Bookmark Service Bookmark Data -
機能の振る舞いをApiServiceに記述 public interface BookmarkApiService { ListResponse list(long userId); record ListResponse(List<App>
apps, …) {} record App(String name, …) {} void add(…); } 27 Bookmark ApiService Bookmark Controller -
ControllerはApiServiceを呼ぶだけ public class BookmarkController { ListResponse list() { return bookmarkApiService.list(getUserId());
} } 28 Bookmark ApiService Bookmark Controller -
ApiServiceを導入してみて ▌曖昧だったControllerの役割が明確になった ⚫ 機能寄りの処理はどこまで書いていいのか? → 書かない ⚫ ApiServiceを呼ぶのみ ⚫ 必要なら、
SpringやHTTPリクエスト等のweb層のオブジェクトから情報を取り出す ⚫ 機能についての知識は持たず、フロントエンドと機能とを繋げることが役割 ▌さらに、下のような効果もあった ⚫ Dataクラス、Serviceクラスの肥大化が抑制された ⚫ Javaのinterfaceで機能を定義できるようになった 29 -
肥大化していたDataクラス ▌フィールドの値を保持するRecordDataクラスが肥大化していた ⚫ 各フィールドの値 (例: 1000) ⚫ アプリ設定に従い、画面表示用にフォーマットした値 (例: “1,000”)
30 Record Service Record Data Record Controller Record Response ・ 1000 ・ “1,000” ・ 1000 ・ “1,000” FieldSetting ServiceExport -
ApiServiceの導入による肥大化の解消 ▌ApiServiceがフォーマットできるようになった ⚫ なぜなら、ApiServiceはResponseの生成と返却が役割で、Response の生成にはフォーマット処理が必要 ▌RecordDataは永続化の値だけ保持すればよい 31 Record Service ・
1000 Record Controller Record Data Record ApiService Record Response ・ 1000 ・ “1,000” FieldSetting ServiceExport -
ApiServiceの導入で判明した複雑さ ▌アプリ名やフォーマットされた値は、 JSONにのみ必要な情報 ⚫ view modelに近い概念 ⚫ 返却されるJSONをviewと解釈としたときに、viewを生成するためのmodel ▌view modelの生成箇所が不適切で、これが複雑化につながっていた
⚫ Controllerでアプリ名を引く → Controllerで生成 ⚫ Controllerではどこまでが変換処理なのか曖昧に ⚫ Dataにフォーマットした値も置く → Serviceで生成 ⚫ Dataクラスが肥大化、Dataクラスを生成するServiceクラスも肥大化 32 -
ApiServiceの役割 ▌ApiServiceは以下の特徴を持つことから、ユースケースを実装する役割 ⚫ 常に機能の外から利用され、機能内の再利用は想定されない ⚫ 外部からの入力と、出力 (view model) を定義している ⚫
したがって、外部が期待する振る舞いを実現する責任を持つ ▌ユースケースの考えを導入して実装を見直すことで、複雑さの解消が見込める ⚫ 外部が期待する振る舞いを分析し、責務を割り出してクラスに定義する等 ⚫ ApiServiceがResponseを生成する際にフォーマットさせるのはこれに該当 ⚫ DataからResponseへの変換処理が曖昧になっていることの見直しも 33 -
Javaのinterfaceで機能を定義できるようになった ▌.exportを中心として図示 34 他機能 Service Bookmark ServiceExport .export Bookmark ApiService
.web Bookmark Controller Bookmark Service Bookmark Data -
Javaのinterfaceで機能を定義できるようになった ▌他機能部分や.web下に、ブックマーク機能に関するコードは存在しない 35 他機能 Service .web Bookmark Controller 機能沿ったパッケージへのコード分割により、 他機能部分にブックマーク機能はない
機能とwebの分離により、 .web層にはブックマーク機能に関する知識がなくなった -
Javaのinterfaceで機能を定義できるようになった 37 ▌外部から機能として認識できるのは.export部分のみ ⚫ 外部からの依存は.exportに制限されているため ⚫ ServiceやDataは外部から認識できず、それらは exportされているメソッドの振る舞いに表れている ▌外部から機能として依存しているのは、.exportにある interfaceと、メソッドが機能として期待
(契約) 通りに 振る舞うことのみ ⚫ ServiceやDataの特定のあり方には依存していない ⚫ あり方が何であっても、メソッドが期待通りに振る舞う ならば、それは機能になっている Bookmark ServiceExport .export Bookmark ApiService -
Javaのinterfaceで機能を定義できるようになった 38 ▌.exportにあるinterfaceが機能を定義している ⚫ ServiceやDataは機能を実現するための内部 実装で、その詳細や複雑さは隠蔽されている ⚫ 機能を抽象データ型で表現 ▌応用 ⚫
結合テストの対象 ⚫ 機能開発の際、修正を考える起点になる Bookmark ServiceExport .export Bookmark ApiService -
応用: 結合テストの対象 39 ▌機能のテストは.exportにあるinterfaceの振る舞 いのテストとして書くことができる ⚫ 機能の振る舞いは全て.exportに定義されてい るため ⚫ addした項目がlistで返ってくる等のテストになる
▌内部実装に依存せず、機能を外側から観測できて いるので、堅牢なテストになる Bookmark ServiceExport .export Bookmark ApiService -
応用: 機能開発の際、修正を考える起点になる 40 Bookmark ServiceExport .export Bookmark ApiService ▌ApiServiceやResponseはどうなるのか、そのために Service、Dataはどう変えるのか、というトップダウンな考
え方が可能になる ⚫ 機能の一番外側から、全体を俯瞰した検討が可能 になる ▌今までは、ServiceとDataをどう変えるか、というボトム アップな考え方がほとんど ⚫ ServiceやDataに詳しくないと修正箇所を見つけら れず、Serviceの役割も曖昧なので考慮漏れが起き やすい -
ApiServiceを起点に機能の修正を考える ▌性能カスタマイズオプション: アプリの用途に適したレコードを実装したい ⚫ 後からでもフィールドを追加できる、柔軟なレコード (← 既存実装) ⚫ 大量のデータを高速に扱うことのできるレコード (←
実装したい) ▌今までは、既存のServiceやDataをどう修正するかを考えがち ⚫ 既存実装にも影響し、影響範囲が広がりすぎてしまう 41 Record Service Record Data -
ApiServiceを起点に機能の修正を考える ▌RecordResponseを返しさえすれば、内部実装はなんでもよい ⚫ 極端な話、実装をもう一つ追加しても機能的には問題ない ▌永続化部分(FastRecordService) のみを新規実装 ⚫ こちらの案で検討を継続中 42 Record
ApiService IRecord Service FastRecord Service FastRecord Data Record Service Record Data Record Response -
重量級なインターフェイスの自動生成 ▌コード分割やwebとの分離のためには、公開 インターフェイスが必要 ▌kintoneでは公開するインターフェイスが重量 級になりがちで、用意が大変 ⚫ フィールドごとクラスが10個以上 ⚫ 各フィールドそれぞれに専用メソッド ▌生成AIで省力化が可能だった
⚫ インターフェイスは既存の実装と似た構成 ⚫ クラスを最初に一つだけ人手で定義、これ をお手本として残りをAIで自動生成 44