README

Ziggy – 在JavaScript中使用Laravel路由

Ziggy提供了一个JavaScript route()助手函数，它的工作方式与Laravel的相同，使得在JavaScript中使用Laravel命名路由变得容易。

Ziggy支持从5.4版本开始的Laravel所有版本，以及所有现代浏览器。

• 安装
• 用法
  • route()助手函数
  • Router类
  • 路由模型绑定
  • TypeScript支持
• 高级设置
  • JavaScript框架
  • Vue
  • React
  • 单页应用或独立仓库
• 过滤路由
  • 基本过滤
  • 使用分组过滤
• 其他
• 贡献

安装

使用composer require tightenco/ziggy将Ziggy安装到您的Laravel应用程序中。

将@routes Blade指令添加到您的主布局中（在应用程序的JavaScript之前），现在全局可用的route()助手函数将可用！

默认情况下，@routes Blade指令的输出包括所有应用程序路由及其参数的列表。此路由列表包含在页面HTML中，并且可以被最终用户查看。要配置要包含在此列表中的路由，或在不同的页面上显示和隐藏不同的路由，请参阅过滤路由。

用法

route()助手函数

Ziggy的route()助手函数的工作方式与Laravel的相同——您可以将您路由的名称和一个要传递给路由的参数传递给它，它将返回一个URL。

基本用法

// routes/web.php

Route::get('posts', fn (Request $request) => /* ... */)->name('posts.index');

// app.js

route('posts.index'); // 'https://ziggy.test/posts'

带参数的用法

// routes/web.php

Route::get('posts/{post}', fn (Request $request, Post $post) => /* ... */)->name('posts.show');

// app.js

route('posts.show', 1);           // 'https://ziggy.test/posts/1'
route('posts.show', [1]);         // 'https://ziggy.test/posts/1'
route('posts.show', { post: 1 }); // 'https://ziggy.test/posts/1'

带多个参数的用法

// routes/web.php

Route::get('events/{event}/venues/{venue}', fn (Request $request, Event $event, Venue $venue) => /* ... */)->name('events.venues.show');

// app.js

route('events.venues.show', [1, 2]);                 // 'https://ziggy.test/events/1/venues/2'
route('events.venues.show', { event: 1, venue: 2 }); // 'https://ziggy.test/events/1/venues/2'

带查询参数的用法

// routes/web.php

Route::get('events/{event}/venues/{venue}', fn (Request $request, Event $event, Venue $venue) => /* ... */)->name('events.venues.show');

// app.js

route('events.venues.show', {
    event: 1,
    venue: 2,
    page: 5,
    count: 10,
});
// 'https://ziggy.test/events/1/venues/2?page=5&count=10'

如果您有一个与路由参数同名的查询参数，请将其嵌套在_query键下

route('events.venues.show', {
    event: 1,
    venue: 2,
    _query: {
        event: 3,
        page: 5,
    },
});
// 'https://ziggy.test/events/1/venues/2?event=3&page=5'

与Laravel的route()助手函数一样，Ziggy自动将布尔查询参数编码为查询字符串中的整数

route('events.venues.show', {
    event: 1,
    venue: 2,
    _query: {
        draft: false,
        overdue: true,
    },
});
// 'https://ziggy.test/events/1/venues/2?draft=0&overdue=1'

带默认参数值的用法

请参阅Laravel关于默认路由参数值的文档。

// routes/web.php

Route::get('{locale}/posts/{post}', fn (Request $request, Post $post) => /* ... */)->name('posts.show');

// app/Http/Middleware/SetLocale.php

URL::defaults(['locale' => $request->user()->locale ?? 'de']);

// app.js

route('posts.show', 1); // 'https://ziggy.test/de/posts/1'

实际AJAX示例

const post = { id: 1, title: 'Ziggy Stardust' };

return axios.get(route('posts.show', post)).then((response) => response.data);

Router类

使用无参数调用Ziggy的route()助手函数将返回一个JavaScript Router类的实例，该类具有一些其他有用的属性和方法。

检查当前路由：route().current()

// Route called 'events.index', with URI '/events'
// Current window URL is https://ziggy.test/events

