VUE 3搭配PINIA的踩坑有感

7,945 阅读4分钟

前言

最近接手了一个新项目,用的是VUE3+pinia的组合。由于之前没有用过这2个库,只能现学现做。幸运的是这两者的上手难度都不大,项目可以正常开发。但这其中也遇到了一些坑,今天就来讲其中我印象最深的一个。

An Object could not be cloned?

不知道有多少开发者遇到过这个报错——An Object could not be cloned

本人这里是一个electron项目,在使用ipcRenderer.invoke通讯时传入了一个对象,就抛出了这个错了。把传入的对象打印出来,发现对象里有字段被转成了proxy对象,估计就是在ipcRenderer.invoke处理proxy的时候无法处理,因此报错。

VUE 3的toRaw

我们都知道VUE 3 相比VUE 2在响应式数据的处理上有着巨大的改动,从2的Object.defineProperty到3的proxy。而为了让用户可以自行选择是否使用响应式,VUE 3提供了 reactive,ref等API。在把数据转成响应式之后,数据就已经被VUE修改成一个新的对象了,通过打印我们可以看到。

const obj = reactive({ a: 1, b: 2 });
console.log(obj);

当然为了避免上述我遇到的这类问题,VUE 3提供了一个API让用户可以把proxy对象转回原生的对象。这个API就是toRaw()。

const obj = reactive({ a: 1, b: 2 });
console.log(obj);
console.log(toRaw(obj));

有了toRaw之后,理应不会遇到什么问题了。可是在我的场景里又有一个情况,就是混用了PINIA。

PINIA与VUE 3可以混合搭配?

PINIA是公认下一代的“VUEX”,同样有着与VUEX一样的特性——与VUE搭配使用会更加流程。但要注意的一点是,PINIA并不是VUE的专属,也就是说无论你开发的是什么项目,只要用到JavaScript你就可以用PINIA。也正因此如此,似乎与前面提到的一点是冲突的,这也出现在了我的项目中。

我们先来写一个简单的PINIA store

// store.js
export const useCounterStore = defineStore('counter', {
  state: () => {
    return {
      myData: {
        o1: {
          b: 2
        },
        a: 1
      }
    }
  },
  actions: {
    setMyData(data) {
      this.myData = { ...data };
    },
  },
})

然后在VUE中使用

import { useCounterStore } from "./stores/index.js";
const counter = useCounterStore();
const obj = reactive({ a: 1, b: 2 });

console.log(counter.myData);
counter.setMyData({newO:obj});
console.log(counter.myData);

打印出来的结果如下:

我们发现这个myData对象是一个proxy嵌套proxy的对象。当我们想要让他转成原生对象时,在VUE 3项目中很自然会想到用toRaw。

console.log('toRaw',toRaw(counter.myData))

可是打印出来的结果是没有把里面的proxy解开的。

正因为这样所以我得到了本文最开始提到的报错信息。

同样的操作在VUE 3下的结果

遇到这样的问题,我第一时间怀疑是不是因为我在用到 setMyData中用到了展开语法。那如果同样的写法在VUE3 可行吗?我们再来试一下:

const obj = reactive({ a: 1, b: 2 });
const obj2 = reactive({c:3,d:4});

obj2.d = {...obj};
console.log(obj2);

我们可以看到在VUE3中展开写法的赋值,并不会出现proxy嵌套的情况。说明VUE3在对自己的响应式数据赋值的时候是做了专门的处理的。因此我们可以得到一个简单的结论:PINIA与VUE3的搭配虽然在使用上可以很自然顺畅,但他们并不是天生一对的。PINIA在数据赋值的时候没有像VUE 3一样有针对VUE 3响应式数据的处理,同时VUE 3的toRaw也没有办法为PINIA的数据完美的还原。

最后的解决方式

说完了问题的原因,简单来提一下本文错误的解决方案。其实说到底我们的目标就是要得到一个“干净”的对象。我最后用是JSON.stringify()解决的,也说明了JSON.stringify的处理是可以解决proxy嵌套的。

console.log(counter.myData);
console.log(JSON.stringify(counter.myData));

当然我的同事用lodash的omit方法也可以解决,只是我觉得JSON.stringify会更加的“原生”。关于lodash的omit更多信息可以看:www.lodashjs.com/docs/lodash…

总结

相信并不是很多人会遇到我的这种情况,我也知道手上的项目代码中有很多可以优化的地方(我是中途加入这个项目的)。但本文想要分享的是在VUE 3搭配PINIA做项目开发的时候,有可能会遇到的问题。以及表明他们两并不是“天生一对”的,当然对于这个问题不知道后续会不会被优化。我个人是觉得如果把他们看作是两个独立的工具,其实这个并不是BUG,更多的是开发者的“一厢情愿”。

最后,希望本文可以帮助到一些开发者,在开发过程中避免掉坑。