コンソールアプリ

[アーティクル]
03/14/2023

このチュートリアルでは、.NET と C# 言語のさまざまな機能を説明します。学習内容:

.NET CLI の基本事項
C# コンソールアプリケーションの構造
コンソール入出力
.NET でのファイル入出力 API の基本
.NET でのタスクベースの非同期プログラミングの基本

テキストファイルを読み取って、そのテキストファイルの内容をコンソールにエコーするアプリケーションをビルドします。コンソールへの出力は、内容を読み上げる速度に一致します。 "<" (小なり) または ">" (大なり) キーを押して、速度を速めたり遅めたりできます。このアプリケーションは、Windows、Linux、macOS 上、または Docker コンテナーで実行できます。

このチュートリアルには、多くの機能が含まれています。それらを 1 つずつビルドしてみましょう。

必須コンポーネント

.NET 6 SDK。
コードエディター。

アプリを作成する

最初に新しいアプリケーションを作成します。コマンドプロンプトを開き、アプリケーション用の新しいディレクトリを作成します。それを、現在のディレクトリとしてください。コマンドプロンプトで dotnet new console のコマンドを入力します。これで、基本的な "Hello World" アプリケーションのスターターファイルが作成されます。

変更を加える前に、このシンプルな Hello World アプリケーションを実行しましょう。アプリケーション作成後、コマンドプロンプトで dotnet run と入力します。このコマンドでは、NuGet パッケージの復元処理を実行し、アプリケーションの実行可能ファイルを作成し、実行可能ファイルを実行します。

シンプルな Hello World アプリケーションのコードはすべて Program.cs に含まれています。使い慣れたテキストエディターでそのファイルを開きます。 Program.cs のコードを次のコードに置き換えます。

namespace TeleprompterConsole;

internal class Program
{
    static void Main(string[] args)
    {
        Console.WriteLine("Hello World!");
    }
}

ファイルの上部に、namespace ステートメントがあります。お使いになったことのある他のオブジェクト指向の言語と同じく、C# では名前空間を使用して型を整理します。この Hello World プログラムも同様です。プログラムが TeleprompterConsole と言う名前の名前空間に含まれていることがわかります。

ファイルの読み取りとエコー

最初に追加する機能は、テキストファイルを読み取り、そのテキストすべてをコンソールに表示する機能です。まず、テキストファイルを追加しましょう。このサンプルの GitHub リポジトリから、sampleQuotes.txt ファイルをプロジェクトディレクトリにコピーします。これがアプリケーションのスクリプトとして機能します。このチュートリアルのサンプルアプリをダウンロードする方法については、「サンプルおよびチュートリアル」の指示をご覧ください。

次に、以下のメソッドを Program クラス (Main メソッドの真下) に追加します。

static IEnumerable<string> ReadFrom(string file)
{
    string? line;
    using (var reader = File.OpenText(file))
    {
        while ((line = reader.ReadLine()) != null)
        {
            yield return line;
        }
    }
}

このメソッドは "反復子メソッド" と呼ばれる特殊な型の C# メソッドです。反復子メソッドは、遅延評価されるシーケンスを返します。つまり、シーケンスを使用するコードによって要求されると、そのシーケンス内の各項目が生成されことになります。反復子メソッドは、1 つまたは複数の yield return ステートメントを含むメソッドです。 ReadFrom メソッドによって返されるオブジェクトには、シーケンス内の各項目を生成するコードが含まれています。この例では、ソースファイルからテキストの次の行を読み取り、その文字列を返す処理が含まれます。呼び出し元のコードがシーケンスから次の項目を要求するたびに、コードはファイルからテキストの次の行を読み取り、それを返します。ファイルが完全に読み取られたら、シーケンスはこれ以上項目がないことを示します。

新機能として C# 構文要素が 2 つあります。このメソッド内の using ステートメントは、リソースのクリーンアップを管理するものです。 using ステートメント内で初期化された変数 (この例では reader) は、IDisposable インターフェイスを実装する必要があります。そのインターフェイスは、リソースの解放が必要なときに呼び出す必要がある 1 つのメソッド Dispose を定義します。実行が using ステートメントの右中かっこに達したときに、コンパイラがその呼び出しを生成します。コンパイラによって生成されたコードでは、using ステートメントによって定義されたブロック内のコードから例外がスローされた場合でも、確実にリソースを解放させます。

reader 変数は var キーワードを使用して定義されます。 var は暗黙的に型指定されたローカル変数を定義します。つまり、変数の型は、変数に割り当てられているオブジェクトのコンパイル時の型によって決まるということです。ここでは、OpenText(String) メソッドからの戻り値のことで、これは StreamReader オブジェクトです。

ここで、Main メソッドにファイルを読み取るコードを入力してみましょう。

