Lzh on GitHub

Vite打包资源

引言

Vite 是一个现代化的前端构建工具,它提供了一个极其快速的开发环境,并为生产环境打包您的代码。在使用 Laravel 构建应用程序时,您通常会使用 Vite 将应用程序的 CSS 和 JavaScript 文件打包成可用于生产环境的资产。

Laravel 通过提供官方插件和 Blade 指令来加载您的开发和生产资产,从而与 Vite 无缝集成。

安装与设置

以下文档讨论了如何手动安装和配置 Laravel Vite 插件。然而,Laravel 的 入门套件 已经包含了所有这些脚手架,并且是开始使用 Laravel 和 Vite 的最快方式。

安装 Node

在运行 Vite 和 Laravel 插件之前,您必须确保已安装 Node.js (16+) 和 NPM:

node -v
npm -v

您可以使用来自 官方 Node 网站 的简单图形安装程序轻松安装最新版本的 Node 和 NPM。或者,如果您使用 Laravel Sail,您可以通过 Sail 调用 Node 和 NPM:

./vendor/bin/sail node -v
./vendor/bin/sail npm -v

安装 Vite 和 Laravel 插件

在全新安装的 Laravel 中,您会在应用程序目录结构的根目录中找到一个 package.json 文件。默认的 package.json 文件已经包含了您开始使用 Vite 和 Laravel 插件所需的一切。您可以通过 NPM 安装应用程序的前端依赖项:

npm install

配置 Vite

Vite 通过项目根目录中的 vite.config.js 文件进行配置。您可以根据需要自由定制此文件,也可以安装应用程序所需的任何其他插件,例如 @vitejs/plugin-vue@vitejs/plugin-react

Laravel Vite 插件要求您指定应用程序的入口点。这些可以是 JavaScript 或 CSS 文件,并包括预处理语言,例如 TypeScript、JSX、TSX 和 Sass。

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel([
            'resources/css/app.css',
            'resources/js/app.js',
        ]),
    ],
});

如果您正在构建一个 SPA,包括使用 Inertia 构建的应用程序,Vite 在没有 CSS 入口点的情况下工作得最好:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel([
            'resources/css/app.css',
            'resources/js/app.js',
        ]),
    ],
});

相反,您应该通过 JavaScript 导入您的 CSS。通常,这会在应用程序的 resources/js/app.js 文件中完成:

import './bootstrap';
import '../css/app.css';

Laravel 插件还支持多个入口点和高级配置选项,例如 SSR 入口点

使用安全的开发服务器

如果您的本地开发 Web 服务器通过 HTTPS 为您的应用程序提供服务,您可能会遇到连接到 Vite 开发服务器的问题。

如果您使用 Laravel Herd 并已保护站点,或者您使用 Laravel Valet 并已对您的应用程序运行 secure 命令,Laravel Vite 插件将自动为您检测和使用生成的 TLS 证书。

如果您使用与应用程序目录名称不匹配的主机来保护站点,您可以在应用程序的 vite.config.js 文件中手动指定主机:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            // ...
            detectTls: 'my-app.test',
        }),
    ],
});

当使用另一个 Web 服务器时,您应该生成一个受信任的证书并手动配置 Vite 以使用生成的证书:

// ...
import fs from 'fs';

const host = 'my-app.test';

export default defineConfig({
    // ...
    server: {
        host,
        hmr: { host },
        https: {
            key: fs.readFileSync(`/path/to/${host}.key`),
            cert: fs.readFileSync(`/path/to/${host}.crt`),
        },
    },
});

如果您无法为您的系统生成受信任的证书,您可以安装和配置 @vitejs/plugin-basic-ssl 插件。当使用不受信任的证书时,您需要在浏览器中接受 Vite 开发服务器的证书警告,方法是在运行 npm run dev 命令时按照控制台中的“本地”链接进行操作。

在 WSL2 上的 Sail 中运行开发服务器

当在 Windows Subsystem for Linux 2 (WSL2) 上的 Laravel Sail 中运行 Vite 开发服务器时,您应该将以下配置添加到您的 vite.config.js 文件中,以确保浏览器可以与开发服务器通信:

// ...

export default defineConfig({
    // ...
    server: {
        hmr: {
            host: 'localhost',
        },
    },
});

如果您的文件更改在开发服务器运行时未反映在浏览器中,您可能还需要配置 Vite 的 server.watch.usePolling 选项

加载您的脚本和样式

