RustのみでUIが書けるFreyaの基本hookを深堀
use_hook, use_state, use_radioの3つを順に説明する
use_hook
[考え方] コンポーネントのインスタンスごとに 1 回だけ作る値を管理するための仕組み。
実装の本体は base.rs にあり、コメントにもある通り、
- 初回 render では
init()を実行して値を作る - 2回目以降の render では前回の値を再利用する
- コンポーネントが捨てられるときに、その値も消える
という動作をする。
use_hookはstate ではあるけど、render ごとに毎回再作成されない。
[例]
let id = use_hook(|| AccessibilityId::new_unique());
これはコンポーネントごとに一意な ID を持ちたいときに使う。
毎回新しい ID を作ると困るので、初回だけ作るのが適切。
[用途]
- 一意の ID
- 初期化済みの計算結果
- 頻繁に作り直したくないオブジェクト
- コンポーネント破棄時に掃除したいリソース
たとえば、入力欄やメニューの ID などは、再 render しても同じ値であるべきである。
[制約]
- 条件分岐の中で使ってはいけない
- for ループの中で使ってはいけない
- 他の hook の中やイベントハンドラの中で使ってはいけない
理由は、「コンポーネントの呼び出し順序が揃わないと、どの値がどの位置に対応するかが崩れる」から。render のトップレベルで固定順に呼ぶ」のが前提。
[実例] use_radio の中でも、内部的に use_hook が使われている。
let mut radio = use_hook(|| {
let antenna = RadioAntenna::new(channel.clone(), station);
Radio::new(State::create(antenna))
});
- コンポーネントの中で
Radioを 1 回だけ作る - その後も同じ
Radioを使い続ける
という意図。
「あるコンポーネントの一生に対応するオブジェクト」を作りたいときの基本 hook。
use_state
use_state は「コンポーネント内の値を、再描画時にも保持しつつ更新できる」仕組み。
Freya で「コンポーネントの中で値を保持し、値が変わったら再描画させる」ための基本機能。
実装の本体は state.rs にあり、
pub fn use_state<T: 'static>(init: impl FnOnce() -> T) -> State<T> {
use_hook(|| State::create(init()))
}
となっている。
つまり、
-
use_hookで「コンポーネント専用の値」を作る - その値が
State<T>で、読み書きと再描画通知を持つ
State<T> は何を持っているのか
State<T> は、実際には次の2つを持っています。
-
key: 実際の値 -
subscribers: 「この状態を見ている reactive context の一覧」
つまり、ただの変数ではなく、
- 値そのもの
- その値を見ている UI
- 変更が起きたときに通知する仕組み
を持っている。
[例]
let mut count = use_state(|| 0);
let current = count.read();
*count.write() += 1;
-
read()で現在値を読む -
write()で変更する - 変更後、購読者subscriberに通知される
- その UI が再描画される
State::read() の中核は次のような動作:
if let Some(mut rc) = ReactiveContext::try_current() {
let subscribers = self.subscribers.try_read().ok()?;
rc.subscribe(&subscribers);
}
つまり、
- 今のコンポーネントがこの state を読んでいる
- そのコンポーネントを「購読者リスト」に追加する
という処理をする。
状態が変わったときにそのコンポーネントが再描画対象になる。
use_radio
この記事のメインテーマ。
アプリで複数のステートをコンポーネント間で共有し、個々のコンポーネントがチャネルを通して、個々のステートを読み書きできる仕組み。
例:「複数のリストを持つUI」を作る:状態管理として radio を使って、各リストごとに別々の更新チャンネルを持っている。examples/state_radio.rs
1. 状態の定義
#[derive(Default)]
struct Data {
pub lists: Vec<Vec<String>>,
}
Data はアプリ全体の状態。
-
listsは「リストの集まり」 - それぞれの要素は
Vec<String>
つまり、1つのアプリで「複数のリスト」、その中に「複数の文字列アイテム」を持てるようにしている。
2. 更新用のチャンネル定義
#[derive(PartialEq, Eq, Clone, Debug, Copy, Hash)]
pub enum DataChannel {
ListCreation,
SpecificListItemUpdate(usize),
}
DataChannel は、どの状態を更新するかを表す識別子
-
ListCreation- 「新しいリストを作る」操作用
-
SpecificListItemUpdate(usize)- 「特定のリスト番号の中にアイテムを追加する」操作用
-usizeはリストの番号
- 「特定のリスト番号の中にアイテムを追加する」操作用
impl RadioChannel<Data> for DataChannel {}
この行で、この enum を radio のチャンネルとして使えるようにしている。
pub trait RadioChannel<T>
where
Self: 'static + PartialEq + Eq + Clone + Hash,
radio通信用のチャネルを定義する。チャネルは、グローバルな状態における特定の変更を購読subscribeするために使用する。RadioStation や Radio で使用するには、各チャネルがこのトレイトを実装する必要がある。
チャネルを使用することで、状態が変化した際にどのコンポーネントを再レンダリングするかをきめ細かく制御できる。コンポーネントは、自身が購読しているチャネルに通知があった場合にのみ再レンダリングする。
3. アプリの起動
fn main() {
launch(LaunchConfig::new().with_window(WindowConfig::new(app)))
}
ここで実際のGUIアプリを起動している。
app() が UI を返す関数。
4. 初期化: radio station の作成
use_init_radio_station::<Data, DataChannel>(Data::default);
この1行で行われていることを分解すると
let initial_data = Data::default();
let station = RadioStation::<Data, DataChannel>::create(initial_data);
use_provide_context(|| station);
その結果、コンポーネントツリーには次のような共有データが登録される:
RadioStation<Data, DataChannel> この登録されるcontextの中身
├── value: Data
│ └── lists: []
└── listeners
├── ListCreation
└── SpecificListItemUpdate(index)
listeners は各 channel を購読しているコンポーネントを管理する。
子コンポーネントでは、
let mut radio =
use_radio::<Data, DataChannel>(channel);
が呼ばれる。
use_radio の内部では、概ね次の処理が行われる。
let station =
use_consume::<RadioStation<Data, DataChannel>>();
つまり、
親コンポーネント
└── RadioStation を context に登録
└── 子コンポーネント
└── context から RadioStation を取得
└── use_radio で利用
という関係。
実際には、以下のコードが例では使用されている:
let mut radio = use_radio::<Data, DataChannel>(DataChannel::ListCreation);
これは「このコンポーネントで Data という共有状態を DataChannel::ListCreation というチャンネルで使うよ」と宣言している部分で、キーは次の3つ:
-
Data- 共有状態の型
- この例では
lists: Vec<Vec<String>>を持っている
-
DataChannel- どの状態更新のチャネルに参加するかを識別するタグ
-
ListCreationとSpecificListItemUpdate(usize)の2種類がある
-
DataChannel::ListCreation- このコンポーネントが「リスト全体の作成イベント」を購読することを意味する
use_radio は Radio<Data, DataChannel> を返すが、これは単なるローカル変数ではなく、共有状態へのハンドル
実際には use_radio.rs:764-795 で定義されていて、内部的には:
-
RadioStation<Value, Channel>をコンテキストから取得 - 指定した
channelを持つRadioAntennaを作る - そのチャンネルが更新されると再描画対象になる
という仕組みになっている
実際に更新するのは、次のコード:
let on_press = move |_| {
radio.write().lists.push(Vec::default());
};
ここで radio.write() は共有状態を変更するためのアクセス。
lists.push(...) により Data の中身が変わり、同じチャンネルに購読しているコンポーネントが再描画される。
再描画の仕組みを経路を辿って確認する
examples/state_radion_derive_chanell.rsを例に再描画の発火からコンポーネントの再描画までの経路を追う:
#[derive(Default)]
struct Counters {
items: Vec<i32>,
}
Counters は全体の状態
items: Vec が複数の数値を持つリスト
この例では「各カウンタの一覧」を表している
#[derive(PartialEq, Eq, Clone, Debug, Copy, Hash)]
pub enum CountersChannel {
WholeList,
Specific(usize),
}
CountersChannel は「どこを更新したか」を表す識別子
WholeList は一覧全体を指す
Specific(usize) は items[i] の個別要素を指す
impl RadioChannel<Counters> for CountersChannel {
fn derive_channel(self, state: &Counters) -> Vec<Self> {
match self {
CountersChannel::WholeList => {
let mut channels = vec[CountersChannel::WholeList];
channels.extend((0..state.items.len()).map(CountersChannel::Specific));
channels
}
CountersChannel::Specific(_) => vec![self],
}
}
}
trait RadioChannelの定義:
freya_radio::hooks::use_radio
pub trait RadioChannel<T>
where
Self: 'static + PartialEq + Eq + Clone + Hash,
radio通信用のチャネルを定義する。チャネルは、グローバルな状態における特定の変更を購読するために使用される。RadioStation や Radio で使用するには、各チャネルがこのトレイトを実装する必要がある。
チャネルを使用することで、状態が変化した際にどのコンポーネントを再レンダリングするかをきめ細かく制御できる。コンポーネントは、自身が購読しているチャネルに通知があった場合にのみ再レンダリングする。
impl RadioChannel<Counters> for CountersChannel {
fn derive_channel(self, state: &Counters) -> Vec<Self> {
match self {
CountersChannel::WholeList => {
let mut channels = vec![CountersChannel::WholeList];
channels.extend((0..state.items.len()).map(CountersChannel::Specific));
channels
}
CountersChannel::Specific(_) => vec![self],
}
}
}
derive_channel の実装部分で、
self は現在更新されたチャンネル。
state は現在の全体の状態。
返すのは「この更新を通知すべきチャンネル一覧」である
WholeList のとき:
let mut channels = vec![CountersChannel::WholeList];
channels.extend((0..state.items.len()).map(CountersChannel::Specific));
一覧全体の更新を通知する
さらに各要素ごとの Specific(i) も通知する
これは、ある要素の変更が「リスト全体の表示」や「個別行の表示」の両方に影響する可能性があるから。
Specific(_) のとき:
vec![self]
個別要素の更新は、その要素だけに通知する
app での WholeList 用 radio
let mut radio = use_radio::<Counters, CountersChannel>(CountersChannel::WholeList);
CountersChannel::WholeList を使って、一覧全体の状態を購読してる。
app 本体は「全体の数」「各行の描画カウント」など、全体の状態に依存している。
let count = radio.read().items.len();
items.len() で現在の個数を取得。
その結果に応じて .children((0..count).map(CounterRow)) で各行を生成する。
- 追加ボタン
Button::new()
.on_press(move |_| radio.write().items.push(10))
.child("Add Counter"),
radio.write() で状態を書き換える。
items.push(10) で末尾に新しい値(10)を追加する。
この変更は WholeList に関係するので、全体と各個別コンポーネントへ通知される。
- リセットボタン
Button::new()
.on_press(move |_| {
for v in radio.write().items.iter_mut() {
*v = 0;
}
})
.child("Reset All"),
全ての要素を 0 に戻す。
これは一覧全体の変更なので、WholeList と各 Specific(i) の両方に更新が届く。
- CounterRow の作成
#[derive(PartialEq)]
struct CounterRow(usize);
usize で何番目の行かを持っている。
それぞれが個別の行コンポーネントである。
- 各行の Specific(i) radio
let i = self.0;
let mut radio = use_radio::<Counters, CountersChannel>(CountersChannel::Specific(i));
個別行ごとに Specific(i) を使って、対応する要素だけを購読する。
これで「他の行の変更で自分が再描画される」ことを避けられる。
- 各行の値取得
let value = radio.read().items[i];
自分の行に対応する items[i] を読む。
変更があったときだけこの行が再描画される。
- 各行の + / - ボタン
.on_press(move |_| radio.write().items[i] += 1)
.on_press(move |_| radio.write().items[i] -= 1)
その行の個別要素だけ更新する。
今回の derive_channel では Specific(i) なので、その要素だけを通知する。
+ボタン押下時のcallの流れを一番下に示した
derive_channelはいつ、誰からcallされるのか?
この関数を直接呼ぶ関数は、このソースには無い。
再描画のきっかけはこのプログラムでは、radio.write()を発行するボタンである。
例えば、"Add Counter"ボタンが押下されるとradio.write().items.push(10)が呼ばれる。
この write() が発火点で、実装は use_radio.rs:542-568 にあり、ここで derive_channel が呼ばれる。
pub fn write(&mut self) -> RadioGuard<Value, Channel> {
let value = self.antenna.peek().station.value.write_unchecked();
let channel = self.antenna.peek().channel.clone();
RadioGuard {
channels: channel.derive_channel(&*value), <-- ここ
station: self.antenna.read().station,
value,
}
}
- derive_channel の実体
この実装は use_radio.rs:79-80 にあるが、derive_channel の default は vec![self] だ。この部分を本プログラムの23行以下のfn derive_channelにより上書きしている。
impl RadioChannel<Counters> for CountersChannel {
fn derive_channel(self, state: &Counters) -> Vec<Self> {
match self {
CountersChannel::WholeList => {
let mut channels = vec![CountersChannel::WholeList];
channels.extend((0..state.items.len()).map(CountersChannel::Specific));
channels
}
CountersChannel::Specific(_) => vec![self],
}
}
}
生成した channels を RadioGuard に持つ
radio.write().items.push(10) の書き込みが終わると、RadioGuard が drop される
notify_listeners が各 channel に対して実行される *注
その結果、購読しているコンポーネントが再描画される
- 注:ここのからくり:
radio.write() が返した RadioGuard は一時的な値。式の評価が終わると破棄されるため、値を更新した直後、文の終わりで drop が走る。そこで保持していたチャネルの購読者に通知が行く。以下がそのからくり:
use_studio.rsの347~
pub struct RadioGuard<Value, Channel>
where
Channel: RadioChannel<Value>,
Value: 'static,
{
pub(crate) station: RadioStation<Value, Channel>,
pub(crate) channels: Vec<Channel>,
pub(crate) value: WriteRef<'static, Value>,
}
impl<Value, Channel> Drop for RadioGuard<Value, Channel>
where
Channel: RadioChannel<Value>,
{
fn drop(&mut self) {
for channel in &mut self.channels {
self.station.notify_listeners(channel)
}
if !self.channels.is_empty() {
self.station.cleanup();
}
}
}
+ボタンで再描画が発生する場合の流れ図
- ボタンでは Specific(i) の Radio から書き込むため、derive_channel はこの例では [Specific(i)] を返す。したがって、該当する CounterRow(i) が通知対象である。
以上。