web注文管理システム アーキテクチャ設計書...

18
アーキテクチャ設計書 Kaleido Modeling プロセス Copyright 2009-2011 eSsEn Corporation. 無断複製・転載をお断りします Web注文管理システム 履歴 バージョン 改訂者 改訂日 0.1 山下 2010/11/1 アーキテクチャ設計書 (サンプル) 改訂内容 新規作成

Upload: others

Post on 01-Sep-2019

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Web注文管理システム

履歴バージョン 改訂者 改訂日

0.1 山下 2010/11/1

アーキテクチャ設計書(サンプル)

改訂内容新規作成

Page 2: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

目次1.はじめに

1.1 本文書の目的1.2 参照資料/文献

2.概説2.1 アーキテクチャ要件2.3 対象とする機能要件(ユースケース)2.4 アーキテクチャ設計方針2.4 仮定と依存

3.構造及び構成3.1 物理配置図3.2 実行環境3.3 アプリケーション基本構造3.4 アプリケーション物理構造(a)全体構造(b)詳細3.5システム基盤仕様(省略)(a)全体構造(b)詳細

4.共通メカニズム(a)共通メカニズム全体図(b)共通メカニズム一覧4.1 システムシーケンス

:(全ての共通メカニズム分)

5.設計・実装制約及び環境6.1 設計・実装規約6.2 開発ツール・環境

6.配布6.1 実行モジュール一覧6.2 実行モジュール内の構成(必要時)6.3 配布物一覧

7.その他

付録(省略)付録A ネットワーク仕様付録B データベースシステム仕様付録C クライアント・サーバー機器仕様付録D 分析クラス図付録E 分析シーケンス図付録F 論理構造図

Page 3: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

1.はじめに説明 サンプル

要件定義書(V0.1)

分析モデル(クラス図、シーケンス図、論理構造図)(V0.1)

1.2 参照資料/文献

この文書が参照する文書やモデルを、できればパイパーリンクを含めて一覧にします。可能な限り参照資料・文献のバージョンも記

載します。

この文書の目的、利用対象を説明します。

本書はWeb注文管理システムのアーキテクチャ(全体の構造、共通メカニズム、その他、設計・実装上の制約等)を説明しています。本アーキテクチャ部分の設計・実装者(アーキテクト)及び、Web注文管理システムの設計・実装担当者(アプリケーション開発者)を対象に記述しています。

1.1 本書の目的

Page 4: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

2.概説説明 サンプル

「UC-U001:商品を注文する」:最も主要で典型的なユースケース

「NFR-001」によるインタネット上での利用を前提に、非機能要件「NFR-002」を重視しできるだけシンプルな構造とする。

「NFR-006」を実現する為に、様々なUI技術を活用する可能性から、UI部分の変更を容易に受けつけられるような内部構造とする

外部システム(クレジットカード決済システム)との接続も今後変更される可能性も踏まえた構造・共通メカニズムを採用する

特定の限られたユースケースのみの分析結果に基いて作成

2.1 アーキテクチャ要件

本システムのアーキテクチャに関係する要件を抽出または参照させます。

要件定義書(V0.1)の以下の項目 -5非機能要件 -2.1稼働環境、2.4設計と実装の制約、2.5仮定と依存性 -4外部インタフェース要求

2.4 仮定と依存性

本文書を作成する上で仮定としていることや依存事項があれば記述します。

2.2 対象とする機能要件

本書を作成に際して対象とするユースケースとその理由を示します。

2.3 アーキテクチャ設計方針

アーキテクチャ設計の全体的な方針を記述します。(どのようなアーキテクチャ要件を優先するか等)

Page 5: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

3.構造及び構成

3.1 物理配置図3.2 実行環境3.3 アプリケーション基本構造3.4 アプリケーション物理構造

Page 6: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

3.1 物理配置図説明 物理配置図の内容を記述して下さい。

<<device>>:クライアント

<<b >>

<<device>>:サーバー

ファイアーウォールは省略

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

:クライアント

<<browser>>:Webブラウザ

::Webブラウザ- ブラウザ = IE6.0以上

<<Web Server>>:Apache2.2

<<web container>>:Tomcat 6

::Tomcat 6- JVM = JRE1.6

b d

<<external system>>:クレジットカード認証システム

ファイアーウォールは省略

HTTP

SSL:Tomcat 6

::Tomcat 6- JVM = JRE1.6

:webordermanager.war

<<database>>:MySQL

<<external system>>:電子メールシステム

JDBC

SSL

SMTP

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Page 7: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

3.2 実行環境物理配置図の配置要素について説明して下さい。

