직렬화 형식 간 변환

직렬화 형식 간 변환은 시스템 통합이나 데이터 교환이 필요한 환경에서 매우 중요한 기능입니다. XML, JSON, YAML, Protobuf 등 여러 직렬화 형식 간의 데이터를 변환하여 사용할 수 있어야 시스템 간의 호환성을 유지할 수 있습니다. 서로 다른 시스템이 데이터 포맷의 차이로 인해 통신할 수 없는 경우, 직렬화 형식 간 변환을 통해 데이터 교환을 원활하게 할 수 있습니다. 이번 글에서는 C#에서 직렬화 형식 간 변환을 효율적으로 수행하기 위한 방법과 고려해야 할 전략을 살펴봅니다.

직렬화 형식 간 변환 개요

직렬화 형식 간 변환은 주로 다음과 같은 시나리오에서 사용됩니다.

시스템 간 데이터 호환성: 서로 다른 직렬화 형식을 사용하는 시스템 간 데이터를 교환하기 위해 변환이 필요합니다.
외부 API와의 연동: 외부 서비스가 JSON 형식을 요구하지만, 내부 시스템이 XML 형식을 사용하고 있을 때.
데이터 저장 형식의 변경: 데이터 저장 방식이 변경될 때 기존 데이터를 새로운 형식으로 변환하여 사용해야 할 때. 직렬화 형식 간 변환은 먼저 특정 형식으로 직렬화된 데이터를 역직렬화하여 객체로 변환한 다음, 다른 형식으로 다시 직렬화하는 과정으로 이루어집니다.

XML ↔ JSON 변환

XML을 JSON으로 변환

C#에서는 XML 데이터를 JSON으로 변환하기 위해 **XmlDocument**와 **JsonConvert**를 사용할 수 있습니다.

using System.Xml;
using Newtonsoft.Json;
public static class XmlToJsonConverter
{
    public static string ConvertXmlToJson(string xmlData)
    {
        XmlDocument doc = new XmlDocument();
        doc.LoadXml(xmlData);
        return JsonConvert.SerializeXmlNode(doc, Newtonsoft.Json.Formatting.Indented);
    }
}

위 코드에서는 **XmlDocument**를 사용하여 XML 데이터를 파싱하고, **JsonConvert.SerializeXmlNode**를 사용하여 JSON 문자열로 변환합니다.

JSON을 XML로 변환

JSON 데이터를 XML 형식으로 변환하는 경우에도 **JsonConvert**를 사용할 수 있습니다.

using Newtonsoft.Json;
using System.Xml;
public static class JsonToXmlConverter
{
    public static string ConvertJsonToXml(string jsonData)
    {
        XmlDocument doc = JsonConvert.DeserializeXmlNode(jsonData, "Root");
        return doc.OuterXml;
    }
}

**JsonConvert.DeserializeXmlNode**를 사용하여 JSON 데이터를 XML로 변환합니다. 여기서 **Root**라는 이름을 지정하여 최상위 요소를 정의할 수 있습니다.

XML ↔ YAML 변환

XML과 YAML은 서로 다른 구조이기 때문에 직접 변환이 어렵지만, 객체를 중간에 사용하면 간단하게 변환할 수 있습니다.

XML을 YAML로 변환

먼저 XML 데이터를 객체로 역직렬화한 다음, YAML 형식으로 변환합니다.

using System.IO;
using System.Xml.Serialization;
using YamlDotNet.Serialization;
public static class XmlToYamlConverter<T> where T : class, new()
{
    public static string ConvertXmlToYaml(string xmlData)
    {
        // XML을 객체로 역직렬화
        XmlSerializer xmlSerializer = new XmlSerializer(typeof(T));
        using StringReader stringReader = new StringReader(xmlData);
        T obj = (T)xmlSerializer.Deserialize(stringReader);
        // 객체를 YAML로 직렬화
        var yamlSerializer = new SerializerBuilder().Build();
        return yamlSerializer.Serialize(obj);
    }
}

위 코드는 XML 데이터를 객체로 변환한 후, YamlDotNet 라이브러리를 사용하여 YAML 형식으로 변환합니다.

YAML을 XML로 변환

YAML 데이터를 객체로 역직렬화한 후 XML로 변환할 수 있습니다.

using System.IO;
using System.Xml.Serialization;
using YamlDotNet.Serialization;
public static class YamlToXmlConverter<T> where T : class, new()
{
    public static string ConvertYamlToXml(string yamlData)
    {
        // YAML을 객체로 역직렬화
        var deserializer = new DeserializerBuilder().Build();
        T obj = deserializer.Deserialize<T>(yamlData);
        // 객체를 XML로 직렬화
        XmlSerializer xmlSerializer = new XmlSerializer(typeof(T));
        using StringWriter stringWriter = new StringWriter();
        xmlSerializer.Serialize(stringWriter, obj);
        return stringWriter.ToString();
    }
}

