使用client-only 解决组件不兼容SSR问题-编程知识

使用client-only 解决组件不兼容SSR问题

前言

一、解决方案

1.基于Nuxt 框架的SSR应用

2.基于vue2框架的应用

3.基于vue3框架的应用

二、总结

往期回顾

前言

最近在我的单页面SSR应用上开发JSON编辑器功能，在引入组件后直接客户端跳转OK，但是在直接加载服务端渲染的时候一直报这个错误：[vite] Error when evaluating SSR module /node_modules/json-editor-vue3/lib/json-editor.vue: failed to import "jsoneditor"

经过查阅资料才知道是组件不兼容SSR，下面我总结了下该问题的解决方案，希望能帮到大家！

一、解决方案

1.基于`Nuxt` 框架的SSR应用

Nuxt框架提供了client-only插件来解决这个问题。

npm：https://www.npmjs.com/package/client-only

SSR场景下只需要将组件包裹起来就ok啦！

2.基于vue2框架的应用

Vue2提供了vue-client-only插件来解决这个问题。

npm：https://www.npmjs.com/package/vue-client-only

那么怎么使用呢？

插件安装

yarn add vue-client-only

模板使用

<template><div id="app"><h1>My Website</h1><client-only><!-- this component will only be rendered on client-side --><comments /></client-only></div>
</template><script>import ClientOnly from 'vue-client-only'export default {components: {ClientOnly}}
</script>

注意：这个是基于vue2的插件，vue3可能不适用。

3.基于vue3框架的应用

vue3有大神解决了vue不兼容的问题。使用@duannx/vue-client-only插件来修复。

npm：https://www.npmjs.com/package/@duannx/vue-client-only

插件安装

npm install --save @duannx/vue-client-only
or
yarn add @duannx/vue-client-only

模板使用

<template><client-only><json-editor-vuev-model="resultInfo":show-btns="false":mode="'tree'"lang="zh":expanded-on-start="true"@json-change="onJsonChange" @json-save="onJsonSave"/></client-only>
</template><script lang="ts">
import ClientOnly from '@duannx/vue-client-only';
import JsonEditorVue from 'json-editor-vue3';
export default defineComponent({name: 'JsonFormat',components:{JsonEditorVue,ClientOnly},setup() {// json编辑器内容变化const onJsonChange = (value:any) => {console.log('value:', value);};// json编辑器内容保存const onJsonSave = (value:any) => {console.log('value:', value);};// 返回return {onJsonChange,onJsonSave,// 在data中添加测试数据resultInfo: {'test1': '1234','test2': '5678'}};}
});
</script>