Language: Japanese

Getting Started

VirtualStorageLibraryへようこそ！このガイドでは、ライブラリを迅速かつ効果的にセットアップし、使用を開始する方法を説明します。

前提条件

使用を開始する前に、以下のソフトウェアがインストールされていることを確認してください。

.NET 8 以降
C# 12 以降
Visual Studio 2022 または Visual Studio Code
基本的なC#と.NETの知識

インストール方法

Visual Studio 2022 でのインストール

NuGet パッケージマネージャーからインストールする方法:

Visual Studio 2022 のソリューションエクスプローラーで、プロジェクトを右クリックし、「NuGet パッケージの管理」を選択します。
「参照」タブで AkiraNetwork.VirtualStorageLibrary を検索し、選択してインストールします。

パッケージマネージャーコンソールからインストールする方法:
Visual Studio 2022 のメニューから「ツール」>「NuGet パッケージマネージャー」>「パッケージマネージャーコンソール」を選択します。
パッケージマネージャーコンソールで以下のコマンドを入力し、インストールします。
```
Install-Package AkiraNetwork.VirtualStorageLibrary
```

.NET CLIを使用したインストール

コマンドラインで、プロジェクトファイル (.csproj) があるディレクトリに移動します。
Visual Studio 2022が起動していないことを確認してください。
以下のコマンドを入力して、VirtualStorageLibrary をインストールします。
この方法でプロジェクトファイルに自動的にパッケージが追加されます。
```
dotnet add package AkiraNetwork.VirtualStorageLibrary
```

インストールの確認

インストールが成功すると、プロジェクトの依存関係に VirtualStorageLibrary が追加され、使用できるようになります。
インストール後、必要に応じて using ディレクティブを追加してライブラリを参照してください。

クイックスタート

まずは簡単なサンプルから始めましょう。
VSLSample01という名前のソリューション、プロジェクトを作成して、以下のソースコードを入力して実行してください。
このサンプルは仮想ストレージの初期化と作成、ノードの作成と取得を実行するサンプルです。

using AkiraNetwork.VirtualStorageLibrary;

namespace VSLSample01
{
    // User-defined class
    public class Person
    {
        public string Name { get; set; } = string.Empty;
        public int Age { get; set; } = 0;
    }

    internal class Program
    {
        static void Main()
        {
            // Initialize the VirtualStorageSettings
            VirtualStorageSettings.Initialize();

            // Create a VirtualStorage instance
            VirtualStorage<Person> vs = new();

            // Create a Person object
            Person person1 = new() { Name = "John", Age = 20 };

            // Create a VirtualItem instance
            VirtualItem<Person> item1 = new("item1", person1);

            // Add the directory and item to the VirtualStorage instance
            vs.AddDirectory("/home1");
            vs.AddItem("/home1", item1);

            // Retrieve the Person object from the VirtualStorage instance
            Person result = vs.GetItem("/home1/item1").ItemData!;

            // Display the retrieved Person object
            Console.WriteLine($"Name: {result.Name}, Age: {result.Age}");
        }
    }
}

このコードは、以下のことを実行します。

仮想ストレージを初期化します。
仮想ストレージを作成します。この時、ルートディレクトリは自動的に作成された状態です。
ユーザー定義オブジェクトperson1を作成します。
ユーザー定義オブジェクトperson1を含むアイテムitem1を作成します。
ディレクトリ/home1を作成します。
ディレクトリ/home1にアイテムitem1を追加します。
パス/home1/item1からユーザー定義オブジェクトresultを取得します。
ユーザー定義オブジェクトresultのNameプロパティとAgeプロパティを表示します。

次のステップ

基本を理解したら、次のステップとして以下を探索してみてください。

APIリファレンス
Introduction
チュートリアル (執筆予定)

サポートとフィードバック

問題が発生したり、提案がある場合は、Issueを作成するか、ディスカッションに参加してください。