配置好 Vite 入口点后,您现在可以在 @vite() Blade 指令中引用它们,并将其添加到应用程序根模板的 <head> 中:

<!DOCTYPE html>
<head>
    {{-- ... --}}

    @vite(['resources/css/app.css', 'resources/js/app.js'])
</head>

如果您通过 JavaScript 导入 CSS,则只需包含 JavaScript 入口点:

<!DOCTYPE html>
<head>
    {{-- ... --}}

    @vite('resources/js/app.js')
</head>

@vite 指令将自动检测 Vite 开发服务器并注入 Vite 客户端以启用热模块更换。在构建模式下,该指令将加载您的已编译和版本化的资产,包括任何导入的 CSS。

如果需要,您还可以在调用 @vite 指令时指定已编译资产的构建路径:

<!doctype html>
<head>
    {{-- 给定的构建路径是相对于公共路径的。 --}}

    @vite('resources/js/app.js', 'vendor/courier/build')
</head>

内联资产

有时可能需要包含资产的原始内容,而不是链接到资产的版本化 URL。例如,当将 HTML 内容传递给 PDF 生成器时,您可能需要将资产内容直接包含在页面中。您可以使用 Vite facade 提供的 content 方法输出 Vite 资产的内容:

@use('Illuminate\Support\Facades\Vite')

<!doctype html>
<head>
    {{-- ... --}}

    <style>
        {!! Vite::content('resources/css/app.css') !!}
    </style>
    <script>
        {!! Vite::content('resources/js/app.js') !!}
    </script>
</head>

运行 Vite

运行 Vite 有两种方法。您可以通过 dev 命令运行开发服务器,这在本地开发时很有用。开发服务器将自动检测您对文件的更改并立即将其反映在任何打开的浏览器窗口中。

或者,运行 build 命令将对应用程序的资产进行版本控制和打包,并为部署到生产环境做好准备:

# 运行 Vite 开发服务器...
npm run dev

# 为生产环境构建和版本化资产...
npm run build

如果您在 WSL2 上的 Sail 中运行开发服务器,您可能需要一些 额外配置 选项。

使用 JavaScript

别名

默认情况下,Laravel 插件提供了一个常见的别名,可帮助您快速入门并方便地导入应用程序的资产:

{
    "@" => "/resources/js"
}

您可以通过在 vite.config.js 配置文件中添加自己的别名来覆盖 @ 别名:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel(['resources/ts/app.tsx']),
    ],
    resolve: {
        alias: {
            '@': '/resources/ts',
        },
    },
});

Vue

如果您想使用 Vue 框架构建前端,那么您还需要安装 @vitejs/plugin-vue 插件:

npm install --save-dev @vitejs/plugin-vue

然后,您可以将插件包含在您的 vite.config.js 配置文件中。将 Vue 插件与 Laravel 一起使用时,您需要一些额外的选项:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';
import vue from '@vitejs/plugin-vue';

export default defineConfig({
    plugins: [
        laravel(['resources/js/app.js']),
        vue({
            template: {
                transformAssetUrls: {
                    // Vue 插件将重写资产 URL,当在单文件组件中引用时,
                    // 以指向 Laravel Web 服务器。将其设置为 `null` 允许
                    // Laravel 插件转而将资产 URL 重写为指向 Vite
                    // 服务器。
                    base: null,

                    // Vue 插件将解析绝对 URL 并将其视为磁盘上文件的绝对路径。
                    // 将其设置为 `false` 将使绝对 URL 保持不变,
                    // 以便它们可以按预期引用公共目录中的资产。
                    includeAbsolute: false,
                },
            },
        }),
    ],
});
Laravel 的 入门套件 已经包含了正确的 Laravel、Vue 和 Vite 配置。这些入门套件提供了开始使用 Laravel、Vue 和 Vite 的最快方式。

React

如果您想使用 React 框架构建前端,那么您还需要安装 @vitejs/plugin-react 插件:

npm install --save-dev @vitejs/plugin-react

然后,您可以将插件包含在您的 vite.config.js 配置文件中:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';
import react from '@vitejs/plugin-react';

export default defineConfig({
    plugins: [
        laravel(['resources/js/app.jsx']),
        react(),
    ],
});

您需要确保任何包含 JSX 的文件都具有 .jsx.tsx 扩展名,并记住在需要时更新您的入口点,如上所示。

您还需要在现有 @vite 指令旁边包含额外的 @viteReactRefresh Blade 指令。

