プロセス

[C#] asyncをつけた非同期メソッドの戻り値を設定する

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

C#で非同期メソッドを定義する際、asyncキーワードを使用します。

このメソッドの戻り値は通常、TaskまたはTask<T>型になります。

Taskは戻り値がない場合に使用し、Task<T>は戻り値がある場合に使用します。

例えば、戻り値がint型の非同期メソッドはTask<int>を返します。

非同期メソッド内でawaitを使用して非同期操作を待機し、その結果を戻り値として設定します。

これにより、非同期処理が完了するまでメソッドの実行が一時停止し、完了後に結果が返されます。

目次から探す

非同期メソッドの戻り値の設定
非同期メソッドの実装例
非同期メソッドのエラーハンドリング
応用例
まとめ

非同期メソッドの戻り値の設定

非同期メソッドは、C#において効率的なプログラムを作成するための重要な機能です。

非同期メソッドを使用することで、プログラムの応答性を向上させ、リソースの効率的な利用が可能になります。

ここでは、非同期メソッドの戻り値の設定について詳しく解説します。

戻り値がない場合のTaskの使用

非同期メソッドが戻り値を持たない場合、Taskを使用します。

Taskは、非同期操作の完了を表すオブジェクトで、メソッドが正常に終了したかどうかを確認するために使用されます。

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

非同期処理が完了しました。
処理が完了しました。

この例では、DoSomethingAsyncメソッドが1秒間の遅延を非同期で行い、その後にメッセージを表示します。

Mainメソッドでは、awaitを使用して非同期メソッドの完了を待機しています。

戻り値がある場合のTask<T>の使用

非同期メソッドが戻り値を持つ場合、Task<T>を使用します。

Tは戻り値の型を表します。

これにより、非同期メソッドから値を返すことができます。

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

計算結果: 15

この例では、CalculateSumAsyncメソッドが2つの整数を受け取り、その合計を非同期で計算して返します。

Mainメソッドでは、awaitを使用して計算結果を待機し、表示しています。

awaitによる非同期操作の待機

awaitキーワードは、非同期メソッドの完了を待機するために使用されます。

awaitを使用することで、非同期操作が完了するまで他の処理をブロックせずに待機することができます。

awaitは、async修飾子が付いたメソッド内でのみ使用可能です。
awaitを使用することで、非同期メソッドの戻り値を取得したり、処理の完了を確認したりできます。

以下の表は、awaitの使用に関するポイントをまとめたものです。

ポイント	説明
使用場所	`asyncメソッド`内でのみ使用可能
戻り値の取得	非同期メソッドの戻り値を取得可能
処理の完了確認	非同期操作の完了を待機

awaitを正しく使用することで、非同期プログラミングの利点を最大限に活用することができます。

非同期メソッドの実装例

非同期メソッドは、C#プログラミングにおいて効率的な処理を実現するための重要な手段です。

ここでは、非同期メソッドの具体的な実装例を紹介します。

戻り値がない非同期メソッドの例

戻り値がない非同期メソッドは、Taskを返すことで実装されます。

このタイプのメソッドは、主に処理の完了を待機するために使用されます。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        await PrintMessageAsync(); // 非同期メソッドの呼び出し
        Console.WriteLine("メッセージの表示が完了しました。");
    }
    static async Task PrintMessageAsync()
    {
        await Task.Delay(500); // 0.5秒待機
        Console.WriteLine("こんにちは、非同期世界！");
    }
}

こんにちは、非同期世界！
メッセージの表示が完了しました。

この例では、PrintMessageAsyncメソッドが0.5秒の遅延の後にメッセージを表示します。

Mainメソッドでは、awaitを使用して非同期メソッドの完了を待機しています。

戻り値がある非同期メソッドの例

戻り値がある非同期メソッドは、Task<T>を返すことで実装されます。

このタイプのメソッドは、非同期処理の結果を返すことができます。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        string message = await GetMessageAsync(); // 非同期メソッドの呼び出し
        Console.WriteLine(message);
    }
    static async Task<string> GetMessageAsync()
    {
        await Task.Delay(500); // 0.5秒待機
        return "非同期処理が完了しました。";
    }
}

非同期処理が完了しました。

この例では、GetMessageAsyncメソッドが0.5秒の遅延の後にメッセージを返します。

Mainメソッドでは、awaitを使用してメッセージを取得し、表示しています。

複数の非同期操作を組み合わせる例

複数の非同期操作を組み合わせることで、より複雑な非同期処理を実現できます。

以下の例では、複数の非同期メソッドを順次実行しています。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        await ExecuteMultipleAsync(); // 複数の非同期操作を実行
        Console.WriteLine("すべての非同期操作が完了しました。");
    }
    static async Task ExecuteMultipleAsync()
    {
        await Task1Async(); // 非同期タスク1を実行
        await Task2Async(); // 非同期タスク2を実行
    }
    static async Task Task1Async()
    {
        await Task.Delay(500); // 0.5秒待機
        Console.WriteLine("タスク1が完了しました。");
    }
    static async Task Task2Async()
    {
        await Task.Delay(300); // 0.3秒待機
        Console.WriteLine("タスク2が完了しました。");
    }
}

タスク1が完了しました。
タスク2が完了しました。
すべての非同期操作が完了しました。

この例では、ExecuteMultipleAsyncメソッドがTask1AsyncとTask2Asyncを順次実行します。

各タスクはそれぞれの遅延時間の後に完了し、メッセージを表示します。

Mainメソッドでは、すべての非同期操作が完了した後にメッセージを表示しています。

非同期メソッドのエラーハンドリング

非同期メソッドを使用する際には、エラーハンドリングが重要です。

非同期処理中に発生する例外を適切に処理することで、プログラムの安定性と信頼性を向上させることができます。

