YAML 직렬화를 통한 클래스-파일 동기화

YAML은 가독성이 뛰어난 데이터 직렬화 형식으로, 주로 설정 파일이나 구성 관리에서 많이 사용됩니다. 들여쓰기 구조를 통해 데이터의 계층을 표현하며, JSON과 비슷한 구조를 가지지만 더 간결하고 사람이 읽기 쉽게 설계되었습니다. 이번 글에서는 C#에서 YAML 직렬화를 사용하여 클래스와 파일 간 데이터를 동기화하는 방법과 주요 특징, JSON 및 XML과의 비교 등을 다룹니다.

YAML 직렬화의 개념

YAML 직렬화는 객체 데이터를 텍스트 형식의 YAML 문자열로 변환하여 파일에 저장하거나 전송하는 것입니다. YAML의 특징은 간결한 구문으로, 중괄호나 큰따옴표 없이 데이터를 들여쓰기만으로 계층 구조를 나타냅니다. 이는 설정 파일을 작성하고 관리하는 데 특히 유용하며, 복잡한 데이터도 쉽게 표현할 수 있습니다.

YAML 직렬화를 사용하는 방법

C#에서 YAML 직렬화를 사용하기 위해서는 YamlDotNet이라는 라이브러리를 주로 사용합니다. 이 라이브러리는 C#에서 YAML 데이터를 직렬화하고 역직렬화하는 기능을 제공합니다.

`YamlDotNet` 설치

먼저 YamlDotNet 라이브러리를 사용하기 위해 NuGet 패키지 관리자에서 YamlDotNet을 설치합니다. 아래 명령어를 사용하여 설치할 수 있습니다.

dotnet add package YamlDotNet

YAML 직렬화 클래스 설계

직렬화할 클래스를 정의합니다. 예를 들어, 사용자 설정 정보를 저장하는 UserSettings 클래스를 정의합니다.

public class UserSettings
{
    public string UserName { get; set; }
    public int FontSize { get; set; }
    public string Theme { get; set; }
}

YAML로 클래스 직렬화하기

YamlDotNet을 사용하여 UserSettings 객체를 YAML 파일에 저장하는 방법은 다음과 같습니다.

using System.IO;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
public static void SaveUserSettings(UserSettings settings, string filePath)
{
    var serializer = new SerializerBuilder()
                        .WithNamingConvention(CamelCaseNamingConvention.Instance)
                        .Build();
    
    var yaml = serializer.Serialize(settings);
    File.WriteAllText(filePath, yaml);
}

위 코드에서는 SerializerBuilder를 사용하여 YAML 직렬화기를 생성합니다. CamelCaseNamingConvention을 사용하면 속성 이름이 YAML 파일에서 CamelCase 형식으로 나타나게 됩니다.

YAML에서 객체로 역직렬화하기

저장된 YAML 파일에서 객체로 복원하려면 DeserializerBuilder를 사용합니다.

public static UserSettings LoadUserSettings(string filePath)
{
    var deserializer = new DeserializerBuilder()
                           .WithNamingConvention(CamelCaseNamingConvention.Instance)
                           .Build();
    
    var yaml = File.ReadAllText(filePath);
    return deserializer.Deserialize<UserSettings>(yaml);
}

이 코드는 파일에서 YAML 데이터를 읽어와 UserSettings 객체로 역직렬화합니다.

컬렉션의 직렬화

여러 객체를 YAML 형식으로 저장해야 하는 경우에는 리스트와 같은 컬렉션을 직렬화할 수 있습니다. 여러 사용자 설정을 YAML 파일로 저장하는 예제를 보겠습니다.

컬렉션 직렬화 예제

ApplicationSettings 클래스를 정의하여 여러 사용자의 설정을 관리합니다.

public class ApplicationSettings
{
    public List<UserSettings> Users { get; set; }
    public ApplicationSettings()
    {
        Users = new List<UserSettings>();
    }
}

이제 ApplicationSettings 객체를 YAML 파일에 저장하고 불러오는 메서드를 구현합니다.

public static void SaveApplicationSettings(ApplicationSettings appSettings, string filePath)
{
    var serializer = new SerializerBuilder()
                        .WithNamingConvention(CamelCaseNamingConvention.Instance)
                        .Build();
    
    var yaml = serializer.Serialize(appSettings);
    File.WriteAllText(filePath, yaml);
}
public static ApplicationSettings LoadApplicationSettings(string filePath)
{
    var deserializer = new DeserializerBuilder()
                           .WithNamingConvention(CamelCaseNamingConvention.Instance)
                           .Build();
    
    var yaml = File.ReadAllText(filePath);
    return deserializer.Deserialize<ApplicationSettings>(yaml);
}

이 예제에서는 여러 사용자를 포함하는 설정 정보를 YAML 파일에 저장하고 불러올 수 있습니다.

YAML 직렬화의 유용한 팁

네이밍 규칙 변경하기

YamlDotNet에서는 다양한 네이밍 규칙을 사용할 수 있습니다. 기본적으로 CamelCase, PascalCase, SnakeCase 등의 규칙을 적용할 수 있습니다.

