プロセス

[C#] async awaitの使い方と非同期プログラミングの基本

2025-01-18更新日: 2025-01-18

C#のasyncとawaitは、非同期プログラミングを簡単にするためのキーワードです。

asyncはメソッドの宣言に使われ、非同期操作を含むことを示します。

awaitは非同期メソッド内で使用され、非同期タスクの完了を待つ間、他の作業を続行できるようにします。

これにより、UIスレッドをブロックせずに長時間の操作を実行できます。

非同期メソッドは通常、TaskまたはTask<T>を返します。

非同期プログラミングの基本は、リソースの効率的な利用とアプリケーションの応答性を向上させることです。

目次から探す

asyncとawaitの使い方
非同期プログラミングの実践例
非同期プログラミングのベストプラクティス
応用例
まとめ

asyncとawaitの使い方

asyncキーワードの役割

asyncキーワードは、メソッドを非同期メソッドとして定義するために使用されます。

非同期メソッドは、通常のメソッドとは異なり、非同期に実行されるタスクを含むことができます。

asyncを付けることで、メソッド内でawaitキーワードを使用できるようになります。

using System;
using System.Threading.Tasks;
class Program
{
    // 非同期メソッドの定義
    static async Task Main(string[] args)
    {
        Console.WriteLine("非同期処理を開始します。");
        await ExampleAsync(); // 非同期メソッドの呼び出し
        Console.WriteLine("非同期処理が完了しました。");
    }
    // 非同期メソッド
    static async Task ExampleAsync()
    {
        await Task.Delay(1000); // 1秒待機
        Console.WriteLine("非同期処理中...");
    }
}

このコードでは、MainメソッドとExampleAsyncメソッドがasyncキーワードを使用して非同期メソッドとして定義されています。

awaitキーワードの役割

awaitキーワードは、非同期メソッド内で非同期操作を待機するために使用されます。

awaitを使用することで、非同期操作が完了するまでメソッドの実行を一時停止し、完了後に続行します。

これにより、UIスレッドをブロックせずに非同期処理を行うことができます。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        Console.WriteLine("非同期処理を開始します。");
        await ExampleAsync(); // 非同期メソッドの呼び出し
        Console.WriteLine("非同期処理が完了しました。");
    }
    static async Task ExampleAsync()
    {
        Console.WriteLine("待機中...");
        await Task.Delay(2000); // 2秒待機
        Console.WriteLine("待機が完了しました。");
    }
}

この例では、await Task.Delay(2000);によって2秒間の待機が行われますが、UIスレッドはブロックされません。

async/awaitの基本的な使い方

asyncとawaitを組み合わせることで、非同期処理を簡潔に記述できます。

非同期メソッドは通常、TaskまたはTask<T>を返します。

awaitを使用することで、非同期操作の完了を待ち、結果を取得することができます。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        Console.WriteLine("計算を開始します。");
        int result = await CalculateAsync(); // 非同期メソッドの呼び出し
        Console.WriteLine($"計算結果: {result}");
    }
    static async Task<int> CalculateAsync()
    {
        await Task.Delay(1000); // 1秒待機
        return 42; // 計算結果を返す
    }
}

このコードでは、CalculateAsyncメソッドが非同期に計算を行い、結果を返します。

非同期メソッドの戻り値

非同期メソッドの戻り値は、通常TaskまたはTask<T>です。

Taskは非同期操作の完了を表し、Task<T>は非同期操作の結果を含みます。

非同期メソッドが値を返さない場合はTaskを、値を返す場合はTask<T>を使用します。

戻り値の型	説明
`Task`	非同期操作の完了を表す。値を返さない。
`Task<T>`	非同期操作の結果を含む。値を返す。

非同期メソッドの戻り値を適切に設定することで、非同期処理の結果を簡単に取得できます。

非同期プログラミングの実践例

ファイルの非同期読み書き

C#では、System.IO名前空間を使用してファイルの非同期読み書きを行うことができます。

StreamReaderやStreamWriterクラスの非同期メソッドを利用することで、ファイル操作を非同期に実行できます。

