Flex Plugins の Reactサンプルを読み解く

:::note alert
2023年5月1日を持ちまして、株式会社KDDIウェブコミュニケーションズのTwilioリセール事業が終了したため、本記事に記載されている内容は正確ではないことを予めご了承ください。
:::

# はじめに

みなさん、こんにちは。
KDDIウェブコミュニケーションズの Twilioエバンジェリストの高橋です。

今回は、Flexプラグインを作成するときに事前に理解をしておきたい FlexプラグインでのReactコンポーネント構造について、CLIで作成されるサンプルコードを読み解きながら解説していきます。

# FlexプラグインとReactの関係

Flexでは、UIにReactを採用しています。よって、Reactベースでコンポーネントを追加することで、FlexのUIを自由に変更することができます。そのため、Flexでプラグインを開発しようとすると、Reactの知識が不可欠になります。
ここがプラグイン開発のハードルになっていることも事実で、ちょっとでもハードルを下げるために、今回はあまりReactを知らない方でも、なんとなくこんな感じなのねっていうところがわかってもらえればと思って記事を書くことにしました。
とはいえ、８０％以上が僕自身の理解を深めるためのものです。

# ハンズオン

なにはともあれ、まずは手を動かしながら学習を始めましょう。

## Flexプラグイン CLIの準備

以下の記事を参考に、Flexプラグイン CLIをインストールしてください。
[Twilio Flex Plugins CLI](https://qiita.com/mobilebiz/items/eeca1ce20bb5b561b515)

そして、記事にも書かれているように、`plugin-cli-test`という名前のプラグインを作成しておいてください。

## ファイルの構成

出来上がったプラグインは以下のようになっています。

```sh
.
├── README.md
├── build
│   ├── plugin-cli-test.js
│   └── plugin-cli-test.js.map
├── jest.config.js
├── node_modules [1102 entries exceeds filelimit, not opening dir]
├── package-lock.json
├── package.json
├── public
│   ├── appConfig.example.js
│   └── appConfig.js
├── src
│   ├── CliTestPlugin.js
│   ├── components
│   │   ├── CustomTaskList
│   │   │   ├── CustomTaskList.Container.js
│   │   │   ├── CustomTaskList.Styles.js
│   │   │   └── CustomTaskList.jsx
│   │   └── __tests__
│   │       └── CustomTaskListComponent.spec.jsx
│   ├── index.js
│   └── states
│       ├── CustomTaskListState.js
│       └── index.js
├── webpack.config.js
└── webpack.dev.js
```

今回学習する必要があるファイルは、以下の6つです。

- src/CliTestPlugin.js
- src/states/index.js
- src/states/CustomTaskListState.js
- src/components/CustomTaskList.container.js
- src/components/CustomTaskList.Styles.js
- src/components/CustomTaskList.jsx

### src/CliTestPlugin.js

プラグインの開始ポイントとなるのがこのファイルです。
![スクリーンショット 2021-08-30 11.27.15.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/682b8fc8-b20e-8acb-8c3e-88eaca5709f0.png)

具体的には、22行目の`init(flex, manager)`関数が開始時に呼ばれることになりますので、ここから順を追って見ていきます。

23行目にある`registerReducers(manager)`は、同じファイルの37行目から定義されています。
ここで重要な技術要素が、**React-Redux**です。

#### <参考> React-Reduxって?

Reactもよくわからない人に、React-Reduxを説明するのは難しいのですが、ここでは非常に簡単に説明します。
Reactというのは、コンポーネントという単位でプログラムを作成していくことで、プログラムを部品化し、再利用性を向上させることができます。たとえば以下の図をみるとわかるように、Flex上には色々なコンポーネントがあり、それぞれを部品化することで管理がしやすくなっています。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/dba854cb-ae69-882a-96df-8a083ce238ff.png)

Reactコンポーネントは通常親子関係をもっており、例えば上の図でいうと、２のMainContainerの中に、3、4、5、16、17のコンポーネントがあります。さらに、16の中には、6と９のコンポーネントがあり、6には更に７と８のコンポーネントが入っています。
Reactでは、各コンポーネントに処理を分割して管理するため、そのコンポーネントで表示するデータなどの**状態**もコンポーネント単位で管理されます。そのため、親コンポーネントが子コンポーネントを作成するときにデータを渡したり、データの代わりに関数を渡すことで、子コンポーネントから親コンポーネントにデータを渡す仕組みになっています。
このような仕様により、コンポーネントにはそのコンポーネント内の処理だけでなく、他のコンポーネントとのデータのやりとりも実装しなくてはいけません。

