Mô-đun sinh mã lỗi tự động

Giới thiệu

Có thể tự động duy trì việc tạo mã lỗi dựa trên các quy tắc cụ thể.

Điều khoản code trả về, tất cả các mã code được tùy chỉnh, số dương biểu thị dịch vụ bình thường, số âm biểu thị lỗi dịch vụ.

Địa chỉ dự án

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

Cài đặt

composer require teamones/response-code-msg

Sử dụng

Tập tin lớp ErrorCode trống

• Đường dẫn tập tin ./support/ErrorCode.php

<?php
/**
 * File được tạo tự động, vui lòng không chỉnh sửa bằng tay.
 * @Author:$Id$
 */
namespace support;

class ErrorCode
{
}

Tập tin cấu hình

Mã lỗi sẽ tự động tăng dựa trên các tham số cấu hình dưới đây. Ví dụ, nếu system_number = 201 và start_min_number = 10000, thì mã lỗi đầu tiên sẽ là -20110001.

• Đường dẫn tập tin ./config/error_code.php

<?php

return [
    "class" => new \support\ErrorCode(), // Tập tin lớp ErrorCode
    "root_path" => app_path(), // Thư mục gốc mã nguồn hiện tại
    "system_number" => 201, // Định danh hệ thống
    "start_min_number" => 10000 // Phạm vi tạo mã lỗi, ví dụ 10000-99999
];

Thêm mã code tự động khởi động vào start.php

• Đường dẫn tập tin ./start.php

// Đặt sau Config::load(config_path(), ['route', 'container']);

// Tạo mã lỗi, chỉ tạo trong chế độ APP_DEBUG
if (config("app.debug")) {
    $errorCodeConfig = config('error_code');
    (new \teamones\responseCodeMsg\Generate($errorCodeConfig))->run();
}

Sử dụng trong mã nguồn

Mã ErrorCode:: ModelAddOptionsError trong đoạn mã dưới đây là mã lỗi. Trong đó, ModelAddOptionsError cần người dùng tự viết theo nhu cầu về ngữ nghĩa chữ cái in hoa.

Sau khi viết xong, bạn sẽ nhận ra rằng bạn không thể sử dụng mã lỗi này, và nó sẽ được tạo tự động sau khi khởi động lại lần tới. Lưu ý rằng đôi khi cần khởi động lại hai lần.

<?php
/**
 * Lớp dịch vụ liên quan đến điều hướng
 */

namespace app\service;

use app\model\Demo as DemoModel;

// Nhập tập tin lớp ErrorCode
use support\ErrorCode;

class Demo
{
    /**
     * Thêm
     * @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) {
            // Xuất thông báo lỗi
            throw_http_exception($e->getMessage(), ErrorCode::ModelAddOptionsError);
        }
        return [];
    }
}

Tập tin ./support/ErrorCode.php sau khi tạo

<?php
/**
 * File được tạo tự động, vui lòng không chỉnh sửa bằng tay.
 * @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;
}