Laravel HTTP—— RESTFul 风格路由的使用与源码分析

最新推荐文章于 2023-04-02 00:15:00 发布
最新推荐文章于 2023-04-02 00:15:00 发布
阅读量543 收藏
点赞数
分类专栏： PHP
原文链接：https://learnku.com/articles/5558/use-and-source-code-analysis-of-laravel-http-restful-style-routing
版权

前言

我们在前面的文章已经讲了整个路由与控制器的源码，我们今天这个文章开始向大家介绍在 laravel 中创建 RESTFul 风格的控制器。

关于什么是 RESTFul 风格及其规范可参考这篇文章：理解 RESTful 架构。

关于 laravel 中 RESTFul 风格控制器的创建简要介绍 ： HTTP 控制器实例教程 —— 创建 RESTFul 风格控制器实现文章增删改查

创建 RESTFul 风格控制器

要想在 laravel 中创建 RESTFul 风格控制器，只需要一句：

Route::resource('post','PostController');

该路由包含了指向多个动作的子路由：

方法路径动作路由名称
GET/postindexpost.index
GET/post/createcreatepost.create
POST/poststorepost.store
GET/post/{post}showpost.show
GET/post/{post}/editeditpost.edit
PUT/PATCH/post/{post}updatepost.update
DELETE/post/{post}destroypost.destroy

这种用法既简单又方便，接下来，我们将会说一下 laravel 为我们提供的更加灵活的用法。

前缀 RESTFul 路由

可以为 RESTFul 路由定义前缀：

$router->resource('prefix/foos', 'FooController');

$this->assertEquals('prefix/foos/{foo}', $routes[3]->uri());
多参数 RESTFul 路由

laravel 允许定义拥有多个参数的 RESTFul 路由：

$router->resource('foos.bars', 'FooController');

$this->assertEquals('foos/{foo}/bars/{bar}', $routes[3]->uri());
参数自定义命名

一般来说，RESTFul 路由的参数命名规则是路由单数，符号 - 转为 _，例如下面例子中 bars，和 foo-baz。

$router->resource('foos', 'FooController');
$this->assertEquals('foos/{foo}', $routes[3]->uri());

$router->resource('foo-bar.foo-baz', 'FooController', ['only' => ['show']]);
$this->assertEquals('foo-bar/{foo_bar}/foo-baz/{foo_baz}', $routes[0]->uri());

我们可以利用 parameters 强制这种单数模式：

$router->resource('foos', 'FooController', ['parameters' => 'singular']);
$this->assertEquals('foos/{foo}', $routes[3]->uri());

我们也可以利用 singularParameters 来强制：

ResourceRegistrar::singularParameters(true);

$router->resource('foos', 'FooController', ['parameters' => 'singular']);
$this->assertEquals('foos/{foo}', $routes[3]->uri());

我们还可以不使用单数，利用 parameters 用自己自定义的名字来定义参数：

$router->resource('bars.foos.bazs', 'FooController', ['parameters' => ['foos' => 'oof', 'bazs' => 'b']]);

$this->assertEquals('bars/{bar}/foos/{oof}/bazs/{b}', $routes[3]->uri());

同时，我们仍然可以利用 setParameters 函数来自定义参数命名：

ResourceRegistrar::setParameters(['foos' => 'oof', 'bazs' => 'b']);

$router->resource('bars.foos.bazs', 'FooController');
$this->assertEquals('bars/{bar}/foos/{oof}/bazs/{b}', $routes[3]->uri());
RESTFul 路由动词控制

laravel 为 RESTFul 路由生成了两个带有动词的路由： create 、 edit，分别用于加载订单的创建页面与编辑页面，这两个动词 laravel 是允许修改的：

ResourceRegistrar::verbs([
    'create' => 'ajouter',
    'edit' => 'modifier',
]);

$router->resource('foo', 'FooController');
$routes = $router->getRoutes();

$this->assertEquals('foo/ajouter', $routes->getByName('foo.create')->uri());
$this->assertEquals('foo/{foo}/modifier', $routes->getByName('foo.edit')->uri());
控制器方法约束

一般情况下，我们都会一次性想要上面所生成的七个路由，然而，有时候，我们只需要其中几个，或者不想要其中几个。这时候就可以利用 only 或者 except:

$router = $this->getRouter();
$router->resource('foo', 'FooController', ['only' => ['show', 'destroy']]);
$routes = $router->getRoutes();

$this->assertCount(2, $routes);

$router = $this->getRouter();
$router->resource('foo', 'FooController', ['except' => ['show', 'destroy']]);
$routes = $router->getRoutes();

