Génération automatique de composants de code d'erreur

Description

Permet de maintenir automatiquement la génération de codes d'erreur en fonction des règles données.

Conventions sur le paramètre code de la réponse, tous les codes personnalisés, les nombres positifs représentent un service normal, les nombres négatifs représentent un service anormal.

Adresse du projet

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

Installation

composer require teamones/response-code-msg

Utilisation

Fichier de classe ErrorCode vide

• Chemin du fichier ./support/ErrorCode.php

<?php
/**
 * Fichier généré automatiquement, ne pas modifier manuellement.
 * @Auteur:$Id$
 */
namespace support;

class ErrorCode
{
}

Fichier de configuration

Les codes d'erreur seront générés automatiquement en fonction des paramètres de configuration ci-dessous, par exemple si le number_system = 201, start_min_number = 10000, le premier code d'erreur généré sera donc -20110001.

• Chemin du fichier ./config/error_code.php

<?php

return [
    "class" => new \support\ErrorCode(), // Fichier de classe ErrorCode
    "root_path" => app_path(), // Répertoire racine du code actuel
    "system_number" => 201, // Identifiant système
    "start_min_number" => 10000 // Plage de génération des codes d'erreur par exemple 10000-99999
];

Ajout du code de génération automatique des codes d'erreur dans start.php

• Chemin du fichier ./start.php

// À placer après Config::load(config_path(), ['route', 'container']); 

// Générer les codes d'erreur, uniquement en mode APP_DEBUG
if (config("app.debug")) {
    $errorCodeConfig = config('error_code');
    (new \teamones\responseCodeMsg\Generate($errorCodeConfig))->run();
}

Utilisation dans le code

Dans le code ci-dessous, ErrorCode::ModelAddOptionsError est le code d'erreur, dont ModelAddOptionsError doit être écrit par l'utilisateur selon le besoin sémantique avec une majuscule au début.

Une fois écrit, vous constaterez qu'il est impossible de l'utiliser, après le prochain redémarrage, le code d'erreur correspondant sera généré automatiquement. Attention, il peut parfois être nécessaire de redémarrer deux fois.

<?php
/**
 * Classe de service pour les opérations liées à la navigation
 */

namespace app\service;

use app\model\Demo as DemoModel;

// Inclusion du fichier de classe ErrorCode
use support\ErrorCode;

class Demo
{
    /**
     * Ajouter
     * @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) {
            // Afficher les informations d'erreur
            throw_http_exception($e->getMessage(), ErrorCode::ModelAddOptionsError);
        }
        return [];
    }
}

Fichier ./support/ErrorCode.php après génération

<?php
/**
 * Fichier généré automatiquement, ne pas modifier manuellement.
 * @Auteur:$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;
}