【ITニュース解説】tauri-helper: A Rust Utility to Auto-Collect Tauri Commands

Tauriは、私たちが普段ウェブサイトを作る技術、例えばHTML、CSS、JavaScriptなどを使って、WindowsやmacOSのようなデスクトップアプリケーションを開発できるフレームワークだ。ウェブ技術で見た目を作り、裏側の複雑な処理は高速なプログラミング言語であるRustで書く、という形でアプリケーションを構築できる。

Tauriアプリケーションでは、ウェブ画面からRustで書かれた裏側の処理を呼び出す必要がある。この呼び出しの仕組みを「コマンド」と呼ぶ。Rustで特定の関数をコマンドとして公開するには、その関数の上に#[tauri::command]という特別な目印（マクロ）を付ける。例えば、ユーザーの名前を受け取って挨拶を返す関数をRustで書き、それをウェブ画面から呼び出せるように設定する、といった具合だ。

しかし、アプリケーションが大きくなり、たくさんのコマンド（Rust関数）が必要になってくると、ある問題が浮上する。これらのコマンドをTauriアプリケーションに登録する際に、invoke_handlerという部分に一つ一つ手動で関数名を書き並べなければならないのだ。最初は数個のコマンドであれば大した手間ではないが、数十、数百とコマンドが増えていくと、この手動での登録作業は非常に面倒で、開発の効率を大きく低下させる「お決まりの繰り返し作業（ボイラープレートコード）」になってしまう。もし関数の名前を変更したり、コマンドを追加・削除したりするたびに、この登録部分も手動で修正する必要があり、これが開発者にとって大きな負担となるのだ。また、spectaのようなツールを使ってRustの型情報をウェブ側で使えるようにする場合でも、結局コマンドの登録自体は手作業で行う必要があり、この根本的な問題は解決されなかった。

このような状況を解決し、開発者が本来のアプリケーション機能開発に集中できるようにするために作られたのが、tauri-helperというRustのライブラリだ。このライブラリの目的は、Tauriのコマンド登録作業を完全に自動化することにある。「もう二度と手動でコマンドリストを管理する手間はかけたくない」という開発者の強い思いから生まれたものだ。

tauri-helperの開発は、決して簡単ではなかった。特に、Rustの持つ特性や制限が開発をより複雑にした。 一つ目の課題は、Rustのマクロの制限だ。Rustのマクロは、コードを生成したり変換したりする強力な機能だが、現在では、ある関数がどのモジュール（ファイル群）のどこにあるのか、その正確な位置を自動で特定することが難しいという制限がある。そのため、tauri-helperがコマンド関数を自動で収集しようとすると、他のモジュールにある関数を使いたい場合、そのモジュール全体をインポートしなければならず、コマンドを収集するためのマクロを設計するのが想定以上に難しくなった。将来的にはこの制限が緩和される予定だが、開発時点ではまだ利用できなかったため、工夫が必要だった。 二つ目の課題は、複数のワークスペース（プロジェクト）の扱いだ。大規模なアプリケーションでは、関連する複数のRustプロジェクト（クレートと呼ぶ）を一つのワークスペースとして管理することがよくある。tauri-helperがこれら複数のクレートに散らばるコマンドを全て収集しようとすると、各クレートが持つ独自のモジュール構成やパスを理解し、どのクレートのどの関数がコマンドとして定義されているかを漏れなく、かつ効率的に検出する仕組みが必要だった。 三つ目の課題は、ファイル構造とビルド時のコード生成だ。コマンドのリストを自動的に生成するには、アプリケーションがコンパイルされる際に特定のファイルを作成する仕組みが必要になる。Rustではbuild.rsという特別なスクリプトを使って、このようなビルド時の処理を行うことができる。tauri-helperでは、このbuild.rsを使って生成されたコマンドリストのファイルを、開発者が管理しやすいように特定のフォルダに格納するようにした。しかし、これにはファイルパスの管理や、元のRustコードの変更（関数の移動や名前変更など）があった際に、生成されたファイルと常に同期を保つための慎重な設計が求められた。