項目 プロダクト名 説明・制約等

サーバーマシン(TBD)下記プロダクトを実行可能で、ユーザからのアクセスに対して十分な処理能力を有するもの

Apache Webサーバー、バージョンは2.2

Tomcat Webコンテナ(JSPサーバー)、バージョンは6

JVM Java実行環境、バージョンは1.6

MySQL データベースサーバー、バージョンはTBD

webordermanager.war 本システムの実行ファイル

クライアントマシン Webブラウザを実行できるもの

Webブラウザ 本システムのクライアント実行環境。IE6.0以上をサポート

クライアント

説明

サーバー

Page 8: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

3.3 アプリケーション基本構造説明 レイヤー等の基本構造に関するの図を張り付けて下さい。各レイヤーの説明(責務)も記述して下さい。

<<partition>> common

<<Layer>> business

<<Layer>> presentation

利用者とのやりとりを行

うUIとUIの制御等を行う

レイヤー間で共通に利用

される型やユーティリティ

業務ロジックやサービス

を実現する

webordermanager内の構造

データベースとのやりとり

を行い、、またアプリケー

ション内で利用される

データを扱う

<<Layer>> persistence

Page 9: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

3.4 アプリケーション物理構造(a)全体構造

説明 アプリケーション物理構造図の内容を記述して下さい。

webordermanager

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

webordermanager

presentation

servlet

common

commonbusiness

commonbusiness

persistence

model

dao

model

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Page 10: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

3.4 アプリケーション物理構造(詳細)(b)詳細

presentationパッケージ

説明 各パッケージの説明(責務)を記述して下さい。

「バウンダリ.画面パッケージ」に該当

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

論理構造図:バウンダリPKG

servlet

notesServletファイルを配置

画面

+ メイン画面+ エラー通知画面+ 会員登録画面+ 商品検索結果画面+ 商品注文画面

「バウンダリ.画面パッケージ」に該当

<<trace>>

common

t

notesServletファイルを配置

共通

画面

+ 会員登録画面+ 商品検索結果画面+ 商品注文画面+ 注文確認画面+ 注文結果確認画面

<<trace>>

notespresentation内で共通に利用されるクラス、インタフェース等

共通

+ 画面

「バウンダリ.共通パッケージ」に該当

<<trace>>

businessパッケージ

「バウンダリ.共通パッケージ」に該当

論理構造図:コントロールPKG上位の<<control>>がbusinesに該当。

この例では、「商品注文管理」「クレ

ジットカード決済管理」「会員登録管

論理構造図:コントロールPKG

注文

+ クレジットカード決済管理

+ 商品注文管理

+ 注文管理business

上位の<<control>>がbusinesに該当。

この例では、「商品注文管理」「クレ

ジットカード決済管理」「会員登録管

理」。

<<trace>>

会員

+ 会員登録管理

+ 会員管理

商品

+ 商品管理

<<trace>>

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Page 11: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

3.4 アプリケーション物理構造(詳細)(b)詳細(続き)persistenceパッケージ

論理構造図:コントロールPKG

注文

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

dao

