自動生成エラーコードコンポーネント

説明

指定されたルールに基づいてエラーコードの生成を自動的に維持できます。

返すデータの中の code パラメータについて、すべてのカスタム code は、正の数がサービス正常、負の数がサービス異常を表します。

プロジェクトアドレス

https://github.com/teamones-open/response-code-msg

インストール

composer require teamones/response-code-msg

使用法

空の ErrorCode クラスファイル

• ファイルパス ./support/ErrorCode.php

<?php
/**
 * 自動生成されたファイルです。手動で変更しないでください。
 * @Author:$Id$
 */
namespace support;

class ErrorCode
{
}

設定ファイル

エラーコードは以下の設定されたパラメータに従って自動的に生成されます。例えば、現在 system_number = 201、start_min_number = 10000 の場合、生成される最初のエラーコードは -20110001 になります。

• ファイルパス ./config/error_code.php

<?php

return [
    "class" => new \support\ErrorCode(), // ErrorCode クラスファイル
    "root_path" => app_path(), // 現在のコードのルートディレクトリ
    "system_number" => 201, // システム識別子
    "start_min_number" => 10000 // エラーコード生成範囲 例えば 10000-99999
];

start.php に自動生成エラーコードを起動するコードを追加

• ファイルパス ./start.php

// Config::load(config_path(), ['route', 'container']); の後に配置します。

// エラーコードを生成します。APP_DEBUGモードでのみ生成されます。
if (config("app.debug")) {
    $errorCodeConfig = config('error_code');
    (new \teamones\responseCodeMsg\Generate($errorCodeConfig))->run();
}

コード内での使用

以下のコードの ErrorCode::ModelAddOptionsError はエラーコードであり、ModelAddOptionsError はユーザーが現在の必要に応じて意味を持たせて首字母を大文字にする必要があります。

書き終えたら、利用できないことがわかります。次回再起動すると、自動的に対応するエラーコードが生成されます。場合によっては、再起動が2回必要なことがあります。

<?php
/**
 * ナビゲーション関連操作サービスクラス
 */

namespace app\service;

use app\model\Demo as DemoModel;

// ErrorCode クラスファイルをインポート
use support\ErrorCode;

class Demo
{
    /**
     * 追加
     * @param $data
     * @return array|mixed
     * @throws \exception
     */
    public function add($data): array
    {
        try {
            $demo = new DemoModel();
            foreach ($data as $key => $value) {
                $demo->$key = $value;
            }

            $demo->save();

            return $demo->getData();
        } catch (\Throwable $e) {
            // エラー情報を出力
            throw_http_exception($e->getMessage(), ErrorCode::ModelAddOptionsError);
        }
        return [];
    }
}

生成された ./support/ErrorCode.php ファイル

<?php
/**
 * 自動生成されたファイルです。手動で変更しないでください。
 * @Author:$Id$
 */
namespace support;

class ErrorCode
{
    const LoginNameOrPasswordError = -20110001;
    const UserNotExist = -20110002;
    const TokenNotExist = -20110003;
    const InvalidToken = -20110004;
    const ExpireToken = -20110005;
    const WrongToken = -20110006;
    const ClientIpNotEqual = -20110007;
    const TokenRecordNotFound = -20110008;
    const ModelAddUserError = -20110009;
    const NoInfoToModify = -20110010;
    const OnlyAdminPasswordCanBeModified = -20110011;
    const AdminAccountCannotBeDeleted = -20110012;
    const DbNotExist = -20110013;
    const ModelAddOptionsError = -20110014;
    const UnableToDeleteSystemConfig = -20110015;
    const ConfigParamKeyRequired = -20110016;
    const ExpiryCanNotGreaterThan7days = -20110017;
    const GetPresignedPutObjectUrlError = -20110018;
    const ObjectStorageConfigNotExist = -20110019;
    const UpdateNavIndexSortError = -20110020;
    const TagNameAttNotExist = -20110021;
    const ModelUpdateOptionsError = -20110022;
}