FamiliesApp.Services.JsonFamilyTenantStore 클래스 참조

더 자세히 ...

FamiliesApp.Services.JsonFamilyTenantStore에 대한 상속 다이어그램 :

FamiliesApp.Services.JsonFamilyTenantStore에 대한 협력 다이어그램:

Public 멤버 함수
	JsonFamilyTenantStore (FamilyOptions opts)
string	GetTenantDataPath (string slug)
async Task< FamilyConfig?>	GetAsync (string slug, CancellationToken ct=default)
async Task< IReadOnlyList< FamilyConfig > >	GetAllAsync (CancellationToken ct=default)
async Task	SaveAsync (FamilyConfig config, CancellationToken ct=default)
Task< bool >	ExistsAsync (string slug, CancellationToken ct=default)
Task	DeleteAsync (string slug, CancellationToken ct=default)

Private 멤버 함수
string	ConfigPath (string slug)

정적 Private 멤버 함수
static string	Sanitize (string slug)

Private 속성
readonly string	_dataRoot

정적 Private 속성
static readonly SemaphoreSlim	_gate = new(1, 1)
static readonly JsonSerializerOptions	_jsonOpts

상세한 설명

Json Family Tenant Store 기능과 관련 상태를 캡슐화합니다.

JsonFamilyTenantStore.cs 파일의 16 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

JsonFamilyTenantStore()

FamiliesApp.Services.JsonFamilyTenantStore.JsonFamilyTenantStore ( FamilyOptions opts )

inline

지정한 설정으로 JsonFamilyTenantStore 클래스의 새 인스턴스를 초기화합니다.

매개변수

opts	opts에 사용할 FamilyOptions 값입니다.

JsonFamilyTenantStore.cs 파일의 68 번째 라인에서 정의되었습니다.

    {
        _dataRoot = opts.ResolvedDataPath;
        Directory.CreateDirectory(_dataRoot);
    }

다음을 참조함 : _dataRoot, FamiliesApp.Services.FamilyOptions.ResolvedDataPath.

멤버 함수 문서화

ConfigPath()

string FamiliesApp.Services.JsonFamilyTenantStore.ConfigPath ( string slug )

inlineprivate

Config Path 작업을 수행합니다.

매개변수

slug	slug에 사용할 string 값입니다.

반환값

Config Path 작업에서 생성한 string 결과입니다.

JsonFamilyTenantStore.cs 파일의 346 번째 라인에서 정의되었습니다.

                                           =>
        Path.Combine(GetTenantDataPath(slug), "config.json");

다음에 의해서 참조됨 : ExistsAsync(), GetAsync(), SaveAsync().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

DeleteAsync()

Task FamiliesApp.Services.JsonFamilyTenantStore.DeleteAsync ( string slug, CancellationToken ct = default )

inline

Delete Async 작업을 수행합니다.

매개변수

slug	slug에 사용할 string 값입니다.
ct	취소 요청을 감시하는 토큰입니다.

반환값

Delete Async 작업에서 생성한 Task 결과입니다.

FamiliesApp.Services.IFamilyTenantStore를 구현.

JsonFamilyTenantStore.cs 파일의 314 번째 라인에서 정의되었습니다.

    {
        var dir = GetTenantDataPath(slug);
        if (Directory.Exists(dir))
            Directory.Delete(dir, recursive: true);
        return Task.CompletedTask;
    }

다음을 참조함 : GetTenantDataPath().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

ExistsAsync()

Task< bool > FamiliesApp.Services.JsonFamilyTenantStore.ExistsAsync ( string slug, CancellationToken ct = default )

inline

Exists Async 작업을 수행합니다.

매개변수

slug	slug에 사용할 string 값입니다.
ct	취소 요청을 감시하는 토큰입니다.

반환값

Exists Async 작업에서 생성한 Task<bool> 결과입니다.

FamiliesApp.Services.IFamilyTenantStore를 구현.

JsonFamilyTenantStore.cs 파일의 279 번째 라인에서 정의되었습니다.

                                                                             =>
        Task.FromResult(File.Exists(ConfigPath(slug)));

다음을 참조함 : ConfigPath().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

GetAllAsync()

async Task< IReadOnlyList< FamilyConfig > > FamiliesApp.Services.JsonFamilyTenantStore.GetAllAsync ( CancellationToken ct = default )

inline

All Async 값을 가져옵니다.

매개변수

ct	취소 요청을 감시하는 토큰입니다.

반환값

Get All Async 작업에서 생성한 Task<IReadOnlyList<FamilyConfig>> 결과입니다.

FamiliesApp.Services.IFamilyTenantStore를 구현.

JsonFamilyTenantStore.cs 파일의 171 번째 라인에서 정의되었습니다.

    {
        var list = new List<FamilyConfig>();
        if (!Directory.Exists(_dataRoot)) return list;
 
        foreach (var dir in Directory.GetDirectories(_dataRoot))
        {
            var cfg = Path.Combine(dir, "config.json");
            if (!File.Exists(cfg)) continue;
 
            await _gate.WaitAsync(ct).ConfigureAwait(false);
            try
            {
                await using var fs = File.OpenRead(cfg);
                var t = await JsonSerializer.DeserializeAsync<FamilyConfig>(fs, _jsonOpts, ct).ConfigureAwait(false);
                if (t != null) list.Add(t);
            }
            finally { _gate.Release(); }
        }
        return list;
    }

