Vueによる自作簡易DSL / Simple DSL with Vue

2023/8/19、ITたこ焼きの会（第2回）にてLTさせていただきました。

https://it-takoyaki.connpass.com/event/291090/

Transcript

1. Vueによる自作簡易DSL @tunemage
2. 自己紹介 • つねまげ(@tunemage) • 現職、管理会計SaaSベンダー勤務（SRE ->ユーザーサポー ト） • ユーザーサポート・SRE担当として社内システム改修を兼務 • （一応）現役プログラマー • 前職、製造業企業に勤務（ 研究開発->情報システム） • Kotlin/SpringBoot+VueJS/TypeScriptで社内システムを新規開発 • 同僚の休職により「ひとり情シス」も経験 • それ以前（SES/自社開発/フリーランス等） • ERP開発・教育システム開発・スマホアプリetc
3. 最近の社外Output紹介 • コーポレートエンジニア関西交流会vol.2（6/28）にてLT登壇 • https://www.youtube.com/watch?v=IPjd8D4LBXw • 『スクラムの拡張による組織づくり』（著:粕谷大輔、技術評論 社）のレビューに参加 • 謝辞に名前（tunemage）を入れていただき感激 • https://gihyo.jp/book/2023/978-4-297-13661-1/content/preface
4. 本日は • 簡易DSLを設計&開発した話 • 動機や背景を含めてお話します
5. まずDSL（ドメイン特化言語）とは • DSLは特定のドメイン（分野）に特化した言語 • 例： HCL・jQuery 、 Excel VBA、pom.xml等 • 対義語は汎用言語 • 例： Java 、 Ruby 、 XML等
6. 要件 • 案件管理システム • 受注案件の見積書作成から請求処理、会計システム連携までのステー タスを管理する • 上長承認機能の追加案件 • 見積や請求業務は担当者がデータ作成後、上長が内容を承認をしない と次の業務に進めない • 事業部によって承認が不要な場合もある事も考慮する • 開発/保守要員1名、希望工期1ヶ月半(つらい)
7. 画面イメージ 承認申請 見積画面 Contents 編集 承認 Contents 編集 次へ Contents Excel出力 承認申請 上長承認 見積画面 見積画面 ステータス：未申請 ステータス：申請中 ステータス：承認済
8. 設計&実装イメージ 1. 表示管理テーブルを作成 2. Vueのカスタムディレクティブ（属性）を作成 機能 アクション ステータス 部署 ユーザ権限 表示 見積 承認申請 未申請 A部 参照 無効 見積 承認申請 未申請 A部 作成 有効 見積 承認申請 未申請 A部 承認 有効 見積 承認申請 見積承認依頼中 A部 参照 非表示 見積 承認申請 見積承認依頼中 A部 作成 非表示 見積 承認申請 見積承認依頼中 A部 承認 非表示 見積 承認申請 見積承認済 A部 参照 非表示 見積 承認申請 見積承認済 A部 作成 非表示 見積 承認申請 見積承認済 A部 承認 非表示 見積 承認 見積作成済 A部 参照 非表示 見積 承認 見積作成済 A部 作成 非表示 見積 承認 見積作成済 A部 承認 非表示 見積 承認 見積承認依頼中 A部 参照 無効 見積 承認 見積承認依頼中 A部 作成 無効 見積 承認 見積承認依頼中 A部 承認 有効 見積 承認 見積承認済 A部 参照 非表示 ︙ ︙ ︙ ︙ ︙ ︙ ※実際のテーブルは正規化してますが説明の都合上省略しています ※CSVやYAMLでも本質は同じです ※Vue2時代の実装例です。
9. カスタムディレクティブ（独自属性）の 内部実装 1. 表示管理テーブルの中身とログインユーザーの情報（所属部 署、権限）を取得 2. 属性値と突合して、表示属性を特定 3. 表示属性に応じたCSSに対応するclassを動的に追加（CSSが 対応）
10. この設計のメリット • コードが宣言的に記述できる(v-ifの嵐を回避） • 要件変更に柔軟に対応できる（テーブルの設定変更のみで対応 可能な場合も多い） • 条件分岐がコンポーネント内に共通化される事でテストケース が削減される • ボタン以外のコンポーネントにも同じ仕組みが適用できる • 設定と制御機構を疎結合にできる（機構と方針の分離）
11. まとめ • 本件は「今の要件を何も考えずにゴリゴリ実装すると大変にな りそうだな。何かもっと上手い方法はないかな。」という悩み から始まりました。 • テーブル駆動の設定とVueのカスタム属性機能を組み合わせて 簡易DSLを実現するアイディアが浮かび、かたちになりました （もちろん、この設計が唯一の正解ではないと思います） • 小さな例ではありますが、設計って奥深くて楽しいなと再認識 できた案件でした。
12. 【おまけ】参考書籍 • ジェネレーティブプログラミング（Krzysztof Czarnecki/Ulrich W. Eisenecker ） 分厚いし難しいけど示唆に富む一冊です。 • 生産管理・原価管理システムのためのデータモデリング（渡辺 幸三 ） テーブル駆動設計を学べる良書です。ただし絶版。 同じ著者の「システム開発・刷新のためのデータモデル大全」が比較的新しく、 入手しやすいので良いかもしれません（私は未読ですが）