Reactコア差分アルゴリズムを実装するための40行のコード

みなさん、こんにちは。Cassonです。

それ虚拟DOMに依存するフレームワークには、前後のノードの変化を比較するためのDiffアルゴリズムが必要です。

Diffインターネット上には、アルゴリズムの論理を説明する記事がたくさんあります。ただ、作者の言葉がもっと洗練されていて、絵や文章が豊富でも、長い間読んでいると忘れてしまう生徒が多いと思います。

今日、私たちは学習への一度限りのアプローチに切り替えます-実装ReactのコアDiffアルゴリズムです。

難しくはありません。たった40行のコードです。信じないで？見下ろしてください。

人間の高品質なフロントエンドフレームワーク研究グループに参加することを歓迎します。

差分アルゴリズムの設計アイデア

想像Diffしてみてください。アルゴリズムはいくつの状況を考慮する必要がありますか？大まかに3つのタイプがあります。

1. 次のようなノード属性の変更：

// 更新前
<ul>
  <li key="0" className="before">0</li>
  <li key="1">1</li>
</ul>

// 更新后
<ul>
  <li key="0" className="after">0</li>
  <li key="1">1</li>
</ul>
复制代码

2. 次のようなノードの追加と削除：

// 更新前
<ul>
  <li key="0">0</li>
  <li key="1">1</li>
  <li key="2">2</li>
</ul>

// 更新后 情况1 —— 新增节点
<ul>
  <li key="0">0</li>
  <li key="1">1</li>
  <li key="2">2</li>
  <li key="3">3</li>
</ul>

// 更新后 情况2 —— 删除节点
<ul>
  <li key="0">0</li>
  <li key="1">1</li>
</ul>
复制代码

3. 次のようなノードの移動：

// 更新前
<ul>
  <li key="0">0</li>
  <li key="1">1</li>
</ul>

// 更新后
<ul>
  <li key="1">1</li>
  <li key="0">0</li>
</ul>
复制代码

アルゴリズムはどのように設計する必要がありますDiffか？上記の3つの状況のみを考慮すると、一般的な設計のアイデアは次のとおりです。

1. まず、現在のノードが属する状況を判別します
2. 追加または削除の場合は、追加および削除ロジックを実行します
3. 属性変更の場合は、属性変更ロジックを実行してください
4. 移動の場合は、移動ロジックを実行します

このスキームによると、実際には暗黙の前提があります-異なる操作の優先順位は同じです。ただし、日常の開発では、ノードの移動はそれほど頻繁には発生しないため、Diffアルゴリズムは他の状況を優先します。

この概念に基づいて、主流のフレームワーク（React、Vue）のアルゴリズムは、最初に一般的な状況を処理し、次に一般的でない状況Diffを処理する、複数回のトラバーサルを実行します。

したがって、これには、さまざまな境界のコツをつかむことができるように、まれなケースを処理するアルゴリズムがcase必要です。

换句话说，完全可以仅使用处理不常见情况的算法完成Diff操作。主流框架之所以没这么做是为了性能考虑。

本文会砍掉处理常见情况的算法，保留处理不常见情况的算法。

这样，只需要40行代码就能实现Diff的核心逻辑。

Demo介绍

首先，我们定义虚拟DOM节点的数据结构：

type Flag = 'Placement' | 'Deletion';

interface Node {
  key: string;
  flag?: Flag;
  index?: number;
}
复制代码

key是node的唯一标识，用于将节点在变化前、变化后关联上。

flag代表node经过Diff后，需要对相应的真实DOM执行的操作，其中：

• Placement对于新生成的node，代表对应DOM需要插入到页面中。对于已有的node，代表对应DOM需要在页面中移动

• Deletion代表node对应DOM需要从页面中删除

index代表该node在同级node中的索引位置

注：本Demo仅实现为node标记flag，没有实现根据flag执行DOM操作。

我们希望实现的diff方法，接收更新前与更新后的NodeList，为他们标记flag：

type NodeList = Node[];

function diff(before: NodeList, after: NodeList): NodeList {
  // ...代码
}
复制代码

比如对于：

// 更新前
const before = [
  {key: 'a'}
]
// 更新后
const after = [
  {key: 'd'}
]

// diff(before, after) 输出
[
  {key: "d", flag: "Placement"},
  {key: "a", flag: "Deletion"}
]
复制代码

{key: "d", flag: "Placement"}代表d对应DOM需要插入页面。

{key: "a", flag: "Deletion"}代表a对应DOM需要被删除。

执行后的结果就是：页面中的a变为d。

再比如：

