LaravelReadme.md

support

安装

$ composer require zhenmu/support -vvv

使用

1. 通过 php artisan make:controller 控制器生成后，继承同目录下的 Controller 基类.
2. 编写接口时可通过 $this->success($data = [], $err_code = 200, $messsage = 'success'); 返回正确数据给接口.
3. 编写接口时可通过 $this->fail($messsage = '', $err_code = 400); 返回错误信息给接口.
4. 在 app/Exceptions/Handler.php 的 register 函数中, 注册 ResponseTrait 的 renderableHandle, 示例见下方错误处理.

控制器

<?php

namespace App\Http\Controllers;

use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Routing\Controller as BaseController;
use ZhenMu\Support\Traits\ResponseTrait; // here

class Controller extends BaseController
{
    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
    use ResponseTrait; // here
}

错误处理

<?php

namespace App\Exceptions;

use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Throwable;
use ZhenMu\Support\Traits\ResponseTrait; // here

class Handler extends ExceptionHandler
{
    use ResponseTrait; // here

    /**
     * A list of exception types with their corresponding custom log levels.
     *
     * @var array<class-string<\Throwable>, \Psr\Log\LogLevel::*>
     */
    protected $levels = [
        //
    ];

    /**
     * A list of the exception types that are not reported.
     *
     * @var array<int, class-string<\Throwable>>
     */
    protected $dontReport = [
        //
    ];

    /**
     * A list of the inputs that are never flashed for validation exceptions.
     *
     * @var array<int, string>
     */
    protected $dontFlash = [
        'current_password',
        'password',
        'password_confirmation',
    ];

    /**
     * Register the exception handling callbacks for the application.
     *
     * @return void
     */
    public function register()
    {
        $this->reportable(function (Throwable $e) {
            //
        });
        
        $this->renderable($this->renderableHandle()); // here
    }
}

控制器调用

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class DemoController extends Controller
{
    public function index()
    {
        // validate data
        \validator()->validate(\request(), [
            'name' => 'required|string',
            'age' => 'nullable|integer',
        ]);

        // your business logic
        $error = false;
        if ($error) { // here business logic error.
            throw new \RuntimeException('error message');
        }

        return $this->success([ // here response success
            'key1' => 'value1',
            'key2' => 'value2',
        ]);
    }
}