https://Hitamuki.github.io/image-upload/requirements/Recent content in 要件定義 on 設計書Hugojahttps://Hitamuki.github.io/image-upload/requirements/req001-upload/Mon, 01 Jan 0001 00:00:00 +0000https://Hitamuki.github.io/image-upload/requirements/req001-upload/<h1 id="画像アップロード機能">画像アップロード機能<a class="anchor" href="#%e7%94%bb%e5%83%8f%e3%82%a2%e3%83%83%e3%83%97%e3%83%ad%e3%83%bc%e3%83%89%e6%a9%9f%e8%83%bd">#</a></h1> <h2 id="id">ID<a class="anchor" href="#id">#</a></h2> <p>req001-upload</p> <h2 id="概要">概要<a class="anchor" href="#%e6%a6%82%e8%a6%81">#</a></h2> <p>ユーザーがアプリケーションを介して画像ファイルをアップロードし、永続化・閲覧できる機能を提供する。</p> <h2 id="ビジネス要件">ビジネス要件<a class="anchor" href="#%e3%83%93%e3%82%b8%e3%83%8d%e3%82%b9%e8%a6%81%e4%bb%b6">#</a></h2> <ul> <li>ユーザーは画像を送信し、表示できる必要がある。</li> <li>不適切なファイルのアップロードを防止し、システムの安定性を担保する。</li> </ul> <h3 id="as-is">As-Is<a class="anchor" href="#as-is">#</a></h3> <p>なし</p> <h3 id="to-be">To-Be<a class="anchor" href="#to-be">#</a></h3> <ul> <li>ユーザーがローカル端末から画像を選択し、クラウドストレージへアップロード・閲覧できる。</li> <li>不正ファイルの混入を防ぎ、安全かつ安定したファイル管理基盤を持つ。</li> </ul> <h3 id="スコープ">スコープ<a class="anchor" href="#%e3%82%b9%e3%82%b3%e3%83%bc%e3%83%97">#</a></h3> <ul> <li>画像の選択・プレビュー・アップロード・閲覧</li> <li>クライアント／サーバー双方でのバリデーション</li> <li>S3 Presigned URL を用いた直接アップロード方式</li> </ul> <h3 id="ステークホルダー--ペルソナ">ステークホルダー / ペルソナ<a class="anchor" href="#%e3%82%b9%e3%83%86%e3%83%bc%e3%82%af%e3%83%9b%e3%83%ab%e3%83%80%e3%83%bc--%e3%83%9a%e3%83%ab%e3%82%bd%e3%83%8a">#</a></h3> <ul> <li><strong>発注者</strong>: システム開発の依頼者であり、最初の利用者</li> <li><strong>エンドユーザー</strong>: MVP段階では発注者のみを想定。将来的に一般ユーザーへの展開を想定</li> </ul> <h2 id="機能要件">機能要件<a class="anchor" href="#%e6%a9%9f%e8%83%bd%e8%a6%81%e4%bb%b6">#</a></h2> <h3 id="画像の選択とプレビュー">画像の選択とプレビュー<a class="anchor" href="#%e7%94%bb%e5%83%8f%e3%81%ae%e9%81%b8%e6%8a%9e%e3%81%a8%e3%83%97%e3%83%ac%e3%83%93%e3%83%a5%e3%83%bc">#</a></h3> <ul> <li>ユーザーはローカル端末から画像ファイルを選択できる。</li> <li>アップロード前に選択したファイルのプレビューを表示する。</li> </ul> <h3 id="画像のアップロード">画像のアップロード<a class="anchor" href="#%e7%94%bb%e5%83%8f%e3%81%ae%e3%82%a2%e3%83%83%e3%83%97%e3%83%ad%e3%83%bc%e3%83%89">#</a></h3> <ul> <li>選択された画像をサーバー（S3）にアップロードする。</li> <li>アップロード成功後、メタデータ（ファイル名、URL、サイズ等）をDBに保存する。</li> </ul> <h3 id="バリデーション">バリデーション<a class="anchor" href="#%e3%83%90%e3%83%aa%e3%83%87%e3%83%bc%e3%82%b7%e3%83%a7%e3%83%b3">#</a></h3> <ul> <li>ファイルサイズ制限: 最大 5MB。</li> <li>対応フォーマット: JPEG, PNG, GIF, WebP。</li> <li>MIMEタイプはバイナリヘッダ（マジックナンバー）で検証する。</li> <li>クライアントサイドとサーバーサイドの両方で検証を行う。</li> </ul> <h3 id="アップロード済み画像の閲覧">アップロード済み画像の閲覧<a class="anchor" href="#%e3%82%a2%e3%83%83%e3%83%97%e3%83%ad%e3%83%bc%e3%83%89%e6%b8%88%e3%81%bf%e7%94%bb%e5%83%8f%e3%81%ae%e9%96%b2%e8%a6%a7">#</a></h3> <ul> <li>アップロード済みの画像はファイル名のリストとして表示される。</li> <li>リストからファイル名を選択することで、その画像のプレビューを表示する。</li> <li>通信量削減のため、初期表示時にすべての画像の実体を取得しない。</li> </ul> <h2 id="非機能要件">非機能要件<a class="anchor" href="#%e9%9d%9e%e6%a9%9f%e8%83%bd%e8%a6%81%e4%bb%b6">#</a></h2> <h3 id="可用性スケーラビリティ">可用性・スケーラビリティ<a class="anchor" href="#%e5%8f%af%e7%94%a8%e6%80%a7%e3%82%b9%e3%82%b1%e3%83%bc%e3%83%a9%e3%83%93%e3%83%aa%e3%83%86%e3%82%a3">#</a></h3> <ul> <li>大容量ファイルの転送によるバックエンドサーバーの負荷を避けるため、<strong>S3 Presigned URL（署名付きURL）</strong> を使用した直接アップロード方式を採用する。</li> </ul> <h3 id="セキュリティ">セキュリティ<a class="anchor" href="#%e3%82%bb%e3%82%ad%e3%83%a5%e3%83%aa%e3%83%86%e3%82%a3">#</a></h3> <ul> <li><strong>マジックナンバーによる検証</strong>: 拡張子だけでなく、バイナリヘッダによるMIMEタイプ検証を行う。</li> <li><strong>署名付きURLの有効期限</strong>: <ul> <li>アップロード用: 5分以内に制限する</li> <li>閲覧用: 1時間以内に制限する</li> </ul> </li> <li><strong>公開設定</strong>: アップロードされたファイルは適切なACL（またはPublic Access Block）を設定し、不要な公開を避ける。</li> </ul> <h3 id="トレーサビリティ">トレーサビリティ<a class="anchor" href="#%e3%83%88%e3%83%ac%e3%83%bc%e3%82%b5%e3%83%93%e3%83%aa%e3%83%86%e3%82%a3">#</a></h3> <ul> <li>アップロード処理全体に <code>trace_id</code> を付与し、フロントエンドからS3、バックエンド、DBまでのログを紐づけ可能とする。</li> </ul> <h2 id="前提条件制約">前提条件・制約<a class="anchor" href="#%e5%89%8d%e6%8f%90%e6%9d%a1%e4%bb%b6%e5%88%b6%e7%b4%84">#</a></h2> <ul> <li>アップロード可能な画像数は最大 5枚 とする。</li> <li>1度の処理でアップロードできる画像数は 1枚 とする。</li> <li>ファイルストレージとして AWS S3 または互換ストレージを使用する。</li> </ul> <h2 id="mvp開発方針">MVP開発方針<a class="anchor" href="#mvp%e9%96%8b%e7%99%ba%e6%96%b9%e9%87%9d">#</a></h2> <h3 id="スコープ外">スコープ外<a class="anchor" href="#%e3%82%b9%e3%82%b3%e3%83%bc%e3%83%97%e5%a4%96">#</a></h3> <ul> <li><strong>ユーザー管理機能</strong>: ユーザー登録、認証、認可は実装しない</li> <li><strong>アクセス制御</strong>: 画像の所有者制限や権限管理は実装しない</li> <li><strong>プライバシー設定</strong>: 画像の公開・非公開設定は実装しない</li> </ul> <h3 id="理由">理由<a class="anchor" href="#%e7%90%86%e7%94%b1">#</a></h3> <p>MVP（Minimum Viable Product）として、まずは画像アップロード・表示の基本機能に集中し、ユーザー管理のような機能は後のバージョンで実装する。これにより早期に価値を提供しつつ、開発期間を短縮する。</p>