この作業を軽減することができるのが、**React-Redux**です。
具体的には、コンポーネント内で状態を管理するのではなく、状態を管理する専用のストアと呼ばれる領域を利用し、各コンポーネント間でのやり取りにもこのストアを利用します。ストアに対するデータのやり取りを行う仕組みを**Reducer**と呼び、ストア内のデータはすべてReducer経由で行います。
先程のソースコードの44行目にある`manager.store.addReducer(namespace, reducers)`で、このプラグインで利用するReducerをFlexプロジェクトのストアに登録しています。

つぎに、ソースコードの25〜30行目を見てみます。
ここでは、`flex.AgentDesktopView.Panel1.Content.add(...)`をしていることがわかります。これは先程のコンポーネント全体図をみるとわかるように、16番の`AgentDesktopView.Panel1`コンポーネント内に新しいコンテンツを追加することを意味します。
以下の図のように左側の上の方に黒いバーが表示されているのが、今回のプラグインで生成したコンポーネントです。
![FlexPlugin_1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/378e79a5-b8a1-2e32-99e5-9bbc8f1c5f46.png)

では次に、`add`関数の中に指定されている`<CustomTaskListContainer .../>`について見ていきましょう。
この実態は、ソースコードの5行目でインポートされている`components/CustomTaskList/CustomTaskList.Container`です。

### src/components/CustomTaskList.Container.js

このファイルは、先ほど説明したReact-Reduxの仕組みを使って、実際のプラグインコンポーネントを呼び出す中間ファイルです。
![スクリーンショット 2021-08-30 13.22.16.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/20215356-7775-27f6-7b98-23c0b7a4b21b.png)
具体的には、15行目で指定しているように、React-Reduxに用意されている`connect`という関数を使って、コンポーネント定義ファイル（同じディレクトリ内にある`CustomTaskList.js`）を呼び出すのですが、その際に、`mapStateToProps`と`mapDispatchToProps`を引数に渡します。最初の引数である`mapStateToProps`は、コンポーネントに変数を渡すためのものです。具体的には、`isOpen`という変数をコンポーネントに渡しています。
とりあえず、変数の内容については後回しにして、実際のコンポーネント定義ファイルを見ていきましょう。

### src/components/CustomTaskList.jsx

こちらが今回のプラグインで表示するコンポーネントを定義したものです。
![スクリーンショット 2021-08-30 13.36.32.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/ed9ee51d-29e4-2598-ce15-93cc7c9685fb.png)
７行目で、パラメータとして受け取った`isOpen`を判定し、`false`だった場合はそのまま何もせずに終了します。
`isOpen`が`true`だった場合は、`This is a dismissible demo component`という文字列と、`close`という文字列を表示しています。後者については、クリックが可能になっており、クリックしたときのイベントに、`props.dismissBar`を指定しています。
文字列のスタイルについては、`<CustomTaskListComponentStyles>`というファイル（CustomTaskList.Style）で定義しています。

### src/components/CustomTaskList.Styles.js

こちらはコンポーネントのスタイルを設定しているものです。
![スクリーンショット 2021-08-30 14.06.17.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/4c107574-f332-756c-b770-6af9b6a76dea.png)

少なくともここまでの情報で、プラグインコンポーネントが表示される仕組みの概要は理解できたかと思います。
ではいよいよ積み残してきたコンポーネントに引き渡す変数や、コンポーネントで実行する関数ハンドラの仕組みについて見ていきましょう。

### src/states/index.js

src/states内のファイル（index.jsとCustomTaskListState.js）がReducerを定義したものです。`index.js`がインデックスの役割になっています。
一番最初に説明した`CliTestPlugin.js`の６行目には以下のような行があります。

```javascript:src/CliTestPlugin.js
import reducers, { namespace } from './states';
```

これにより、まず`src/states/index.js`が参照され、`namespace`と`reducers`がインポートされます。
reducersについては、9〜11行目でreduxのcombineReducersを使ってreducersが返却されています。

```javascript:src/states/index.js
export default combineReducers({
  customTaskList: CustomTaskListReducer
});
```

combineReducersは複数のReducerをマージする役目があります（ただし、このコンポーネントでは`CustomTaskListState`の１つしか定義されていません）。
整理すると、このコンポーネントでは、CustomTaskListStateというReducerが定義されていて、ストアに対する値のやり取りはそこで指定することがわかります。

### src/states/CustomTaskListState.js

![スクリーンショット 2021-08-30 14.36.18.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/740dff3e-a549-4c44-d8e7-d335af9bbd81.png)

