探秘组件实例的内部 API

1. 什么是 getCurrentInstance？

getCurrentInstance 是 Vue 3 提供的一个方法，它可以获取当前组件实例。这个方法主要用于 setup 函数 或 组合式 API 中，帮助开发者访问一些当前组件的内部数据和上下文。

官方说明：getCurrentInstance 是一个内部方法，主要供插件开发者或高阶开发使用。虽然可以在项目中使用，但需要谨慎，因为 Vue 可能会在未来版本中调整其实现。

2. 使用 getCurrentInstance 的语法

import { getCurrentInstance, defineComponent } from 'vue';

export default defineComponent({
  setup() {
    const instance = getCurrentInstance();
    console.log(instance);
  },
});

• 返回值：当前组件实例的对象。
• 无效上下文调用：如果不在 setup 或有效的组合式 API 环境中调用，getCurrentInstance 将返回 null。

3. getCurrentInstance 返回的实例对象内容

常见属性：

4. 使用场景

4.1 访问组件的 proxy 和其他上下文信息

在 setup 中可以通过 getCurrentInstance 访问当前组件的 proxy，从而间接获取数据或方法。

import { getCurrentInstance } from 'vue';

export default {
  setup() {
    const instance = getCurrentInstance();
    console.log(instance.proxy); // 相当于 `this`，可以访问 data 和 methods
    console.log(instance.props); // 访问 props 数据
    console.log(instance.attrs); // 获取未声明的属性
  },
};

4.2 在自定义 Hooks 中获取组件实例

编写自定义组合式函数（hooks），需要获取组件实例，可以通过 getCurrentInstance 实现。

import { getCurrentInstance } from 'vue';

export function useCurrentInstance() {
  const instance = getCurrentInstance();
  if (!instance) {
    console.warn('useCurrentInstance 必须在 setup 中调用');
  }
  return instance;
}

// 使用
import { useCurrentInstance } from './useCurrentInstance';

export default {
  setup() {
    const instance = useCurrentInstance();
    console.log('当前实例:', instance);
  },
};

4.3 在插件开发中

比如获取组件实例，访问内部属性并做扩展。

import { getCurrentInstance } from 'vue';

export default {
  setup() {
    const instance = getCurrentInstance();

    // 调试、插件开发中使用
    console.log('当前组件的上下文:', instance);
  },
};

4.4 触发自定义事件

在组合式 API 中，如果你想通过 emit 触发事件，可以通过 getCurrentInstance 获取 emit 方法：

import { getCurrentInstance } from 'vue';

export default {
  setup() {
    const instance = getCurrentInstance();

    // 触发事件
    instance.emit('custom-event', '数据传递');
  },
};

5. 注意事项

• 仅限 setup 中使用：getCurrentInstance 只能在 setup 或有效的组合式 API 内部调用，其他地方（如生命周期钩子外）会返回 null。

• 内部 API，不稳定：官方将其标记为内部 API，未来版本可能会进行调整，因此项目中应尽量避免过度依赖。

• 调试和插件开发场景为主：日常业务开发中通常不需要使用这个 API，推荐使用标准的组合式 API。