@viteReactRefresh
@vite('resources/js/app.jsx')

@viteReactRefresh 指令必须在 @vite 指令之前调用。

Laravel 的 入门套件 已经包含了正确的 Laravel、React 和 Vite 配置。这些入门套件提供了开始使用 Laravel、React 和 Vite 的最快方式。

Inertia

Laravel Vite 插件提供了一个方便的 resolvePageComponent 函数来帮助您解析您的 Inertia 页面组件。以下是该助手与 Vue 3 一起使用的示例;但是,您也可以在 React 等其他框架中使用该函数:

import { createApp, h } from 'vue';
import { createInertiaApp } from '@inertiajs/vue3';
import { resolvePageComponent } from 'laravel-vite-plugin/inertia-helpers';

createInertiaApp({
  resolve: (name) => resolvePageComponent(`./Pages/${name}.vue`, import.meta.glob('./Pages/**/*.vue')),
  setup({ el, App, props, plugin }) {
    createApp({ render: () => h(App, props) })
      .use(plugin)
      .mount(el)
  },
});

如果您将 Vite 的代码拆分功能与 Inertia 一起使用,我们建议配置 资产预取

Laravel 的 入门套件 已经包含了正确的 Laravel、Inertia 和 Vite 配置。这些入门套件提供了开始使用 Laravel、Inertia 和 Vite 的最快方式。

URL 处理

在使用 Vite 并引用应用程序的 HTML、CSS 或 JS 中的资产时,需要考虑一些注意事项。首先,如果您使用绝对路径引用资产,Vite 将不会在构建中包含该资产;因此,您应该确保该资产在您的公共目录中可用。当使用 专用的 CSS 入口点 时,您应该避免使用绝对路径,因为在开发期间,浏览器会尝试从 Vite 开发服务器(托管 CSS 的地方)而不是您的公共目录加载这些路径。

当引用相对资产路径时,您应该记住路径是相对于引用它们的文件。通过相对路径引用的任何资产都将被 Vite 重写、版本化和打包。

考虑以下项目结构:

public/
  taylor.png
resources/
  js/
    Pages/
      Welcome.vue
  images/
    abigail.png

以下示例演示了 Vite 将如何处理相对和绝对 URL:

<!-- This asset is not handled by Vite and will not be included in the build -->
<img src="/taylor.png">

<!-- This asset will be re-written, versioned, and bundled by Vite -->
<img src="../../images/abigail.png">

使用样式表

Laravel 的 入门套件 已经包含了正确的 Tailwind 和 Vite 配置。或者,如果您想在不使用我们的任何入门套件的情况下使用 Tailwind 和 Laravel,请查看 Tailwind 的 Laravel 安装指南

所有 Laravel 应用程序都已包含 Tailwind 和正确配置的 vite.config.js 文件。因此,您只需要启动 Vite 开发服务器或运行 dev Composer 命令,它将启动 Laravel 和 Vite 开发服务器:

composer run dev

应用程序的 CSS 可以放在 resources/css/app.css 文件中。

使用 Blade 和路由

使用 Vite 处理静态资产

当在 JavaScript 或 CSS 中引用资产时,Vite 会自动处理和版本化它们。此外,在构建基于 Blade 的应用程序时,Vite 还可以处理和版本化您仅在 Blade 模板中引用的静态资产。

然而,为了实现这一点,您需要通过将静态资产导入到应用程序的入口点来让 Vite 知道您的资产。例如,如果您想处理和版本化存储在 resources/images 中的所有图像和存储在 resources/fonts 中的所有字体,您应该在应用程序的 resources/js/app.js 入口点中添加以下内容:

import.meta.glob([
  '../images/**',
  '../fonts/**',
]);

现在,当运行 npm run build 时,这些资产将由 Vite 处理。然后,您可以使用 Vite::asset 方法在 Blade 模板中引用这些资产,该方法将返回给定资产的版本化 URL:

<img src="{{ Vite::asset('resources/images/logo.png') }}">

保存时刷新

当您的应用程序使用带有 Blade 的传统服务器端渲染构建时,当您对应用程序中的视图文件进行更改时,Vite 可以通过自动刷新浏览器来改善您的开发工作流。要开始,您可以简单地将 refresh 选项指定为 true

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            // ...
            refresh: true,
        }),
    ],
});

