bulkRequestで複数アプリの一括処理（在庫管理や予約申請など） – cybozu developer network

Index

はじめに
起こりうる問題
- 在庫数増減時の競合
- ロールバックできない
問題への対応
- 在庫数の取得
- 入出庫アプリへの登録と、在庫アプリの更新を同時実行
おわりに

はじめに

kintone で在庫管理システムや予約申請システムを構築する場合は、複数人での同時操作の考慮が必要です。
また、複数アプリを用いたデータ管理が必要な場合はデータの不整合を防ぐ必要があります。
これらの考慮ができないと、在庫数以上の注文を受け付けてしまったり、予約が重複してしまうなどの問題が発生します。

このような問題に対応するために複数アプリのレコード操作を一括処理する「bulkRequest」が用意されています。

本記事では、bulkRequest を利用してデータの整合性をとる方法を紹介します。

起こりうる問題

どういったことが起こるのか、在庫管理を例に紹介します。

「在庫」アプリと「入出庫」アプリがあるとします。
「在庫」アプリには、商品ごとに現在の在庫数が管理されており、「入出庫」アプリには、入庫処理、出庫処理の情報が登録されます。

在庫数増減時の競合

たとえば、A という商品が 10 個あったとします。
A に対して、山田さんが 5 個入庫し、鈴木さんが 8 個出庫すると、A の在庫数は 7 個です。
ところが、次のように山田さんと鈴木さんが同時に操作したケースを考えてみます。

山田さんが在庫数を確認する。 → 10 個
鈴木さんが在庫数を確認する。 → 10 個
山田さんが在庫数を5増やす → 15 個
鈴木さんが在庫数を8減らす → 2 個

山田さんが 5 個増やしているにもかかわらず、最終的な在庫数が 2 個になってしまいます。

ロールバックできない

入出庫では次の 2 つの操作が必要になります。

「入出庫」アプリに登録する
「在庫」アプリの在庫数を更新する

このとき、いずれかのリクエストがエラーになってしまった場合は入出庫アプリと在庫アプリとの整合性がとれなくなります。

問題への対応

これらの問題に対応するために bulkRequest を利用します。

在庫数の取得

下準備として在庫アプリから在庫数を取得します。
このとき、$revision というプロパティも取得できます。

GET /k/v1/record.json?app={在庫アプリのID}&id=1  HTTP/1.1
Host: sample.cybozu.com:443

{
    "record":{
        "record_id": {
            "type": "RECORD_NUMBER",
            "value": "1"
        },
        "$revision":{
            "type":"__REVISION__",
            "value":"17"
        },
        "在庫数":{
            "type":"NUMBER",
            "value":"10"
        }
    }
}

$revision の値はレコードが更新されるたびにインクリメントされます。
レコード更新のリクエストに revision を指定することで、レコードが他のユーザーによって更新されていた場合はリクエストをエラーにできます。

入出庫アプリへの登録と、在庫アプリの更新を同時実行

次に bulkRequest を使って入出庫アプリへの登録と在庫アプリの更新を同時に実行します。
bulkRequest ではいずれかの処理が失敗した場合、すべてのリクエストがロールバックされます。

POST /k/v1/bulkRequest.json HTTP/1.1
Host: sample.cybozu.com:443

{
  "requests": [
    {
      "method": "PUT",
      "api": "/k/v1/record.json",
      "payload": {
        "app": {在庫アプリのID},
        "id": 1,
        "revision": 17,
        "record": {
          "在庫数": {
            "value": "15"
          }
        }
      }
    },
    {
      "method": "POST",
      "api": "/k/v1/record.json",
      "payload": {
        "app": {入出庫アプリのID},
        "record": {
          "入庫数": {
            "value": "5"
          }
        }
      }
    }
  ]
}

このとき、在庫アプリの更新リクエストに revision を指定していることに注目してください。
revision には在庫数を取得したときの $revision と同じ値を設定します。
在庫アプリのレコードが他のユーザーによって更新されていた場合は、在庫アプリの更新がエラーになり、入出庫アプリへの登録もロールバックされます。