これらの技術的な課題を一つ一つ解決していくことで、tauri-helperは信頼性が高く、使いやすいツールとして完成した。 実際にtauri-helperを使うことで、Tauriアプリケーションの開発は格段にシンプルになる。まず、プロジェクトのCargo.tomlファイルにtauri-helperを通常の依存関係として、そしてビルド時に使うbuild-dependenciesとしても追加する。次に、build.rsというファイルにtauri_helper::generate_command_fileという一行を追加する。これにより、アプリケーションがビルドされる際に、tauri-helperがコマンドの自動収集とそれらを登録するためのコード生成を行うようになる。

プロジェクトが複数のRustクレートで構成されている場合、Cargo.tomlの[workspace]セクションで、コマンドを収集したい全てのクレート（プロジェクト）をメンバーとして明示的に指定する必要がある。特に、メインのアプリケーションクレートも「.」（現在のディレクトリ）としてメンバーに含めることが重要だ。そうしないと、メインクレートのコマンドが収集されない可能性がある。

コマンドを自動収集する方法は二通りある。一つは、自動で収集したいRust関数の上に#[auto_collect_command]という目印を付ける方法だ。これにより、開発者はどの関数をコマンドとして公開するかを明示的に選択できる。もう一つは、build.rsの設定を少し変更して、#[tauri::command]が付いている全ての関数を自動的に収集する方法だ。この方法は手間がかからない反面、意図しない関数までコマンドとして公開してしまうリスクがあるため、推奨はされていない。

コマンドの収集設定が完了したら、あとは非常にシンプルだ。アプリケーションの起動部分でtauri::Builderのinvoke_handlerにtauri_collect_commands!()というマクロを記述する。すると、tauri-helperが自動で収集した全てのコマンドが、この一行によってTauriアプリケーションに一括で登録される。spectaを使っている場合も同様に、specta_collect_commands!()マクロを使うことで、自動収集されたコマンドを簡単に連携できる。

ただし、Rustのマクロの制限により、複数のクレートで構成されるワークスペースの場合、各クレートのlib.rsファイルで、公開したいコマンド関数を含むモジュールをpub useを使って再エクスポートしておく必要がある。これは、現在のRustの安定版では、マクロがモジュールのフルパスを直接取得できないため、公開されたモジュールを通じてコマンドを見つける必要があるからだ。

例えば、greetやcalculate_sumといった複数のRust関数をコマンドとして定義し、それぞれに#[tauri::command]と#[auto_collect_command]の目印を付けておく。そしてmain関数の中でinvoke_handler(tauri_collect_commands!())と記述するだけで、これらの関数がTauriアプリケーションに自動的に登録され、ウェブ画面から呼び出せるようになるのだ。これにより、開発者は数百行にも及ぶ手動でのコマンド登録コードから解放され、よりクリーンで管理しやすいコードベースを維持できるようになる。

このようにtauri-helperは、Rustのマクロの特性、複数のクレートを含むワークスペースの管理、そしてビルド時のコード生成といった多くの技術的課題を乗り越えて開発された。その結果、Tauriアプリケーション開発におけるコマンド登録という、これまで多くの開発者を悩ませてきた「お決まりの繰り返し作業」を劇的に簡素化する、堅牢で便利なライブラリとなった。開発者は、コマンドの管理に頭を悩ませることなく、アプリケーションの核となる機能開発に集中できるようになるため、開発効率が大きく向上する。私自身も、新しくTauriプロジェクトを始める際には必ずtauri-helperを利用しており、その有用性を強く実感している。さらに、Rust 1.90.0で導入されたcargo publish --workspaceという新機能は、複数のクレートで構成されるプロジェクトの公開を非常に簡単にした。これにより、tauri-helperを使って、より多くのクレートにコマンドを分散させても、その公開が容易になるため、Tauri開発がさらに快適になるだろう。