refresh 选项为 true 时,在您运行 npm run dev 期间,保存以下目录中的文件将触发浏览器执行完整的页面刷新:

  • app/Livewire/**
  • app/View/Components/**
  • lang/**
  • resources/lang/**
  • resources/views/**
  • routes/**

如果您正在利用 Ziggy 在应用程序的前端生成路由链接,那么监视 routes/** 目录会很有用。

如果这些默认路径不适合您的需要,您可以指定自己的要监视的路径列表:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            // ...
            refresh: ['resources/views/**'],
        }),
    ],
});

在底层,Laravel Vite 插件使用 vite-plugin-full-reload 包,它提供了一些高级配置选项来微调此功能的行为。如果您需要这种级别的自定义,您可以提供一个 config 定义:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            // ...
            refresh: [{
                paths: ['path/to/watch/**'],
                config: { delay: 300 }
            }],
        }),
    ],
});

别名

在 JavaScript 应用程序中,创建别名 以引用经常引用的目录是很常见的。但是,您也可以通过使用 Illuminate\Support\Facades\Vite 类上的 macro 方法来创建在 Blade 中使用的别名。通常,“宏”应该在 服务提供者boot 方法中定义:

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Vite::macro('image', fn (string $asset) => $this->asset("resources/images/{$asset}"));
}

定义宏后,可以在模板中调用它。例如,我们可以使用上面定义的 image 宏来引用位于 resources/images/logo.png 的资产:

<img src="{{ Vite::image('logo.png') }}" alt="Laravel Logo">

资产预取

当使用 Vite 的代码拆分功能构建 SPA 时,在每次页面导航时都会获取所需的资产。这种行为可能会导致 UI 渲染延迟。如果这是您选择的前端框架的问题,Laravel 提供了在初始页面加载时预先获取应用程序的 JavaScript 和 CSS 资产的功能。

您可以通过在 服务提供者boot 方法中调用 Vite::prefetch 方法来指示 Laravel 预先获取您的资产:

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Vite;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Vite::prefetch(concurrency: 3);
    }
}

在上面的示例中,在每次页面加载时,资产将以最多 3 个并发下载进行预取。您可以修改并发以适应您应用程序的需求,或者如果不应限制应用程序一次下载所有资产,则不指定并发限制:

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Vite::prefetch();
}

默认情况下,预取将在 page load event 触发时开始。如果您想自定义预取何时开始,您可以指定 Vite 将侦听的事件:

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Vite::prefetch(event: 'vite:prefetch');
}

给定上面的代码,现在当您手动在 window 对象上调度 vite:prefetch 事件时,预取将开始。例如,您可以在页面加载三秒后开始预取:

<script>
    addEventListener('load', () => setTimeout(() => {
        dispatchEvent(new Event('vite:prefetch'))
    }, 3000))
</script>

自定义基本 URL

如果您的 Vite 编译资产部署到与您的应用程序分离的域,例如通过 CDN,您必须在应用程序的 .env 文件中指定 ASSET_URL 环境变量:

ASSET_URL=https://cdn.example.com

配置资产 URL 后,所有重写到您的资产的 URL 都将以配置的值为前缀:

https://cdn.example.com/build/assets/app.9dce8d17.js

请记住,绝对 URL 不会由 Vite 重写,因此它们不会被添加前缀。

环境变量

您可以通过在应用程序的 .env 文件中以 VITE_ 为前缀将环境变量注入到您的 JavaScript 中:

VITE_SENTRY_DSN_PUBLIC=http://example.com

您可以通过 import.meta.env 对象访问注入的环境变量:

import.meta.env.VITE_SENTRY_DSN_PUBLIC

在测试中禁用 Vite

Laravel 的 Vite 集成将在运行测试时尝试解析您的资产,这要求您要么运行 Vite 开发服务器,要么构建您的资产。

如果您希望在测试期间模拟 Vite,您可以调用 withoutVite 方法,该方法可用于扩展 Laravel 的 TestCase 类的任何测试:

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_without_vite_example(): void
    {
        $this->withoutVite();

        // ...
    }
}

如果您想为所有测试禁用 Vite,您可以从您的基本 TestCase 类上的 setUp 方法中调用 withoutVite 方法:

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        $this->withoutVite();
    }
}

服务器端渲染 (SSR)

Laravel Vite 插件可以轻松地使用 Vite 设置服务器端渲染。首先,在 resources/js/ssr.js 创建一个 SSR 入口点,并通过将配置选项传递给 Laravel 插件来指定入口点:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            input: 'resources/js/app.js',
            ssr: 'resources/js/ssr.js',
        }),
    ],
});

为了确保您不会忘记重建 SSR 入口点,我们建议您增加应用程序的 package.json 中的“build”脚本以创建您的 SSR 构建:

"scripts": {
     "dev": "vite",
     "build": "vite build" 
     "build": "vite build && vite build --ssr" 
}

然后,要构建和启动 SSR 服务器,您可以运行以下命令:

npm run build
node bootstrap/ssr/ssr.js

如果您将 SSR 与 Inertia 一起使用,您可以改用 inertia:start-ssr Artisan 命令来启动 SSR 服务器:

php artisan inertia:start-ssr
Laravel 的 入门套件 已经包含了正确的 Laravel、Inertia SSR 和 Vite 配置。这些入门套件提供了开始使用 Laravel、Inertia SSR 和 Vite 的最快方式。

脚本和样式标签属性

内容安全策略 (CSP) Nonce

如果您希望在您的脚本和样式标签上包含 nonce 属性 作为您的 内容安全策略 的一部分,您可以在自定义 中间件 中使用 useCspNonce 方法生成或指定 nonce:

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Vite;
use Symfony\Component\HttpFoundation\Response;

class AddContentSecurityPolicyHeaders
{
    /**
     * Handle an incoming request.
     *
     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
     */
    public function handle(Request $request, Closure $next): Response
    {
        Vite::useCspNonce();

        return $next($request)->withHeaders([
            'Content-Security-Policy' => "script-src 'nonce-".Vite::cspNonce()."'",
        ]);
    }
}

