순환 참조와 XmlSerializer
XmlSerializer 같은 기능을 만들어야 (또는 이용해야) 할 때 유의해야 할 것이 바로 "순환 참조"겠지요. 보통 계층적 데이터 구조를 가진 경우에 문제가 되는데, 이해를 돕기 위해 예제 코드와 함께 설명해보겠습니다.
[System.SerializableAttribute()]
[System.Xml.Serialization.XmlTypeAttribute(Namespace = "http://www.tempuri.org", TypeName = "Type1")]
[System.Xml.Serialization.XmlRootAttribute(Namespace = "http://www.tempuri.org", IsNullable = true, ElementName = "Type1")]
public class Type1
{
public Type1() { }
Type1 child;
[System.Xml.Serialization.XmlElement("Child")]
public Type1 Child
{
get { return this.child; }
set { this.child = value; }
}
int age;
[System.Xml.Serialization.XmlElement("Age")]
public int Age
{
get { return this.age; }
set { this.age = value; }
}
}
Type1과 같은 식으로 정의를 할 때, XmlSerializer 입장에서 고려해야 하는 경우가 바로 다음과 같이 인스턴스 정의가 순환 참조를 할 때입니다.
Type1 type = new Type1();
type.Child = type;
다행히, 위와 같은 무한 반복이 될 수 있는 구조를 XmlSerializer는 고려하고 있기 때문에 실행 시에 다음과 같이 예외를 발생시킵니다.
System.InvalidOperationException occurred
Message="A circular reference was detected while serializing an object of type WpfApplication1.Type1."
Source="System.Xml"
StackTrace:
at System.Xml.Serialization.XmlSerializationWriter.WriteStartElement(String name, String ns, Object o, Boolean writePrefixed, XmlSerializerNamespaces xmlns)
InnerException:
재미있는 것은, 이런 순환 참조 오류가 꼭 위와 같은 경우에만 국한되지는 않는다는 점입니다. 예를 들어, 다음의 코드도 순환 참조 오류에 걸릴 수 있습니다.
Type1 type = new Type1();
Type1 child = new Type1();
type.Child = child;
물론, 위와 같은 코드만으로는 발생하지 않습니다. 다음과 같이 Type1 정의에 Equals/GetHashCode를 만들어 주면 발생하게 됩니다.
public class Type1
{
...[생략]...
public override bool Equals(object obj)
{
return this.age == (obj as Type1).age;
}
public override int GetHashCode()
{
return this.age.GetHashCode();
}
}
대강 짐작이 되시죠? 지금까지의 이야기를 통해 XmlSerializer가 순환 참조를 밝혀내는 과정을 짐작할 수 있습니다. XmlSerializer는 직렬화를 시도하는 개체를 Hash 테이블에 저장하고 이 때 object.GetHashCode를 사용하여 버킷을 정하게 됩니다. 재미있는 것은, 설령 GetHashCode가 같다고 나와도 XmlSerializer는 2차 단계로 Equals 메서드를 호출하여 2개의 개체가 같은 것인지 확인을 한 번 더 합니다. 만약, 동일한 Object Graph 문맥 내에서 그와 같이 Equals와 GetHashCode가 동일하다고 판단되는 상황이 발생하면 순환 참조라고 여기는 것입니다.
자,,, 그럼 이해가 되셨나요?
그럼, 다음의 경우는 어떻게 될까요?
// 같은 개체를 순환 참조했는데,
Type1 type = new Type1();
type.Child = type;
public override bool Equals(object obj)
{
// 무조건 같지 않은 개체라고 한다면?
return false;
}
public override int GetHashCode()
{
return this.age.GetHashCode();
}
그렇습니다. 이런 경우 XmlSerializer는 순환 참조 판단이 안 되어서 무한정 직렬화 과정을 반복하다가 결국에는 다음과 같은 예외를 발생시켜버립니다.
An unhandled exception of type 'System.StackOverflowException' occurred in System.Xml.dll
System.StackOverflowException was unhandled
{Cannot evaluate expression because the current thread is in a stack overflow state.}
첨부된 프로젝트는 이를 간단히 테스트해볼 수 있는 소스 코드를 담고 있습니다.
[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]