route().current();               // 'events.index'
route().current('events.index'); // true
route().current('events.*');     // true
route().current('events.show');  // false

current()方法可选地接受第二个参数，并且将检查这些值是否与当前URL中的值匹配

// Route called 'events.venues.show', with URI '/events/{event}/venues/{venue}'
// Current window URL is https://myapp.com/events/1/venues/2?authors=all

route().current('events.venues.show', { event: 1, venue: 2 }); // true
route().current('events.venues.show', { authors: 'all' });     // true
route().current('events.venues.show', { venue: 6 });           // false

检查路由是否存在：route().has()

// App has only one named route, 'home'

route().has('home');   // true
route().has('orders'); // false

检索当前路由参数：route().params

// Route called 'events.venues.show', with URI '/events/{event}/venues/{venue}'
// Current window URL is https://myapp.com/events/1/venues/2?authors=all

route().params; // { event: '1', venue: '2', authors: 'all' }

注意：使用route().params检索的参数值始终返回为字符串。

路由模型绑定

Ziggy支持Laravel的路由模型绑定，甚至可以识别自定义路由键名。如果您将JavaScript对象作为路由参数之一传递给route()，Ziggy将使用为该路由注册的路由模型绑定键来在对象中查找参数值并将其插入URL中（如果路由模型绑定键不存在，则回退到id键）。

// app/Models/Post.php

class Post extends Model
{
    public function getRouteKeyName()
    {
        return 'slug';
    }
}

// app/Http/Controllers/PostController.php

class PostController
{
    public function show(Request $request, Post $post)
    {
        return view('posts.show', ['post' => $post]);
    }
}

// routes/web.php

Route::get('blog/{post}', [PostController::class, 'show'])->name('posts.show');

// app.js

const post = {
    title: 'Introducing Ziggy v1',
    slug: 'introducing-ziggy-v1',
    date: '2020-10-23T20:59:24.359278Z',
};

// Ziggy knows that this route uses the 'slug' route-model binding key name:

route('posts.show', post); // 'https://ziggy.test/blog/introducing-ziggy-v1'

Ziggy还支持路由定义中作用域绑定的自定义键（需要Laravel 7+）

// routes/web.php

Route::get('authors/{author}/photos/{photo:uuid}', fn (Request $request, Author $author, Photo $photo) => /* ... */)->name('authors.photos.show');

// app.js

const photo = {
    uuid: '714b19e8-ac5e-4dab-99ba-34dc6fdd24a5',
    filename: 'sunset.jpg',
}

route('authors.photos.show', [{ id: 1, name: 'Jacob' }, photo]);
// 'https://ziggy.test/authors/1/photos/714b19e8-ac5e-4dab-99ba-34dc6fdd24a5'

TypeScript支持

由 benallfree 维护 Ziggy 的非官方 TypeScript 类型定义，作为 DefinitelyTyped 的一部分，可以使用 npm install @types/ziggy-js 进行安装。

高级设置

JavaScript框架

如果您不使用 Blade 或不希望使用 @routes 指令，Ziggy 提供了一个 artisan 命令来将配置和路由输出到文件：php artisan ziggy:generate。默认情况下，此命令将您的路由存储在 resources/js/ziggy.js 中，但您可以通过传递参数来指定不同的路径。或者，您可以从 Laravel API 中的端点返回 Ziggy 的配置为 JSON 格式（见下文 从 API 端点检索 Ziggy 的路由和配置 的示例，了解如何设置此功能）。

由 php artisan ziggy:generate 生成的文件将类似于以下内容

// ziggy.js

const Ziggy = {
    routes: {"home":{"uri":"\/","methods":["GET","HEAD"],"domain":null},"login":{"uri":"login","methods":["GET","HEAD"],"domain":null}},
    url: 'http://ziggy.test',
    port: false
};

export { Ziggy };

您可以选择创建一个 webpack 别名，以便更容易导入 Ziggy 的核心源文件

// webpack.mix.js

// Mix v6
const path = require('path');