调用 useCspNonce 方法后,Laravel 将自动在所有生成的脚本和样式标签上包含 nonce 属性。

如果您需要在其他地方指定 nonce,包括 Laravel 的 入门套件 中包含的 Ziggy @route 指令,您可以使用 cspNonce 方法检索它:

@routes(nonce: Vite::cspNonce())

如果您已经有您想指示 Laravel 使用的 nonce,您可以将 nonce 传递给 useCspNonce 方法:

Vite::useCspNonce($nonce);

子资源完整性 (SRI)

如果您的 Vite 清单包含您的资产的 integrity 哈希,Laravel 将自动在它生成的任何脚本和样式标签上添加 integrity 属性,以强制执行 子资源完整性。默认情况下,Vite 不在其清单中包含 integrity 哈希,但您可以通过安装 vite-plugin-manifest-sri NPM 插件来启用它:

npm install --save-dev vite-plugin-manifest-sri

然后,您可以在 vite.config.js 文件中启用此插件:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';
import manifestSRI from 'vite-plugin-manifest-sri';

export default defineConfig({
    plugins: [
        laravel({
            // ...
        }),
        manifestSRI(),
    ],
});

如果需要,您还可以自定义可以找到 integrity 哈希的清单键:

use Illuminate\Support\Facades\Vite;

Vite::useIntegrityKey('custom-integrity-key');

如果您想完全禁用此自动检测,您可以将 false 传递给 useIntegrityKey 方法:

Vite::useIntegrityKey(false);

任意属性

如果您需要在脚本和样式标签上包含额外的属性,例如 data-turbo-track 属性,您可以通过 useScriptTagAttributesuseStyleTagAttributes 方法指定它们。通常,此方法应从 服务提供者 中调用:

use Illuminate\Support\Facades\Vite;

Vite::useScriptTagAttributes([
    'data-turbo-track' => 'reload', // 为属性指定一个值...
    'async' => true, // 指定一个没有值的属性...
    'integrity' => false, // 排除一个本应包含的属性...
]);

Vite::useStyleTagAttributes([
    'data-turbo-track' => 'reload',
]);

如果您需要有条件地添加属性,您可以传递一个回调,该回调将接收资产源路径、其 URL、其清单块和整个清单:

use Illuminate\Support\Facades\Vite;

Vite::useScriptTagAttributes(fn (string $src, string $url, array|null $chunk, array|null $manifest) => [
    'data-turbo-track' => $src === 'resources/js/app.js' ? 'reload' : false,
]);

Vite::useStyleTagAttributes(fn (string $src, string $url, array|null $chunk, array|null $manifest) => [
    'data-turbo-track' => $chunk && $chunk['isEntry'] ? 'reload' : false,
]);
在 Vite 开发服务器运行时,$chunk$manifest 参数将为 null