using System;
using System.IO;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        string filePath = "example.txt";
        string content = "これは非同期で書き込まれたテキストです。";
        // ファイルに非同期で書き込む
        await WriteTextAsync(filePath, content);
        // ファイルから非同期で読み込む
        string readContent = await ReadTextAsync(filePath);
        Console.WriteLine($"読み込んだ内容: {readContent}");
    }
    static async Task WriteTextAsync(string filePath, string content)
    {
        using (StreamWriter writer = new StreamWriter(filePath))
        {
            await writer.WriteLineAsync(content); // 非同期で書き込み
        }
    }
    static async Task<string> ReadTextAsync(string filePath)
    {
        using (StreamReader reader = new StreamReader(filePath))
        {
            return await reader.ReadToEndAsync(); // 非同期で読み込み
        }
    }
}

このコードでは、WriteTextAsyncメソッドでファイルに非同期で書き込み、ReadTextAsyncメソッドで非同期に読み込んでいます。

これにより、ファイル操作中に他の処理を行うことが可能です。

Webリクエストの非同期処理

HttpClientクラスを使用すると、Webリクエストを非同期で行うことができます。

非同期メソッドを利用することで、ネットワーク待機中に他の処理を行うことができます。

using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        string url = "https://jsonplaceholder.typicode.com/todos/1";
        string response = await GetWebContentAsync(url);
        Console.WriteLine($"取得したデータ: {response}");
    }
    static async Task<string> GetWebContentAsync(string url)
    {
        using (HttpClient client = new HttpClient())
        {
            HttpResponseMessage response = await client.GetAsync(url); // 非同期でGETリクエスト
            response.EnsureSuccessStatusCode();
            return await response.Content.ReadAsStringAsync(); // 非同期でコンテンツを読み込み
        }
    }
}

この例では、GetWebContentAsyncメソッドを使用して指定したURLからデータを非同期で取得しています。

HttpClientの非同期メソッドを利用することで、ネットワーク待機中に他の処理を行うことができます。

データベースアクセスの非同期化

データベースアクセスも非同期で行うことができます。

Entity Framework CoreなどのORMを使用する場合、非同期メソッドを利用することで、データベース操作を非同期に実行できます。

using System;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
class Program
{
    static async Task Main(string[] args)
    {
        using (var context = new MyDbContext())
        {
            // データベースから非同期でデータを取得
            var data = await context.MyEntities.ToListAsync();
            foreach (var item in data)
            {
                Console.WriteLine($"ID: {item.Id}, Name: {item.Name}");
            }
        }
    }
}
public class MyDbContext : DbContext
{
    public DbSet<MyEntity> MyEntities { get; set; }
}
public class MyEntity
{
    public int Id { get; set; }
    public string Name { get; set; }
}

このコードでは、ToListAsyncメソッドを使用してデータベースからデータを非同期で取得しています。

非同期メソッドを利用することで、データベース操作中に他の処理を行うことが可能です。

非同期プログラミングのベストプラクティス

デッドロックを避ける方法

非同期プログラミングでは、デッドロックを避けるためにいくつかの注意が必要です。

特に、UIスレッドをブロックすることなく非同期操作を行うことが重要です。

ConfigureAwait(false)の使用: 非同期メソッド内でawaitを使用する際に、ConfigureAwait(false)を付けることで、コンテキストのキャプチャを防ぎ、デッドロックを回避できます。

await SomeAsyncMethod().ConfigureAwait(false);

UIスレッドをブロックしない: UIアプリケーションでは、Task.Wait()やTask.Resultを使用して同期的に待機することは避けましょう。

これにより、UIスレッドがブロックされ、デッドロックが発生する可能性があります。

エラーハンドリングの注意点

非同期メソッドでのエラーハンドリングは、通常の同期メソッドと少し異なります。

非同期メソッド内で例外が発生した場合、Taskに例外が格納されるため、適切に処理する必要があります。

try-catchブロックの使用: 非同期メソッド内でtry-catchブロックを使用して例外をキャッチし、適切に処理します。

