caipan_shop_admin/app/controller/BaseController.php

<?php
declare (strict_types=1);

namespace app\controller;

use think\{App, Request, response\Json, response\Redirect, response\View, Validate};
use Exception;
use think\exception\ValidateException;

/**
 * 控制器基础类
 */
abstract class BaseController
{
    /**
     * 无需登录的方法,同时也就不需要鉴权了
     *
     * @var array
     */
    protected $noNeedLogin = [];

    /**
     * 无需鉴权的方法,但需要登录
     *
     * @var array
     */
    protected $noNeedRight = [];

    /**
     * Request实例
     * @var Request
     */
    protected $request;

    /**
     * 应用实例
     * @var App
     */
    protected $app;

    /**
     * 是否批量验证
     * @var bool
     */
    protected $batchValidate = false;

    /**
     * 控制器中间件
     * @var array
     */
    protected $middleware = [];

    /**
     * 构造方法
     * @access public
     * @param  App  $app  应用对象
     */
    public function __construct(App $app)
    {
        $this->app     = $app;
        $this->request = $this->app->request;

        // 控制器初始化
        $this->initialize();
    }

    // 初始化
    protected function initialize()
    {
    }

    /**
     * 验证数据
     * @access protected
     * @param  array  $data  数据
     * @param  string|array  $validate  验证器名或者验证规则数组
     * @param  array  $message  提示信息
     * @param  bool  $batch  是否批量验证
     * @return array|string|true
     * @throws ValidateException
     */
    protected function validate(array $data, $validate, array $message = [], bool $batch = false)
    {
        if (is_array($validate)) {
            $v = new Validate();
            $v->rule($validate);
        } else {
            if (strpos($validate, '.')) {
                // 支持场景
                list($validate, $scene) = explode('.', $validate);
            }
            $class = false !== strpos($validate, '\\') ? $validate : $this->app->parseClass('validate', $validate);
            $v     = new $class();
            if (!empty($scene)) {
                $v->scene($scene);
            }
        }

        $v->message($message);

        // 是否批量验证
        if ($batch || $this->batchValidate) {
            $v->batch(true);
        }

        return $v->failException(true)->check($data);
    }

    /**
     * 验证器
     *
     * @param  array  $data
     * @param $validate
     * @param  array  $message
     * @param  bool  $batch
     * @return Json|bool
     * @throws Exception
     */
    protected function validateByApi(array $data, $validate, array $message = [], bool $batch = false)
    {
        try {
            $this->validate($data, $validate, $message, $batch);
            return true;
        } catch (ValidateException $e) {
            $msg = $e->getMessage();
            if ($batch) {
                $msg = implode(',', $e->getError());
            }

            return $this->json(4000, $msg);
        } catch (Exception $e) {
            throw $e;
        }
    }

    /**
     * 验证器
     *
     * @param  array  $data
     * @param $validate
     * @param  array  $message
     * @param  bool  $batch
     * @return Redirect
     * @throws Exception
     */
    protected function validateByView(array $data, $validate, array $message = [], bool $batch = false): Redirect
    {
        try {
            $this->validate($data, $validate, $message, $batch);
        } catch (ValidateException $e) {
            $msg = $e->getMessage();
            if ($batch) {
                $msg = implode(',', $e->getError());
            }

            return $this->error( $msg);
        } catch (Exception $e) {
            throw $e;
        }
    }

    /**
     * 操作成功跳转的快捷方法
     * @access protected
     * @param  mixed  $msg  提示信息
     * @param  string|null  $url  跳转的URL地址
     * @param  mixed  $data  返回的数据
     * @param  integer  $wait  跳转等待时间
     * @param  array  $header  发送的Header信息
     * @return Redirect
     */
    protected function success($msg = '', string $url = null, $data = '', int $wait = 3, array $header = []): Redirect
    {
        if (is_null($url) && isset($_SERVER["HTTP_REFERER"])) {
            $url = $_SERVER["HTTP_REFERER"];
        } elseif ($url) {
            $url = (strpos($url, '://') || 0 === strpos($url, '/')) ? $url : $this->app->route->buildUrl($url);
        }

        $result = [
            'code' => 1,
            'msg'  => $msg,
            'data' => $data,
            'url'  => $url,
            'wait' => $wait,
        ];
        return $this->redirect(url('error/404', $result));
    }

    /**
     * 操作错误跳转的快捷方法
     * @access protected
     * @param  mixed  $msg  提示信息
     * @param  string|null  $url  跳转的URL地址
     * @param  mixed  $data  返回的数据
     * @param  integer  $wait  跳转等待时间
     * @return Redirect
     */
    protected function error($msg = '', string $url = null, $data = '', int $wait = 3): Redirect
    {
        if (is_null($url)) {
            $referer = $_SERVER['HTTP_REFERER'] ?? null;
            if (empty($referer)) {
                $url = $this->request->isAjax() ? '' : '/';
            } else {
                $url = $this->request->isAjax() ? '' : 'javascript:history.back(-1);';
            }
        } elseif ($url) {
            $url = (strpos($url, '://') || 0 === strpos($url, '/')) ? $url : $this->app->route->buildUrl($url);
        }
        $result = [
            'code' => 0,
            'msg'  => $msg,
            'data' => $data,
            'url'  => $url,
            'wait' => $wait,
        ];

        return $this->redirect(url('error/404', $result));
    }

    /**
     * 返回封装后的API数据到客户端
     * 以json格式抛出异常
     * @access protected
     * @param  integer  $code  返回的code
     * @param  mixed  $msg  提示信息
     * @param  mixed  $data  要返回的数据
     * @return Json
     */
    protected function json(int $code = 0, $msg = '操作成功', $data = []): Json
    {
        $result = [
            'code' => $code,
            'msg'  => $msg,
            'data' => $data
        ];
        return json($result);
    }

    /**
     * URL重定向
     * @access protected
     * @param  string  $url  跳转的URL表达式
     * @return Redirect
     */
    protected function redirect($url): Redirect
    {
        if (!is_string($url)) {
            $url = $url->__toString();
        }
        return redirect($url);
    }
}