위 코드에서는 YAML을 객체로 역직렬화하고, XML로 다시 직렬화하여 XML 형식의 데이터를 생성합니다.

JSON ↔ YAML 변환

JSON과 YAML은 둘 다 텍스트 기반 포맷으로, 서로 변환하기가 비교적 쉽습니다. YamlDotNet 라이브러리를 사용하여 JSON과 YAML 간의 변환을 수행합니다.

JSON을 YAML로 변환

using System.Text.Json;
using YamlDotNet.Serialization;
public static class JsonToYamlConverter
{
    public static string ConvertJsonToYaml(string jsonData)
    {
        var deserializedObject = JsonSerializer.Deserialize<object>(jsonData);
        var yamlSerializer = new SerializerBuilder().JsonCompatible().Build();
        return yamlSerializer.Serialize(deserializedObject);
    }
}

**JsonSerializer.Deserialize<object>**를 사용하여 JSON을 객체로 변환한 다음, YamlDotNet 라이브러리를 사용하여 YAML 형식으로 직렬화합니다.

YAML을 JSON으로 변환

using System.Text.Json;
using YamlDotNet.Serialization;
public static class YamlToJsonConverter
{
    public static string ConvertYamlToJson(string yamlData)
    {
        var deserializer = new DeserializerBuilder().Build();
        var deserializedObject = deserializer.Deserialize<object>(yamlData);
        return JsonSerializer.Serialize(deserializedObject);
    }
}

위 코드에서는 YAML 데이터를 객체로 역직렬화한 후 **JsonSerializer.Serialize**를 사용하여 JSON 형식으로 변환합니다.

형식 간 변환 전략

데이터 구조 호환성 관리

직렬화 형식 간 변환에서 가장 중요한 것은 데이터 구조의 호환성입니다. 예를 들어, XML과 JSON의 경우 태그 이름이 속성이나 객체로 변환되므로 필드 이름 충돌이나 중첩 구조 차이가 발생할 수 있습니다. 변환 대상 형식 간의 차이를 고려하여 변환 과정에서 데이터 유실이 발생하지 않도록 해야 합니다.

중간 객체를 통한 변환

직렬화 형식 간 변환을 수행할 때 중간 객체를 사용하는 것이 일반적입니다. 먼저 데이터를 객체로 역직렬화한 후 원하는 형식으로 재직렬화하는 방식입니다. 이 방법을 사용하면 데이터 구조에 대한 명확한 정의를 통해 변환의 안정성을 높일 수 있습니다.

자동 매핑 도구 사용

**AutoMapper**와 같은 자동 매핑 도구를 사용하여 데이터 구조가 다른 객체 간 변환을 쉽게 할 수 있습니다. 예를 들어, JSON 객체와 XML 객체 간의 매핑을 자동으로 수행하면 데이터 변환을 단순화할 수 있습니다.

using AutoMapper;
public static class ObjectMapper
{
    private static readonly MapperConfiguration Config = new MapperConfiguration(cfg => cfg.CreateMap<SourceClass, TargetClass>());
    public static TargetClass MapObject(SourceClass source)
    {
        var mapper = Config.CreateMapper();
        return mapper.Map<TargetClass>(source);
    }
}

위 코드는 **AutoMapper**를 사용하여 SourceClass 객체를 **TargetClass**로 매핑하는 예제입니다. 이를 통해 서로 다른 형식의 데이터를 쉽게 변환할 수 있습니다.

변환 시 데이터 무결성 보장

직렬화 형식 간 변환 시 데이터 무결성을 보장하기 위해 변환 전에 유효성 검사를 수행하는 것이 좋습니다. 예를 들어, XML을 JSON으로 변환하기 전에 스키마 검증을 수행하여 데이터 구조가 예상한 대로 올바른지 확인해야 합니다.

결론

직렬화 형식 간 변환은 데이터 호환성을 유지하고 시스템 간 데이터 교환을 원활하게 하기 위한 중요한 작업입니다. C#에서는 XML, JSON, YAML 등 다양한 직렬화 형식을 간단히 변환할 수 있는 도구와 라이브러리를 제공하며, 이를 통해 시스템 통합이나 데이터 저장 형식 변경 시 변환 과정을 효율적으로 수행할 수 있습니다. 변환 시 데이터 구조의 차이를 관리하고, 중간 객체를 통한 변환 및 자동 매핑 도구를 활용하여 변환의 안정성과 효율성을 높일 수 있습니다. 데이터 변환에서 무결성 유지와 변환 후 데이터 검증을 철저히 하여, 데이터를 안전하고 일관되게 관리하는 것이 중요합니다.

Buy me a coffee

메모리 맵 파일을 통한 직렬화 대안