lara-igniter/route-js

生成一个Blade指令，导出所有的Laraigniter命名路由。同时提供JavaScript中的route()辅助函数。

维护者

详细信息

github.com/lara-igniter/route-js

主页

源代码

问题

安装次数: 3

依赖项: 0

建议者: 0

安全: 0

星级: 0

关注者: 1

分支: 0

开放问题: 0

语言:JavaScript

v1.0.3 2022-04-11 19:48 UTC

Requires

MIT 15d2051c0fd602bf69bdd71714dc89ac9a4e0efe

  • George Tsachrelias <geo.tsachrelias.woop@laraigniter.com>

javascriptrouteslaraigniterroute-js

This package is auto-updated.

Last update: 2024-09-12 01:04:52 UTC

README

route-js提供了一个JavaScript route()辅助函数，类似于Laraigniter，使得在JavaScript中使用Laraigniter命名路由变得简单。

route-js支持从1.x版本开始的所有Laraigniter版本和所有现代浏览器。

安装

使用 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将使用已注册的路由-model绑定键为此路由查找对象中的参数值并将其插入到URL中（如果路由-model绑定键不存在，则回退到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支持

非官方的 Ziggy TypeScript 类型定义由 benallfree 维护，作为 Definitely Typed 的一部分，可以使用 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 任何地方导入。

SPAs或单独的仓库

Ziggy 的 route() 辅助函数也作为 NPM 包提供，用于管理与 Laravel 后端分离的 JavaScript 项目（即没有 Composer 或 vendor 目录）。您可以使用 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.toJson();

// ...

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

过滤路由

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

基本过滤

要设置基本的路由过滤，请在您的Laravel应用程序中创建一个名为config/ziggy.php的配置文件，并定义一个only或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终止或位于负载均衡器或代理后面，或者托管在提供此类服务的平台上，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可以轻松地从您的Laravel应用程序中的一个端点返回其配置对象作为JSON。例如，您可以设置一个类似于下面的/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做出贡献，请查看贡献指南。

致谢

感谢Caleb Porzio、Adam Wathan和Jeffrey Way在巩固这个想法方面的帮助。

安全

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

许可证

Ziggy是一款开源软件，遵循MIT许可证发布。更多信息请参见许可证。