mix.alias({
    ziggy: path.resolve('vendor/tightenco/ziggy/dist'), // or 'vendor/tightenco/ziggy/dist/vue' if you're using the Vue plugin
});

// Mix v5
const path = require('path');

mix.webpackConfig({
    resolve: {
        alias: {
            ziggy: path.resolve('vendor/tightenco/ziggy/dist'),
        },
    },
});

最后，像其他任何 JavaScript 库一样导入和使用 Ziggy。因为 Ziggy 配置对象在此设置中不可用，所以通常需要手动将配置对象传递给 route() 函数

// app.js

import route from 'ziggy';
import { Ziggy } from './ziggy';

// ...

route('home', undefined, undefined, Ziggy);

Vue

Ziggy 包含一个 Vue 插件，可以轻松地在整个 Vue 应用中使用 route() 辅助函数

import { createApp } from 'vue';
import { ZiggyVue } from 'ziggy';
import { Ziggy } from './ziggy';
import App from './App';

createApp(App).use(ZiggyVue, Ziggy);

// Vue 2
import Vue from 'vue'
import { ZiggyVue } from 'ziggy';
import { Ziggy } from './ziggy';

Vue.use(ZiggyVue, Ziggy);

如果使用上述 Laravel Mix 别名与该插件，请确保将别名更新为 vendor/tightenco/ziggy/dist/vue。

注意：如果您在视图中使用 @routes Blade 指令，Ziggy 的配置已经全局可用，因此不需要导入 Ziggy 配置对象并将其传递到 use() 中。

现在您可以在 Vue 组件和模板中的任何地方使用 route()，如下所示

<a class="nav-link" :href="route('home')">Home</a>

React

要使用 Ziggy 与 React 一起使用，首先导入 route() 函数和您的 Ziggy 配置。因为 Ziggy 配置对象在此设置中不可用，所以必须将配置对象手动传递给 route() 函数

// app.js

import route from 'ziggy';
import { Ziggy } from './ziggy';

// ...

route('home', undefined, undefined, Ziggy);

我们正在努力为 Ziggy 添加一个 Hook 以使其更简洁，但到目前为止，请确保将配置对象作为上述第四个参数传递给 route() 函数。

注意：如果您在视图中包含 @routes Blade 指令，则 route 辅助函数已经在全局范围内可用，包括您的 React 应用程序中，因此不需要在任何地方导入 route 或 Ziggy。

单页应用或独立仓库

Ziggy 的 route() 辅助函数也作为 NPM 包提供，用于在单独管理 JavaScript 项目（即没有 Composer 或 vendor 目录）的 Laravel 后端中。您可以使用 npm install ziggy-js 安装该 NPM 包。

为了使此函数可用的路由在前端，您可以运行 php artisan ziggy:generate 并将生成的路由文件添加到项目中，或者您可以从 Laravel API 的端点返回 Ziggy 的配置为 JSON 格式（见下文 从 API 端点检索 Ziggy 的路由和配置 的示例，了解如何设置此功能）。

然后，按照上述方法导入和使用 Ziggy

// app.js

import route from 'ziggy-js';

import { Ziggy } from './ziggy';
// or...
const response = await fetch('/api/ziggy');
const Ziggy = await response.json();

// ...

route('home', undefined, undefined, Ziggy);

过滤路由

Ziggy 支持过滤提供给您的 JavaScript 的路由，如果您有一些不想在返回给客户端的响应源中包含和可见的路由，这将非常有用。过滤路由是可选的——默认情况下，Ziggy 包括您应用程序的所有命名路由。

基本过滤

要设置基本路由过滤，在您的 Laravel 应用程序中创建一个名为 config/ziggy.php 的配置文件，并定义一个 仅限 或 except 设置，它是一个包含路由名称模式数组的数组。

注意：您必须选择其一。同时设置only和except将禁用过滤并返回所有命名路由。

// config/ziggy.php

return [
    'only' => ['home', 'posts.index', 'posts.show'],
];

您还可以在路由过滤器中使用星号作为通配符。以下示例中，admin.*将排除名为admin.login和admin.register的路由。

// config/ziggy.php

return [
    'except' => ['_debugbar.*', 'horizon.*', 'admin.*'],
];

