Componente di generazione automatica dei codici di errore

Descrizione

In grado di generare automaticamente i codici di errore in base alle regole date.

Convenzione del parametro code nei dati restituiti, tutti i code personalizzati, i numeri positivi indicano un servizio normale, i numeri negativi indicano un'anomalia del servizio.

Indirizzo del progetto

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

Installazione

composer require teamones/response-code-msg

Utilizzo

File di classe ErrorCode vuoto

• Percorso del file: ./support/ErrorCode.php

<?php
/**
 * File generato, non modificare manualmente.
 * @Author:$Id$
 */
namespace support;

class ErrorCode
{
}

File di configurazione

I codici di errore verranno generati automaticamente in base ai parametri di configurazione come mostrato di seguito. Ad esempio, se il system_number è 201 e start_min_number è 10000, il primo codice di errore generato sarà -20110001.

• Percorso del file: ./config/error_code.php

<?php

return [
    "class" => new \support\ErrorCode(), // File della classe ErrorCode
    "root_path" => app_path(), // Directory radice del codice corrente
    "system_number" => 201, // Identificativo di sistema
    "start_min_number" => 10000 // Intervallo di generazione dei codici di errore, ad esempio 10000-99999
];

Aggiunta del codice di avvio automatico della generazione dei codici di errore in start.php

• Percorso del file: ./start.php

// Collocare dopo Config::load(config_path(), ['route', 'container']);

// Genera i codici di errore, solo in modalità APP_DEBUG
if (config("app.debug")) {
    $errorCodeConfig = config('error_code');
    (new \teamones\responseCodeMsg\Generate($errorCodeConfig))->run();
}

Utilizzo nel codice

Nel codice ErrorCode::ModelAddOptionsError è il codice di errore, in cui ModelAddOptionsError deve essere scritto dall'utente in base alle proprie esigenze semantiche con l'iniziale maiuscola.

Dopo averlo scritto, scoprirai di non poterlo utilizzare, verrà generato al riavvio successivo. A volte è necessario riavviare due volte.

<?php
/**
 * Classe di servizio per operazioni correlate alla navigazione
 */

namespace app\service;

use app\model\Demo as DemoModel;

// Inclusione del file della classe ErrorCode
use support\ErrorCode;

class Demo
{
    /**
     * Aggiunta
     * @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) {
            // Stampa messaggi di errore
            throw_http_exception($e->getMessage(), ErrorCode::ModelAddOptionsError);
        }
        return [];
    }
}

File ./support/ErrorCode.php generato

<?php
/**
 * File generato, non modificare manualmente.
 * @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;
}