$this->assertCount(5, $routes);
RESTFul 路由名称自定义

RESTFul 路由的每个路由都要自己默认的路由名称，laravel 允许我们对路由名称进行修改：

我们可以用 as 来为路由名称添加前缀：

$router->resource('foo-bars', 'FooController', ['only' => ['show'], 'as' => 'prefix']);

$this->assertEquals('prefix.foo-bars.show', $routes[0]->getName());

当有多个路由参数的时候，路由参数默认添加到了路由名称中：

$router->resource('prefix/foo.bar', 'FooController');

$this->assertTrue($router->getRoutes()->hasNamedRoute('foo.bar.index'));

可以利用 names 为单个路由来命名：

$router->resource('foo', 'FooController', ['names' => [
    'index' => 'foo',
    'show' => 'bar',
]]);

$this->assertTrue($router->getRoutes()->hasNamedRoute('foo'));
$this->assertTrue($router->getRoutes()->hasNamedRoute('bar'));

还可以利用 names 为所有路由来命名：

$router->resource('foo', 'FooController', ['names' => 'bar']);

$this->assertTrue($router->getRoutes()->hasNamedRoute('bar.index'));

RESTFul 路由源码分析

RESTFul 路由的创建工作由类 ResourceRegistrar 负责，这个类为默认为用户创建七个路由，函数方法 register 是创建路由的主函数：

class ResourceRegistrar
{
    public function register($name, $controller, array $options = [])
    {
        if (isset($options['parameters']) && ! isset($this->parameters)) {
            $this->parameters = $options['parameters'];
        }

        if (Str::contains($name, '/')) {
            $this->prefixedResource($name, $controller, $options);

            return;
        }

        $base = $this->getResourceWildcard(last(explode('.', $name)));

        $defaults = $this->resourceDefaults;

        foreach ($this->getResourceMethods($defaults, $options) as $m) {
            $this->{'addResource'.ucfirst($m)}($name, $base, $controller, $options);
        }
    }
}

这个函数主要流程分为三段：

  • 判断是否由前缀
  • 获取路由的基础参数
  • 添加路由
拥有前缀的 RESTFul 路由

如果我们为 RESTFul 路由添加了前缀，那么 laravel 将会以 group 的形式添加路由：

protected function prefixedResource($name, $controller, array $options)
{
    list($name, $prefix) = $this->getResourcePrefix($name);

    $callback = function ($me) use ($name, $controller, $options) {
        $me->resource($name, $controller, $options);
    };

    return $this->router->group(compact('prefix'), $callback);
}

protected function getResourcePrefix($name)
{
    $segments = explode('/', $name);

    $prefix = implode('/', array_slice($segments, 0, -1));

    return [end($segments), $prefix];
}
获取基础 RESTFul 路由参数

在添加各种路由之前，我们需要先获取路由的基础参数，也就是当存在多参数情况下，最后的参数。获取参数后，如果用户有自定义命名，则获取自定义命名：

public function getResourceWildcard($value)
{
    if (isset($this->parameters[$value])) {
        $value = $this->parameters[$value];
    } elseif (isset(static::$parameterMap[$value])) {
        $value = static::$parameterMap[$value];
    } elseif ($this->parameters === 'singular' || static::$singularParameters) {
        $value = Str::singular($value);
    }

    return str_replace('-', '_', $value);
}
添加各种路由

添加路由主要有三个步骤：

  • 计算路由 uri
  • 获取路由属性
  • 创建路由
protected function addResourceIndex($name, $base, $controller, $options)
{
    $uri = $this->getResourceUri($name);

    $action = $this->getResourceAction($name, $controller, 'index', $options);

    return $this->router->get($uri, $action);
}

当计算路由 uri 时，由于存在多参数的情况，需要循环计算路由参数：

public function getResourceUri($resource)
{
    if (! Str::contains($resource, '.')) {
        return $resource;
    }

    $segments = explode('.', $resource);

    $uri = $this->getNestedResourceUri($segments);

    return str_replace('/{'.$this->getResourceWildcard(end($segments)).'}', '', $uri);
}

protected function getNestedResourceUri(array $segments)
{  
    return implode('/', array_map(function ($s) {
        return $s.'/{'.$this->getResourceWildcard($s).'}';
    }, $segments));
}

当计算路由的属性时，最重要的是获取路由的名字，路由的名字可以是默认，也可以是用户利用 names 或者 as 属性来自定义：