使用分组进行过滤

您还可以使用配置文件中的groups键定义您想要在不同地方提供的路由分组

// config/ziggy.php

return [
    'groups' => [
        'admin' => ['admin.*', 'users.*'],
        'author' => ['posts.*'],
    ],
];

然后，您可以通过传递分组名称到@routes Blade指令来公开特定的分组

{{-- authors.blade.php --}}

@routes('author')

要公开多个分组，您可以传递一个分组名称数组

{{-- admin.blade.php --}}

@routes(['admin', 'author'])

注意：传递分组名称到@routes指令将始终优先于您的其他only或except设置。

其他

TLS/SSL终止和受信任的代理

如果您的应用程序正在使用TLS/SSL终止或位于负载均衡器或代理后面，或者托管在提供TLS/SSL终止服务的平台上，Ziggy可能会生成方案为http的URL，而不是您的应用程序URL使用的https。为了避免这种情况，请根据配置受信任的代理的文档设置Laravel应用程序的TrustProxies中间件。

使用@routes与内容安全策略

内容安全策略（CSP）可能会阻止内联脚本，包括Ziggy的@routes Blade指令输出的脚本。如果您有CSP并使用nonce标记安全内联脚本，可以将nonce作为@routes指令的第二个参数传递，它将被添加到Ziggy的脚本标签中。

// PHP ^8.0
@routes(nonce: 'your-nonce-here')

// PHP <=7.4
@routes(null, 'your-nonce-here')

禁用route()辅助函数

如果您只想使用@routes指令使应用程序的路由在JavaScript中可用，但不需要route()辅助函数，请将skip-route-function配置值设置为true。

// config/ziggy.php

return [
    'skip-route-function' => true,
];

从API端点检索Ziggy的路由和配置

Ziggy可以轻松地将其配置对象作为JSON从Laravel应用程序的端点返回。例如，您可以设置一个类似于以下的/api/ziggy路由

// routes/api.php

use Tightenco\Ziggy\Ziggy;

Route::get('api/ziggy', fn () => response()->json(new Ziggy));

然后，客户端可以通过HTTP请求检索配置

// app.js

import route from 'ziggy-js';

const response = await fetch('/api/ziggy');
const Ziggy = await response.toJson();

// ...

route('home', undefined, undefined, Ziggy);

当应用程序的路由发生变化时重新生成路由文件

如果您通过运行php artisan ziggy:generate将Ziggy路由作为文件导出，您可能想监视应用程序的路由文件，并在它们更新时自动重新运行命令。以下是一个Laravel Mix插件示例，但可以在不使用Mix的情况下实现类似的功能。感谢Nuno Rodrigues提供这个想法和示例实现！

const mix = require('laravel-mix');
const { exec } = require('child_process');

mix.extend('ziggy', new class {
    register(config = {}) {
        this.watch = config.watch ?? ['routes/**/*.php'];
        this.path = config.path ?? '';
        this.enabled = config.enabled ?? !Mix.inProduction();
    }

    boot() {
        if (!this.enabled) return;

        const command = () => exec(
            `php artisan ziggy:generate ${this.path}`,
            (error, stdout, stderr) => console.log(stdout)
        );

        command();

        if (Mix.isWatching() && this.watch) {
            ((require('chokidar')).watch(this.watch))
                .on('change', (path) => {
                    console.log(`${path} changed...`);
                    command();
                });
        };
    }
}());

mix.js('resources/js/app.js', 'public/js')
    .postCss('resources/css/app.css', 'public/css', [])
    .ziggy();

贡献

要开始为Ziggy做出贡献，请查看贡献指南。

鸣谢

• Daniel Coulbourne
• Jake Bathman
• Matt Stauffer
• Jacob Baker-Kretzmar
• 所有贡献者

感谢Caleb Porzio、Adam Wathan和Jeffrey Way的帮助，他们帮助巩固了这个想法。

安全性

请查看我们的安全策略，了解如何报告安全漏洞。

许可

Ziggy是一个在MIT许可下发布的开源软件。更多信息请参阅许可协议。