.net column

.NET開発者のためのブログメディア

C#のusingを活用しよう!

2020年05月07日

SE
C#のusingは、どのような利用方法があるのでしょうか。

PM
ファイルアクセス処理の後始末やfinally処理を代行で行ってくれる便利な機能です。

C#のusingとは?

C#のプログラミングをする方は、usingを活用していますでしょうか?「using?あの先頭にいつもあるやつだよね」と思う人が多いでしょう。しかし以下のようなC#のソースコードの先頭にあるusing宣言は、名前空間を呼び出すためのもので、今回説明するusingとは違います。using System;using System.IO;今から紹介するusingは、ファイルアクセス処理などでとても便利に使える機能です。この記事を読んで、是非シンプルで安全なC#プログラミングを行ってください。

usingはファイルアクセス処理の後始末をしてくれる

C#のusingとは、IDisposableインターフェイスを実装したアンマネージドクラスを正常に終了してくれる構文です。と言うと難しそうですが、簡単に言えばファイルのアクセス処理を自動的に終了してくれる便利な機能です。例としては以下のように使います。try{ using (StreamReader sread = new StreamReader(“”C:\\download\\text.txt””)) { Console.WriteLine(sread.ReadToEnd()); }}catch (FileNotFoundException e){ Console.WriteLine(“”ファイルがありません。””);}なおこのようにStreamReaderを、文字コードを指定せず生成した場合は、UTF-8で読み込むのでご注意下さい。日本のWindows標準のShift_JISではありません。これはC#がWindows専用ではなくマルチプラットフォーム言語を目指していることによります。

usingを使えばfinallyが不要

上のサンプルプログラムはdownloadフォルダにあるtext.txtを読み込んで、中身をコンソールに表示します。ファイルが無かった場合は例外が発生し、catchで捉えてエラーメッセージを表示します。もしファイルアクセスを少し学んだ人なら「あれ?終了処理のfinallyが無くていいの?」と思うでしょう。そうですね、ファイルアクセス処理は最初以下のように習ったかもしれません。StreamReader sread = null;try{ sread = new StreamReader(“”C:\\download\\text.txt””); Console.WriteLine(sread.ReadToEnd());}catch (FileNotFoundException e){ Console.WriteLine(“”ファイルがありません。””);}finally // 最後に必ず実行される{ if (sread != null) sread.Close(); // ファイルの後始末}

usingはfinally処理を代行してくれる

ところがusingを使えばfinally節が不要になるのです。usingが終了処理のfinallyとその中で行うDisposeを実行してくれるからです。正確に言えば、usingはファイル処理クラスに実装されているIDisposableインターフェイスのDisposeメソッドを必ず実行する、ということです。「ファイルアクセスの終了処理はDisposeじゃなくてCloseじゃないの?」と思う人もいるかもしれませんが、C#ではCloseの処理はDisposeと同じなので問題ありません。

usingを使ってプログラムをシンプルに

usingを使うことでC#のファイルアクセス処理はシンプルになります。また、このサンプルで言えばsreadの宣言をtryの中で行えるので、処理がスマートになるメリットもあります。finallyを使う場合はそういったファイル制御変数をtryの外で宣言する必要がありますよね。ファイル操作変数が1つだけだとあまりメリットを感じないかもしれませんが、次の例のように2つ以上あればusingの効果を実感できるでしょう。try{ using (StreamReader sread = new StreamReader(“”C:\\download\\text.txt””)) using (StreamWriter swrite = new StreamWriter(“”C:\\download\\newtext.txt””)) { string buffer = sread.ReadToEnd(); swrite.WriteLine(buffer); }}catch (FileNotFoundException e){ Console.WriteLine(“”ファイルがありません。””);}

複数のusingでソースコードがよりすっきりする

上のサンプルは読み込んだファイルの内容をそのまま複製します。上のようにusingは2つ並べて使用することもできます。usingを使わない場合はfinallyに複数のファイルアクセス変数のDispose処理を記述するので冗長になりますが、usingを使えばそれが不要なのですっきりします。便利なusingですが、注意すべき点もあります。次のサンプルプログラムを見てください。StreamReader sread = null;try{ using (sread = new StreamReader(“”C:\\download\\text.txt””)) { Console.WriteLine(sread.ReadToEnd()); } Console.WriteLine(“”もう一度表示””); Console.WriteLine(sread.ReadToEnd());}catch (FileNotFoundException e){ Console.WriteLine(“”ファイルがありません。””);}

usingが有効な範囲は{}の中だけ

上のサンプルを実行すると、ファイルの中身が表示されて、「もう一度表示」というメッセージが出た後に、ObjectDisposedExceptionが発生してプログラムが異常終了します。usingが有効な範囲は次の{}の中だけで、その外に出てしまうとDispose処理が行われた後なのでアクセスができないのです。このような間違ったプログラムを記述してもビルドの時点ではエラーにはならないので、注意しましょう。

usingの応用

ここまで標準のファイルアクセスクラスに対してのusingの使い方を説明してきましたが、自分が作ったクラスでもIDisposableを実装すればusingが使えます。以下のサンプルプログラムをご覧ください。class MyClass : IDisposable{ public void Dispose() { Console.WriteLine(“”MyClass内のDisposeが呼ばれました。””); }}static void Main(string[] args){ using (MyClass myc = new MyClass()) { Console.WriteLine(“”usingでMyClassを生成しました。””); } Console.WriteLine(“”usingを抜けました。””);}

工夫次第で便利に使えるusing

上のサンプルプログラムを実行すると、コンソールに以下のように表示されます。usingでMyClassを生成しました。MyClass内のDisposeが呼ばれました。usingを抜けました。自作のクラスにIDisposableを実装してDisposeメソッドを記述し、usingを使用して自作のクラスを生成した場合でも、usingの後の{}を抜ける時にDisposeが呼ばれることが分かります。これを上手く利用すれば、シンプルなC#のコードを記述できるでしょう。

SE
C#のusingは、基本から応用までさまざまな利用方法があるのですね。

PM
そうですね。usingはC#にしかない機能なので上手に活用して行きましょう!

おわりに

C#のusingについて説明しましたがご理解頂けましたでしょうか。usingを利用することでファイルアクセス処理がシンプルになるだけでなく、自作のクラスにも役立てることができます。usingはC#以外の言語では見当たらない機能なので、是非活用してください。


.NET分野でのキャリアアップをお考えの方は、現在募集中の求人情報をご覧ください。

求人一覧

また、直接のエントリーも受け付けております。

エントリー(応募フォーム)