Vue3 响应式原理之 readonly

简介: readonly和 reactive 类似,只不过,readonly不需要进行依赖收集,并且不可被 set,我们只需要在 set 时报错即可

readonly


readonly和 reactive 类似,只不过,readonly不需要进行依赖收集,并且不可被 set,我们只需要在 set 时报错即可

仍然从测试用例入手

it("readonly", () => { 
  const original = { foo: 1, bar: { baz: 2 } };
  const wrapped = readonly(original);
  expect(wrapped).not.toBe(original);
  expect(wrapped.foo).toBe(1);
})
复制代码

讲一个对象 readonly 包装之后,值是一样的,但是对象的比较是不同的

export function readonly(raw: Record<any, any>) {
  return new Proxy(raw, {
    get: createGetter(true),
    set() {
      // readonly 不可 set, 抛出异常
      // TODO 自定义异常
      return true
    }
  })
}
复制代码

这里因为 get 的逻辑用到了两次,所以提取出来

function createGetter(isReadOnly: boolean = false) {
  return function get(target: Record<any, any>, key: string | symbol) {
    const res = Reflect.get(target, key);
    // 如果不是 readonly 收集依赖
    if (!isReadOnly)
      track(target, key);
    return res;
  }
}
复制代码

然后我们来完善 readonly set 时的报错

it("warn when set", () => {
  console.warn = jest.fn()
  const user = readonly({
    age: 10
  })
  // @ts-expect-error
  user.age = 11
  expect(console.warn).toBeCalled()
})
复制代码

在 readonly 被 set 时调用 console.warn

export const readonlyHandlers = {
  get: readonlyGet, // 将原来的creater 提取出去
  set(target: Record<any, any>, key: string, value: any) {
    // readonly 不可 set, 抛出异常
    console.warn(`key: ${key}设置失败, 因为${target}是 readonly 类型`)
    return true
  }
}
复制代码


isReactive & isReadonly


这两个API 用于判读是否是响应式对象和是否为只读对象。这两个 API 的实现思路是一样的,在 proxy 代理 getter 的时候判断是否为 isReactive 和 isReadonly,然后返回对应的结果即可。

首先是 siReactive, 还是先来写测试用例

it('happy path', () => {
  const original = { foo: 1 };
  const observed = reactive({ foo: 1 });
  expect(observed).not.toBe(original);
  expect(observed.foo).toBe(1);
  expect(isReactive(observed)).toBe(true)
  expect(isReactive(original)).toBe(false)
})
复制代码

这里沿用之前的测试用例,添加了两行isReactive 相关的断言,分别对普通对象和 reactive 对象进行判断。

然后回到 reactive.ts 文件中实现这个方法,内容很简单,返回代理对象的指定字段即可

export function isReactive(value: any) {
  return !!value[ReactiveFlags.IS_REACTIVE]
}
export enum ReactiveFlags {
  IS_REACTIVE = '__v_isReactive',
  IS_READONLY = '__v_isReadonly',
}
复制代码

然后再 getter 中添加判断条件

// 返回 getter
function createGetter(isReadOnly: boolean = false) {
  return function get(target: Record<any, any>, key: string | symbol) {
    if (key === ReactiveFlags.IS_REACTIVE)
      return !isReadOnly
    const res = Reflect.get(target, key);
    // 如果不是 readonly 收集依赖
    if (!isReadOnly)
      track(target, key);
    return res;
  }
}
复制代码

如果是代理对象,并且访问的是指定字段,并且不是 readonly,那么就会返回 true;如果不是代理对象,那么取指定字段时会是 undefined,经过取非再取非之后就是一个 boolean 值。

执行测试

1682566042(1).png

isReadonly同理,只是将读取的字段修改一下

最终的代码如下

// 返回 getter
function createGetter(isReadOnly: boolean = false) {
  return function get(target: Record<any, any>, key: string | symbol) {
    if (key === ReactiveFlags.IS_REACTIVE)
      return !isReadOnly
    else if (key === ReactiveFlags.IS_READONLY)
      return isReadOnly
    const res = Reflect.get(target, key);
    // 如果不是 readonly 收集依赖
    if (!isReadOnly)
      track(target, key);
    return res;
  }
}
复制代码


reactive 嵌套


使用过Vue 的应该都知道,Vue 的响应式是深层的,即深层对象也会被进行响应式处理,但是上面的逻辑我们只实现了一层的响应式代理,下面我们就来讲代理转为递归的。

首先是测试用例,我们需要判断对象的子级对象是被也被代理

it('nested reactive', () => {
  const original = {
    nested: { foo: 1 },
    array: [{bar: 2}]
  }
  const observed = reactive(original)
  expect(isReactive(observed.nested)).toBe(true)
  expect(isReactive(observed.array)).toBe(true)
  expect(isReactive(observed.array[0])).toBe(true)
})
复制代码

实现这个很简单,只需要在返回值的时候判断值的类型是否为对象类型即可

