一時ディレクトリの取得、一時ファイルの作成について。 また、一時ディレクトリを設定する環境変数について。
一時ディレクトリの取得 (Path.GetTempPath)
Path.GetTempPathメソッドを呼び出すと、一時ディレクトリのパスを取得することができる。 このメソッドが返す一時ディレクトリは、環境変数の設定によって変わる。 (§.環境変数とPath.GetTempPathメソッドが返すパス)
一時ディレクトリ配下かつ任意のファイル名でのパスを直接生成するメソッドはないので、Path.Combineメソッドと組み合わせてパスを連結・生成する必要がある。
using System;
using System.IO;
class Sample {
static void Main()
{
// 一時ディレクトリへのパスを取得する (パスは環境変数によって変わる)
Console.WriteLine(Path.GetTempPath());
// 一時ディレクトリ配下かつファイル名がtemp.txtのフルパスを生成する
Console.WriteLine(Path.Combine(Path.GetTempPath(), "temp.txt"));
}
}
>dotnet run C:\Users\user\AppData\Local\Temp\ C:\Users\user\AppData\Local\Temp\temp.txt >set TMP=E:\Temp\ >dotnet run E:\Temp\ E:\Temp\temp.txt
Path.GetTempFileNameメソッドを使えば、一時ディレクトリ配下かつランダムなファイル名でファイルを作成することができる。
環境変数とPath.GetTempPathメソッドが返すパス
Path.GetTempPathメソッドは、OSやランタイムの種類によってそれぞれ異なる環境変数を参照し、設定されているパスを返す。 Path.GetTempPathメソッドが参照する環境変数と、優先順位は次のようになる。
- 環境変数
TMP - 環境変数
TEMP - レジストリキー
HKEY_CURRENT_USER\EnvironmentのTMP - レジストリキー
HKEY_CURRENT_USER\EnvironmentのTEMP -
Windowsディレクトリ
- 環境変数
TMPDIR -
/tmpディレクトリ
- 環境変数
TMP - 環境変数
TEMP -
/tmpディレクトリ
これに従いPath.GetTempPathメソッドの動作は次のようになる。
- 参照される環境変数
-
- Windows上の.NET/.NET Core/.NET Framework、およびMono
-
TMPまたはTEMP - Linux上の.NET/.NET Core
-
TMPDIR
- 環境変数で設定されているパスが存在しない場合
-
- Windows上の.NET/.NET Core/.NET Framework、およびMono
- 特に例外等は発生しない
- Linux上の.NET/.NET Core
- 起動時にFailed to create CoreCLR, HRESULT: 0x80004005となる模様
- 環境変数が設定/変更されていない場合のデフォルト
-
- Windows
-
%USERPROFILE%\AppData\Local\Temp(C:\Users\user\AppData\Local\Temp) - Linux
-
/tmp
環境変数がデフォルトの状態の場合、Windowsではユーザー別のディレクトリ、Linux等では全ユーザーが共用するディレクトリが一時ディレクトリとして返される点に注意する必要がある。
一時ファイルの作成 (Path.GetTempFileName)
Path.GetTempFileNameメソッドを使うと、一時ディレクトリに一時ファイルを作成することができる。 GetTempFileNameメソッドを呼び出すと、拡張子が.tmpでサイズが0のファイルが作成される。 そのため、一時ファイルを使用し終えたら必要に応じて削除する。 このメソッドでは常にファイルが作成されるため、一時ファイルのファイル名のみを取得することはできない。
Path.GetTempFileNameメソッドで作成される一時ファイルは、GetTempPathメソッドと同じ一時ディレクトリに作成される。
using System;
using System.IO;
class Sample {
static void Main()
{
string tempfile = null;
try {
// 一時ディレクトリ下に一時ファイルを作成し、そのファイルパスを取得する
tempfile = Path.GetTempFileName();
// 一時ファイルにテキストを書き込む
File.WriteAllText(tempfile, "Hello, world!");
}
finally {
// 一時ファイルが作成された場合、一時ファイルを使った処理が終了した時点で削除する
if (tempfile != null && File.Exists(tempfile))
File.Delete(tempfile);
}
}
}
GetTempFileNameメソッドは呼び出す度に異なるファイル名で一時ファイルを作成する。 作成されるファイル名は拡張子が.tmpとなる以外、どのようなファイル名となるか具体的には定められていない点に注意。
using System;
using System.IO;
class Sample {
static void Main()
{
// 一時ファイルを5個作成する
for (var i = 0; i < 5; i++) {
Console.WriteLine(Path.GetTempFileName());
}
}
}
C:\Users\user\AppData\Local\Temp\tmp7381.tmp C:\Users\user\AppData\Local\Temp\tmp7382.tmp C:\Users\user\AppData\Local\Temp\tmp7383.tmp C:\Users\user\AppData\Local\Temp\tmp7384.tmp C:\Users\user\AppData\Local\Temp\tmp7385.tmp
ランダムなファイル名の生成
一時ファイルの名前に用いる目的でランダムなファイル名を生成するには、Path.GetRandomFileNameメソッドを用いることができる。
このメソッドはPath.GetTempFileNameメソッドとは異なりファイル名のみを生成し、ファイル自体は生成しない。 一方、Path.GetRandomFileNameは拡張子もランダムな文字列となる。 拡張子をランダムにしたくない場合にはPath.ChangeExtensionメソッドを使って拡張子を変更する必要がある。 また生成されるファイル名にはディレクトリ名は含まれないので、一時ファイル名として用いる場合はPath.Combineメソッドでパスを結合する必要がある。
using System;
using System.IO;
class Sample {
static void Main()
{
// ランダムなファイル名を5個生成する
for (var i = 0; i < 5; i++) {
Console.WriteLine(Path.GetRandomFileName());
}
Console.WriteLine();
// 一時ディレクトリ下に配置するランダムなファイル名(拡張子.tmp)を5個生成する
for (var i = 0; i < 5; i++) {
// ランダムなファイル名を生成し、拡張子を.tmpに変更する
var filename = Path.ChangeExtension(Path.GetRandomFileName(), ".tmp");
// 生成したファイル名と一時ディレクトリのパスを結合して表示する
Console.WriteLine(Path.Combine(Path.GetTempPath(), filename));
}
}
}
df3kkr3v.wds qenz2rxf.z0j ct3sjsvc.eo3 h3awteth.fsm 4k15rb5t.arn C:\Users\user\AppData\Local\Temp\nq324ouf.tmp C:\Users\user\AppData\Local\Temp\vna2k0yi.tmp C:\Users\user\AppData\Local\Temp\hu421sz1.tmp C:\Users\user\AppData\Local\Temp\52u4clr2.tmp C:\Users\user\AppData\Local\Temp\ul4simjx.tmp
この例では生成したファイル名が衝突する可能性があるため、実際に一時ファイル名として使用する場合は、すでにファイル名が使用されていないかを調べる必要がある。