Skip to content

Beyond Fast

ViteConf 2023

Watch the replay!

Backend-Integration

HINWEIS

Wenn Sie die HTML-Dateien mit einem traditionellen Backend (z. B. Rails, Laravel) bereitstellen und gleichzeitig Vite zur Bereitstellung von Assets verwenden möchten, überprüfen Sie vorhandene Integrationen in Awesome Vite.

Wenn Sie eine benutzerdefinierte Integration benötigen, können Sie den Schritten in dieser Anleitung folgen, um sie manuell zu konfigurieren.

  1. In Ihrer Vite-Konfiguration konfigurieren Sie den Einstiegspunkt und aktivieren das Build-Manifest:

    js
    // vite.config.js
    export default defineConfig({
      build: {
        // generiert .vite/manifest.json in outDir
        manifest: true,
        rollupOptions: {
          // Überschreibe den Standard-.html-Einstieg
          input: '/path/to/main.js'
        }
      }
    })

    Wenn Sie das Module-Preload-Polyfill nicht deaktiviert haben, müssen Sie auch das Polyfill in Ihrem Einstiegspunkt importieren:

    js
    // am Anfang Ihres Anwendungseinstiegspunkts
    import 'vite/modulepreload-polyfill'
  2. Für die Entwicklung fügen Sie Folgendes in das HTML-Template Ihres Servers ein (ersetzen Sie http://localhost:5173 durch die lokale URL, unter der Vite ausgeführt wird):

    html
    <!-- wenn Entwicklung -->
    <script type="module" src="http://localhost:5173/@vite/client"></script>
    <script type="module" src="http://localhost:5173/main.js"></script>

    Um Assets ordnungsgemäß bereitzustellen, haben Sie zwei Optionen:

    • Stellen Sie sicher, dass der Server so konfiguriert ist, dass er Anfragen nach statischen Assets an den Vite-Server weiterleitet.
    • Legen Sie server.origin fest, damit generierte Asset-URLs mithilfe der URL des Backend-Servers anstelle eines relativen Pfads aufgelöst werden.

    Dies ist erforderlich, damit Assets wie Bilder ordnungsgemäß geladen werden.

    Beachten Sie, dass Sie, wenn Sie React mit @vitejs/plugin-react verwenden, dies auch vor den oben genannten Skripten hinzufügen müssen, da das Plugin nicht in der Lage ist, den von Ihnen bereitgestellten HTML-Code zu ändern (ersetzen Sie http://localhost:5173 durch die lokale URL, unter der Vite ausgeführt wird):

    html
    <script type="module">
      import RefreshRuntime from 'http://localhost:5173/@react-refresh'
      RefreshRuntime.injectIntoGlobalHook(window)
      window.$RefreshReg$ = () => {}
      window.$RefreshSig$ = () => (type) => type
      window.__vite_plugin_react_preamble_installed__ = true
    </script>
  3. Für die Produktion: Nach Ausführung von vite build wird eine Datei .vite/manifest.json neben anderen Asset-Dateien generiert. Eine Beispieldatei für das Manifest sieht so aus:

    json
    {
      "main.js": {
        "file": "assets/main.4889e940.js",
        "src": "main.js",
        "isEntry": true,
        "dynamicImports": ["views/foo.js"],
        "css": ["assets/main.b82dbe22.css"],
        "assets": ["assets/asset.0ab0f9cd.png"]
      },
      "views/foo.js": {
        "file": "assets/foo.869aea0d.js",
        "src": "views/foo.js",
        "isDynamicEntry": true,
        "imports": ["_shared.83069a53.js"]
      },
      "_shared.83069a53.js": {
        "file": "assets/shared.83069a53.js"
      }
    }
    • Das Manifest hat eine Struktur Record<Name, Chunk>.
    • Für Einstiegs- oder dynamische Einstiegschunks ist der Schlüssel der relative Quellpfad vom Projektstamm aus.
    • Für Nicht-Einstiegschunks ist der Schlüssel der Basename der generierten Datei mit einem _-Präfix.
    • Chunks enthalten Informationen zu ihren statischen und dynamischen Importen (beide sind Schlüssel, die auf den entsprechenden Chunk im Manifest verweisen), sowie ihre zugehörigen CSS- und Asset-Dateien (falls vorhanden).

    Sie können diese Datei verwenden, um Links oder Preload-Anweisungen mit gehashten Dateinamen zu generieren (Hinweis: Die hier gezeigte Syntax dient nur zur Erklärung, ersetzen Sie sie durch Ihre Server-Template-Sprache):

    html
    <!-- wenn Produktion -->
    <link rel="stylesheet" href="/assets/{{ manifest['main.js'].css }}" />
    <script type="module" src="/assets/{{ manifest['main.js'].file }}"></script>

Veröffentlicht unter der MIT-Lizenz. (a0fbd52a)