はじめに
INIファイルの入出力を行うクラスを作成しました。
C#でINIファイルを操作する方法は、デフォルトでは用意されていません。
メジャーなのはWin32のGetPrivateProfileStringやWritePrivateProfileStringを使用する方法でしょうか。
初期化ファイル内の指定したセクションから文字列を取得します。
GetPrivateProfileString function (winbase.h) – Win32 apps | Microsoft Docs
ただし、Win32だとDLLImportが必要なのと、読込みの度にファイルアクセスが必要だったりで、微妙に使いづらいなと個人的に思ったりします。
自作INIファイルクラス
今回作成したINIファイルクラスでは、メモリにINIファイルの内容を保持するため、ファイルアクセスは初回の読込み時と出力時のみです。
今時のPCでINIファイル程度のサイズならメモリ使用量も気にする必要はないと思いますので、問題はないと考えます。
メモリに保持するといっても、Dictionaryに読み込むだけです。マネージドです。
ごりへい
メモリを気にするならWinFormsではなく、C++でアプリケーションを作成する方がずっと効果的ウホ
また、コメントの読込み、出力、エンコーディング指定に対応しています。
IniFile.cs
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 |
using System; using System.IO; using System.Text; using System.Linq; using System.Diagnostics; using System.Threading.Tasks; using System.Collections.Generic; using System.Text.RegularExpressions; namespace Files { /// <summary> /// INIファイルを操作する機能を提供します。 /// WIN32APIを使用しない為、文字コードセットの指定が可能です。 /// /// ■仕様 /// ・セクション無しのキーバリューは無いものとして扱う。 /// ・キーバリューと同じ行に記載されているコメントは保持する。 /// ・コメントのみの行は無いものとして扱う。(コメントのみの行があるINIファイルを読込み→保存とした場合、コメントのみの行は削除される。) /// ・「;」または「#」以降の行末までの文字をコメントとして扱います。 /// ・コメントの出力時は「;」として出力します。 /// </summary> public class IniFile : IFile { #region Constant /// <summary> /// セクションチェック正規表現パターン /// </summary> /// private static readonly string SECTION_PATTERN = @"^\s*\[(?<SECTION>[^\[\]]+?)\]\s*$"; /// <summary> /// キー/値チェック正規表現パターン /// </summary> private static readonly string KEYVALUE_PATTERN = @"^\s*(?<KEY>[^=;#]+?)\s*=\s*(?<VALUE>[^=;#]*?)(;.*|#.*|\s*)$"; /// <summary> /// コメントチェック正規表現パターン /// </summary> private static readonly string COMMENT_PATTERN = @"^.*(;|#)(?<COMMENT>.*)$"; /// <summary> /// 正規表現グループ セクション /// </summary> private static readonly string SECTION = "SECTION"; /// <summary> /// 正規表現グループ キー /// </summary> private static readonly string KEY = "KEY"; /// <summary> /// 正規表現グループ 値 /// </summary> private static readonly string VALUE = "VALUE"; /// <summary> /// 正規表現グループ コメント /// </summary> private static readonly string COMMENT = "COMMENT"; /// <summary> /// Mapの値を表すキー /// </summary> private const string KEY_VALUE = "value"; /// <summary> /// Mapのコメントを表すキー /// </summary> private const string KEY_COMMENT = "comment"; #endregion #region Property /// <summary> /// INIファイル構造ディクショナリ /// </summary> private Dictionary<string, Dictionary<string, Dictionary<string, string>>> Map { get; set; } /// <summary> /// ファイルのエンコーディングを取得します。 /// </summary> public Encoding Encoding { get; private set; } /// <summary> /// ファイルの名前を取得または設定します。 /// </summary> public string Name => System.IO.Path.GetFileName(Path); /// <summary> /// ファイルのパスを取得または設定します。 /// </summary> public string Path { get; set; } /// <summary> /// ファイルが読み取り専用かどうかを取得します。 /// </summary> public bool IsReadOnly { get { if (string.IsNullOrEmpty(Path)) { return false; } var info = new FileInfo(Path); if (info.Exists && info.IsReadOnly) { return true; } else { return false; } } set { // INIファイルは読み取り専用のSETはしない } } /// <summary> /// コメントの開始文字を取得または設定します。デフォルトは";"です。 /// 出力時のみ使用されまうす。読込み時のコメント開始文字は";"または"#"が使用可能です。 /// </summary> public string CommentChar { get; set; } = ";"; /// <summary> /// インデクサー /// 指定のセクションのキーから値を取得または設定します。 /// </summary> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <returns></returns> public string this[string section, string key] { get { return GetValue<string>(section, key); } set { SetValue(section, key, value); } } /// <summary> /// インデクサー /// 指定のセクションのキーから値を取得または設定します。 /// 取得に失敗した場合、デフォルト値を返却します。 /// </summary> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <param name="defaultValue">デフォルト値</param> /// <returns></returns> public string this[string section, string key, string defaultValue] { get { return GetValue(section, key, defaultValue); } set { SetValue(section, key, value); } } #endregion #region Constructor /// <summary> /// 空のINIファイルインスタンスを初期化します。 /// </summary> public IniFile() : this(null, Encoding.UTF8) { } /// <summary> /// ファイル名を含む絶対パスを指定してINIファイルインスタンスを初期化します。 /// </summary> /// <param name="filePath"></param> public IniFile(string filePath) : this(filePath, Encoding.UTF8) { } /// <summary> /// 文字エンコーディングを指定して空のINIファイルインスタンスを初期化します。 /// </summary> /// <param name="enc"></param> public IniFile(Encoding enc) : this(null, enc) { } /// <summary> /// ファイル名を含む絶対パスと文字エンコーディングを指定してINIファイルクラスインスタンスを初期化します。 /// </summary> /// <param name="filePath">ファイル名を含む絶対パス</param> /// <param name="enc">エンコーディング</param> public IniFile(string filePath, Encoding enc) { Path = filePath; Encoding = (enc is null) ? Encoding.UTF8 : enc; Map = new Dictionary<string, Dictionary<string, Dictionary<string, string>>>(); if (File.Exists(filePath)) { Load(filePath); } } #endregion #region Method /// <summary> /// 指定したパスのINIファイルをDictionaryに読み込みます。 /// </summary> /// <param name="path">ファイル名を含む絶対パス</param> public bool Load(string path) { Path = path; var lines = new List<string>(); // 全行取得 using (var sr = new StreamReader(path, Encoding)) { while (!sr.EndOfStream) { lines.Add(sr.ReadLine()); } } if (!lines.Any()) return true; // セクションとキー/値をチェック var secRegex = new Regex(SECTION_PATTERN); var keyRegex = new Regex(KEYVALUE_PATTERN); var commentRegex = new Regex(COMMENT_PATTERN); var lastSec = string.Empty; foreach (var line in lines) { // セクション行 if (secRegex.IsMatch(line)) { // セクション名取得 var section = secRegex.Match(line).Groups[SECTION].Value.Trim(); // 読込み済みではないセクションの場合 if (!Map.ContainsKey(section)) { Map[section] = new Dictionary<string, Dictionary<string, string>>(); } // 最終読込みセクションをメモ lastSec = section; } // キー＆値行 else if (keyRegex.IsMatch(line)) { // 最終読込みセクションが空 if (string.IsNullOrWhiteSpace(lastSec)) { continue; } // キーと値を取得 var key = keyRegex.Match(line).Groups[KEY].Value.Trim(); var value = keyRegex.Match(line).Groups[VALUE].Value.Trim(); // キーと値をセクションに追加 Map[lastSec][key] = new Dictionary<string, string>(); Map[lastSec][key][KEY_VALUE] = value; // コメント有り if (commentRegex.IsMatch(line)) { var comment = commentRegex.Match(line).Groups[COMMENT].Value; Map[lastSec][key][KEY_COMMENT] = comment; } } } return true; } /// <summary> /// INIファイルを指定のパスに保存します。 /// <paramref name="path"/>がnullの場合、インスタンス初期化時のパスに上書き出力します。 /// </summary> /// <param name="path">ファイル名を含む絶対パス</param> /// <returns>true:保存成功</returns> public bool Save(string path = null) { var savePath = path; if (string.IsNullOrWhiteSpace(savePath)) { // INIファイルが新規作成の場合 if (string.IsNullOrWhiteSpace(Path)) { return false; } // INIファイルを読込んでいる場合 else { savePath = Path; } } using (var fs = new FileStream(savePath, FileMode.Create)) using (var sw = new StreamWriter(fs, Encoding)) { foreach (var section in Map.Keys) { sw.WriteLine($"[{section}]"); foreach (var pair in Map[section]) { // キーと値を出力 var text = $"{pair.Key}={pair.Value[KEY_VALUE]}"; if (pair.Value.ContainsKey(KEY_COMMENT)) { // コメントを出力 text += $"{CommentChar}{pair.Value[KEY_COMMENT]}"; } sw.WriteLine(text); } } sw.Flush(); fs.Flush(); } return true; } /// <summary> /// セクション名一覧を取得します。 /// </summary> /// <returns>セクション名コレクション</returns> public IEnumerable<string> GetSections() { if (!Map.Any()) { return null; } else { return Map.Keys; } } /// <summary> /// キー名一覧を取得します。 /// </summary> /// <param name="section">セクション名</param> /// <returns>キー名コレクション</returns> public IEnumerable<string> GetKeys(string section) { if (!IsSectionExists(section)) { return null; } else { return Map[section].Keys; } } /// <summary> /// キー名と値のディクショナリを取得します。 /// </summary> /// <param name="section">セクション名</param> /// <returns>キー名=値のディクショナリ</returns> public IDictionary<string, string> GetKeyValuePair(string section) { if (!IsSectionExists(section)) { return null; } else { return Map[section].ToDictionary(m => m.Key, m => m.Value[KEY_VALUE]); } } /// <summary> /// INIファイルに指定のセクションが存在するかチェックします。 /// </summary> /// <param name="section">セクション名</param> /// <returns>true:セクション有/false:セクション無</returns> public bool IsSectionExists(string section) { if (!Map.Any()) { return false; } else { return Map.ContainsKey(section); } } /// <summary> /// INIファイルの指定のセクションに指定のキー名が存在するかチェックします。 /// </summary> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <returns>true:キー有/false:キー無</returns> public bool IsKeyExists(string section, string key) { if (!IsSectionExists(section)) { return false; } else { return Map[section].ContainsKey(key); } } /// <summary> /// INIファイルの指定のセクションの指定のキー名から値を取得します。 /// 取得に失敗した場合、デフォルト値を返却します。 /// </summary> /// <typeparam name="T"></typeparam> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <param name="defVal">デフォルト値</param> /// <returns>値</returns> public T GetValue<T>(string section, string key, T defVal = default) { T result = defVal; if (!IsKeyExists(section, key)) { return result; } var val = Map[section][key][KEY_VALUE]; Type t = typeof(T); try { result = (T)Convert.ChangeType(val, t); } catch (Exception e) { Debug.Write(e.Message); } return result; } /// <summary> /// INIファイルの指定のセクションの指定のキー名からコメントを取得します。 /// </summary> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <returns>コメント</returns> public string GetComment(string section, string key) { if (IsKeyExists(section, key)) { return Map[section][key][KEY_COMMENT]; } else { return ""; } } /// <summary> /// INIファイルの指定のセクションの指定のキー名に値を設定します。 /// </summary> /// <typeparam name="T"></typeparam> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <param name="value">設定値</param> /// <param name="comment">コメント</param> public void SetValue<T>(string section, string key, T value) { // 存在しないセクションの場合は追加する if (!Map.ContainsKey(section)) { Map[section] = new Dictionary<string, Dictionary<string, string>>(); } // 存在しないキーの場合追加する if (!Map[section].ContainsKey(key)) { Map[section][key] = new Dictionary<string, string>(); } Map[section][key][KEY_VALUE] = value.ToString(); } /// <summary> /// INIファイルの指定のセクションの指定のキー名にコメントを設定します。 /// </summary> /// <param name="section">セクション名</param> /// <param name="key">キー名</param> /// <param name="comment">コメント</param> public void SetComment(string section, string key, string comment) { if (IsKeyExists(section, key)) { Map[section][key][KEY_COMMENT] = comment; } } #endregion } } |
IFile.cs
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
/// <summary>ファイルの共通的な振る舞いを定義します。</summary> public interface IFile { /// <summary>ファイルの名前を取得または設定します。</summary> string Name { get; } /// <summary>ファイルのパスを取得または設定します。</summary> string Path { get; set; } /// <summary>ファイルが読み取り専用かどうかを取得します。</summary> bool IsReadOnly { get; set; } /// <summary>指定したパスのファイルを読み込みます。</summary> bool Load(string path = null); /// <summary>指定したパスにファイルを保存します。</summary> bool Save(string path = null); } |
IFile.csは他に作成しているCSVやPDF等の自作クラスを共通で処理するためのインターフェイスなので、あまり気にしないでください。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
C:\test.ini ---------------------------------------------- [blog] name=凡人プログラマーのブログ author=gorihei;コメント！ ---------------------------------------------- var ini = new IniFile(@"C:\test.ini") Console.Write(ini["blog", "name"]); // 凡人プログラマーのブログ Console.Write(ini["blog", "author"]); // gorihei Console.Write(ini.GetComment("blog", "author")); // コメント! ini["blog", "author"] = "ごりら"; ini.Save(@"C:\test2.ini"); C:\test2.ini ---------------------------------------------- [blog] name=凡人プログラマーのブログ author=ごりら;コメント！ ---------------------------------------------- |
説明
関数コメントに記載しているため不要かもしれませんが、軽く説明します。
ファイルの読込み
ファイルのパスを指定してインスタンスを初期化します。
処理としては、INIファイルを行毎に正規表現で解析してDictionaryに追加していくだけです。
ファイルパスを指定せずにインスタンスを初期化する事も可能です。
その場合、値を設定して出力することでINIファイルを作成する事が出来ます。
値の取得、設定
値を取得する方法は２つあります。
GetValueとインデクサーを使用する方法です。
インデクサーとは
インデクサー – C# プログラミング ガイド | Microsoft Docs
インデクサーを使用すると、配列と同じようにクラスまたは構造体のインスタンスにインデックスを作成することができます。 インデックス値は、型またはインスタンス メンバーの明示的な指定なしで設定または取得できます。 インデクサーはプロパティと似ていますが、そのアクセサーがパラメーターを取る点が異なります。
インデクサーで値を取得する場合、ini[“セクション”, “キー”]で値を取得出来ます。
ただし、IniFileクラスはジェネリッククラスではないため、インデクサーにジェネリックを使用できません。そのため、string型でのアクセスとなります。
GetValueで値を取得する場合、ini.GetValue<T>(“セクション”, “キー”)で値を取得できます。
string型以外の型で値を取得する場合はGetValueを使用します。
|
1 |
ini.GetValue<int>("セクション", "キー"); |
値を設定する方法も取得する場合と同様、２つあります。
SetValueとインデクサーを使用する方法です。
使用方法は設定する方法と同様なので省略します。
ファイル出力
Save関数でファイルを出力します。
ファイルを読み込んでいる場合に引数を指定しなければ上書き出力となります。
引数で出力先パスを指定した場合、指定したパスに出力します。
まとめ
今回作成したINIファイルクラスでは、以下の点がWin32より優れている点、劣っている点を挙げてみます。(主観)
- 値の取得、設定の度にファイルアクセスが発生しない。
- DLLImportを使用しなくてよい。
- 直感的に操作しやすい。(個人の主観ばりばり入ってます)
- ファイルエンコーディングが指定出来る。
- コメントの読込み、出力に対応。
- 広く普及しているWin32の仕様と異なる為、人によっては使いにくく感じる。
- メモリにファイルを読み込む為、メモリを圧迫する。
上記の挙げた通り、ほぼデメリットは無いと思っています。
何かありましたら気軽にコメントを頂けますと幸いです。
また、コードはご自由にご自由にコピペしていただいて構いませんが、利用によって生じた損害等の一切の責任を負いかねますのでご了承ください。
おまけ
最近はめっきりINIファイルを使用する事がなくなりましたので、需要はほぼないかもしれません。
ごりへい自身、INIファイルを使用する事はほぼないですし、あまり使いたくありません。
今時のアプリケーションはJsonまたはxmlでシリアライズするのがモダンなやり方ですよね。
ただ、たまに
お客
Jsonやxmlはよくわからん！INIファイルを使え！INIファイルを！
というお客様もいるので、そんな時お役に立てれば幸いです。
コメント