# 機能設計書 42-バーコードスキャン

## 概要

本ドキュメントは、InvenTreeシステムにおけるバーコードスキャン機能の設計仕様を定義する。この機能は、スキャンされたバーコードデータを解析し、対応するオブジェクト（部品、在庫アイテム、ロケーション等）を検索・識別する。

### 本機能の処理概要

**業務上の目的・背景**：
倉庫・製造現場では、部品や在庫の識別を迅速に行う必要がある。バーコードスキャン機能により、手作業での検索やID入力を省略し、スキャン一回でオブジェクトを特定できる。これにより、入出庫処理、在庫カウント、ピッキング作業などの業務効率が大幅に向上する。また、発注受領処理やサプライヤーバーコードの自動認識にも対応し、サプライチェーン全体でのトレーサビリティを確保する。

**機能の利用シーン**：
- モバイルアプリでQRコードをスキャンして在庫アイテムを即座に特定
- 発注品の受領時にサプライヤーバーコードをスキャンして入庫処理
- ロケーションのバーコードをスキャンして在庫を移動
- 販売注文に対して在庫をスキャンで割り当て

**主要な処理内容**：
1. バーコードデータの受信と解析
2. InvenTree内部バーコードフォーマットのマッチング
3. サードパーティバーコード（ハッシュベース）のマッチング
4. プラグインシステムを介した拡張バーコードフォーマットのサポート
5. スキャン結果の履歴記録（オプション）

**関連システム・外部連携**：
- プラグインシステム（BarcodeMixin, SupplierBarcodeMixin）
- 発注受領処理との連携
- 販売注文への在庫割当
- モバイルアプリとのAPI連携

**権限による制御**：
- バーコードスキャンAPIは認証済みユーザーでアクセス可能
- 発注受領スキャンはpurchase_order.add権限が必要
- 販売注文割当スキャンはsales_order.add権限が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 12 | バーコードスキャン画面 | 主機能 | バーコード入力・スキャン、アイテム検索・識別処理 |
| 15 | 在庫ロケーション一覧・詳細画面 | 補助機能 | 在庫アイテムのスキャン受入処理 |

## 機能種別

データ検索 / データ連携 / バリデーション

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| barcode | string | Yes | スキャンされたバーコードデータ | 空文字列不可 |
| purchase_order | integer | No | 発注受領時の発注書ID | 正の整数 |
| location | integer | No | 受入先ロケーションID | 正の整数 |
| sales_order | integer | No | 販売注文割当時の受注ID | 正の整数 |
| line_item | integer | No | 明細行ID | 正の整数 |
| shipment | integer | No | 出荷ID | 正の整数 |
| quantity | decimal | No | 数量 | 正の数値 |

### 入力データソース

- APIリクエスト（POST /api/barcode/）
- APIリクエスト（POST /api/barcode/po-receive/）
- APIリクエスト（POST /api/barcode/so-allocate/）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| plugin | string | マッチしたプラグイン名 |
| barcode_data | string | 元のバーコードデータ |
| barcode_hash | string | バーコードのハッシュ値 |
| part | object | マッチした部品情報（該当時） |
| stockitem | object | マッチした在庫アイテム情報（該当時） |
| stocklocation | object | マッチしたロケーション情報（該当時） |
| supplierpart | object | マッチしたサプライヤー部品情報（該当時） |
| success | string | 成功メッセージ |
| error | string | エラーメッセージ（該当時） |

### 出力先

- APIレスポンス（JSON形式）
- BarcodeScanResult テーブル（履歴記録時）

## 処理フロー

### 処理シーケンス

```
1. バーコードスキャンリクエストの受信
   └─ BarcodeScan APIエンドポイント
2. バーコードデータの正規化
   └─ 前後の空白除去
3. 登録済みプラグインでの順次マッチング
   └─ BarcodeMixinを持つプラグインを順に試行
4. マッチ結果の判定
   └─ 最初に成功したプラグインの結果を採用
5. スキャン履歴の記録（設定有効時）
   └─ BarcodeScanResultに保存
6. レスポンスの返却
   └─ マッチ情報またはエラーを返却
```

### フローチャート