ここでは、非同期メソッドにおけるエラーハンドリングの基本を解説します。

例外処理の基本

例外処理は、プログラムの実行中に発生するエラーを検出し、適切に対応するための仕組みです。

C#では、例外が発生するとプログラムの通常の流れが中断され、例外がスローされます。

例外をキャッチして処理することで、プログラムの異常終了を防ぐことができます。

例外はExceptionクラスを基底クラスとするオブジェクトとして表現されます。
例外が発生すると、スタックトレースが生成され、例外の発生場所や原因を特定するのに役立ちます。

try-catchによるエラーハンドリング

try-catchブロックを使用することで、例外をキャッチして処理することができます。

非同期メソッド内でもtry-catchを使用して例外を処理することが可能です。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            await PerformAsyncOperation(); // 非同期メソッドの呼び出し
        }
        catch (Exception ex)
        {
            Console.WriteLine($"エラーが発生しました: {ex.Message}");
        }
    }
    static async Task PerformAsyncOperation()
    {
        await Task.Delay(500); // 0.5秒待機
        throw new InvalidOperationException("無効な操作が行われました。"); // 例外をスロー
    }
}

エラーが発生しました: 無効な操作が行われました。

この例では、PerformAsyncOperationメソッド内で例外がスローされますが、Mainメソッドのtry-catchブロックでキャッチされ、エラーメッセージが表示されます。

非同期メソッドでの例外の伝播

非同期メソッドで発生した例外は、awaitを使用している箇所に伝播されます。

これにより、非同期メソッドの呼び出し元で例外をキャッチして処理することができます。

非同期メソッド内で例外が発生した場合、awaitを使用している箇所で例外が再スローされます。
呼び出し元でtry-catchを使用して例外をキャッチすることができます。

using System;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        try
        {
            await Method1Async(); // 非同期メソッドの呼び出し
        }
        catch (Exception ex)
        {
            Console.WriteLine($"メインでキャッチされた例外: {ex.Message}");
        }
    }
    static async Task Method1Async()
    {
        await Method2Async(); // 別の非同期メソッドの呼び出し
    }
    static async Task Method2Async()
    {
        await Task.Delay(500); // 0.5秒待機
        throw new Exception("Method2で例外が発生しました。"); // 例外をスロー
    }
}

メインでキャッチされた例外: Method2で例外が発生しました。

この例では、Method2Asyncでスローされた例外がMethod1Asyncを経由してMainメソッドに伝播され、try-catchブロックでキャッチされます。

これにより、非同期メソッド間で例外を適切に伝播し、処理することができます。

応用例

非同期メソッドは、さまざまな場面で効率的な処理を実現するために活用できます。

ここでは、非同期メソッドを用いた具体的な応用例を紹介します。

非同期メソッドを用いたファイル操作

非同期メソッドを使用することで、ファイルの読み書き操作を効率的に行うことができます。

これにより、ファイル操作中にプログラムがブロックされることを防ぎ、ユーザーインターフェースの応答性を維持できます。

using System;
using System.IO;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        string filePath = "example.txt";
        await WriteTextAsync(filePath, "こんにちは、ファイル操作の非同期世界！"); // 非同期でファイルに書き込み
        string content = await ReadTextAsync(filePath); // 非同期でファイルを読み込み
        Console.WriteLine($"ファイルの内容: {content}");
    }
    static async Task WriteTextAsync(string filePath, string content)
    {
        using (StreamWriter writer = new StreamWriter(filePath))
        {
            await writer.WriteAsync(content); // 非同期で書き込み
        }
    }
    static async Task<string> ReadTextAsync(string filePath)
    {
        using (StreamReader reader = new StreamReader(filePath))
        {
            return await reader.ReadToEndAsync(); // 非同期で読み込み
        }
    }
}

ファイルの内容: こんにちは、ファイル操作の非同期世界！

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

非同期メソッドを用いたネットワーク通信

非同期メソッドは、ネットワーク通信においても有効です。

非同期でデータを送受信することで、通信中にプログラムがブロックされることを防ぎます。

using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        string url = "https://www.example.com";
        string content = await FetchContentAsync(url); // 非同期でWebページの内容を取得
        Console.WriteLine($"取得した内容: {content.Substring(0, 100)}..."); // 先頭100文字を表示
    }
    static async Task<string> FetchContentAsync(string url)
    {
        using (HttpClient client = new HttpClient())
        {
            return await client.GetStringAsync(url); // 非同期でデータを取得
        }
    }
}

取得した内容: <!doctype html><html><head><title>Example Domain</title>...

この例では、FetchContentAsyncメソッドを使用して、指定したURLから非同期でWebページの内容を取得しています。

非同期メソッドを用いたデータベースアクセス

データベースアクセスにおいても、非同期メソッドを使用することで効率的なデータ操作が可能です。

非同期でクエリを実行することで、データベース操作中にプログラムがブロックされることを防ぎます。

using System;
using Microsoft.Data.SqlClient;
using System.Threading.Tasks;
class Program
{
    static async Task Main(string[] args)
    {
        string connectionString = "your_connection_string_here";
        string query = "SELECT TOP 1 Name FROM Employees";
        string result = await FetchDataAsync(connectionString, query); // 非同期でデータを取得
        Console.WriteLine($"取得したデータ: {result}");
    }
    static async Task<string> FetchDataAsync(string connectionString, string query)
    {
        using (SqlConnection connection = new SqlConnection(connectionString))
        {
            await connection.OpenAsync(); // 非同期で接続を開く
            using (SqlCommand command = new SqlCommand(query, connection))
            {
                return (string)await command.ExecuteScalarAsync(); // 非同期でクエリを実行
            }
        }
    }
}