var serializer = new SerializerBuilder()
                    .WithNamingConvention(PascalCaseNamingConvention.Instance)
                    .Build();

PascalCaseNamingConvention을 사용하면 클래스 속성들이 PascalCase 형식으로 YAML에 나타나게 됩니다. 이를 통해 출력 형식의 일관성을 유지할 수 있습니다.

객체의 중첩 구조 직렬화

YAML은 객체의 중첩 구조를 직렬화하기에 매우 적합합니다. 예를 들어, UserSettings가 다른 객체를 포함하고 있는 경우에도 이를 계층적 구조로 쉽게 직렬화할 수 있습니다.

public class UserSettings
{
    public string UserName { get; set; }
    public int FontSize { get; set; }
    public UserPreferences Preferences { get; set; }
}
public class UserPreferences
{
    public bool ReceiveNotifications { get; set; }
    public string Language { get; set; }
}

이런 중첩 구조를 직렬화하면 YAML 파일에서 사용자 설정과 선호도가 계층적으로 표현됩니다.

userName: "Alice"
fontSize: 14
preferences:
  receiveNotifications: true
  language: "English"

YAML 직렬화의 장단점

장점

가독성: JSON이나 XML보다 구문이 간단하여 사람이 읽고 편집하기 쉽습니다. 설정 파일을 관리할 때 YAML의 단순한 문법이 큰 장점입니다.
구조 표현의 유연성: 들여쓰기를 사용하여 데이터의 계층을 표현하므로 복잡한 데이터를 구조적으로 나타내기 쉽습니다.
다양한 도구에서 지원: YAML은 Kubernetes, Ansible 등 다양한 DevOps 도구에서 널리 사용됩니다.

단점

구문 오류 발생 가능성: 들여쓰기로 계층을 표현하기 때문에 들여쓰기 오류로 인해 파싱 오류가 발생할 수 있습니다.
복잡한 구조에서는 어려움: 매우 복잡한 데이터 구조의 경우, 들여쓰기가 깊어지면서 가독성이 떨어질 수 있습니다.

JSON, XML과의 비교

JSON과의 비교: YAML은 JSON과 비교해 더 간결하고 사람이 읽기 쉽습니다. 그러나 JSON은 브라우저 및 API에서 널리 사용되므로 웹 애플리케이션과의 호환성에서는 JSON이 더 유리할 수 있습니다.
XML과의 비교: XML은 데이터의 스키마 검증과 복잡한 데이터 구조를 명확하게 표현하는 데 강점이 있습니다. 그러나 YAML은 더 간단한 구문을 통해 설정 파일 관리에서 큰 장점을 가지며, XML보다 덜 장황합니다.

YAML 직렬화의 성능 최적화

데이터 크기 최소화

YAML은 기본적으로 사람이 읽기 쉽게 설계되었기 때문에, 파일 크기가 커질 수 있습니다. 이를 최적화하기 위해 기본값을 제외하거나 불필요한 정보를 최소화하도록 클래스 설계를 해야 합니다.

비동기 처리를 통한 성능 개선

큰 YAML 파일을 다룰 때는 비동기 처리를 사용하여 파일 입출력으로 인한 메인 스레드 차단을 방지할 수 있습니다.

public static async Task SaveUserSettingsAsync(UserSettings settings, string filePath)
{
    var serializer = new SerializerBuilder()
                        .WithNamingConvention(CamelCaseNamingConvention.Instance)
                        .Build();
    
    var yaml = serializer.Serialize(settings);
    await File.WriteAllTextAsync(filePath, yaml);
}
public static async Task<UserSettings> LoadUserSettingsAsync(string filePath)
{
    var deserializer = new DeserializerBuilder()
                           .WithNamingConvention(CamelCaseNamingConvention.Instance)
                           .Build();
    
    var yaml = await File.ReadAllTextAsync(filePath);
    return deserializer.Deserialize<UserSettings>(yaml);
}

비동기 입출력을 통해 파일을 효율적으로 처리할 수 있습니다.

결론

YAML 직렬화는 설정 파일이나 구성 관리에서 큰 장점을 가지는 직렬화 방법입니다. C#에서 YamlDotNet을 사용하여 YAML 직렬화와 역직렬화를 쉽게 구현할 수 있으며, JSON과 XML보다 간결한 형식 덕분에 사람이 쉽게 읽고 관리할 수 있습니다. 들여쓰기 기반의 구조적 표현으로 데이터의 계 층을 명확하게 나타낼 수 있으며, 이를 통해 복잡한 설정 데이터를 직관적으로 관리할 수 있습니다. YAML 직렬화를 적절히 사용하면 구성 파일이나 설정 파일을 효율적으로 관리하고, 유지보수 비용을 절감할 수 있습니다. 특히 DevOps 환경이나 클라우드 설정 관리에서 YAML의 유용성을 극대화할 수 있습니다.

Buy me a coffee

JSON 직렬화를 통한 클래스-파일 동기화 INI 직렬화를 통한 클래스-파일 동기화