protected function getResourceAction($resource, $controller, $method, $options)
{
    $name = $this->getResourceRouteName($resource, $method, $options);

    $action = ['as' => $name, 'uses' => $controller.'@'.$method];

    if (isset($options['middleware'])) {
        $action['middleware'] = $options['middleware'];
    }

    return $action;
}

protected function getResourceRouteName($resource, $method, $options)
{
    $name = $resource;

    if (isset($options['names'])) {
        if (is_string($options['names'])) {
            $name = $options['names'];
        } elseif (isset($options['names'][$method])) {
            return $options['names'][$method];
        }
    }

    $prefix = isset($options['as']) ? $options['as'].'.' : '';

    return trim(sprintf('%s%s.%s', $prefix, $name, $method), '.');
}

值得注意的是，如果单独为某一个方法命名，那么直接回返回命名，而不会受 as 和方法名 ‘method’ 的影响。

————————————————
原文作者：leoyang
转自链接：https://learnku.com/articles/5558/use-and-source-code-analysis-of-laravel-http-restful-style-routing
版权声明：著作权归作者所有。商业转载请联系作者获得授权，非商业转载请保留以上作者信息和原文链接。

oye-game
关注
专栏目录
laravel所有底层源码解析链接
李澎昆的博客
01-17 3839
  Laravel Passport——OAuth2 API 认证系统源码解析（下）laravel源码解析   Laravel Passport——OAuth2 API 认证系统源码解析（上）laravel源码解析   Laravel Broadcast——广播系统源码剖析laravel源码解析   Laravel Queue——消息队列任务处理器源码剖析laravel源码解析   La...