// 返回 getter
function createGetter(isReadOnly: boolean = false) {
  return function get(target: Record<any, any>, key: string | symbol) {
    if (key === ReactiveFlags.IS_REACTIVE)
      return !isReadOnly
    else if (key === ReactiveFlags.IS_READONLY)
      return isReadOnly
    const res = Reflect.get(target, key);
    if (isObject(res)) {
      // 如果是对象类型, 递归代理
      return reactive(res)
    }
    // 如果不是 readonly 收集依赖
    if (!isReadOnly)
      track(target, key);
    return res;
  }
}
const isObject = val => val !== null && typeof val === 'object'
复制代码

同理 readonly 的代理任然需要递归处理

it('nested readonly', () => {
  const original = { foo: 1, bar: { baz: 2 } };
  const wrapped = readonly(original);
  expect(isReadonly( wrapped )).toBe(true)
  expect(isReadonly(original)).toBe(false)
  expect(isReadonly( original.bar )).toBe(false)
  expect(isReadonly( wrapped.bar )).toBe(true)
})
复制代码

此时执行测试是有问题的,因为经过我们的封装后,reactive 和 readonly 的 getter 调用的是同一个,所以我们在刚才的地方要加上判断。

// 返回 getter
function createGetter(isReadonly: boolean = false) {
  return function get(target: Record<any, any>, key: string | symbol) {
    if (key === ReactiveFlags.IS_REACTIVE)
      return !isReadonly
    else if (key === ReactiveFlags.IS_READONLY)
      return isReadonly
    const res = Reflect.get(target, key);
    if (isObject(res)) {
      // 如果是对象类型, 递归代理, 根据类型不同调用不同得到方法
      return isReadonly ? readonly(res) : reactive(res)
    }
    // 如果不是 readonly 收集依赖
    if (!isReadonly)
      track(target, key);
    return res;
  }
}


相关文章
|
29天前
|
缓存 JavaScript UED
Vue3中v-model在处理自定义组件双向数据绑定时有哪些注意事项?
在使用`v-model`处理自定义组件双向数据绑定时,要仔细考虑各种因素,确保数据的准确传递和更新,同时提供良好的用户体验和代码可维护性。通过合理的设计和注意事项的遵循,能够更好地发挥`v-model`的优势,实现高效的双向数据绑定效果。
129 64
|
29天前
|
JavaScript 前端开发 API
Vue 3 中 v-model 与 Vue 2 中 v-model 的区别是什么?
总的来说,Vue 3 中的 `v-model` 在灵活性、与组合式 API 的结合、对自定义组件的支持等方面都有了明显的提升和改进,使其更适应现代前端开发的需求和趋势。但需要注意的是,在迁移过程中可能需要对一些代码进行调整和适配。
110 60
|
4天前
|
JavaScript API 数据处理
vue3使用pinia中的actions,需要调用接口的话
通过上述步骤,您可以在Vue 3中使用Pinia和actions来管理状态并调用API接口。Pinia的简洁设计使得状态管理和异步操作更加直观和易于维护。无论是安装配置、创建Store还是在组件中使用Store,都能轻松实现高效的状态管理和数据处理。
22 3
|
29天前
|
前端开发 JavaScript 测试技术
Vue3中v-model在处理自定义组件双向数据绑定时,如何避免循环引用?
Web 组件化是一种有效的开发方法,可以提高项目的质量、效率和可维护性。在实际项目中,要结合项目的具体情况,合理应用 Web 组件化的理念和技术,实现项目的成功实施和交付。通过不断地探索和实践,将 Web 组件化的优势充分发挥出来,为前端开发领域的发展做出贡献。
34 8
|
28天前
|
存储 JavaScript 数据管理
除了provide/inject,Vue3中还有哪些方式可以避免v-model的循环引用?
需要注意的是,在实际开发中,应根据具体的项目需求和组件结构来选择合适的方式来避免`v-model`的循环引用。同时,要综合考虑代码的可读性、可维护性和性能等因素,以确保系统的稳定和高效运行。
31 1
|
28天前
|
JavaScript
Vue3中使用provide/inject来避免v-model的循环引用
`provide`和`inject`是 Vue 3 中非常有用的特性,在处理一些复杂的组件间通信问题时,可以提供一种灵活的解决方案。通过合理使用它们,可以帮助我们更好地避免`v-model`的循环引用问题,提高代码的质量和可维护性。
39 1
|
29天前
|
JavaScript
在 Vue 3 中,如何使用 v-model 来处理自定义组件的双向数据绑定?
需要注意的是,在实际开发中,根据具体的业务需求和组件设计,可能需要对上述步骤进行适当的调整和优化,以确保双向数据绑定的正确性和稳定性。同时,深入理解 Vue 3 的响应式机制和组件通信原理,将有助于更好地运用 `v-model` 实现自定义组件的双向数据绑定。
|
1月前
|
JavaScript 前端开发 开发者
Vue是如何劫持响应式对象的
Vue是如何劫持响应式对象的
31 1
|
1月前
|
JavaScript 前端开发 API
从Vue 2到Vue 3的演进
从Vue 2到Vue 3的演进
41 0
|
1月前
|
JavaScript 前端开发 API
Vue.js响应式原理深度解析:从Vue 2到Vue 3的演进
Vue.js响应式原理深度解析:从Vue 2到Vue 3的演进
58 0

热门文章

最新文章