try
{
    await SomeAsyncMethod();
}
catch (Exception ex)
{
    Console.WriteLine($"エラーが発生しました: {ex.Message}");
}

Taskの例外処理: TaskのContinueWithメソッドを使用して、例外を処理することもできます。

SomeAsyncMethod().ContinueWith(task =>
{
    if (task.IsFaulted)
    {
        Console.WriteLine($"エラーが発生しました: {task.Exception?.Message}");
    }
});

パフォーマンスの最適化

非同期プログラミングでは、パフォーマンスを最適化するためのいくつかの方法があります。

非同期処理を適切に設計することで、アプリケーションの応答性を向上させることができます。

非同期メソッドの適切な使用: 非同期メソッドを使用することで、I/O操作やネットワーク操作の待機中に他の処理を行うことができます。

これにより、アプリケーションの応答性が向上します。

並列処理の活用: Task.WhenAllやTask.WhenAnyを使用して、複数の非同期操作を並列に実行することができます。

これにより、全体の処理時間を短縮できます。

var task1 = SomeAsyncMethod1();
var task2 = SomeAsyncMethod2();
await Task.WhenAll(task1, task2);

リソースの効率的な使用: 非同期メソッドを使用する際には、リソースの効率的な使用を心がけましょう。

例えば、HttpClientは使い回すことで、接続の再利用が可能になり、パフォーマンスが向上します。

これらのベストプラクティスを守ることで、非同期プログラミングの効果を最大限に引き出し、アプリケーションのパフォーマンスと信頼性を向上させることができます。

応用例

UIスレッドの非同期処理

UIアプリケーションでは、UIスレッドをブロックしないように非同期処理を行うことが重要です。

これにより、アプリケーションの応答性を維持し、ユーザーエクスペリエンスを向上させることができます。

非同期イベントハンドラ: UIイベントハンドラを非同期にすることで、UIスレッドをブロックせずに長時間の処理を実行できます。

private async void Button_Click(object sender, EventArgs e)
{
    // 非同期処理を実行
    await LongRunningOperationAsync();
    MessageBox.Show("処理が完了しました。");
}
private async Task LongRunningOperationAsync()
{
    await Task.Delay(2000); // 2秒待機
}

この例では、ボタンのクリックイベントを非同期に処理し、UIスレッドをブロックしないようにしています。

並列処理と非同期処理の組み合わせ

非同期処理と並列処理を組み合わせることで、複数の非同期タスクを同時に実行し、全体の処理時間を短縮することができます。

Task.WhenAllの使用: 複数の非同期タスクを並列に実行し、すべてのタスクが完了するのを待ちます。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        Task task1 = Task1Async();
        Task task2 = Task2Async();
        await Task.WhenAll(task1, task2); // 並列に実行
        Console.WriteLine("すべてのタスクが完了しました。");
    }
    static async Task Task1Async()
    {
        await Task.Delay(1000); // 1秒待機
        Console.WriteLine("タスク1が完了しました。");
    }
    static async Task Task2Async()
    {
        await Task.Delay(1500); // 1.5秒待機
        Console.WriteLine("タスク2が完了しました。");
    }
}

このコードでは、Task1AsyncとTask2Asyncを並列に実行し、両方のタスクが完了するのを待っています。

非同期ストリームの利用

C# 8.0以降では、非同期ストリームを使用して、非同期にデータをストリームとして処理することができます。

IAsyncEnumerable<T>を使用することで、非同期にデータを生成し、消費することが可能です。

非同期ストリームの定義と使用: 非同期ストリームを定義し、await foreachを使用してデータを非同期に処理します。

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        await foreach (var number in GenerateNumbersAsync())
        {
            Console.WriteLine($"受信した番号: {number}");
        }
    }
    static async IAsyncEnumerable<int> GenerateNumbersAsync()
    {
        for (int i = 0; i < 5; i++)
        {
            await Task.Delay(500); // 0.5秒待機
            yield return i;
        }
    }
}