[.Net] XML 파일 읽기와 쓰기, 그리고 직렬화(Serialization)로 객체와 연동하는 방법(예제 포함)

XML이란?

XML은 eXtensible Markup Language약자로, 말 그대로 '확장 가능한 마크업 언어'를 뜻하는데, 좀 더 의미를 풀자면 '데이터를 정의하는 규칙을 제공하는 마크업 언어'입니다.

XML을 몰랐을 때에는 프로그램의 설정 파일로 INI 포맷을 사용했었으나, XML을 접한 이후로는 줄곧 XML 파일만 사용하고 있습니다. 배열 형태로 나열이 가능하고, 데이터의 깊이도 자유롭게 설정이 가능하기 때문입니다. 또한, 가장 중요한 점은 직렬화(Serialization)를 사용하여 객체와 연동이 쉬워 읽고 쓰기가 아주 편리하다는 점입니다.

그럼, 본문에서는 XML 파일의 구조와 C#으로 어떻게 읽고 쓰는지를 보여주고, Serialization을 사용해 어떻게 객체화하는지 설명하겠습니다.

XML 구조

XML은 트리(Tree) 구조입니다. 하나의 노드(Node)를 요소(Element)라고 부르고, 루트(Root)부터 시작하여 하위요소가 이어집니다. 하위 요소 입장에서 상위 요소를 부모(Parent) 요소라고 부르고, 반대로는 자식(Child) 요소라고 부릅니다.

XML 트리 구조

그리고 각 요소는 속성(Attribute)을 가질 수 있습니다. 아래 이미지는 Product 노드 이름에 'index'라는 속성과 '0'이라는 값이 포함된 모습입니다.

노드에 속성이 포함된 모습

그럼 간단하게 반 별로 학생들의 개인 정보가 담긴 XML을 예시로 보겠습니다. A와 B라는 이름의 Class가 있고, Class 별로 몇 명의 학생이 포함되어 있습니다. 그리고 각 학생의 정보에는 이름과 핸드폰 번호가 담겨 있습니다.

<?xml version="1.0"?>
<Root xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Class Name="A">
	<Student Index="0">
	  <Name>철수</Name>
	  <Phone>010-xxxx-xxxx</Phone>
	</Student>  
	<Student Index="1">
	  <Name>영희</Name>
	  <Phone>010-yyyy-yyyy</Phone>
	</Student>  
  </Class>
  <Class Name="B">
	<Student Index="0">
	  <Name>짱구</Name>
	  <Phone>010-zzzz-zzzz</Phone>
	</Student>  
	<Student Index="1">
	  <Name>맹구</Name>
	  <Phone>010-xxxx-yyyy</Phone>
	</Student>  
	<Student Index="2">
	  <Name>기영</Name>
	  <Phone>010-xxxx-zzzz</Phone>
	</Student>  
  </Class>
</Root>

사실 굳이 'Index' 속성을 붙일 필요가 없습니다. 그리고 Name과 Phone 노드도 속성으로 넣으면 더욱 심플해지죠. 그럼 위 파일을 코드로 어떻게 불러올 수 있는지, 어떻게 노드의 값에 접근하는지 보겠습니다.

using System.Xml;
 
private void btnOpen_Click(object sender, EventArgs e)
{
    try
    {
        OpenFileDialog dlg = new OpenFileDialog();
        if (dlg.ShowDialog() == DialogResult.OK )
        {
            XmlDocument doc = new XmlDocument();
            doc.Load(dlg.FileName);
 
            XmlNodeList nodes = doc.SelectNodes(@"/Root/Class");
            var classes = nodes.Count; //반환 값: 2
            
            nodes = doc.SelectNodes(@"/Root/Class[@Name='B']/Student");
            var students = nodes.Count; //반환 값: 3
 
            var node = doc.SelectSingleNode(@"/Root/Class[@Name='B']/Student[@Index='1']/Name");
            var name = node.InnerText; //반환 값: 맹구
        }
    }
    catch(Exception exc)
    {
        MessageBox.Show(exc.Message);
    }
}

노드에 접근하기 위해서는 올바른 XPath(XML Path) 식을 사용해야 합니다. 위 예시처럼, 절대 경로 또는 상대 경로를 입력해야 하며, 속성에 접근하기 위해서는 노드에 [@속성='값'] 키워드를 추가해야 합니다.

만약, 불러오는 것뿐만 아니라 노드 삽입, 삭제, 값 변경 등의 편집도 원한다면 CreateElement, RemoveChild, AppendChild, CreateAttribute 등의 함수를 사용합니다.

XMLDocument의 자세한 사용법은 아래 링크를 참고하세요.

https://learn.microsoft.com/ko-kr/dotnet/api/system.xml.xmldocument?view=netframework-4.8

XmlDocument 클래스 (System.Xml)

