简化 Laravel 路由功能

Laravel的路由设置非常简单,但是在大型项目中需要配置很多路由信息,显得比较臃肿,可以对路由进行如下简化:
首先创建一个中间件 HttpDiscernMiddleware:

<?php

namespace App\Http\Middleware;

use Closure;
use Log;
use App;

class HttpDiscernMiddleware
{
    protected $controller;
    protected $method;
    protected $api_version;

    /**
     * Request Method&Api Version Discern Middleware
     * @param $request
     * @param Closure $next
     * @return mixed
     * @throws \Exception
     */
    public function handle($request, Closure $next)
    {
        $real_method = $request->getRealMethod();
        $scheme_host = $request->getSchemeAndHttpHost();
        $request_uri = $request->getRequestUri();
        $client_ip = $request->getClientIp();
        $content_type = $request->getContentType();
        $base_url = $request->getBaseUrl();

        $data = [
            "real_method"=>$real_method,
            "scheme_host"=>$scheme_host,
            "request_uri"=>$request_uri,
            "client_ip"=>$client_ip,
            "content_type"=>$content_type,
            "base_url"=>$base_url,
        ];

        Log::info("Http Request : ".json_encode($data));

        if (strrpos($request_uri,'?')) {
            $temp = explode('?', $request_uri);
            $temp = explode('/', current($temp));
        }else{
            $temp = explode('/', $request_uri);
        }

        $this->controller = $temp[1];
        $this->method = $temp[2];

        try {
            if (strtolower($this->controller)=="api") {
                $this->api_version = $temp[2];
                $this->controller = $temp[3];
                $this->method = $temp[4];
            }

            $tag = ['@method','@api'];
            $request_method = $this->getProperty(
                'App\Http\Controllers\\'.ucwords($this->controller).'Controller',
                $this->method,
                $tag
            );

            Log::info("request_method: ",$request_method);
            if ($request_method['@method'] != strtolower($real_method)) {
                throw new \Exception('方法不支持');
            }

            if (!empty($request_method['@api'])) {
                if (empty($this->api_version)) {
                    throw new \Exception("@api 版本为空");
                }
                $api = (float) explode(':', $request_method['@api'])[1];
                $req_api = (float) explode('v',$this->api_version)[1];

                if ($api != $req_api) {
                    throw new \Exception("@api 版本不正确");
                }
            }

        } catch (\Exception $e) {
            throw $e;
        }

        return $next($request);
    }

    /**
     * Get Class Property Function
     * @param $class
     * @param $method
     * @param $tags
     * @return array|null
     * @throws \Exception
     */
    public function getProperty($class, $method, $tags)
    {
        try {
            $req_property = null;
            if (empty($tags)) {
                throw new \Exception('Tag 不能空');
            }
            $controller = new \ReflectionClass($class);
            $method = $controller->getMethod($method);
            $doc = $method->getDocComment();
            $matches = array();
            $req_property = array();
            foreach ($tags as $item) {
                preg_match("/".$item."(.*)(\\r\\n|\\r|\\n)/U", $doc, $matches);
                if (isset($matches[1])) {
                    $req_property[$item]  =trim($matches[1]) ;
                }
            }
            if (!isset($req_property['@method'])) {
                throw new \Exception('请设置@method 属性[必填]');
            }
            return $req_property;

        } catch (\Exception $e) {
            throw $e;
        }
    }
}

HttpDiscernMiddleware的任务是完成用户请求和Controller中的方法进行匹配,通过反射获取Controller中Function注释信息(@method,@api),这样可以不需要在routes文件夹下配置很多路由信息了;

在Kernel.php,$routeMiddleware中配置如下:

'discern'=> \App\Http\Middleware\HttpDiscernMiddleware::class,

在RouteServiceProvider 中加入:

    public function boot()
    {
        //

        parent::boot();

        Route::bind('controller', function ($controller) {
            try {
                return app($this->namespace.'\\'.ucwords($controller).'Controller');
            } catch (\Exception $e) {
                throw new \Exception('Controller 解析失败');
            }
        });
    }

绑定$controller变量为解析后的Controller对象 ;

然后在routes/web.php中 加入:

Route::group([
    'middleware'=>[
        'discern'
    ]
],function () {
    Route::match(['get','post','put','delete','patch'],'/{controller}/{method}',function ($controller,$method){
        try {
            $result = $controller->$method();
            if(is_scalar($result)){
                return response()->json($result);
            }
            return $result;
        } catch (\Exception $e) {
            throw new Exception($e->getMessage());
        }
    });
});

在routes/api.php中加入:


Route::group([
    'middleware'=>[
        'discern'
    ]
],function () {
    Route::match(['get','post','put','delete','patch'],'/{version}/{controller}/{method}',function ($version,$controller,$method){
        try {
            $result = $controller->$method();
            if(is_scalar($result)){
                return response()->json($result);
            }
            return $result;
        } catch (\Exception $e) {
            throw new Exception($e->getMessage());
        }
    });
});

这样就配置好web.php 和 api.php了。

这些配置好后就只需要在控制器中配置请求method或者api版本信息 就可以了,不需要写繁琐的路由信息,当然可以根据自己的需要修改。

Demo1: [ 请求uri : http://domain/demo/testGet?user=ethan]

class DemoController extends Controller
{

    /**
     * Controller-Route Demo
     * @method get
     * @return array
     */
    public function testGet()
    {
        $user = $this->getParam("user");
        return view('home')->with($user);
    }
}

@method 定义了请求的方法必须为get

Demo2: [ 请求uri : http://domain/api/v1/demo/testGet?user=ethan]

class DemoController extends Controller
{

    /**
     * Controller-Route Demo
     * @method get
     * @api version:1.0
     * @return array
     */
    public function testGet()
    {
        $user = $this->getParam("user");
        return view('home')->with($user);
    }
}

@method 定义了请求的方法必须为get,@api 定义了版本为v1(v是version的简写)

其中 @method 支持 [get,post,put,delete]

通过Demo1和Demo2可以通过注释来控制route路由的请求规则了,达到了简化路由的目的,并且使用很方便。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容