```mermaid
flowchart TD
    A[バーコードスキャンリクエスト] --> B[バーコードデータ正規化]
    B --> C{プラグインループ}
    C --> D[プラグイン.scan実行]
    D --> E{マッチ成功?}
    E -->|No| F{次のプラグイン?}
    F -->|Yes| C
    F -->|No| G[エラー: マッチなし]
    E -->|Yes| H[マッチ結果取得]
    H --> I{履歴記録有効?}
    G --> I
    I -->|Yes| J[BarcodeScanResult保存]
    I -->|No| K[レスポンス返却]
    J --> K
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-42-01 | プラグイン優先順位 | 登録順にプラグインを試行し、最初に成功した結果を採用 | 全てのスキャンリクエスト |
| BR-42-02 | ハッシュマッチング | 外部バーコードはMD5ハッシュでマッチング | サードパーティバーコード |
| BR-42-03 | 履歴保存上限 | BARCODE_RESULTS_MAX_NUM設定値を超えた古い履歴は自動削除 | 履歴記録有効時 |
| BR-42-04 | 発注受領権限 | PO受領スキャンにはpurchase_order.add権限が必要 | /api/barcode/po-receive/ |
| BR-42-05 | 販売割当権限 | SO割当スキャンにはsales_order.add権限が必要 | /api/barcode/so-allocate/ |

### 計算ロジック

バーコードハッシュの計算：
```python
barcode_hash = hashlib.md5(barcode_data.encode()).hexdigest()
```

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| バーコードマッチング | part_part, stock_stockitem等 | SELECT | barcode_hashでの検索 |
| スキャン履歴記録 | common_barcodescanresult | INSERT | スキャン結果の保存 |
| 古い履歴削除 | common_barcodescanresult | DELETE | 上限超過分の削除 |

### テーブル別操作詳細

#### common_barcodescanresult

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | data | スキャンされたバーコードデータ | 最大250文字 |
| INSERT | user | スキャン実行ユーザー | ForeignKey |
| INSERT | timestamp | 現在日時 | auto_now_add |
| INSERT | endpoint | APIエンドポイントパス | |
| INSERT | context | リクエストコンテキスト | JSON |
| INSERT | response | レスポンスデータ | JSON |
| INSERT | result | 成功/失敗 | Boolean |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 400 | ValidationError | バーコードが空または無効 | 有効なバーコードを入力 |
| 400 | ValidationError | マッチするオブジェクトなし | バーコードを確認または手動検索 |
| 403 | PermissionDenied | 必要な権限がない | 管理者に権限付与を依頼 |
| 400 | ValidationError | 既に受領済みの在庫アイテム | 別のバーコードをスキャン |

### リトライ仕様

スキャン操作は冪等であり、再試行が可能。

## トランザクション仕様

- 基本スキャン：トランザクション管理不要（読み取り専用）
- 発注受領・販売割当：在庫操作時にトランザクション内で実行

## パフォーマンス要件

- スキャンレスポンス時間：200ms以内
- プラグインタイムアウト：各プラグイン3秒

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

- 認証済みユーザーのみアクセス可能
- スキャン履歴にはユーザーIDが記録される
- バーコードデータは250文字に制限

## 備考

- BARCODE_STORE_RESULTS設定で履歴記録の有効/無効を切替
- サプライヤー固有バーコードはSupplierBarcodeMixinで処理

---

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

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

### 推奨読解順序

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

バーコードスキャン結果のデータモデルを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | models.py | `src/backend/InvenTree/common/models.py` | BarcodeScanResultクラス（2796-2858行目） |

**読解のコツ**:
- `data`フィールドがスキャンされた生のバーコードデータ
- `response`フィールドがJSON形式でマッチ結果を保存
- `BARCODE_SCAN_MAX_LEN = 250`がバーコードの最大長

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

バーコードスキャンAPIの基底クラスとメインエンドポイントを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | api.py | `src/backend/InvenTree/plugin/base/barcodes/api.py` | BarcodeViewクラス（34-186行目）、BarcodeScanクラス（189-222行目） |

**主要処理フロー**:
1. **40-105行目**: log_scan()でスキャン履歴を記録
2. **113-127行目**: create()でリクエスト処理
3. **143-186行目**: scan_barcode()でプラグインマッチング
4. **199-221行目**: BarcodeScan.handle_barcode()でレスポンス生成

#### Step 3: 発注受領・販売割当の拡張処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | api.py | `src/backend/InvenTree/plugin/base/barcodes/api.py` | BarcodePOReceive（476-584行目）、BarcodeSOAllocate（587-754行目） |

**主要処理フロー**:
- **496-584行目**: 発注品受領のバーコードスキャン処理
- **657-754行目**: 販売注文への在庫割当処理

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

```
BarcodeScan.create()
    │
    ├─ BarcodeSerializer.is_valid()
    │
    ├─ BarcodeView.handle_barcode()
    │      │
    │      └─ scan_barcode()
    │             │
    │             ├─ registry.with_mixin(BARCODE)
    │             │      └─ 全バーコードプラグイン取得
    │             │
    │             └─ plugin.scan(barcode)
    │                    └─ 各プラグインでマッチング試行
    │
    └─ log_scan()
           │
           ├─ get_global_setting('BARCODE_STORE_RESULTS')
           │
           └─ BarcodeScanResult.objects.create()
```

### データフロー図

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

POST Request    ───▶ BarcodeScan           ───▶ JSON Response
  barcode:            APIエンドポイント          plugin: "..."
  "QR12345"                                     stockitem: {...}
                        │                        success: "..."
                        ▼
                 scan_barcode()
                        │
                        ▼
                 プラグイン.scan()
                        │                    [副作用]
                        ▼
                 マッチング結果        ───▶ BarcodeScanResult
                                              テーブルに保存
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| api.py | `src/backend/InvenTree/plugin/base/barcodes/api.py` | ソース | バーコードスキャンAPIエンドポイント |
| models.py | `src/backend/InvenTree/common/models.py` | ソース | BarcodeScanResultモデル |
| serializers.py | `src/backend/InvenTree/plugin/base/barcodes/serializers.py` | ソース | リクエスト/レスポンスシリアライザ |
| helper.py | `src/backend/InvenTree/plugin/base/barcodes/helper.py` | ソース | サポートモデル取得ヘルパー |
| InvenTree/helpers.py | `src/backend/InvenTree/InvenTree/helpers.py` | ソース | hash_barcode関数 |
