MemoizationによるReactのパフォーマンスチューニング

この記事は[Qiita Advent Calendar2020 React #2](https://qiita.com/advent-calendar/2020/react-2)12/6の記事になります。

今回はmemoizationによるReactのレンダリングパフォーマンスの改善について書いていこうと思います。

# memoizationとは？
memoization（メモ化）は関数の呼び出しと実行結果を保持しておくことで処理の高速化を図る手法です。中にはmemoizationではなくて、memo **r** izationじゃないの？と思う人がいると思います（自分も途中まで間違えていました）。暗記の意味を持った英語としてはmemo **r** izationで正しいですが、技術用語としてはmemo **r** izationを元として作られた造語であるmemoizationが使用されます。

# 実測
Javascriptにはmemoization用のライブラリがいくつか存在します。
汎用ライブラリのlodashもこの機能を備えています。
Reactにもそれぞれ`React.memo()`と`React.useMemo()`が存在しています。しかし、これらは最新のpropsと前回のpropsのみを比較しているため複数結果の保持はできません。
なので今回は複数保持できる下記のライブラリを使用しました。

## moize
複数あるmemoizationライブラリの中でも今回はパフォーマンスに優れている[moize](https://github.com/planttheidea/moize)を使用します。
パフォーマンスに加えReactのコンポーネントに対応しているという点でも優れています。

では、実際にメモ化をした場合としなかった場合の違いを測っていきたいと思います。処理の重さの違いを確かめるためにこのような関数を用意します。

```javascript
function calc(num1, num2) {
  let result = 1;
  for (let i = 0; i < num1; i++) {
    result *= num2;
  }
  return result;
}
```
`moize()`の引数に関数を指定することでメモ化の対象とします。

```javascript
const moizedCalc = moize(calc);
```
この関数を100回実行した際の合計時間を測ります。

```javascript
for (let i = 0; i < 100; i++) {
  moizedCalc(100, 3);
}
```

#### 結果
実行にかかった時間は`hrtime`を使用して5回測定する形で行いました。

| メモ化なし (ms) | メモ化あり (ms) |
|:----------|:----------|
| 0.4223    | 0.1842    |
| 0.2003    | 0.1263    |
| 0.1791    | 0.1104    |
| 0.2257    | 0.1349    |
| 0.3768    | 0.1243    | 


この程度の重さの関数であればメモ化をした際に、メモ化をしていないものと比べ大きく処理速度の差が出ています。

次は同じ関数の引数を1に変えて試してみます。

```javascript
for (let i = 0; i < 100; i++) {
  moizedCalc(1, 1);
}
```

#### 結果

| メモ化なし (ms) | メモ化あり (ms) |
|:----------|:----------|
| 0.0213    | 0.1784    |
| 0.0247    | 0.1890    |
| 0.0215    | 0.1134    |
| 0.0254    | 0.1973    |
| 0.0493    | 0.1737    | 

ライブラリを挟むことによるメモ化や結果の引き出しによって処理が発生してしまうため、逆にこのような処理の軽い場合ではメモ化の対象としたほうが時間がかかってしまいます。

また極端に引数が多い場合も比較する要素が増え、かえって処理に時間がかかってしまうため注意です。

## コンポーネントのメモ化
色々前置きがありましたが、本題のReactのコンポーネントにおけるメモ化について紹介していこうと思います。
`moize.react()`もしくは`isReact`オプションを使用することでReactのコンポーネントをメモ化することができます。

今回は`text`を`num`×`num`で表示するコンポーネントを用意しました。

```javascript
export const TextRenderer = ({ text, num }) => {
  return (
    <table>
      {[...Array(num)].map(() => {
        return (
          <td>
            {[...Array(num)].map(() => {
              return <tr>{text}</tr>
            })}
          </td>
        );
      })}
    </table>
  );
};

export const MemorizedTextRenderer = moize.react(TextRenderer);
```
今回は比較のためにメモ化の対象とする前のコンポーネントも`export`しています。

このコンポーネントを↓の要領でボタンを1回押すと1秒おきに`["a", "b", "c", "d", "e", "f"]`の順に表示するように実装しました。

```javascript
  const texts = ["a", "b", "c", "d", "e", "f"];
  const [text, setText] = useState("");

  const sleep = (ms) => {
    return new Promise((resolve) => setTimeout(resolve, ms));
  }

  const start = async () => {
    for (let t of texts) {
      setText(t);
      await sleep(1000);
    }
  }

  return (
    <div className="App">
      <button onClick={start}>start</button>
      <TestRender text={text}></TestRender>
      <MemorizedTestRender text={text}></MemorizedTestRender>
    </div>
  );
```

moizeはコンポーネントに渡されたpropsを元にキャッシュを引き出しています。

レンダリングにかかった時間はデベロッパーツールのProfilerタブを使って調べていきます。
なお、測定に影響を及ぼさないようにReact DevTools以外の拡張機能は無効化しておきます。

#### 結果
上がメモ化なし、下がメモ化ありの結果です。
メモ化ありの方が明らかにレンダリングにかかる時間が短くなっていることがわかります。

##### メモ化なし
| a (ms) | b (ms) | c (ms) | d (ms) | e (ms) | f (ms) |
|:---|:---|:---|:---|:---|:---|
| 1.1 | 0.7 | 2.0 | 2.5 | 2.6 | 2.5 | 
| 1.1 | 1.1 | 3.0 | 2.1 | 2.0 | 1.7 |

##### メモ化あり
| a (ms) | b (ms) | c (ms) | d (ms) | e (ms) | f (ms) |
|:---|:---|:---|:---|:---|:---|
| 1.5 | 1.4 | 0.7 | 2.2 | 1.4 | 1.4 | 
| 0.1 | 0.2 | 0.2 | 0.2 | 0.1 | 0.1 |

## 注意点
便利な機能ですが実行結果を保持しているということは、パターンや、対象となる関数が増えるにつれてメモリを消費してしまうということになります。Reactコンポーネントも同様です。測ってないので具体的な数値までわかりませんが、、、

防ぐためには↓のようにオプションで保持しておく数に制限をかけておく必要があります。

```javascript
moize(calc, { maxSize: 5 });
moize.react(TextRenderer, { maxSize: 5 });
```

こうすることによって直近5回までの結果を保持しておくように制限をかけることができます。

# おわり
今回使用したコンポーネントは親となる要素をメモ化していましたが、例えば複数コンポーネントで使用される子コンポーネントをメモ化することで効果的に活用できると思います。
便利ですが、メモリの使用量や呼び出される頻度や処理の重さなど様々な要素を考慮して使用する必要がありそうですね。

react: https://github.com/facebook/react
moize: https://github.com/planttheidea/moize

リポジトリ: https://github.com/mugi111/memoization-react-demo