WPF での画像読み込みをバックグラウンドで処理する

WPF でインターネット上にある画像を表示させる場合、その URI を BitmapImage に指定することで表示することができます。

<Image>
    <Image.Source>
        <BitmapImage UriSource="https://chitoku.jp/media/icon.png" />
    </Image.Source>
</Image>

var img = new Image();
img.Source = new BitmapImage(new Uri("https://chitoku.jp/media/icon.png"));

var img = new Image();
var source = new BitmapImage();
source.BeginInit();
source.UriSource = new Uri("https://chitoku.jp/media/icon.png");
source.EndInit();
img.Source = source;

でもこの BitmapImage における読み込み処理は UI スレッドで行われているようです。つまり、画像のダウンロードに時間がかかったり、画像の数が多かったりすると、他の要素の表示速度にも影響を与えることがあるということです。今回は、XAML 側から利用できるバッググラウンド処理の機構を考えてみます。

要件

画像のダウンロードと生成がバックグラウンド（UI スレッド以外のスレッド）で処理されること
XAML またはデータバインディングで URI を指定できること
System.Windows.Controls.Image と System.Windows.Media.ImageBrush で使用できること

バックグラウンドで画像を生成する

最近の .NET 開発では非同期型の記述が容易になりましたが、WPF ではその性質上、オブジェクトがスレッドをまたぐ際にその扱いに制約があります。ここでのオブジェクトは Freezable の派生クラスを指します。 System.Windows.Media.Imaging.BitmapImage もこれにあたります。

UI スレッドで表示に用いられるオブジェクトは UI スレッドで生成する
非 UI スレッドで生成したオブジェクトを UI スレッドで使用する場合は Freeze（変更不可能化）する必要がある

また、非 UI スレッドで生成したオブジェクトに対して Freeze を呼び出さずに UI スレッドで使用した場合は例外が発生します。

System.ArgumentException: DependencySource は、DependencyObject と同じ Thread 上で作成する必要があります。

これを考慮して、BitmapImage を生成した後は変更不可能化の処理をしておきます。画像生成のクラス（Model 側）は次のようなコードになります。

using System;
using System.IO;
using System.Net;
using System.Net.Cache;
using System.Threading.Tasks;
using System.Windows.Media.Imaging;

public static class LazyBitmapImage
{
    public static Task<BitmapImage> GetImage(Uri uri)
    {
        return Task.Run(() =>
        {
            var wc = new WebClient { CachePolicy = new RequestCachePolicy(RequestCacheLevel.CacheIfAvailable) };
            try
            {
                var image = new BitmapImage();
                image.BeginInit();
                image.StreamSource = new MemoryStream(wc.DownloadData(uri));
                image.EndInit();
                image.Freeze();
                return image;
            }
            catch (WebException) { }
            catch (IOException) { }
            catch (InvalidOperationException) { }
            finally
            {
                wc.Dispose();
            }
            return null;
        });
    }

    public static Task<BitmapImage> GetImage(string uri)
    {
        return GetImage(new Uri(uri));
    }
}

添付プロパティを登録して XAML から呼び出し可能にする

さてここでは XAML 側から画像の読み込みメソッドを呼び出すわけですが、このような場合はビヘイビアという手法を用いるのが一般的なようです。 Expression Blend にはビヘイビアを利用できるクラスが用意されていますが、今回は添付プロパティを実装した静的クラスを作成してその代用とします。

using System;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Media;
using System.Windows.Media.Imaging;

public class LazyImageBehavior
{
    #region LazySource 添付プロパティ

    [AttachedPropertyBrowsableForType(typeof(Image))]
    public static Uri GetLazySource(Image element)
    {
        return (Uri)element.GetValue(LazySourceProperty);
    }

    [AttachedPropertyBrowsableForType(typeof(Image))]
    public static void SetLazySource(Image element, Uri value)
    {
        element.SetValue(LazySourceProperty, value);
    }

    public static readonly DependencyProperty LazySourceProperty =
        DependencyProperty.RegisterAttached("LazySource", typeof(Uri), typeof(LazyImageBehavior), new PropertyMetadata(null, LazySource_Changed));

    #endregion

    #region LazyImageSource 添付プロパティ

    [AttachedPropertyBrowsableForType(typeof(ImageBrush))]
    public static Uri GetLazyImageSource(ImageBrush element)
    {
        return (Uri)element.GetValue(LazyImageSourceProperty);
    }

    [AttachedPropertyBrowsableForType(typeof(ImageBrush))]
    public static void SetLazyImageSource(ImageBrush element, Uri value)
    {
        element.SetValue(LazyImageSourceProperty, value);
    }

    public static readonly DependencyProperty LazyImageSourceProperty =
        DependencyProperty.RegisterAttached("LazyImageSource", typeof(Uri), typeof(LazyImageBehavior), new PropertyMetadata(null, LazyImageSource_Changed));

    #endregion

    private static async void LazySource_Changed(DependencyObject sender, DependencyPropertyChangedEventArgs e)
    {
        var element = sender as Image;
        if (element == null)
        {
            return;
        }
        var image = await LazyBitmapImage.GetImage(e.NewValue as Uri);
        if (image != null)
        {
            element.Source = image;
        }
    }

    private static async void LazyImageSource_Changed(DependencyObject sender, DependencyPropertyChangedEventArgs e)
    {
        var element = sender as ImageBrush;
        if (element == null)
        {
            return;
        }
        var image = await LazyBitmapImage.GetImage(e.NewValue as Uri);
        if (image != null)
        {
            element.ImageSource = image;
        }
    }
}

XAML からコードを呼び出す

あとはこれを XAML から次のように呼び出せば、バックグラウンドから画像を非同期で生成、取得して表示することができます。

<Image behaviors:LazyImageBehavior.LazySource="https://chitoku.jp/media/icon.png" />

ここでは XML 名前空間を behaviors: としましたが、プロジェクトに合わせて適当に設定してください。お疲れさまでした。