通过读dcat-admin源码学习laravel
CouryLove的博客
08-23 1321
通过读dcat-admin源码学习laravel 第一次接触laravel，直接去读文档总觉得有点生涩，就想通过一个项目入手对laravel进行学习，于是通过官方推荐对dcat-admin在homestead环境中进行了安装启动。好家伙，可以见到的页面的代码我竟然找不到，那么就带着问题去找一下答案吧～ 运行网站时，如何加载dcat-admin dcat-admin源码 通过查看laravel的请求周期可知道，在页面请求执行前，Illuminate\Foundation\Http\Kern..
laravel之RESTful资源路由
zs_4336的博客
03-14 617
1.创建RESTful风格控制器 执行 php artisan make:controller PostController 形如： class PostController extends Controller{ * * 显示文章列表 public function index(){ } * ...
laravel 使用 restful 路由访问
DuTianTian_csdn的博客
03-03 609
正常使用resource进行访问 自带的几个增删改查方法 Route::resource('/image_text', 'ImageTextController'); 如果仅仅访问其中一个方法/操作，使用only 进行限定 Route::resource('/image_text', 'ImageTextController', ['only' => ['show','index...
Golang进阶 —— 实现一个RESTful风格的路由
金戈鐡馬
04-02 434
​ 在上一篇文章中，我们聊了聊在Golang中怎么实现一个Http服务器。但是在最后我们可以发现，固然DefaultServeMux可以做路由分发的功能，但是他的功能同样是不完善的。 由DefaultServeMux做路由分发，是不能实现RESTful风格的API的，我们没有办法定义请求所需的方法，也没有办法在API路径中加入query参数。其次，我们也希望可以让路由查找的效率更高。 所以在这篇文章中，我们将分析httprouter这个包，从源码的层面研究他是如何实现我们上面提到的那些功能。并且，对于这
laravel的RESTful实现：RESTful资源控制器-通过laravel 学习RESTful
lenix的CSDN博客
06-14 1146
RESTful资源控制器 资源控制器让你可以轻松地创建与资源相关的 RESTful 控制器.Laravel的资源路由将典型的「CURD (增删改查)」路由分配给具有单行代码的控制器。例如，你希望创建一个控制器来处理保存 "照片" 应用的所有 HTTP 请求。使用 Artisan 命令make:controller，我们可以快速创建这样一个控制器: php artisan make:controller PhotoController --resource 这个命令将会生成一个控制器app/H...
Laravel 构建Restful风格 API
a1513049385的博客
03-13 1227
1.创建模型 php artisan make:model Article -m 2.修改默认生成的数据迁移文件 类名为CreateArticlesTable 将默认的迁移文件修改为如下，就是数据库字段的一些定义啦 use Illuminate\Support\Facades\Schema; use Illuminate\Database\Schema\Blueprint; us...
PHP实例开发源码——php-vue单商户版客服聊天系统.zip
12-01
【标题】"PHP实例开发源码——php-vue单商户版客服聊天系统.zip" 提供了一个基于PHP和Vue.js技术的单商户客服聊天系统的实现。这个项目旨在为一个商家提供实时、高效的在线客服功能，帮助商家与客户进行无缝沟通。 ...
基于微信小程序的家政服务预约系统的设计与实现+php后端源码案例设计带文档说明.zip
最新发布
04-21
《基于微信小程序的家政服务预约系统设计与实现——PHP后端源码解析》 在当前信息化社会，家政服务预约系统已经成为了人们日常生活的一部分，它极大地便利了用户寻找和预订家政服务。本篇文章将深入探讨一个基于...
毕业设计源码之PHP_基于KPI的医疗废弃物管理系统.zip
09-19
在本项目中，PHP作为前端与后端之间的桥梁，可能使用了诸如Laravel或Symfony等框架，这些框架简化了路由、模板引擎和数据库操作，使得开发更为高效。 “源码”标签意味着用户可以查看并学习整个项目的代码结构和...
[Laravel]使用PHP Laravel框架编写restful风格API
m0_46470372的博客
01-31 978
使用PHP Laravel框架编写restful风格API 准备工作 创建laravel项目 composer create-project --prefer-dist laravel/laravel myproject 数据库准备数据（我的数据在student库的stu表） 打开项目，修改项目数据库配置 打开根目录下的 .env 文件进行数据库配置 项目/.env DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DA
php用路由做restful,php – 如何在Laravel 5中使用restful ajax路由到方法？
weixin_26766909的博客
03-26 148
所以我有一条看起来像这样的路线：Route::any('some/page', ['as' => 'some-page', 'uses' => 'SomePageController@index']);但是,我也在同一个URL上使用ajax调用(使用名为ajax的请求参数：some / page /？ajax = my_action),我想在我的控制器上点击方法：index ...
Laravel笔记-搭建Restful风格的后端
IT1995的博客
02-13 1752
这里需要在routes/api.php中添加代码，不用在web.php中添加。首先创建Controller和resource。
laravel中的resource路由的相关介绍
hxthon的博客
04-14 761
建立方法如下的两种方式都可以的 Route::resource('test','App\Controllers\TestController'); $router->resource('ercode', ErcodeController::class); 但是使用的时候，要注意了。resource只支持用一下的几种方式来自动绑定 ...
【Rails】再探RESTfull路由规则与具名路由
Chunyang Guo
10-14 1492
下午工作中用到路由嵌套，对REST的认识进一步加深。  假设有一个user模型，那么，users_path对应index的action，不需要参数，而对于user_path()，后面需要一个参数作为id，例如user_path(@user)，表示@user对应的页面，具体含义与get/patch/delete有关 而edit_user_path(@user)和new_user_path
第一节：WebApi的纯原生态的RestFul风格接口和路由规则介绍
weixin_34306593的博客
01-08 506
一. 原生态接口 1. 从默认路由开始分析 　在WebApiConfig.cs类中的Register方法中，我们可以看到默认路由如下： 分析：请求地址在 controller 前面需要加上 api/，controller后面没有action，最后有一个参数{id}，webapi默认的路由规则就是一种RestFul风格的接口调用规则。 2. WebApi的默认调用规则 (1). 方法名...
「学习阶段」restful风格优化路由
chen_zhuo_you的博客
09-17 232
目录结构： 连接数据库公共文件： // fools/sql.js // 1.加载mysql var mysql = require('mysql'); // 2.创建连接 var connection = mysql.createConnection({ host: 'localhost', // 你要连接的数据库服务器的地址 port: 3306, // 端口号 user: 'root', // 连接数据库服务器需要的用户名 password: ...
PHP类参数_PHP编码风格规范
weixin_39668479的博客
11-23 147
由于PHP的灵活性，很多人写起代码来也不讲求一个好的代码规范，使得本就灵活的PHP代码看起来很乱，其实PSR规范中的PSR-1和PSR-2已经定义了在PHP编码中的一些规范，只要我们好好遵守这些规范，即使是使用灵活的脚本语言，也能写出非常漂亮工整的代码。首先我们来看一下已经通过的PSR规范，然后大致讲解一下PSR-1和PSR-2规范的一些具体要求。已通过的PSRPSR-1基础编码规范开闭标签首先，...
Laravel资源路由自定义URL重写详解与实现
在Laravel框架中，资源路由是一种简化RESTful API开发的便捷方式，它通过预定义的一系列HTTP动词（如GET、POST、PUT、DELETE等）映射到控制器中的相应方法。然而，有时候开发者可能需要对这些默认的URL结构进行...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值