13,051
回編集
「C Sharpの基礎 - TOML」の版間の差分
ナビゲーションに移動
検索に移動
→TOMLファイルとYAMLファイルの比較
| 164行目: | 164行目: | ||
* 型推論が強く、明示的な型宣言が少なくて済む。 | * 型推論が強く、明示的な型宣言が少なくて済む。 | ||
* <u>TOMLは小〜中規模の設定ファイルに適している。</u> | * <u>TOMLは小〜中規模の設定ファイルに適している。</u> | ||
<br><br> | |||
== Tomlynライブラリ == | |||
==== Tomlynライブラリとは ==== | |||
Tomlynライブラリは、C#でTOML (Tom's Obvious, Minimal Language) ファイルを扱うためのライブラリである。<br> | |||
TOMLは設定ファイルフォーマットとして人気があり、読みやすさと書きやすさを兼ね備えている。<br> | |||
<br> | |||
Tomlynライブラリの主な特徴として、TOMLファイルの解析と生成が挙げられる。<br> | |||
このライブラリを使用することにより、開発者はTOMLデータを簡単にC#オブジェクトに変換したり、C#オブジェクトからTOMLデータを生成することができる。<br> | |||
<br> | |||
パフォーマンスもTomlynライブラリの強みの1つである。<br> | |||
効率的な解析アルゴリズムを採用しており、大きなTOMLファイルでも高速に処理することができる。<br> | |||
また、メモリ使用量も抑えられるよう設計されている。<br> | |||
<br> | |||
柔軟性もTomlynライブラリの特徴である。<br> | |||
様々なTOMLデータ型 (文字列、整数、浮動小数点数、ブール値、日時、配列、テーブル等) をサポートしており、複雑な構造のTOMLファイルも扱える。<br> | |||
<br> | |||
エラーハンドリングにも配慮がなされており、解析中に問題が発生した場合は、詳細なエラーメッセージと行番号情報を提供して、デバッグを容易にする。<br> | |||
<br> | |||
さらに、Tomlynライブラリは.NET Standardに準拠しているため、様々な.NETプラットフォーム (.NET Framework、.NET Core、Xamarin等) で使用できる。<br> | |||
<br> | |||
使いやすさも重視されており、直感的なAPIを提供しており、基本的な操作は数行のコードで実装でき、複雑な操作も比較的簡単に行えるよう設計されている。<br> | |||
<br> | |||
これらの特徴により、Tomlynライブラリは設定ファイルの管理やTOMLフォーマットを使用するアプリケーションの開発において、非常に有用なツールとなっている。<br> | |||
<br> | |||
<u>Tomlynライブラリのライセンスは、2条項BSDライセンスに準拠している。</u><br> | |||
<br> | |||
* TomlynライブラリのGithub | |||
*: https://github.com/xoofx/Tomlyn | |||
<br> | |||
==== Tomlynライブラリのインストール ==== | |||
RiderまたはVisual StudioからNuGetを使用して、Tomlynライブラリをインストールする。<br> | |||
* Riderの場合 | |||
*# プロジェクトを開く。 | |||
*# [ツール]メインメニュー - [Nuget] - [ソリューション の Nuget パッケージを管理] (または、[<プロジェクト名> の Nuget パッケージを管理])を選択する。 | |||
*# メイン画面下部にある[パッケージ]タブから <u>Tomlyn</u> と入力して検索する。 | |||
*# メイン画面下部の右にある[+]ボタンを押下して、Tomlynライブラリをインストールする。 | |||
*: <br> | |||
* Visual Studioの場合 | |||
*# プロジェクトを開く。 | |||
*# NuGetパッケージマネージャーを開く。 | |||
*#* [ツール]メインメニュー - [NuGetパッケージマネージャー]を選択して、[ソリューションのNuGetパッケージの管理]を選択する。 | |||
*#* または、ソリューションエクスプローラーでプロジェクトを右クリックして、コンテキストメニューから[NuGetパッケージの管理]を選択する。 | |||
*# Tomlynライブラリを検索する。 | |||
*#: NuGetパッケージマネージャーの検索ボックスに <u>Tomlyn</u> と入力して検索する。 | |||
*# Tomlynライブラリのインストール | |||
*#: 検索結果からTomlynライブラリを選択して、[インストール]ボタンを押下する。 | |||
*# インストールの確認ダイアログが表示されるので、[OK]ボタンを押下してインストールを完了する。 | |||
*# 参照の確認 | |||
*#: インストールが完了した後、プロジェクトの参照にTomlynライブラリが追加されていることを確認する。 | |||
*: <br> | |||
* パッケージマネージャーコンソールからインストールする場合 | |||
*# プロジェクトを開く。 | |||
*# [表示]メインメニュー - [その他のウィンドウ] - [パッケージマネージャーコンソール]を選択して、パッケージマネージャーコンソールを開く。 | |||
*# パッケージマネージャーコンソールから、Tomlynライブラリをダウンロードしてインストールする。 | |||
*#: <code>Install-Package Tomlyn</code> | |||
*# ソリューションエクスプローラーのプロジェクトの参照において、Tomlynライブラリが追加されていることを確認する。 | |||
*: <br> | |||
* <code>dotnet</code>コマンドを使用する場合 | |||
*# ターミナルを開く。 | |||
*# プロジェクトのルートディレクトリに移動する。 | |||
*# Tomlynライブラリをインストールする。 | |||
*#: 最新の安定版をインストールする場合 | |||
*#: <code>dotnet add package Tomlyn</code> | |||
*#: <br> | |||
*#: バージョンを指定してインストールする場合 | |||
*#: <code>dotnet add package Tomlyn --version <バージョン></code> | |||
*#: <br> | |||
*: <u>※注意</u> | |||
*: <u>プロジェクトがGit等のバージョン管理システムを使用している場合、これらの変更がトラッキングされることを確認すること。</u> | |||
*: <u>プロジェクトを再ビルドして、新しく追加されたパッケージが正しく統合されていることを確認することを推奨する。</u> | |||
<br> | |||
プロジェクトにおいて、Tomlynライブラリを使用する場合は、ソースコードファイルの先頭にusingステートメントを追加する。<br> | |||
これにより、名前空間を使用することで、TOMLのシリアライズ / デシリアライズに関する主要な機能にアクセスすることができる。<br> | |||
<syntaxhighlight lang="c#"> | |||
using Tommy; | |||
using Tommy.Serialization; // シリアライゼーション / デシリアライゼーションを使用する場合 | |||
</syntaxhighlight> | |||
<br> | |||
また、大きなサイズなTOMLファイルを扱う場合は、ストリーミング処理を使用することを推奨する。<br> | |||
<br><br> | <br><br> | ||