React中的Ref是什么

这篇文章主要介绍React中的Ref是什么，文中介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们一定要看完！

Intro

在 React 项目中，有很多场景需要用到 Ref。例如使用 ref 属性获取 DOM 节点，获取 ClassComponent 对象实例；用 useRef Hook 创建一个 Ref 对象，以便解决像 setInterval 获取不到最新的 state 的问题；你也可以调用 React.createRef 方法手动创建一个 Ref 对象。

虽然 Ref 用起来也很简单，但在实际项目中实战还是难免遇到问题，这篇文章将从源码的角度出发梳理各种和 Ref 相关的问题，理清和 ref 相关的 api 背后都干了什么。看完这篇文章或许可以让你对的 Ref 有更深入地认识。

Ref 相关的类型声明

首先 ref 是 reference 的简称，也就是引用。在 react 的类型声明文件中，可以找到好几个和 Ref 相关的类型，这里将它们一一列举出来。

RefObject/MutableRefObject

interface RefObject<T> { readonly current: T | null; }
interface MutableRefObject<T> { current: T; }

使用 useRef Hook 的时候返回的就是 RefObject/MutableRefObejct，这两个类型都是定义了一个 { current: T } 的对象结构，区别是 RefObject 的 current 属性是只读的，如果修改 refObject.current，typescript 会警告⚠️。

const ref = useRef<string>(null)
ref.current = '' // Error

TS 报错：无法分配到 "current" ，因为它是只读属性。

查看 useRef 方法的定义，这里用了函数重载，当传入的泛型参数 T 不包含 null 时返回RefObject<T>，当包含 null 时将返回 MutableRefObject<T>。

function useRef<T>(initialValue: T): MutableRefObject<T>;
function useRef<T>(initialValue: T | null): RefObject<T>;

所以如果你希望创建的 ref 对象 current 属性是可修改的，需要加上 | null。

const ref = useRef<string | null>(null)
ref.current = '' // OK

调用 React.createRef() 方法时返回的也是一个 RefObject。

createRef

export function createRef(): RefObject {
  const refObject = {
    current: null,
  };
  if (__DEV__) {
    Object.seal(refObject);
  }
  return refObject;
}

RefObject/MutableRefObject 是在 16.3 版本才新增的，如果使用更早的版本，需要使用 Ref Callback。

RefCallback

使用 Ref Callback 就是传递一个回调函数，react 回调时会将对应的实例回传过来，可以自行保存以便调用。这个回调函数的类型就是 RefCallback。

type RefCallback<T> = (instance: T | null) => void;

使用 RefCallback 示例：

import React from 'react'

export class CustomTextInput extends React.Component {
  textInput: htmlInputElement | null = null;

  saveInputRef = (element: HTMLInputElement | null) => {
    this.textInput = element;
  }

  render() {
    return (
      <input type="text" ref={this.saveInputRef} />
    );
  }
}

Ref/LegacyRef

在类型声明中，还有 Ref/LegacyRef 类型，它们用于泛指 Ref 类型。 LegacyRef 是兼容版本，在之前的老版本 ref 还可以是 字符串。

type Ref<T> = RefCallback<T> | RefObject<T> | null;
type LegacyRef<T> = string | Ref<T>;

理解了和 Ref 相关的类型，写起 Typescript 来才能更得心应手。

Ref 的传递

特殊的 props

在 jsX 组件上使用 ref 时，我们是通过给 ref 属性设置一个 Ref。我们都知道 jsx 的语法，会被 Babel 等工具编译成 createElement 的形式。

// jsx
<App ref={ref} id="my-app" ></App>

// compiled to
React.createElement(App, {
  ref: ref,
  id: "my-app"
});

看起来 ref 和其他 prop 没啥区别，不过如果你尝试在组件内部打印 props.ref 却是 undefined。并且 dev 环境控制台会给出提示。

Trying to access it will result in undefined being returned. If you need to access the same value within the child component, you should pass it as a different prop.

React 对 ref 做了啥？在 ReactElement 源码中可以看到，ref 是 RESERVED_PROPS，同样有这种待遇的还有 key，它们都会被特殊处理，从 props 中提取出来传递给 Element。

const RESERVED_PROPS = {
  key: true,
  ref: true,
  __self: true,
  __source: true,
};

所以 ref 是会被特殊处理的 “props“。

forwardRef

在 16.8.0 版本之前，Function Component 是无状态的，只会根据传入的 props render。有了 Hook 之后不仅可以有内部状态，还可以暴露方法供外部调用（需要借助 forwardRef 和 useImperativeHandle）。

如果直接对一个 Function Component 用 ref，dev 环境下控制台会告警，提示你需要用 forwardRef 进行包裹起来。

function Input () {
    return <input />
}

const ref = useRef()
<Input ref={ref} />

Function components cannot be given refs. Attempts to access this ref will fail. Did you mean to use React.forwardRef()?