// 更新前
const before = [
  {key: 'a'},
  {key: 'b'},
  {key: 'c'},
]
// 更新后
const after = [
  {key: 'c'},
  {key: 'b'},
  {key: 'a'}
]

// diff(before, after) 输出
[
  {key: "b", flag: "Placement"},
  {key: "a", flag: "Placement"}
]
复制代码

由于b之前已经存在，{key: "b", flag: "Placement"}代表b对应DOM需要向后移动（对应parentNode.appendChild方法）。abc经过该操作后变为acb。

由于a之前已经存在，{key: "a", flag: "Placement"}代表a对应DOM需要向后移动。acb经过该操作后变为cba。

执行后的结果就是：页面中的abc变为cba。

Diff算法实现

核心逻辑包括三步：

1. 遍历前的准备工作

2. 遍历after

3. 遍历后的收尾工作

function diff(before: NodeList, after: NodeList): NodeList {
  const result: NodeList = [];

  // ...遍历前的准备工作

  for (let i = 0; i < after.length; i++) {
    // ...核心遍历逻辑
  }

  // ...遍历后的收尾工作

  return result;
}
复制代码

遍历前的准备工作

我们将before中每个node保存在以node.key为key，node为value的Map中。

这样，以O(1)复杂度就能通过key找到before中对应node：

// 保存结果
const result: NodeList = [];
  
// 将before保存在map中
const beforeMap = new Map<string, Node>();
before.forEach((node, i) => {
  node.index = i;
  beforeMap.set(node.key, node);
})
复制代码

遍历after

当遍历after时，如果一个node同时存在于before与after（key相同），我们称这个node可复用。

比如，对于如下例子，b是可复用的：

// 更新前
const before = [
  {key: 'a'},
  {key: 'b'}
]
// 更新后
const after = [
  {key: 'b'}
]
复制代码

对于可复用的node，本次更新一定属于以下两种情况之一：

• 不移动

• 移动

如何判断可复用的node是否移动呢？

我们用lastPlacedIndex变量保存遍历到的最后一个可复用node在before中的index：

// 遍历到的最后一个可复用node在before中的index
let lastPlacedIndex = 0;  
复制代码

当遍历after时，每轮遍历到的node，一定是当前遍历到的所有node中最靠右的那个。

これnodeが可复用的nodeの場合、次の2つの関係nodeBeforeがありlastPlacedIndexます。

注：対応する対応をnodeBefore表し可复用的nodeますbeforenode

• nodeBefore.index < lastPlacedIndex

更新する前nodeに左側にある必要があることを表します。lastPlacedIndex对应node

更新後は、左側に配置しnodeないでください（現在トラバースされているすべてのノードの右端にあるため）。lastPlacedIndex对应node

これはnode、右に移動する時間であり、マークを付ける必要があることを意味しPlacementます。

• nodeBefore.index >= lastPlacedIndex

所定の位置にnodeある必要があり、移動する必要はありません。

// 遍历到的最后一个可复用node在before中的index
let lastPlacedIndex = 0;  

for (let i = 0; i < after.length; i++) {
const afterNode = after[i];
afterNode.index = i;
const beforeNode = beforeMap.get(afterNode.key);

if (beforeNode) {
  // 存在可复用node
  // 从map中剔除该 可复用node
  beforeMap.delete(beforeNode.key);

  const oldIndex = beforeNode.index as number;

  // 核心判断逻辑
  if (oldIndex < lastPlacedIndex) {
    // 移动
    afterNode.flag = 'Placement';
    result.push(afterNode);
    continue;
  } else {
    // 不移动
    lastPlacedIndex = oldIndex;
  }

} else {
  // 不存在可复用node，这是一个新节点
  afterNode.flag = 'Placement';
  result.push(afterNode);
}
复制代码

トラバーサル後の仕上げ作業

トラバーサル後、beforeMapが残っているnode場合は、これらnodeを再利用できず、削除のマークを付ける必要があることを意味します。

たとえば、次の場合、トラバーサルafter後beforeMapもまだ残ってい{key: 'a'}ます。

// 更新前
const before = [
  {key: 'a'},
  {key: 'b'}
]
// 更新后
const after = [
  {key: 'b'}
]
复制代码

これはa、削除のマークを付ける必要があることを意味します。

したがって、最後に、削除をマークするロジックを追加する必要があります。

beforeMap.forEach(node => {
  node.flag = 'Deletion';
  result.push(node);
});
复制代码

完全なコードについては、オンラインデモアドレスを参照してください

要約する

アルゴリズム全体Diffの難しさは、lastPlacedIndex関連する論理にあります。

何度かデバッグDemoすれば、原理は理解できると思います。