# 帳票設計書 4-字典类型

## 概要

本ドキュメントは、RuoYiシステムにおける辞書タイプ情報のExcelエクスポート機能に関する帳票設計書である。システム管理者が辞書タイプ管理画面から辞書タイプ情報をExcel形式で一括出力するための仕様を定義する。

### 本帳票の処理概要

本帳票は、システムに登録されている辞書タイプ（マスタ分類）情報をExcel形式でエクスポートする機能を提供する。

**業務上の目的・背景**：システム管理者が辞書タイプ情報を一覧で確認・管理するため、またはシステム設計書作成やマスタデータの棚卸しのために辞書タイプ情報を出力する必要がある。Excelファイルとして出力することで、マスタ体系の分析や文書化が容易になり、システム保守の効率化に寄与する。

**帳票の利用シーン**：辞書タイプ管理画面において、検索条件を指定して辞書タイプ一覧を絞り込んだ後、「エクスポート」ボタンをクリックすることで、条件に合致する辞書タイプ情報をExcelファイルとしてダウンロードする。マスタデータの棚卸し、システム設計書作成、データ移行時の辞書タイプ一覧作成などで利用される。

**主要な出力内容**：
1. 辞書タイプ基本情報（辞書ID、辞書名、辞書タイプ）
2. 辞書タイプ状態情報（状態）

**帳票の出力タイミング**：辞書タイプ管理画面（/system/dict）の一覧画面から「エクスポート」ボタンをクリックした時点で、現在の検索条件に基づいてデータを取得し、Excelファイルを生成してダウンロードする。

**帳票の利用者**：システム管理者、開発者

## 帳票種別

一覧表

## 利用画面

| 画面No | 画面名 | URL/ルーティング | 出力操作 |
|--------|--------|-----------------|---------|
| SYS-004 | 辞書タイプ管理 | /system/dict | 「エクスポート」ボタン |

## 出力形式

### 基本仕様

| 項目 | 内容 |
|-----|------|
| ファイル形式 | Excel (.xlsx) |
| 用紙サイズ | A4横相当（印刷時） |
| 向き | 横 |
| ファイル名 | 字典类型_{yyyyMMddHHmmss}.xlsx |
| 出力方法 | ダウンロード |
| 文字コード | UTF-8 |

### Excel固有設定

| 項目 | 内容 |
|-----|------|
| シート名 | 字典类型 |
| 保護設定 | 無 |

## 帳票レイアウト

### レイアウト概要

Excelファイルは単一シートで構成され、1行目にヘッダー行、2行目以降にデータ行が出力される。

```
┌─────────────────────────────────────┐
│         ヘッダー行（項目名）          │
├─────────────────────────────────────┤
│         データ行1                    │
│         データ行2                    │
│         ...                         │
│         データ行N                    │
└─────────────────────────────────────┘
```

### ヘッダー部

| No | 項目名 | 説明 | データ取得元 | 表示形式 |
|----|-------|------|-------------|---------|
| 1 | 字典主键 | 辞書ID | sys_dict_type.dict_id | 数値 |
| 2 | 字典名称 | 辞書名 | sys_dict_type.dict_name | 文字列 |
| 3 | 字典类型 | 辞書タイプ | sys_dict_type.dict_type | 文字列 |
| 4 | 状态 | 辞書タイプ状態 | sys_dict_type.status | 変換表示 |

### 明細部

| No | 項目名 | 説明 | データ取得元 | 表示形式 | 列幅 |
|----|-------|------|-------------|---------|-----|
| 1 | 字典主键 | 辞書ID | sys_dict_type.dict_id | 数値 | 15 |
| 2 | 字典名称 | 辞書名 | sys_dict_type.dict_name | 文字列 | 25 |
| 3 | 字典类型 | 辞書タイプ | sys_dict_type.dict_type | 文字列 | 25 |
| 4 | 状态 | 辞書タイプ状態 | sys_dict_type.status | 変換表示 | 12 |

### フッター部

本帳票にフッター部はない。

## 出力条件

### 抽出条件

| 条件名 | 説明 | 必須 |
|-------|------|-----|
| 辞書名 | 部分一致検索 | No |
| 辞書タイプ | 部分一致検索 | No |
| 状態 | 完全一致（0/1） | No |
| 作成日From | 範囲検索 | No |
| 作成日To | 範囲検索 | No |

### ソート順

| 優先度 | 項目 | 昇順/降順 |
|-------|------|---------|
| 1 | dict_id | 昇順 |

### 改ページ条件

Excel出力のため、65536行を超える場合は新しいシートを作成

## データベース参照仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 結合条件 |
|-----------|------|---------|
| sys_dict_type | 辞書タイプ基本情報 | メインテーブル |