forwardRef 为何物？查看源码 ReactForwardRef.js 将 __DEV__ 相关的代码折叠起来，它只是一个无比简单的高阶组件。接收一个 render 的 FunctionComponent，将它包裹一下定义 $$typeof 为 REACT_FORWARD_REF_TYPE，return 回去。

跟踪代码，找到 resolveLazyComponentTag，在这里 $$typeof 会被解析成对应的 WorkTag。

REACT_FORWARD_REF_TYPE 对应的 WorkTag 是 ForwardRef。紧接着 ForwardRef 又会进入 updateForwardRef 的逻辑。

case ForwardRef: {
  child = updateForwardRef(
    null,
    workInProgress,
    Component,
    resolvedProps,
    renderLanes,
  );
  return child;
}

这个方法又会调用 renderWithHooks 方法，并在第五个参数传入 ref。

nextChildren = renderWithHooks(
  current,
  workInProgress,
  render,
  nextProps,
  ref, // 这里
  renderLanes,
);

继续跟踪代码，进入 renderWithHooks 方法，可以看到，ref 会作为 Component 的第二个参数传递。到这里我们可以理解被 forwardRef 包裹的 FuncitonComponent 第二个参数 ref 是从哪里来的（对比 ClassComponent contructor 第二个参数是 Context）。

了解如何传递 ref，那下一个问题就是 ref 是如何被赋值的。

ref 的赋值

打断点（给 ref 赋值一个 RefCallback，在 callback 里面打断点） 跟踪到代码 commitAttachRef，在这个方法里面，会判断 Fiber 节点的 ref 是 function 还是 RefObject，依据类型处理 instance。如果这个 Fiber 节点是 HostComponent (tag = 5) 也就是 DOM 节点，instance 就是该 DOM 节点；而如果该 Fiber 节点是 ClassComponent (tag = 1)，instance 就是该对象实例。

function commitAttachRef(finishedWork) {
  var ref = finishedWork.ref;

  if (ref !== null) {
    var instanceToUse = finishedWork.statenode;

    if (typeof ref === 'function') {
      ref(instanceToUse);
    } else {
      ref.current = instanceToUse;
    }
  }
}

以上是 HostComponent 和 ClassComponent 中对 ref 的赋值逻辑，对于 ForwardRef 类型的组件走的是另外的代码，但行为基本是一致的，可以看这里 imperativeHandleEffect。

接下里，我们继续挖掘 React 源码，看看 useRef 是如何实现的。

useRef 的内部实现

通过跟踪代码，定位到 useRef 运行时的代码 ReactFiberHooks

这里有两个方法，mountRef 和 updateRef，顾名思义就是对应 Fiber 节点 mount 和 update 时对 ref 的操作。

function updateRef<T>(initialValue: T): {|current: T|} {
  const hook = updateWorkInProgresshook();
  return hook.memoizedState;
}

function mountRef<T>(initialValue: T): {|current: T|} {
  const hook = mountWorkInProgressHook();
  const ref = {current: initialValue};
  hook.memoizedState = ref;
  return ref;
}

可以看到 mount 时，useRef 创建了一个 RefObject，并将它赋值给 hook 的 memoizedState，update 时直接将它取出返回。

不同的 Hook memoizedState 保存的内容不一样，useState 中保存 state 信息， useEffect 中 保存着 effect 对象，useRef 中保存的是 ref 对象...

mountWorkInProgressHook，updateWorkInProgressHook 方法背后是一条 Hooks 的链表，在不修改链表的情况下，每次 render useRef 都能取回同一个 memoizedState 对象，就这么简单。

应用：合并 ref

至此，我们了解了在 React 中 ref 的传递和赋值逻辑，以及 useRef 相关的源码。用一个应用题来巩固以上知识点：有一个 Input 组件，在组件内部需要通过 innerRef HTMLInputElement 来访问 DOM 节点，同时也允许组件外部 ref 该节点，需要怎么实现？

const Input = forwardRef((props, ref) => {
  const innerRef = useRef<HTMLInputElement>(null)
  return (
    <input {...props} ref={???} />
  )
})

考虑一下上面代码中的 ??? 应该怎么写。

============ 答案分割线 ==============

通过了解 Ref 相关的内部实现，很明显我们这里可以创建一个 RefCallback，在里面对多个 ref 进行赋值就可以了。

export function combineRefs<T = any>(
  refs: Array<MutableRefObject<T | null> | RefCallback<T>>
): React.RefCallback<T> {
  return value => {
    refs.forEach(ref => {
      if (typeof ref === 'function') {
        ref(value);
      } else if (ref !== null) {
        ref.current = value;
      }
    });
  };
}

const Input = forwardRef((props, ref) => {
  const innerRef = useRef<HTMLInputElement>(null)
  return (
    <input {...props} ref={combineRefs(ref, innerRef)} />
  )
})

以上是“React中的Ref是什么”这篇文章的所有内容，感谢各位的阅读！希望分享的内容对大家有帮助，更多相关知识，欢迎关注编程网html频道！