프로그램 운영 중 XML을 편집하길 원한다면 사용하기 쉽게 Wrapper Class를 만드는 것을 추천합니다.

XML 직렬화

직렬화(Serialize)란, 데이터를 저장이나 전송을 위해 연속적인 바이트 단위의 데이터로 가공하는 것을 의미합니다. 이렇게 직렬화된 데이터는 반대로 역직렬화(Deserialize)를 통해 다시 원래의 데이터로 되돌릴 수 있습니다. XML 직렬화는 어떤 객체를 XML 데이터로 직렬화하여 저장(또는 전송)하고, 다시 직렬화된 데이터를 객체로 되돌리는 데 사용될 수 있습니다. 위에서 예시로 보여줬던 학생 정보가 담긴 XML 구조를 객체로 표현하면 다음과 같습니다.

using System.Xml.Serialization;

namespace ExamXML
{
    [Serializable]
    [XmlRoot("Root")]
    public class School
    {
        [XmlElement("Class")]
        public List<Class> Classes { get; set; }
    }

    [Serializable]
    public class Class
    {
        [XmlAttribute("Name")]
        public string Name { get; set; }

        [XmlElement("Student")]
        public List<Student> Students { get; set; }
    }

    [Serializable]
    public class Student
    {
        [XmlAttribute("Index")]
        public int Index { get; set; }

        [XmlElement("Name")]
        public string Name { get; set; }

        [XmlElement("Phone")]
        public string Phone { get; set; }
    }
}

Serializable 키워드는 객체가 직렬화할 수 있다는 의미이고, XmlRoot와 XmlElement는 노드의 이름, 그리고 XmlAttrinute는 속성을 의미합니다.

객체를 XML 직렬화하기

학생 정보가 담긴 School 객체를 Xml 직렬화하는 코드는 다음과 같습니다.

private void btnSeiralize_Click(object sender, EventArgs e)
{
    try
    {
        var school = new School
        {
            Classes = new List<Class>
            {
                new Class
                {
                    Name = "A",
                    Students = new List<Student>
                    {
                        new Student { Index = 0, Name = "철수", Phone = "010-xxxx-xxxx" },
                        new Student { Index = 1, Name = "영희", Phone = "010-yyyy-yyyy" }
                    }
                },
                new Class
                {
                    Name = "B",
                    Students = new List<Student>
                    {
                        new Student { Index = 0, Name = "짱구", Phone = "010-zzzz-zzzz" },
                        new Student { Index = 1, Name = "맹구", Phone = "010-xxxx-yyyy" },
                        new Student { Index = 2, Name = "기영", Phone = "010-xxxx-zzzz" }
                    }
                }
            }
        };

        SaveFileDialog dlg = new SaveFileDialog();
        if (dlg.ShowDialog() == DialogResult.OK)
        {
            XmlSerializer serializer = new XmlSerializer(typeof(School));
            using (FileStream fileStream = new FileStream(dlg.FileName, FileMode.Create))
            {
                serializer.Serialize(fileStream, school);
            }
        }
    }
    catch (Exception exc)
    {
        MessageBox.Show(exc.Message);
    }
}

객체를 XML 구조로 직렬화할 것이니, 확장자는 XML로 지정합니다. 저장된 파일을 열어보면 처음에 제시한 XML 파일과 동일합니다.

XML 파일을 객체로 역직렬화하기

이번엔 반대로, XML 파일을 불러오면 School 객체로 변환이 가능합니다.

private void btnDeserialize_Click(object sender, EventArgs e)
{
    try
    {
        OpenFileDialog dlg = new OpenFileDialog();
        if (dlg.ShowDialog() == DialogResult.OK)
        {
            XmlSerializer serializer = new XmlSerializer(typeof(School));
            using (FileStream fileStream = new FileStream(dlg.FileName, FileMode.Open))
            {
                School school = (School)serializer.Deserialize(fileStream);
            }
        }
    }
    catch (Exception exc)
    {
        MessageBox.Show(exc.Message);
    }
}

위 코드를 사용해 XML 파일을 불러오면, 아래와 같이 객체를 얻을 수 있습니다.

XML 파일로부터 객체로 역직렬화한 결과

정리하기

개인적으로 XML은 주로 프로그램의 시스템 설정 값을 관리하는 용도로 사용합니다. INI보다 사용하기 편하고 직렬화를 통해 객체 관리가 더 용이한 것 같습니다. 참고로, 직렬화는 XML만 가능한 것은 아니고 어떤 객체든 직렬화/역직렬화가 가능합니다.

게다가 PropertyGrid 컨트롤과 XML 객체를 연동하면 XML 편집이 더욱 용이하고 활용성이 높아지는 장점이 있습니다. 한번 사용해 보세요.

ExamXML.zip

0.01MB