var lines = ReadFrom("sampleQuotes.txt");
foreach (var line in lines)
{
    Console.WriteLine(line);
}

プログラム (dotnet run を使用) を実行すると、コンソールに出力されるすべての行を確認できます。

遅延の追加と出力の書式設定

コードは今の状態だと、表示が早すぎて読み上げることができません。出力に遅延を追加する必要があります。非同期処理を可能にするコアコードを作成していくことになります。しかしここでの手順では、アンチパターンをいくつか使います。このアンチパターンは、コードを追加しながらコメントで指摘され、コードは後の手順で更新されます。

このセクションでは 2 つの手順があります。最初に、行全体ではなく単一の語を返すように反復子メソッドを更新します。そのために、次の変更を行います。 yield return line; ステートメントを、次のコードに置き換えます。

var words = line.Split(' ');
foreach (var word in words)
{
    yield return word + " ";
}
yield return Environment.NewLine;

次に、ファイルの行を使用する方法を変更し、各語を書き込んだ後に遅延を追加する必要があります。 Main メソッドの Console.WriteLine(line) ステートメントを、次のブロックに置き換えます。

Console.Write(line);
if (!string.IsNullOrWhiteSpace(line))
{
    var pause = Task.Delay(200);
    // Synchronously waiting on a task is an
    // anti-pattern. This will get fixed in later
    // steps.
    pause.Wait();
}

このサンプルを実行し、出力を確認します。これで、各語が出力されるたびに 200 ミリ秒の遅延が発生するようになりました。しかし、表示される出力には問題があります。ソーステキストファイルには、改行なしで 80 文字を超える行が複数あるからです。スクロール中にそれを読み取るのは困難です。これは簡単に修正できます。各行の長さを追跡して、行の長さが特定のしきい値に達したら新しい行を生成するだけです。行の長さを保持する ReadFrom メソッドの words の宣言の後に、ローカル変数を宣言します。

var lineLength = 0;

そして、次のコードを yield return word + " "; ステートメントの後 (右中かっこの前) に追加します。

lineLength += word.Length + 1;
if (lineLength > 70)
{
    yield return Environment.NewLine;
    lineLength = 0;
}

サンプルを実行すると、事前に設定されていたペースで読み上げることができます。

非同期タスク

この最後の手順では、1 つのタスク内で非同期的に出力を記述するとともに、別のタスクを実行して、テキスト表示の速度を上げ下げしたり、テキスト表示をまとめて停止したりする場合のユーザーからの入力を読み取ります。これは少しの手順だけで済み、これで必要な変更はすべて完了となります。最初に、ここまでで作成したファイルを読み取り表示するコードを表す、非同期の Task を返すメソッドを作成します。

このメソッドを Program クラス (Main メソッドの本体から取得したもの) に追加します。

private static async Task ShowTeleprompter()
{
    var words = ReadFrom("sampleQuotes.txt");
    foreach (var word in words)
    {
        Console.Write(word);
        if (!string.IsNullOrWhiteSpace(word))
        {
            await Task.Delay(200);
        }
    }
}

2 点、変更されます。 1 点目は、メソッドの本体で、Wait() を呼び出してタスクが終了するのを同期的に待つかわりに、このバージョンでは await キーワードを使用することです。そのためには、async 修飾子をメソッドシグネチャに追加する必要があります。このメソッドは Task を返します。 Task オブジェクトを返す return ステートメントがないことに注意してください。かわりに、その Task オブジェクトは await 演算子を使用した時にコンパイラが生成したコードによって作成されます。このメソッドは await に達するときに戻ることが想像できます。 Task が返されたということは、作業が完了していないことを表しています。このメソッドは、待機中のタスクが完了したときに再開します。それが完了すると Task が返され、タスクが完了したことがわかります。コード呼び出しでは、その返された Task を監視して、いつ完了したのか判断します。

ShowTeleprompter を呼び出すの前に await キーワードを追加します。

await ShowTeleprompter();

これには、Main メソッドシグネチャを次に変更する必要があります。

static async Task Main(string[] args)

async Main 方法の詳細については、「基礎」セクションを参照してください。

次に、2 つ目の非同期メソッドを記述して、コンソールから読み取り、"<" (小なり)、">" (大なり)、および "X" または "x" キーを監視する必要があります。そのタスクに追加するメソッドは次のとおりです。

private static async Task GetInput()
{
    var delay = 200;
    Action work = () =>
    {
        do {
            var key = Console.ReadKey(true);
            if (key.KeyChar == '>')
            {
                delay -= 10;
            }
            else if (key.KeyChar == '<')
            {
                delay += 10;
            }
            else if (key.KeyChar == 'X' || key.KeyChar == 'x')
            {
                break;
            }
        } while (true);
    };
    await Task.Run(work);
}

