FC2ブログ

記事一覧

非同期スレッドからコントロールオブジェクトを操作する方法 | Xamarin.Forms


今回は Xamarin.Forms で 非同期のスレッドからコントロールやデバイスなどのオブジェクトにアクセスする際にエラーが出ると思いますが、その対処方法についてご紹介いたします。
既に AndroidiOS でエラーが発生する対処方法について既知の情報なのですが、覚え書きの為にここにまとめてみました。


前提条件
・Windows10 Pro 64Bit 1803
・Visual Studio 2017 Community
・Xamarin 4.11.0.776 (NuGet Xamarin.Forms 2.4.0.282)
・macOS Mojave 10.14 / Xcode10.1 / Xamarin.iOS 12.0.0.10



1.エラーについて

非同期のスレッドからコントロールやデバイスを操作するコードを実行すると、エラーとなります。これはコントロールやデバイスを操作しているスレッドと同じスレッドで操作しなければならない制約から、エラーが発生するようにされているからです。

Android の場合
Unhandled Exception:
Java.Lang.RuntimeException: Only the original thread that created a view hierarchy can touch its views.


iOS の場合
UIKit Consistency error: you are calling a UIKit method that can only be invoked from the UI thread.

エラーを再現するコードを以下に記載します。
TestPage.xaml.cs
using System.Threading.Tasks;
using Xamarin.Forms;
public class TestPage : ContentPage
{
async void OnInvokeTestClick(object sender, EventArgs e)
{
await Task.Run(() =>
{
this.btnTest.Text = ""; //ここでエラーになります。
}).ConfigureAwait(false);
}
}



1.PCLの記述方法

非同期スレッドからのエラーを回避するには、非同期スレッドからのコントロールへのアクセスをやめる(設計変更)方法と、以下の回避コードを埋め込む方法の2種類があります。

TestPage.xaml.cs
using System.Threading.Tasks;
using Xamarin.Forms;
public class TestPage : ContentPage
{
async void OnInvokeTestClick(object sender, EventArgs e)
{
await Task.Run(() =>
{
Device.BeginInvokeOnMainThread(() =>
{
this.btnTest.Text = ""; //エラーになりません。
});
}).ConfigureAwait(false);
}
}



2.Androidの実装方法

Android プロジェクト内で使用する為には、以下のいずれかのコードを使用します。
・Device.BeginInvokeOnMainThread
・Activity.RunOnUiThread

Test.cs
using Android.App;
using Android.Content;
using Android.Widget;
using System.Threading.Tasks;
using Xamarin.Forms;
public class Test
{
async void OnInvokeTest(object sender, EventArgs e)
{
await Task.Run(() =>
{
((Activity)Forms.Context).RunOnUiThread(() =>
{
Toast.MakeText(Forms.Context, "test", ToastLength.Short).Show(); //エラーになりません。
});
}).ConfigureAwait(false);
}
}


詳しくは以前の記事でご紹介しました Android のエラー対処方法についてご確認ください。



3.iOSの実装方法

iOS プロジェクト内で使用する為には、以下のいずれかのコードを使用します。
・Device.BeginInvokeOnMainThread
・UIApplication.SharedApplication.InvokeOnMainThread
・View.InvokeOnMainThread

Test.cs
using UIKit;
using System.Threading.Tasks;
using Xamarin.Forms;
public class Test
{
async void OnInvokeTest(object sender, EventArgs e)
{
await Task.Run(() =>
{
UIApplication.SharedApplication.InvokeOnMainThread(() =>
{
this.btnTest.Text = ""; //エラーになりません。
});
}).ConfigureAwait(false);
}
}


詳しくは以前の記事でご紹介しました iOS のエラー対処方法についてご確認ください。






最後までお読みいただきありがとうございます。
当ブログの内容をまとめた Xamarin逆引きメニュー は以下のURLからご覧になれます。
http://itblogdsi.blog.fc2.com/blog-entry-81.html



関連記事

コメント

コメントの投稿

※名前とタイトルが入力されていないコメントでは他のコメントとの区別ができません。

 入力されていないコメントには返信しませんのであらかじめご了承くださいませ。

※ニックネームでも良いので必ずご入力ください。

    

※必ずご入力ください。

    
    

※必ずご入力ください。

※技術的な質問には環境やエラーについて正確かつ詳細にお教えください。

・正確なエラーの内容

・Windowsのバージョン番号

・Visual Studioのバージョン

・機器の型番

・アプリやソフトのバージョン

    

カテゴリ別記事一覧

広告

プロフィール

石河 純


著者名 :石河 純
自己紹介:素人上がりのIT技術者。趣味は卓球・車・ボウリング

IT関連の知識はざっくりとこんな感じです。
【OS関連】
WindowsServer: 2012/2008R2/2003/2000/NT4
Windows: 10/8/7/XP/2000/me/NT4/98
Linux: CentOS RedHatLinux9
Mac: macOS Sierra 10.12 / OSX Lion 10.7.5 / OSX Snow Leopard 10.6.8
【言語・データベース】
VB.net ASP.NET C#.net Java VBA
Xamarin.Forms
Oracle10g SQLServer2008R2 SQLAnywhere8/11/16
ActiveReport CrystalReport ReportNet(IBM)
【ネットワーク関連】
CCNP シスコ技術者認定
Cisco Catalyst シリーズ
Yamaha RTXシリーズ
FireWall関連
【WEB関連】
SEO SEM CSS IIS6/7 apache2

休みの日は卓球をやっています。
現在、卓球用品通販ショップは休業中です。