### テーブル別参照項目詳細

#### sys_dict_type

| 参照項目（カラム名） | 帳票項目との対応 | 取得条件 | 備考 |
|-------------------|----------------|---------|------|
| dict_id | 字典主键 | - | - |
| dict_name | 字典名称 | - | - |
| dict_type | 字典类型 | - | - |
| status | 状态 | - | 0=正常,1=停用に変換 |

## 計算仕様

### 計算項目一覧

本帳票に計算項目はない。

## 処理フロー

### 出力フロー

```mermaid
flowchart TD
    A[エクスポートボタン押下] --> B[権限チェック]
    B --> C{system:dict:export権限あり?}
    C -->|No| D[権限エラー]
    C -->|Yes| E[検索条件取得]
    E --> F[dictTypeService.selectDictTypeList呼出]
    F --> G[データ取得]
    G --> H[ExcelUtil初期化]
    H --> I[@Excelアノテーション解析]
    I --> J[ヘッダー行生成]
    J --> K[データ行生成]
    K --> L[値変換処理]
    L --> M[Excelファイル生成]
    M --> N[ファイルダウンロード]
    N --> O[終了]
```

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 表示メッセージ | 対処方法 |
|----------|---------|--------------|---------|
| 権限エラー | system:dict:export権限がない場合 | 権限がありません | 管理者に権限付与を依頼 |
| データなし | 検索条件に該当するデータがない場合 | 空のExcelファイルが出力される | 検索条件を見直す |
| システムエラー | Excel生成時にエラーが発生した場合 | エクスポートに失敗しました | システム管理者に連絡 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定データ件数 | 50件 |
| 目標出力時間 | 2秒以内 |
| 同時出力数上限 | 制限なし |

## セキュリティ考慮事項

- system:dict:export権限を持つユーザーのみエクスポート可能
- 操作ログに「字典类型」「EXPORT」として記録される

## 備考

- @Excelアノテーションにより出力項目を定義
- readConverterExp属性により状態の変換を実現
- 辞書タイプは辞書データ（sys_dict_data）の親分類を管理

---

## コードリーディングガイド

本帳票を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、エクスポート対象のデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | SysDictType.java | `ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysDictType.java` | @Excelアノテーションの定義、フィールド構成 |

**読解のコツ**: @Excelアノテーションのname属性がヘッダー名、cellTypeでNUMERICを指定している項目は数値として出力

#### Step 2: エントリーポイントを理解する

処理の起点となるControllerを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | SysDictTypeController.java | `ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java` | exportメソッド（55-65行目）、権限チェック、ExcelUtil呼び出し |

**主要処理フロー**:
1. **55-56行**: @Log、@RequiresPermissionsで操作ログと権限制御
2. **62行**: dictTypeService.selectDictTypeList(dictType)でデータ取得
3. **63行**: ExcelUtil<SysDictType>インスタンス生成
4. **64行**: exportExcel(list, "字典类型")でExcel出力

### プログラム呼び出し階層図

```
SysDictTypeController.export()
    │
    ├─ dictTypeService.selectDictTypeList(dictType)
    │      └─ SysDictTypeMapper.selectDictTypeList()
    │             └─ SQL実行（sys_dict_type）
    │
    └─ ExcelUtil.exportExcel(list, sheetName)
           ├─ createExcelField() - @Excelアノテーション解析
           ├─ createWorkbook() - SXSSFWorkbook生成
           └─ fillExcelData() - データ行生成
```

### データフロー図

```
[入力]               [処理]                    [出力]

検索条件 ───▶ SysDictTypeController.export() ───▶ Excelファイル
(SysDictType)│                              (字典类型_{日時}.xlsx)
             ├─▶ ISysDictTypeService
             │      └─▶ SysDictTypeMapper
             │             └─▶ MySQL
             │
             └─▶ ExcelUtil
                    └─▶ Apache POI
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| SysDictTypeController.java | `ruoyi-admin/src/main/java/com/ruoyi/web/controller/system/SysDictTypeController.java` | ソース | エントリーポイント、exportメソッド定義 |
| SysDictType.java | `ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysDictType.java` | ソース | 辞書タイプエンティティ、@Excelアノテーション定義 |
| ISysDictTypeService.java | `ruoyi-system/src/main/java/com/ruoyi/system/service/ISysDictTypeService.java` | ソース | サービスインターフェース |
| SysDictTypeMapper.xml | `ruoyi-system/src/main/resources/mapper/system/SysDictTypeMapper.xml` | 設定 | SQL定義 |
| ExcelUtil.java | `ruoyi-common/src/main/java/com/ruoyi/common/utils/poi/ExcelUtil.java` | ソース | Excel出力ユーティリティ |
