Svelte igration 的经验和注意事项

我最近更新了一个相当复杂的网络应用程序。该应用具有 auth、Stripe、i18n、dark/light 模式、PWA 等功能。总体而言，它有大约 30 个页面和组件，几乎没有第三方 npm 包。

我想指出在将应用程序迁移到 Svelte 5 时我发现非常具有挑战性的事情。

自动迁移脚本锤

Svelte 提供的自动迁移脚本可以在终端 npx sv migrate svelte-5 中使用这个“one-liner”命令为您完成这项工作（在完成所有必要的更新并安装之后：“@sveltejs/vite -plugin-svelte”：“^4.0.0”和“svelte”：“^5”）。但我并不推荐这种“锤子”的做法。

使用 Ctrl Shift P (Windows/Linux) / Shift Command P (Mac) 逐个文件、逐个组件地进行操作，并使用 Migrate Component to Svelte 5 Syntax 命令而是使用 VS Code 命令面板。这样你就会有更多的控制权。

已弃用的 run() 惊喜

脚本无法创造奇迹。将反应式变量声明升级到 $state() 通常就可以了。但是，脚本可能很难检测 $: 是否应转换为 $driven()/$衍生.by(() => {}) 或 $effect(() => {})。

那么，你猜怎么着？使用自动迁移脚本，您最终可能会得到大量 run(() => {})。

例如，想象一个使用如下内容的简化示例：

<script>
...
   let notext = false;
   $: if (data.completeDoc == 'NoLangVersion') {
      notext = true;
   }
   $: if (data.completeDoc !== 'NoLangVersion') {
      notext = false;
   }
</script>

...
{#if notext}
   {data.userPrefferedLang.noTextWarning}
{:else}
...
{/if}
...

自动迁移脚本将为您提供：

<script>
    import { run } from 'svelte/legacy';
...
    let notext = $state(false);
    run(() => {
        if (data.completeDoc == 'NoLangVersion') {
            notext = true;
        }
    });
    run(() => {
        if (data.completeDoc !== 'NoLangVersion') {
            notext = false;
        }
    });
</script>

有一个很好的小警告，run 函数已被弃用。

我猜更好的 Svelte 5 代码是这样的：

<script>
...
    let notext = $derived.by(() => {
        if (data.completeDoc == 'NoLangVersion') {
            return  true;
        }
        if (data.completeDoc !== 'NoLangVersion') {
            return false;
        }
    });
...
</script>

或者如果你的代码并不复杂，即使是这样：

<script>
...
    let notext = $derived(
        data.completeDoc == 'NoLangVersion' 
        ? 
        true
        :
        false
        ) 
...
</script>

原因是脚本无法轻松地将代码转换为 $categories.by(() => {})，因此它希望使用更脏的方法 $effect()。但 $effect() 仅在客户端运行，因此脚本使用已弃用的 run 函数。

如果可以的话避免$效应

现在我们得到了最重要的结论。 $effect() 仅在客户端运行。所以服务器上没有 $effect()，用于预渲染页面和 SSR。

$effect() 不在服务器上运行！

Svelte 5 文档中应该强调这一点。

看这两个例子：

<script>
let a = 1
let b = 2

$: c = a + b
</script>

{c}  // server responds with c == 3

<script>
let a = $state(1)
let b = $state(2)
let c = $state(0)

$effect(() => {
  c = a + b
})
</script>

{c}  // server responds with c == 0

它们不一样。这带来了很多挑战。客户端在安装页面时需要重新评估 c 变量。从服务器发送的页面和最终在客户端上进行 DOM 渲染时的页面看起来会有所不同（SSR、SEO、闪烁问题等）。

因此，请始终尝试使用 $衍生或 $衍生.by(() => {}) 而不是 $effect()。这会帮你省去很多麻烦。

这与我们被劝阻不要在 SvelteKit 和 SSR 中使用商店时的情况完全相同。

SvelteKit 中的 $effect 与 onMount()

由于 Svelte 5 到来期间给出的示例，您可能会想用 $effect() 替换 SvelteKit 中的 onMount() 。由于已经提到的原因，我暂时不鼓励这样做。 onMount 仍然是核心 Svelte 生命周期挂钩。

$bindable $props 惊喜

另一个令人惊喜的地方是 Svelte 5 非常注意变量值的一致性。如果您将变量作为 prop 传递给组件，并稍后在组件中更改此变量，脚本将尝试使用 $bindable $prop 解决此不一致问题。应通知家长，以便您的应用程序状态保持一致。

看这个例子：

<script>
...
   let notext = false;
   $: if (data.completeDoc == 'NoLangVersion') {
      notext = true;
   }
   $: if (data.completeDoc !== 'NoLangVersion') {
      notext = false;
   }
</script>

...
{#if notext}
   {data.userPrefferedLang.noTextWarning}
{:else}
...
{/if}
...

自动迁移脚本将要求您使用具有绑定值的组件，以确保父级可以取回更新的值：

<script>
    import { run } from 'svelte/legacy';
...
    let notext = $state(false);
    run(() => {
        if (data.completeDoc == 'NoLangVersion') {
            notext = true;
        }
    });
    run(() => {
        if (data.completeDoc !== 'NoLangVersion') {
            notext = false;
        }
    });
</script>

但也许我们也可以使用更简单的方法，你猜对了，使用 $衍生():

<script>
...
    let notext = $derived.by(() => {
        if (data.completeDoc == 'NoLangVersion') {
            return  true;
        }
        if (data.completeDoc !== 'NoLangVersion') {
            return false;
        }
    });
...
</script>

:global { } 块

我在迁移过程中发现的一个非常好的功能是我们现在可以使用 CSS :global 和 block。例如，如果您想在 @html 中设置 HTML 元素的样式，则使用 :global 进行样式设置是非常必要的。

所以代替这个：

<script>
...
    let notext = $derived(
        data.completeDoc == 'NoLangVersion' 
        ? 
        true
        :
        false
        ) 
...
</script>

你可以使用这个：

<script>
let a = 1
let b = 2

$: c = a + b
</script>

{c}  // server responds with c == 3

样式作为组件中的道具

在 Svelte 4 中，如果您想提供 CSS 类作为组件的 prop，您可以使用 {$$props.class}:

<script>
let a = $state(1)
let b = $state(2)
let c = $state(0)

$effect(() => {
  c = a + b
})
</script>

{c}  // server responds with c == 0

在 Svelte 5 中你可以使用 class={className}:

// parent svelte file
<script>
   import ComponentBinded from './ComponentBinded.svelte';
   import ComponentWithDerived from './ComponentWithDerived.svelte';
   let name = $state('John Wick');
</script>

<p>Name value in parent: {name}</p>

<componentbinded bind:name="{name}"></componentbinded>

<componentwithderived></componentwithderived>

灯塔性能可能下降

当我使用自动合并脚本时，我对应用程序的性能下降感到震惊。有了 Svelte 4，我几乎获得了 100% 的成绩。直到我手动迁移并仔细考虑如何（主要是如果可能的话如何避免 $effect()）后，我的 Lighthouse 分数才再次回到绿色。

最后的话

迁移到 Svelte 5 的时间比我预期的要长。不过，我还没有将这个新版本投入生产。 Svelte 5 的更新频率仍然相当高。

希望我的经验对其他人有用。

以上是Svelte igration 的经验和注意事项的详细内容。更多信息请关注PHP中文网其他相关文章！