非同期時の登録処理、更新処理のresponseについて

Question

非同期で呼ぶ用処理のresponse項目についての相談になります。
サーバーサイドの登録処理と更新処理を行った結果で画面表示を切替える機能を作成しているのですが、この時に
更新処理が成功していた場合update_flagという項目のみで値0または1を、
エラーだった場合はunfinished_flagという項目のみで値1をフロント側に返そうと思っているのですが、通常の場合もエラーの場合もunfinished_flag、update_flag両方とも項目として返却したほうが自然なのでしょうか、
それともupdate_flagの項目値をupdate_flag:9の場合はエラーのようにして1つの値で区別できるようにした方が良いのでしょうか。

言葉だけだと表現し辛いので案の各項目を記載します

現行案
正常
{
    update_flag:(0 or 1)
}
エラー
{
    unfinished_flag:1
}

質問案1
正常
{
    update_flag:(0 or 1),
    unfinished_flag:""
}
エラー
{
    update_flag:"",
    unfinished_flag:”1”
}
質問案2
正常
{
    update_flag:(0 or 1)
}
エラー
{
    update_flag:”9”
}

Answer 1

ぶっちゃけどのパターンも見かけるものです。フロント側がどういう処理になっていて、どういうふうに返したほうが都合が良いか、それだけのことだと思います。最初からjQueryのdoneとfailのように処理を書く場所自体が違うのであれば現行案ですし、「レスポンスが返ってきた」ことだけを判定して処理が流れているのであれば案1、または案2です。成功、失敗時の項目が増やしやすいのは現行案ですし、定数判定だけで成功失敗状況確認が全て済む案2もいいですし…ただ、あんまり案1は好みじゃないです。

※jQueryのDefferedでfailと対になるのはsuccessじゃなくてdoneだったので修正しました

Comments

[enigumalu]

更新時の成功と失敗(エラー)と、ON OFFがあるかなとおもって分けてい見たのですがいかがでしょうか、
今現在更新処理のみ考えていましたが、登録処理も同様な挙動の方がいいでしょうか
更新は更新の是非と更新ステータス（ON 、OFF）がありますが
登録は正常か異常かなのでステータス項目1つでの判定(案2)になるのか、エラーステータス項目を設けた方がいいのか…

[masaya_ohashi]

すみません、質問の意図を読み取り違えていたようです。通常処理とエラー処理のレスポンスを統一すべきかという質問かと思っていましたが、「登録」と「更新」のレスポンスを統一すべきか、という質問だったのですね

[enigumalu]

日本語が下手ですいません。登録時と更新時＋正常終了時とエラー発生時の両方の挙動でのレスポンスですっ

Answer 2

update_flagとunfinished_flagの相関関係次第ではないでしょうか？
update_flagとunfinished_flagが表裏一体であれば
むしろupdate_flagのtrueとfalseでやったほうが効率的ですよね。
仕様上どうしても両方利用したいならしてもそれでもよいですが
存在しないフラグをチェックしないとundefinedとなるなら
クライアント側で事前にチェックするか、サーバー側から両方返すか
好きな方を選べばいいでしょう。

Comments

[enigumalu]

更新時の成功と失敗(エラー)と、ON OFFがあるかなとおもって分けてい見たのですがいかがでしょうか、
今現在更新処理のみ考えていましたが、登録処理も同様な挙動の方がいいでしょうか
更新は更新の是非と更新ステータス（ON 、OFF）がありますが
登録は正常か異常かなのでステータス項目1つでの判定(案2)になるのか、エラーステータス項目を設けた方がいいのか…

[yambejp]

回答にも書きましたがupdate_flagとunfinished_flagが排他的な関係で
ないような仕様でしたら、両方設定すればいいでしょう
あとは戻り値をチェックするときに両方のフラグをチェックするなら
両方返してもらってもいいし、フラグが戻ってこないこと自体に
意味付けをするような仕様であれば戻ってこなくても十分
実用に耐えうると思います