正直、このファイルの仕組みが一番難解です。
まず、このファイルの`reduce`関数（11行目〜）がReducerとなり**stateを返します**。stateの初期値は、3〜5行目で指定されている通り、`isOpen: true`です。

ここで重要な概念が、**Actions**です。Reducerを使ってストアの値を操作するには、Actionsというオブジェクトを利用する必要があります。Actionsの構造は以下のようになっています。

```json:Actionsオブジェクト
{
    type: "アクションの種類を一意に識別できる文字列またはシンボル",
    payload: "アクションの実行に必要な任意のデータ",
}
```

これは`src/states/CustomTaskListState.js`内でいうと、以下の部分になります。

```javascript:src/states/CustomTaskListState.js（7〜9行目）
export class Actions {
  static dismissBar = () => ({ type: ACTION_DISMISS_BAR });
}
```

これは、**dismissBarという名前のActionsを定義し、このアクションのTypeはACTION_DISMISS_BARであり、payloadは省略されている**と読むことができます。

で、実際にこのReducer経由で値を取得するときに実行されるのが、以下の部分です。

```javascript:src/states/CustomTaskListState.js（11〜23行目）
export function reduce(state = initialState, action) {
  switch (action.type) {
    case ACTION_DISMISS_BAR: {
      return {
        ...state,
        isOpen: false,
      };
    }

    default:
      return state;
  }
}
```

ここでのポイントは、stateの返し方です。具体的には、

```javascript
return {
  ...state,
  isOpen: false,
}
```
のように、既存の値を残しながら差分をマージすることです。これによって、他の値を上書き削除しないようにします。

では最後に、コンポーネントの呼び出し時（connect実行時）の動作を解説します。
具体的には、`src/components/CustomTaskList.Container.js`の以下の部分です。

```javascript:CustomTaskList.Container.js
const mapStateToProps = (state) => ({
    isOpen: state['cli-test'].customTaskList.isOpen,
});

const mapDispatchToProps = (dispatch) => ({
  dismissBar: bindActionCreators(Actions.dismissBar, dispatch),
});

export default connect(mapStateToProps, mapDispatchToProps)(CustomTaskList);
```

先ほど説明したように、このファイルは中間ファイルで、`CustomTaskList`コンポーネントを呼び出すときのパラメータを指定しているのが、`mapStateToProps`です。
`state['cli-test'].customTaskList`でストア内に格納されている現在のstateを参照することができます。コンポーネントを作成するときの`isOpen`パラメータは初期値である`true`になっています。よって、`CustomTaskList`コンポーネントには、`{ isOpen: true "}`というパラメータが渡されることになります。
ちなみに、`state['cli-test']`の*cli-test*は、stateのネームスペースです（`src/states/index.js`内で指定してあります）。

次に、コンポーネントからストアの値を更新するのが、`mapDispatchToProps`です。今回は`dismissBar`という名前のハンドラとしてコンポーネントには渡しているので、コンポーネント内では、`onClick={props.dismissBar}`という形で利用することができます。
実際の動作としては、reduxに用意されている`bindActionCreators`を使ってReducerアクションのバインドを行っています。先程解説したとおり、dismissBarアクションは、TypeとしてACTION_DISMISS_BARを返しますので、結果的にdismissBarを呼び出すと、`isOpen`に`false`が設定され、stateを利用しているコンポーネントの表示が消えることになります。

# まとめ

多分一度読んだくらいでは理解できないかと思いますが、実際にコードを色々と弄ってみることで理解が深まると思いますので、ぜひチャレンジしてみてください。

---
### Twilio（トゥイリオ）とは

https://cloudapi.kddi-web.com
Twilio は音声通話、メッセージング（SMS /チャット）、ビデオなどの 様々なコミュニケーション手段をアプリケーションやビジネスへ容易に組み込むことのできるクラウド API サービスです。初期費用不要な従量課金制で、各種開発言語に対応しているため、多くのハッカソンイベントやスタートアップなどにも、ご利用いただいております。

自己紹介|　
:--|:--
<img src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/86046/b51a8b88-abd5-ce5e-195a-de3564ba2ae6.png" height='200' width='150'/>|高橋克己（Katsumi Takahashi） 自称「<font color='red'>赤い芸人</font>」<br />グローバル・インターネット・ジャパン株式会社　代表取締役<br />株式会社KDDIウェブコミュニケーションズ　Twilio事業部エバンジェリスト<br /><br />2001年より大手通信事業者の法人サービスの教育に携わり、企業における電話のしくみや重要性を研究。2016年よりTwilio事業部にジョインし、Twilioを使ったスマートコミュニケーションの普及活動を精力的に行っている。<br />2015 Hall of Doers<br />2019 Twilio Champions