ここでは、ラムダ式を作成して、コンソールからキーを読み取り、ユーザーが "<" (小なり) キーまたは ">" (大なり) キーを押したときの遅延を表すローカル変数を変更する Action デリゲートを表します。デリゲートメソッドは、ユーザーが "X" または "x" キーを押したときに終了し、ユーザーはテキスト表示をいつでも停止できます。このメソッドは ReadKey() を使用してブロックし、ユーザーがキーを押すまで待機します。

この機能を完成させるには、これら両方のタスク (GetInput と ShowTeleprompter) を開始し、これら 2 つのタスク間で共有データを管理する、async Task を返す新しいメソッドを作成する必要があります。

これら 2 つのタスク間で共有データを処理するクラスを作成しましょう。このクラスには、2 つのパブリックプロパティが含まれます。遅延、そして、ファイルが完全に読み取られたことを示すフラグ Done です。

namespace TeleprompterConsole;

internal class TelePrompterConfig
{
    public int DelayInMilliseconds { get; private set; } = 200;
    public void UpdateDelay(int increment) // negative to speed up
    {
        var newDelay = Min(DelayInMilliseconds + increment, 1000);
        newDelay = Max(newDelay, 20);
        DelayInMilliseconds = newDelay;
    }
    public bool Done { get; private set; }
    public void SetDone()
    {
        Done = true;
    }
}

そのクラスを新しいファイルに配置し、上記のように、TeleprompterConsole 名前空間にそのクラスを含めます。ファイルの上部にさらに using static ステートメントを追加し、囲むクラスや名前空間の名前なしで Min および Max メソッドを参照できるようにする必要があります。 using static ステートメントは 1 つのクラスからメソッドをインポートします。これは、名前空間からすべてのクラスをインポートする static がない using ステートメントと対照的です。

using static System.Math;

次に、ShowTeleprompter メソッドと GetInput メソッドを更新して、新しい config オブジェクトを使用する必要があります。最後の Task を返す async メソッドを書いて、両方のタスクを開始し、最初のタスクが終了するときに終了させます。

private static async Task RunTeleprompter()
{
    var config = new TelePrompterConfig();
    var displayTask = ShowTeleprompter(config);

    var speedTask = GetInput(config);
    await Task.WhenAny(displayTask, speedTask);
}

ここでの 1 つの新しいメソッドは WhenAny(Task[]) の呼び出しです。これによって、その引数リスト内の任意のタスクが完了したらすぐに終了する Task が作成されます。

次に、遅延の config オブジェクトを使用するように、ShowTeleprompter メソッドと GetInput メソッドの両方を更新する必要があります。

private static async Task ShowTeleprompter(TelePrompterConfig config)
{
    var words = ReadFrom("sampleQuotes.txt");
    foreach (var word in words)
    {
        Console.Write(word);
        if (!string.IsNullOrWhiteSpace(word))
        {
            await Task.Delay(config.DelayInMilliseconds);
        }
    }
    config.SetDone();
}

private static async Task GetInput(TelePrompterConfig config)
{
    Action work = () =>
    {
        do {
            var key = Console.ReadKey(true);
            if (key.KeyChar == '>')
                config.UpdateDelay(-10);
            else if (key.KeyChar == '<')
                config.UpdateDelay(10);
            else if (key.KeyChar == 'X' || key.KeyChar == 'x')
                config.SetDone();
        } while (!config.Done);
    };
    await Task.Run(work);
}

この新しいバージョンの ShowTeleprompter は、TeleprompterConfig クラスの新しいメソッドを呼び出します。ここで、Main を更新して ShowTeleprompter の代わりに RunTeleprompter を呼び出す必要があります。

await RunTeleprompter();

まとめ

このチュートリアルでは、コンソールアプリケーションでの作業に関連する、C# 言語と .NET Core ライブラリについての多くの機能を説明しました。ここでの知識を基にすれば、この言語やここで紹介したクラスについてさらに理解していけるでしょう。ファイルとコンソール入出力の基本、タスクベースの非同期プログラミングのブロック使用と非ブロック使用、C# 言語のツアーと C# プログラムの構成方法、および .NET CLI について説明しました。

ファイル入出力の詳細については、「ファイルおよびストリーム入出力」を参照してください。このチュートリアルで使用される非同期プログラミングモデルの詳細については、「タスクベースの非同期プログラミング」と「非同期プログラミング」を参照してください。

コンソールアプリ

必須コンポーネント

アプリを作成する

ファイルの読み取りとエコー

遅延の追加と出力の書式設定

非同期タスク

まとめ

フィードバック

その他のリソース

コンソール アプリ

必須コンポーネント

アプリを作成する

ファイルの読み取りとエコー

遅延の追加と出力の書式設定

非同期タスク

まとめ

フィードバック

その他のリソース

コンソールアプリ