(14/30)一緒にBlazorを学ぼう:JavaScript interop(相互運用)

(14/30)一緒にBlazorを学ぼう:JavaScript interop(相互運用)

BlazorはJavaScriptを必要としませんが、既存の便利なJSライブラリを全て捨てるわけにはいきません。BlazorはJavaScriptを呼び出す方法を提供しており、これをJavaScript interoperability(略してJavaScript interop)と呼びます。今回はDeleteボタンの確認ダイアログを実装します。削除は重要な機能なので、ユーザーが軽い気持ちで押して削除できないようにするためです。

最終更新 2021/12/16 21:02
StrayaWorker
読了目安 3 分
カテゴリ
Blazor
テーマ
一緒にBlazorを学ぶシリーズ
タグ
.NET C# ASP.NET Core Blazor

Blazor は JavaScript を必ずしも必要としませんが、既存の JS ライブラリの中には非常に便利なものもあり、JavaScript を使いたくないからといってすべて捨てるのはもったいないです。Blazor には JavaScript を呼び出す方法が用意されており、これを JavaScript interoperability(略して JavaScript interop)と呼びます。この記事では、Delete ボタンに確認ダイアログを実装します。削除は重要な機能なので、ユーザーが軽い気持ちで簡単に削除できないようにするためです。

Day 07 で説明したように、Blazor には組み込みの JavaScript Service があるため、Program.cs で依存関係の注入を行う必要はなく、使いたいページで注入するだけで済みます。razor コンポーネントに注入する場合は、@inject IJSRuntime js と記述するだけです。

次に、元のReturnPostId()DeletePost()にリネームし、型をTaskに変更し、内部のロジックを少し修正します。JavaScript もEventCallback の方式で呼び出されており、値を返すInvokeAsyncと値を返さないInvokeVoidAsyncが利用できます。第1引数にはJSメソッドの名前を指定し、そのJSメソッドに引数が必要な場合は順に後ろに並べるだけです。

では、このコードをカプセル化して C# クラスを作り、強タイピングの利点を享受したい場合はどうすればよいでしょうか?Blazor にはその方法も用意されています。まずSharedフォルダにJsInteropClasses.csを作成します。このクラスでは3つのことだけを行います。依存関係の注入、confirm メソッド、そしてDisposeです。

次にPostBase.razor.csの先頭で、JS をJsInteropClassesに注入し、IDisposableを継承します。

そして、元のメソッドを先ほどカプセル化した_jsClass.Confirm()メソッドに変更し、最後にDisposeメソッドをオーバーライドします。

これで、元のPostBase.razor.csで直接 JS のconfirmを呼び出したのと同じ結果になるのがわかります。忘れていましたが、Post.razorで Delete ボタンのクリックイベントのコールバックメソッドをDeletePostに変更しておく必要があります。

Blazor で JS ファイルを読み込める場所は4つあります。それぞれ<head><body>、外部JS script、そして Blazor 起動後の読み込みです。いずれの場合も、必要な<script>_Layout.cshtml(Blazor Server)またはindex.html(Blazor WebAssembly)に配置します。特に最後の方法は特殊なので、ここで説明します。

_Layout.cshtmlの元の_framework/blazor.server.jsの下に独自の script を追加します。中身は非常にシンプルで、console.log で文字を出力するだけです。特に注意しなければならないのは、元の script に属性autostart="false"を追加することです。これは Blazor にプログラムを自動起動しないように指示するもので、この属性を追加しないと、次のようなエラーメッセージが表示されます。

しかし、現在の削除確認ダイアログはあまり見栄えが良くないので、別のライブラリに切り替えましょう。筆者は多くの人がSweetAlert2を使っているのを見たので、試してみることにしました。

まず SweetAlert2 の公式サイトからファイルをダウンロードし、sweetalert.js<head>に配置します。次に、先ほど追加した4番目のBlazor.start()を削除します。また、_framework/blazor.server.jsautostart="false"も忘れずに削除してください。あるいは、Blazor.start()内に直接記述することもできます。

さらに独自の<script>を追加します。ここでは特別にPromiseを使用しています。Promise は非同期処理をより扱いやすくするための構文で、resolveは処理が成功した場合に返す内容です(ここでの成功は例外が発生しなかったという意味で、つまり「確定」でも「キャンセル」でも押された場合に値を返します)。

Confirmメソッドは、先ほど定義したSweetConfirm()を呼び出すように変更します。

Delete ボタンをクリックし、「確定」を押すと、willDeleteが true になり、resolveがそのwillDeleteを返します。JsInteropClassesConfirmが無事にtrueを受け取ります(ここに少し問題があります。確定をクリックした後、最初に「削除成功」のポップアップが表示され、その後にJsInteropClassestrueを受け取っています。後日、最適化する機会があれば行います)。

「キャンセル」をクリックすると、willDeleteは null になります。

Promise はフロントエンドで避けて通れない構文です。興味のある方は、筆者が添付したリンクをご覧ください。筆者は当初 Observable と subscribe の構文を使おうと考えましたが、SweetAlert2 ではまだ実装されていません。

また、SweetAlert2 には既に Blazor 版 も用意されており、方法はほぼ同じです。どうしても JS に触れたくない方は試してみてください。

最後に、この記事の動画効果で締めくくります。

参照:

  1. Blazor JavaScript interoperability (JS interop)
  2. Call JavaScript functions from .NET methods in ASP.NET Core Blazor
  3. HANDLING BUTTONS (CONFIRM, DENY, CANCEL)
  4. Day 20:JavaScript interop
  5. JavaScript Promise 全介绍
  6. Support ObservableLike #1982
  7. Blazor - Making a Promise in JS - SweetAlert2 Confirmation Dialog
  8. SweetAlert - upgrading-from-1x

注:本記事のコードは .NET 6 + Visual Studio 2022 でリファクタリングされ、SweetAlert は 2.0 バージョンを使用しています。元の記事とはかなり異なりますので、元の記事のリンクとリファクタリング後のコードを比較して学習してください。お読みいただきありがとうございます。

さらに探索

関連読書

その他の記事
同じカテゴリ / 同じタグ 2021/12/25

(29/30)みんなで学ぶBlazor:Blazor単体テスト

システム開発において最も退屈なプロセスは、おそらくバグ修正です。特に、null オブジェクトにアクセスしようとするエラー(`Object reference not set to an instance of an object.`)は、多くの初心者が最初に直面する問題です。退屈なバグ修正から解放されるために、この記事では「単体テスト」を紹介します。

続きを読む
同じカテゴリ / 同じタグ 2021/12/25

(28/30)みんなで学ぶBlazor:ポリシーベースの認可

以前に「ASP.NET Core Identity」は「Claim」ベースの検証を使用すると述べましたが、実は「ASP.NET Core Identity」には異なる種類の認可方法があります。最も簡単な「ログイン認可」「ロール認可」「Claim認可」ですが、これらはすべて同じ方法で実現されています:原則認可(ポリシーベースの認可)です。

続きを読む