Generazione Automatica dei Codici di Errore

Descrizione

Consente di mantenere automaticamente la generazione dei codici di errore in base a regole fornite.

È convenuto che nel dato di ritorno il parametro code, tutti i codici personalizzati, i numeri positivi rappresentano il normale funzionamento del servizio, mentre i numeri negativi rappresentano un malfunzionamento del servizio.

Indirizzo del Progetto

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

Installazione

composer require teamones/response-code-msg

Utilizzo

File vuoto della classe ErrorCode

• Percorso del file ./support/ErrorCode.php

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

class ErrorCode
{
}

File di Configurazione

I codici di errore verranno generati automaticamente in base ai parametri configurati di seguito, ad esempio, se il current system_number = 201, 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 principale del codice corrente
    "system_number" => 201, // Identificatore di sistema
    "start_min_number" => 10000 // Intervallo di generazione del codice di errore, ad esempio 10000-99999
];

Aggiungere il codice per la generazione automatica dei codici di errore in start.php

• Percorso del file ./start.php

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

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

Utilizzo nel Codice

Nel codice sottostante, ErrorCode::ModelAddOptionsError è il codice di errore, dove ModelAddOptionsError deve essere scritto dall'utente in base alle esigenze attuali con la prima lettera maiuscola.

Una volta scritto, si scopre che non è utilizzabile, ma verrà automaticamente generato il codice di errore corrispondente al successivo riavvio. Nota che a volte è necessario riavviare due volte.

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

namespace app\service;

use app\model\Demo as DemoModel;

// Importa il file della classe ErrorCode
use support\ErrorCode;

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

File ./support/ErrorCode.php dopo la generazione

<?php
/**
 * File generato automaticamente, 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;
}