unshiu

最近の更新履歴

開発仕様‎ > ‎

エラーコード仕様

エラーコードとは

エラー画面へ出力される番号。多くのエンドユーザは問題が発生した際「エラーがおきました」しか状況を把握していない場合が多いため、サービス運営者が状況の確認などがしやすいように振っておくもの。

エラールール

以下の場合にあてはまるもののみエラーコードを振ることとする

  • そのエラー状態からの復帰がユーザのみでは不可能である場合
  • パラメータを直接改変されたりなど、通常の想定遷移ではありえない場合
  • そのエラー番号とエラー理由をサービス運営者が管理画面で知ることで、サービス運営者がなんらかの対応が可能なもの

具体例)

  • アルバムなどアクセス制限がかかっている機能において、URLを直接編集し権限がないユーザが閲覧しようとした際
  • 外部サーバ等と通信しており、そのレスポンスがかえらない場合や、返答結果が想定外のため処理できなかった場合

エラーコードは「どこで発生したか」を明確にするためのものであるため、同じエラー内容であっても、発生箇所が違う場合は違うエラー番号を振ることを基本とする。

ただし以下の場合にあてはまるもののみエラーコードは振らない

  • ロジックに問題がないと発生しないような場合

採番しない理由)

  • ロジックに問題がある場合すべてに問題別にエラーコードを振ると膨大な量になる。
  • そういったバグは納品前にすべてチェックされているべきであり、本番環境上で発生してはいけないものである

具体例)

  • レコードの更新や作成に単純に失敗した場合。
    • (DBが落ちていたという理由で更新できない場合はそもそもエラーコードを取得できない)

コード番号ルール

エラーコードは以下の規則にそって振ることとする。

アルファベット1桁(D) + plugin/案件番号(数字2桁) + 数字3桁

例)

D-01001

アルファベットルール

以下のルールにそって定義する。

処理区分アルファベット補記
管理画面Mmanageから
ユーザ画面Uuserから
スクリプト系Sscriptから

プラグイン/案件番号

50番以降を案件独自の番号とします。

plugin番号
pluginに属さない基盤00
base01
album02
cmm03
dia04
mlg05
msg06
pnt07
prf08
tpc09




一覧

一覧は管理画面で 番号、理由、対処方法を 確認できるようにしておく。