明月のプログラム: [C#]「IDisposable」と「using」

こんにちは。明月です。
前の投稿までFileシステムについて勉強しました。少し勉強順番が悪くなりましたが、今日は「C#」の文法の「using」と「IDisposable」のインターフェースについて勉強します。

IDisposable

「IDisposable」のインターフェースは「Dispose」のメソッドを抽象してコネクションと関係あるクラスに継承して「Ｄｉｓｐｏｓｅ」（解除）メソッドを実装させるようことです。すなわち、FileStreamと通信、データベース連携等のクラスレベルでリソースを解除するためにDisposeメソッドを実装することです。

MSDNリンク - IDisposable インターフェイス

 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO;

namespace IDisposable
{
    class Program
    {
        static void Main(string[] args)
        {
            //ファイル「c:\work\file.txt」のコネクションを取得する。
            FileStream stream = new FileStream("c:\\work\\file.txt", FileMode.Append, FileAccess.Write);
            //その状況で同じファイルのコネクションを取得する。
            stream = new FileStream("c:\\work\\file.txt", FileMode.Open, FileAccess.Read);

            Console.WriteLine("Press any key...");
            Console.ReadLine();
        }
    }
}

上の例は「Dispose」メソッドでリソースを解除しなく、他のストリームで同じリソースのコネクションを取得するようにしてエラーを発生することを実装したことです。
すなわち、データを作成するリソースのコネクションを取得してリソースを解除しない状況で読み込むためにコネクションを取得するように実装したのでエラーが発生したことです。

 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO;

namespace IDisposable
{
    class Program
    {
        static void Main(string[] args)
        {
            //ファイル「c:\work\file.txt」のコネクションを取得する。
            FileStream stream = new FileStream("c:\\work\\file.txt", FileMode.Append, FileAccess.Write);
            //リソース(ストリーム)解除
            stream.Dispose();
            //その状況で同じファイルのコネクションを取得する。
            stream = new FileStream("c:\\work\\file.txt", FileMode.Open, FileAccess.Read);
            //リソース(ストリーム)解除
            stream.Dispose();

            Console.WriteLine("Press any key...");
            Console.ReadLine();
        }
    }
}

リソースを取得~解除の規則はC#だけではなく全てのプログラム言語にも同じ規則です。それでリソースを取得する時には必ず解除しますという構造をちゃんと認識するべきです。

今まで勉強したとおりに簡単なプログラムな作成する時にはリソース取得、解除がそんなに難しくないです。しかし大きいプログラムからはリソース返却するロジックはそんなに簡単ではありません。

using

「using」はソースの一番上端で「namespace」を宣言する時に使うキーワードです。でも、「.NetFramewor3.5」から「IDisposable」インターフェースを継承しているクラスに囲まれていれば処理が終わる時期に「Dispose」メソッドを呼び出す機能もあります。

 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO;

namespace IDisposable
{
    class Program
    {
        public Program()
        {
            //FileStreamコネクション取得、BufferdStreamコネクション取得、TextWriterコネクション取得
            TextWriter writer = getWriter(getFileStream(getFileInfo("c:\\work\\file.txt")));
            writer.WriteLine("Hello world");
            //「TextWriter」の場合は「Dispose」を呼び出して解除しましたが、FileStreamとBufferdStreamは？？
            writer.Dispose();
        }
        public FileInfo getFileInfo(String filename)
        {
            return new FileInfo(filename);
        }
        public Stream getFileStream(FileInfo info)
        {
            if(info.Exists)
            {
                info.Delete();
            }
            return info.OpenWrite();
        }
        public StreamWriter getWriter(Stream stream)
        {
            return new StreamWriter(new BufferedStream(stream));
        }
        static void Main(string[] args)
        {
            new Program();

            Console.WriteLine("Press any key...");
            Console.ReadLine();
        }
    }
}

上のコンストラクタをみると最後にTextWriterタイプのオブジェクトは「Dispose」のメソッドを呼び出して解除しましたが、中のFileStream、BufferedStreamのストリームは解除することが大変になっています。

 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.IO;

namespace IDisposable
{
    class Program
    {
        public Program()
        {
            //FileStreamコネクション取得、BufferdStreamコネクション取得、TextWriterコネクション取得
            using (TextWriter writer = getWriter(getFileWriteStream(getFileInfo("c:\\work\\file.txt"))))
            {
                //usingキーハードのブロック処理が終わると自動にDisposeを呼ばれてリソースを解除します。
                writer.WriteLine("Hello world");
            }
            //上のリーソースは解除したので新しいストリームで取得が可能
            using (TextReader reader = getReader(getFileReadStream(getFileInfo("c:\\work\\file.txt"))))
            {
                //usingキーハードのブロック処理が終わると自動にDisposeを呼ばれてリソースを解除します。
                Console.WriteLine(reader.ReadLine());
            }
        }
        public FileInfo getFileInfo(String filename)
        {
            return new FileInfo(filename);
        }
        public Stream getFileReadStream(FileInfo info)
        {
            return info.OpenRead();
        }
        public Stream getFileWriteStream(FileInfo info)
        {
            if(info.Exists)
            {
                info.Delete();
            }
            return info.OpenWrite();
        }
        public TextReader getReader(Stream stream)
        {
            return new StreamReader(new BufferedStream(stream));
        }
        public TextWriter getWriter(Stream stream)
        {
            return new StreamWriter(new BufferedStream(stream));
        }
        static void Main(string[] args)
        {
            new Program();

            Console.WriteLine("Press any key...");
            Console.ReadLine();
        }
    }
}

今まで「IDisposable」と「using」の関係について勉強しました。「using」と「IDisposable」はJavaの「try」と「IClosable」の関係と同じですね。
「using」〜「IDisposable」はプログラムの性能とは関係ないですが、リソース管理をしやすく処理して生産性を上がられるキーワードだと思うのでちゃんと勉強したほうがプログラムを開発する時に良いと思います。

初めに

[C#]「IDisposable」と「using」

IDisposable

using

0 件のコメント