notesデータベースアクセスを隠蔽するDAO(Database Access

を格納

注文

+ クレジットカード決済管理

+ 商品注文管理

+ 注文管理

会員商品

下位の<<control>>がdaoに該当。

この例では、「注文管理」「商品

管理」「会員管理」。

<<trace>>

論理構造図:エンティティPKG

notesデータベースアクセスを隠蔽するDAO(Database AccessObject)を格納

会員

+ 会員登録管理

+ 会員管理

商品

+ 商品管理

商品

<<trace>>

論理構造図:エンティティPKG

model

notesビジネスドメインに存在するエンティティデータ。全レイヤー(パッケージ)で利用さ

商品

+ 商品

+ 在庫

注文

+ 配送

+ 注文

+ 注文明細

<<trace>>

ビジネスドメインに存在するエンティティデータ。全レイヤー(パッケージ)で利用されるPOJOクラスを格納。

会員

+ 会員

エンティティパッケー

ジがmodelに該当

<<trace>>

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Page 12: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

4.共通メカニズム(a)共通メカニズム全体図

説明

(b)共通メカニズム一覧

各共通メカニズムについの説明を記述して下さい。

番号 共通メカニズム名 説明

1 システムシーケンス システム全体の処理の流れ

2 UI制御方式 UIの表示や遷移の制御方法

3 ユーザ認証方式 ユーザの認証方法

4 レイヤ間データ転送方式 presentationとbusiness間のデータ転送方法

5 外部システム接続方式 外部システムのとの接続方法

6 永続処理方式 ORマッピング方法

7 データベースコネクション管理方式 コネクションの再利用方法

8 データセキュリティ方式 永続データの暗号化等

9 ログ出力管理方式 ログの出力・管理方法

10 例外処理方式 例外の処理方法

アプリケーション物理構造図に対して、共通メカニズムの位置付けを示して下さい。

説明

webordermanager

presentation

common

common

servlet

business

persistence

model

dao

UI制御方式

レイヤ間データ転送方式

外部システム接続方式

データベースコネクション

管理方式

ユーザー認証方式

永続処理方式

データセキュリティ方式

ログ出力管理方式

システムシーケンス

(全体の処理の流れ)

例外処理方式

Page 13: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

4.1 システムシーケンス(a)シーケンス図

説明 シーケンス図、クラス図等を用いて、共通メカニズムの内容を説明してください。

本シートは全ての共通メカニズムに対して作成し

xxxServlet RequestxxxServlet Request

xxxService

業務処理を実行

UIからのリクエ

スト発生

参照系のシステムシーケンス

1.0

1.1

xxxDAO

業務処理を実行

ビジネス層のServiceクラ

スに処理を依頼

データベースのデー

タを扱う為、DAOク

データベースとの接

続とSQL発行

1.1

1.2

1.3

1.4

anEntity

xxxxUIDO

データベースのデー

タを扱う為、DAOク

ラスを生成

デ タベ スとの接

続とSQL発行

データ(モデル)オ

ブジェクトを生成

1.4

1.5

1.6

1.7

1.8

1 9xxxxUIDO

データ(モデル)オ

ブジェクトを生成JSPへ渡す為に

Requestオブジェク

トにUIDOを生成して

格納

次画面(JSP)に

フォワード

取得データの処理と

接続のクローズ

1.8

1.9

1.10

1.11 次画面(JSP)に

フォワード

1.11

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Page 14: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

4.1 システムシーケンス(続き)(b)クラス図

システムシーケンスのクラス概略

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

WebPage(html) <<JSP page>>xxx.jsp

presentation

シ テ シ ケ クラ 概略

HttpServletxxxServlet

UIDOxxxxUIDO

<<Layer>> presen

<<instantiate>>

xxxService

<Layer>> business

DAOxxxDAO

<<Layer

istence

xxxDAO

anEntity

<<Layer>> persistenc

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

Page 15: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

5.設計・実装制約及び環境

5.1 設計・実装制約

設計・実装上の制約等を記述して下さい。

No. 項目 内容

1 Web画面標準 社内Web標準

2 Javaコーディング規約 「Javaコーディング規約2004」(電通国際情報サービス)

3クレジットカード決済システム接続仕様

X社決済サーバー仕様

4 電子メールシステム接続仕様 Java Mail API仕様書

5.2 開発ツール・環境

開発で用いるツールや環境を記述して下さい。

No. 項目 内容

1 設計ツール Enterprise Architect(V7.5)

2 統合開発環境 Eclipse 3.0

3 単体テストツール JUnit(Eclipseに統合)

説明

説明

Page 16: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

6.配布

6.1 実行モジュール一覧

No. 項目 形式 内容1 UIファイル *.html, *.jsp ブラウザ用UIファイル2 実行アーカイブ webordermanager.war Servletコンテナ用実行アーカイブファイル

6.2 実行モジュール内の構成(必要時)

No. 項目 形式 内容

6.3 配布物一覧

No. 項目 形式 内容

説明

説明

説明

ソフトウェア成果物としての実行モジュール(*.exe、*.dll、*.jar、*.war)等の一覧を記述して下さい。

実行モジュール(*.jar、*.war)内の主要なディレクトリ(パッケージ)構成を記述して下さい。

インストール対象に配布する実行用ファイルの一覧を記述して下さい。

TBD

TBD

Page 17: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

7.その他説明 その他、記述が必要な設計・実装上のルールや補足事項を記述します。

TBD

Page 18: Web注文管理システム アーキテクチャ設計書 (サンプル)kmd.essens.co.jp/wp-content/uploads/recipe/general-design/architecture_document/rcp... · 造、共通メカニズム、その他、設計・実装上の制約等)を説

アーキテクチャ設計書 Kaleido Modeling プロセス

Copyright 2009-2011 eSsEn Corporation.無断複製・転載をお断りします

付録

付録A ネットワーク仕様

付録B データベースシステム仕様

付録C クライアント・サーバー機器仕様

付録D 分析クラス図

付録E 分析シーケンス図

付録F 論理構造図

説明 以下の成果物の内容を記載します。(必要に応じて追加・削除して下さい)