|
| 1 | +# HMR `hotUpdate` Plugin Hook |
| 2 | + |
| 3 | +::: tip Feedback |
| 4 | +Geben Sie uns Rückmeldungen in der ["Environment API Feedback"-Diskussion](https://github.com/vitejs/vite/discussions/16358) |
| 5 | +::: |
| 6 | + |
| 7 | +Wir planen, den Plugin-Hook `handleHotUpdate` zugunsten des Hooks `hotUpdate` zu verwerfen, um Environment API-kompatibel zu sein und zusätzliche Überwachungsereignisse mit `create` und `delete` zu verarbeiten. |
| 8 | + |
| 9 | +Betroffener Bereich: `Vite Plugin-Authoren` |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +::: warning Future Deprecation |
| 14 | +`hotUpdate` wurde zum ersten Mal in `v6.0` eingeführt. Die Veraltung von `handleHotUpdate` ist für eine zukünftige Hauptversion geplant. Wir empfehlen, vorerst noch nicht von `handleHotUpdate` abzuweichen. Wenn Sie herumexperimentieren möchten, können Sie gerne die `future.removePluginHookHandleHotUpdate` in Ihrer Vite-Konfiguration auf `"warn"` setzen und uns Feedback geben. |
| 15 | +::: |
| 16 | + |
| 17 | +## Motivation |
| 18 | + |
| 19 | +Die [`handleHotUpdate`-Hook](/guide/api-plugin.md#handlehotupdate) erlaubt eine benutzerdefinierte Behandlung von HMR Updates. Eine Liste der zu aktualisierenden Module wird im `HmrContext` angegeben. |
| 20 | + |
| 21 | +```ts |
| 22 | +interface HmrContext { |
| 23 | + file: string |
| 24 | + timestamp: number |
| 25 | + modules: Array<ModuleNode> |
| 26 | + read: () => string | Promise<string> |
| 27 | + server: ViteDevServer |
| 28 | +} |
| 29 | +``` |
| 30 | + |
| 31 | +Dieser Hook wird einmal für alle Umgebungen aufgerufen, und die übergebenen Module enthalten ausschließlich gemischte Informationen aus der Client- und der SSR-Umgebung. Sobald Frameworks zu benutzerdefinierten Umgebungen wechseln, wird für jede von ihnen eine neue Hook benötigt. |
| 32 | + |
| 33 | +Die neue `hotUpdate`-Hook funktioniert gleichartig wie `handleHotUpdate`, aber sie wird für jede Umgebung aufgerufen und erhält eine neue `HotUpdateOptions`-Instanz: |
| 34 | + |
| 35 | +```ts |
| 36 | +interface HotUpdateOptions { |
| 37 | + type: 'create' | 'update' | 'delete' |
| 38 | + file: string |
| 39 | + timestamp: number |
| 40 | + modules: Array<EnvironmentModuleNode> |
| 41 | + read: () => string | Promise<string> |
| 42 | + server: ViteDevServer |
| 43 | +} |
| 44 | +``` |
| 45 | + |
| 46 | +Auf die aktuelle Entwicklungsumgebung kann, wie in anderen Plugin-Hooks, mit `this.environment` zugegriffen werden. Die `modules`-Liste wird von nun an nur noch Modulknoten aus der aktuellen Umgebung enthalten. Jedes Umgebungsupdate kann unterschiedliche Strategien zur Aktualisierung festlegen. |
| 47 | + |
| 48 | +Diese Hook wird nun auch für zusätzliche "watch"-Events aufgerufen und nicht nur für `'update'`. Verwenden Sie `type`, um zwischen ihnen zu unterscheiden. |
| 49 | + |
| 50 | +## Migrationsleitfaden |
| 51 | + |
| 52 | +Filtern und Einschränken der Liste der betroffenen Module, damit HMR präziser ist. |
| 53 | + |
| 54 | +```js |
| 55 | +handleHotUpdate({ modules }) { |
| 56 | + return modules.filter(condition) |
| 57 | +} |
| 58 | + |
| 59 | +// Migration zu: |
| 60 | + |
| 61 | +hotUpdate({ modules }) { |
| 62 | + return modules.filter(condition) |
| 63 | +} |
| 64 | +``` |
| 65 | + |
| 66 | +Zurückgeben eines leeren Arrays, damit ein komplettes Neuladen stattfindet: |
| 67 | + |
| 68 | +```js |
| 69 | +handleHotUpdate({ server, modules, timestamp }) { |
| 70 | + // Module manuell ungültig machen |
| 71 | + const invalidatedModules = new Set() |
| 72 | + for (const mod of modules) { |
| 73 | + server.moduleGraph.invalidateModule( |
| 74 | + mod, |
| 75 | + invalidatedModules, |
| 76 | + timestamp, |
| 77 | + true |
| 78 | + ) |
| 79 | + } |
| 80 | + server.ws.send({ type: 'full-reload' }) |
| 81 | + return [] |
| 82 | +} |
| 83 | + |
| 84 | +// Migration zu: |
| 85 | + |
| 86 | +hotUpdate({ modules, timestamp }) { |
| 87 | + // Invalidate modules manually |
| 88 | + const invalidatedModules = new Set() |
| 89 | + for (const mod of modules) { |
| 90 | + this.environment.moduleGraph.invalidateModule( |
| 91 | + mod, |
| 92 | + invalidatedModules, |
| 93 | + timestamp, |
| 94 | + true |
| 95 | + ) |
| 96 | + } |
| 97 | + this.environment.hot.send({ type: 'full-reload' }) |
| 98 | + return [] |
| 99 | +} |
| 100 | +``` |
| 101 | + |
| 102 | +Zurückgeben eines leeren Arrays und durchführen einer kompletten, benutzerdefinierten HMR-Behandlung durch das Versenden von benutzerdefinierten Events zum Client: |
| 103 | + |
| 104 | +```js |
| 105 | +handleHotUpdate({ server }) { |
| 106 | + server.ws.send({ |
| 107 | + type: 'custom', |
| 108 | + event: 'special-update', |
| 109 | + data: {} |
| 110 | + }) |
| 111 | + return [] |
| 112 | +} |
| 113 | + |
| 114 | +// Migration zu... |
| 115 | + |
| 116 | +hotUpdate() { |
| 117 | + this.environment.hot.send({ |
| 118 | + type: 'custom', |
| 119 | + event: 'special-update', |
| 120 | + data: {} |
| 121 | + }) |
| 122 | + return [] |
| 123 | +} |
| 124 | +``` |
0 commit comments