Maia OSS版のアプリケーションアーキテクチャCSR編（サーバーサイド）を作成する

[tsuna-can-se]

目次案

Maia OSS版のアプリケーションアーキテクチャ クライアントサイドレンダリング編

• アプリケーションスタック

  • 概要編で挙げた図を詳細化して解説。
  • Spring系ライブラリ、という書き方ではなく、実際にサンプルAPに組み込むものを具体的に書く。
    • 特に、Spring Securityのように設定だけでは使えない物は詳しく説明が欲しい。
  • Vue.js側も対象に含める。
    → Maia OSS版のアプリケーションアーキテクチャCSR編（クライアントサイド）を作成する #76 で対応
  • この図が欲しい。 https://terasolunaorg.github.io/guideline/5.7.0.RELEASE/ja/Overview/FrameworkStack.html#software-framework

• アプリケーション論理構成

  • アプリケーションアーキテクチャ

    

    • クリーンアーキテクチャ、レイヤードアーキテクチャ、ＤＤＤの知識は前提にしてよい（リンク先だけ提示）

  • レイヤー構造

  • コンポーネント構造（このへんは前段の節でまとめてかけそうなら無理に分割しなくて良い）

• 推奨ディレクトリ/パッケージ構成
  すでに概要編で記述済みのためここでは記載しない

  • Maia OSS版の推奨構成（Mono-repo版）として、当部の研究結果をここに書き表す
  • Multi-repoとする場合はどこをどう分けると良いか示す。詳しい解説はしない。

• 機能詳細

  • 各層で実装する機能の詳細。

    • 機能や実現方法の概要、重要なカスタマイズポイントを示す。
    • 手順までは落とさない。開発に必須な作業やカスタマイズは開発手順書でフォローする。
    • Milestone 0.1では、「※T.B.D」が付いていない部分の内容を記載する。

  • サーバーサイド

    • ドメイン層
      • Bean Validation
      • トランザクション管理 ※T.B.D 概要編に書く
        → アプリケーションアーキテクチャ概要編にトランザクション管理に関して追記する #81 で対応
    • アプリケーション層
      • 入力チェック
      • 例外ハンドリング
      • 二重送信防止 ※T.B.D
        → アプリケーションアーキテクチャCSR編に二重送信防止に関して追記する #77 で対応
      • セッション管理 ※T.B.D SSR編に書くほうが良さそう
        → アプリケーションアーキテクチャSSR編を作成する #82 で対応
      • ファイルアップロード・ダウンロード ※T.B.D
        → アプリケーションアーキテクチャCSR編にファイルアップロード・ダウンロードに関して追記する #83 で対応
      • ヘルスチェック ※T.B.D
        → アプリケーションアーキテクチャCSR編にヘルスチェックに関して追記する #84 で対応
      • 外部システム呼出し ※T.B.D
        → アプリケーションアーキテクチャCSR編に外部インターフェースの呼び出しに関して追記する #78 で対応
    • インフラストラクチャ層
      • データベースアクセス（JDBC編） ※T.B.D 優先度低
        → アプリケーションアーキテクチャCSR編にJDBCのデータベースアクセスに関して追記する #85 で対応
      • データベースアクセス（MyBatis編）
      • データベースアクセス（JPA編） ※T.B.D 優先度低
        → アプリケーションアーキテクチャCSR編にJPAのデータベースアクセスに関して追記する #86 で対応
      • 静的リソースアクセス
      • DBアクセスの排他制御 ※T.B.D
        → アプリケーションアーキテクチャCSR編にデータベースアクセスの排他制御に関して追記する #87 で対応
    • システム共通
      • ロギング → 概要編に書く
        → アプリケーションアーキテクチャ概要編にログ出力方針について追記する #88 で対応
      • メッセージ管理 → 概要編に書く
        → アプリケーションアーキテクチャ概要編にメッセージ管理方針を追記する #89 で対応
      • プロパティ管理 ※T.B.D → 概要編に書く
        → アプリケーションアーキテクチャ概要編にメッセージ管理方針を追記する #89 で対応
      • セキュリティ（Spring Security） ※T.B.D → 概要編に書く
        → アプリケーションアーキテクチャ概要編にセキュリティ方針を追記する #90 で対応
      • 認証・認可 ※T.B.D（Web API独特の何かがあればここに書く、全体的な設計とか仕組みの話は概要編）
        → アプリケーションアーキテクチャ概要編にセキュリティ方針を追記する #90 で対応（形態別の認証認可に関する話は別途検討）

  • クライアントサイド ※T.B.D
    → Maia OSS版のアプリケーションアーキテクチャCSR編（クライアントサイド）を作成する #76 で対応

• テスト方式

  • Milestone 0.1では、「※T.B.D」が付いていない部分の内容を記載する。
  • どこを対象にどうやってテストするか
  • テストレベルをどう定義するか ※T.B.D
  • ある程度一般的な内容で
  • 基本方針として、機能面のテストは可能な限りJUnitに寄せる。
  • Spring TestのMockMVCを活用してE2EテストもJUnit上で行う。
  • Seleniumなどを使った打鍵テストは負荷テストなどの非機能要件に絞る。 ※T.B.D
  • 非機能テストのノウハウを可能な限り盛り込む。 ※T.B.D
  • Vue.js側のテストも盛り込む。ベストプラクティスがありそうだし。Jestとか使うのだろう。 ※T.B.D
    → アプリケーションアーキテクチャ概要編にテスト方式について追記する #91 で対応
    → アプリケーションアーキテクチャCSR編にテスト方式について追記する #92 で対応

[syamada36]

参考サイト

• TERASOLUNA ドキュメントhttps://terasolunaorg.github.io/guideline/5.7.0.RELEASE/ja/index.html
  全体構成やアーキテクチャ概要など大枠の説明
• プライマリー汎化 アーキテクチャ方式設計書https://nihon-unisys.ent.box.com/file/869764618605
  個別機能の説明など