高级自定义

开箱即用,Laravel 的 Vite 插件使用合理的约定,应该适用于大多数应用程序;但是,有时您可能需要自定义 Vite 的行为。为了启用额外的自定义选项,我们提供以下方法和选项,可以代替 @vite Blade 指令使用:

<!doctype html>
<head>
    {{-- ... --}}

    {{
        Vite::useHotFile(storage_path('vite.hot')) // 自定义“hot”文件...
            ->useBuildDirectory('bundle') // 自定义构建目录...
            ->useManifestFilename('assets.json') // 自定义清单文件名...
            ->withEntryPoints(['resources/js/app.js']) // 指定入口点...
            ->createAssetPathsUsing(function (string $path, ?bool $secure) { // 自定义内置资产的后端路径生成...
                return "https://cdn.example.com/{$path}";
            })
    }}
</head>

vite.config.js 文件中,您应该指定相同的配置:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            hotFile: 'storage/vite.hot', // 自定义“hot”文件...
            buildDirectory: 'bundle', // 自定义构建目录...
            input: ['resources/js/app.js'], // 指定入口点...
        }),
    ],
    build: {
      manifest: 'assets.json', // 自定义清单文件名...
    },
});

开发服务器跨域资源共享 (CORS)

如果您在从 Vite 开发服务器获取资产时遇到浏览器中的跨域资源共享 (CORS) 问题,您可能需要授予自定义源对开发服务器的访问权限。Vite 与 Laravel 插件结合使用,无需任何额外配置即可允许以下来源:

  • ::1
  • 127.0.0.1
  • localhost
  • *.test
  • *.localhost
  • 项目中 .env 中的 APP_URL

允许您的项目使用自定义来源的最简单方法是确保您的应用程序的 APP_URL 环境变量与您在浏览器中访问的来源匹配。例如,如果您访问 https://my-app.laravel,您应该更新您的 .env 以匹配:

APP_URL=https://my-app.laravel

如果您需要对来源进行更精细的控制,例如支持多个来源,您应该利用 Vite 全面而灵活的内置 CORS 服务器配置。例如,您可以在项目的 vite.config.js 文件中的 server.cors.origin 配置选项中指定多个来源:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            input: 'resources/js/app.js',
            refresh: true,
        }),
    ],
    server: {  
        cors: {  
            origin: [  
                'https://backend.laravel',  
                'http://admin.laravel:8566',  
            ],  
        },  
    },  
});

您还可以包含正则表达式模式,如果您想允许给定顶级域的所有来源,例如 *.laravel,这会很有帮助:

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';

export default defineConfig({
    plugins: [
        laravel({
            input: 'resources/js/app.js',
            refresh: true,
        }),
    ],
    server: {  
        cors: {  
            origin: [ 
                // 支持: SCHEME://DOMAIN.laravel[:PORT] 
                /^https?:\/\/.*\.laravel(:\d+)?$/, 
            ], 
        }, 
    }, 
});

纠正开发服务器 URL

Vite 生态系统中的某些插件假定以斜杠开头的 URL 总是指向 Vite 开发服务器。然而,由于 Laravel 集成的性质,情况并非如此。

例如,vite-imagetools 插件在 Vite 提供资产时输出如下所示的 URL:

<img src="/@imagetools/f0b2f404b13f052c604e632f2fb60381bf61a520">

vite-imagetools 插件期望输出的 URL 将被 Vite 拦截,然后该插件可以处理所有以 /@imagetools 开头的 URL。如果您使用的插件期望此行为,则需要手动纠正 URL。您可以在 vite.config.js 文件中使用 transformOnServe 选项来执行此操作。

在这个特定示例中,我们将开发服务器 URL 前置到生成的代码中所有出现的 /@imagetools

import { defineConfig } from 'vite';
import laravel from 'laravel-vite-plugin';
import { imagetools } from 'vite-imagetools';

export default defineConfig({
    plugins: [
        laravel({
            // ...
            transformOnServe: (code, devServerUrl) => code.replaceAll('/@imagetools', devServerUrl+'/@imagetools'),
        }),
        imagetools(),
    ],
});

现在,当 Vite 提供资产时,它将输出指向 Vite 开发服务器的 URL:

- <img src="/@imagetools/f0b2f404b13f052c604e632f2fb60381bf61a520">
+ <img src="http://[::1]:5173/@imagetools/f0b2f404b13f052c604e632f2fb60381bf61a520">