다음을 참조함 : _dataRoot, _gate, _jsonOpts.

GetAsync()

async Task< FamilyConfig?> FamiliesApp.Services.JsonFamilyTenantStore.GetAsync ( string slug, CancellationToken ct = default )

inline

Async 값을 가져옵니다.

매개변수

slug	slug에 사용할 string 값입니다.
ct	취소 요청을 감시하는 토큰입니다.

반환값

Get Async 작업에서 생성한 Task<FamilyConfig?> 결과입니다.

FamiliesApp.Services.IFamilyTenantStore를 구현.

JsonFamilyTenantStore.cs 파일의 133 번째 라인에서 정의되었습니다.

    {
        var path = ConfigPath(slug);
        if (!File.Exists(path)) return null;
 
        await _gate.WaitAsync(ct).ConfigureAwait(false);
        try
        {
            await using var fs = File.OpenRead(path);
            return await JsonSerializer.DeserializeAsync<FamilyConfig>(fs, _jsonOpts, ct).ConfigureAwait(false);
        }
        finally { _gate.Release(); }
    }

다음을 참조함 : _gate, _jsonOpts, ConfigPath().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

GetTenantDataPath()

string FamiliesApp.Services.JsonFamilyTenantStore.GetTenantDataPath ( string slug )

inline

Tenant Data Path 값을 가져옵니다.

매개변수

slug	slug에 사용할 string 값입니다.

반환값

Get Tenant Data Path 작업에서 생성한 string 결과입니다.

FamiliesApp.Services.IFamilyTenantStore를 구현.

JsonFamilyTenantStore.cs 파일의 98 번째 라인에서 정의되었습니다.

                                                 =>
        Path.Combine(_dataRoot, Sanitize(slug));

다음을 참조함 : _dataRoot.

다음에 의해서 참조됨 : DeleteAsync(), SaveAsync().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

Sanitize()

string FamiliesApp.Services.JsonFamilyTenantStore.Sanitize ( string slug )

inlinestaticprivate

Sanitize 작업을 수행합니다.

매개변수

slug	slug에 사용할 string 값입니다.

반환값

Sanitize 작업에서 생성한 string 결과입니다.

JsonFamilyTenantStore.cs 파일의 373 번째 라인에서 정의되었습니다.

                                                =>
        string.Concat(slug.ToLowerInvariant().Split(Path.GetInvalidFileNameChars()));

SaveAsync()

async Task FamiliesApp.Services.JsonFamilyTenantStore.SaveAsync ( FamilyConfig config, CancellationToken ct = default )

inline

Async 데이터를 저장합니다.

매개변수

config	config에 사용할 FamilyConfig 값입니다.
ct	취소 요청을 감시하는 토큰입니다.

반환값

Save Async 작업에서 생성한 Task 결과입니다.

FamiliesApp.Services.IFamilyTenantStore를 구현.

JsonFamilyTenantStore.cs 파일의 225 번째 라인에서 정의되었습니다.

    {
        var dir = GetTenantDataPath(config.Slug);
        Directory.CreateDirectory(dir);
        Directory.CreateDirectory(Path.Combine(dir, "posts"));
        Directory.CreateDirectory(Path.Combine(dir, "albums"));
        Directory.CreateDirectory(Path.Combine(dir, "reactions"));
        Directory.CreateDirectory(Path.Combine(dir, "media"));
 
        var tmp = ConfigPath(config.Slug) + ".tmp";
        await _gate.WaitAsync(ct).ConfigureAwait(false);
        try
        {
            await using (var fs = File.Create(tmp))
                await JsonSerializer.SerializeAsync(fs, config, _jsonOpts, ct).ConfigureAwait(false);
 
            File.Copy(tmp, ConfigPath(config.Slug), overwrite: true);
            File.Delete(tmp);
        }
        finally { _gate.Release(); }
    }

다음을 참조함 : _gate, _jsonOpts, ConfigPath(), GetTenantDataPath(), FamiliesApp.Models.FamilyConfig.Slug.

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

멤버 데이터 문서화

_dataRoot

readonly string FamiliesApp.Services.JsonFamilyTenantStore._dataRoot

private

data Root 값을 보관합니다.

JsonFamilyTenantStore.cs 파일의 26 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetAllAsync(), GetTenantDataPath(), JsonFamilyTenantStore().

_gate

readonly SemaphoreSlim FamiliesApp.Services.JsonFamilyTenantStore._gate = new(1, 1)

staticprivate

gate 값을 보관합니다.

JsonFamilyTenantStore.cs 파일의 35 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : GetAllAsync(), GetAsync(), SaveAsync().

_jsonOpts

readonly JsonSerializerOptions FamiliesApp.Services.JsonFamilyTenantStore._jsonOpts

staticprivate

초기값:

                                                        = new()
{
    WriteIndented = true,
    PropertyNameCaseInsensitive = true,
    Converters = { new JsonStringEnumConverter() }
}

json Opts 값을 보관합니다.

JsonFamilyTenantStore.cs 파일의 45 번째 라인에서 정의되었습니다.

    {
        WriteIndented = true,
        PropertyNameCaseInsensitive = true,
        Converters = { new JsonStringEnumConverter() }
    };

다음에 의해서 참조됨 : GetAllAsync(), GetAsync(), SaveAsync().

---

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

• JsonFamilyTenantStore.cs