Microsoft MVP성태의 닷넷 이야기
.NET Framework: 152. 순환 참조와 XmlSerializer [링크 복사], [링크+제목 복사],
조회: 29530
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일
(연관된 글이 2개 있습니다.)

순환 참조와 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.}

첨부된 프로젝트는 이를 간단히 테스트해볼 수 있는 소스 코드를 담고 있습니다.



[이 토픽에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]

[연관 글]






[최초 등록일: ]
[최종 수정일: 12/22/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 작성자
 




... [91]  92  93  94  95  96  97  98  99  100  101  102  103  104  105  ...
NoWriterDateCnt.TitleFile(s)
11693정성태9/16/201823522VS.NET IDE: 128. Unity - shader 코드 디버깅 방법
11692정성태9/13/201824254Graphics: 22. Unity - shader의 Camera matrix(UNITY_MATRIX_V)를 수작업으로 구성
11691정성태9/13/201820855VS.NET IDE: 127. Visual C++ / x64 환경에서 inline-assembly를 매크로 어셈블리로 대체하는 방법 - 두 번째 이야기
11690정성태9/13/201824279사물인터넷: 43. 555 타이머의 단안정 모드파일 다운로드1
11689정성태9/13/201823221VS.NET IDE: 126. 디컴파일된 소스에 탐색을 사용하도록 설정(Enable navigation to decompiled sources)
11688정성태9/11/201818402오류 유형: 485. iisreset - The data is invalid. (2147942413, 8007000d) 오류 발생
11687정성태9/11/201821124사물인터넷: 42. 사물인터넷 - 트랜지스터 다중 전압 테스트파일 다운로드1
11686정성태9/8/201820123사물인터넷: 41. 다중 전원의 소스를 가진 회로파일 다운로드1
11685정성태9/6/201820004사물인터넷: 40. 이어폰 소리를 capacitor로 필터링파일 다운로드1
11684정성태9/6/201822605개발 환경 구성: 396. pagefile.sys를 비활성화시켰는데도 working set 메모리가 줄어드는 이유파일 다운로드1
11683정성태9/5/201820299개발 환경 구성: 395. Azure Web App의 이벤트 로그를 확인하는 방법
11682정성태9/5/201819180오류 유형: 484. Fakes를 포함한 단위 테스트 프로젝트를 빌드 시 CS1729 관련 오류 발생
11681정성태9/5/201822000Windows: 149. 다른 컴퓨터의 윈도우 이벤트 로그를 구독하는 방법 [2]
11680정성태9/2/201823997Graphics: 21. shader - _Time 내장 변수를 이용한 UV 변동 효과파일 다운로드1
11679정성태8/30/201822151.NET Framework: 792. C# COM 서버가 제공하는 COM 이벤트를 C++에서 받는 방법 [1]파일 다운로드1
11678정성태8/29/201820599오류 유형: 483. 닷넷 - System.InvalidProgramException [1]
11677정성태8/29/201818262오류 유형: 482. TFS - Could not find a part of the path '...\packages\Microsoft.AspNet.WebApi.5.2.5\.signature.p7s'.
11676정성태8/29/201829254.NET Framework: 791. C# - ElasticSearch를 위한 Client 라이브러리 제작 [1]파일 다운로드1
11675정성태8/29/201819356오류 유형: 481. The located assembly's manifest definition does not match the assembly reference.
11674정성태8/29/201820596Phone: 12. Xamarin - 기존 리모컨 기능을 핸드폰의 적외선 송신으로 구현파일 다운로드1
11673정성태8/28/201818636오류 유형: 480. Fritzing 실행 시 Ordinal Not Found 오류
11672정성태8/28/201818386오류 유형: 479. 윈도우 - 시스템 설정에서 도메인 참가를 위한 "Change" 버튼이 비활성화된 경우
11671정성태8/28/201824905사물인터넷: 39. 아두이노에서 적외선 송신기 기본 사용법파일 다운로드1
11670정성태8/28/201823675사물인터넷: 38. 아두이노에서 적외선 수신기 기본 사용법 [1]파일 다운로드1
11669정성태8/24/201822406개발 환경 구성: 394. 윈도우 환경에서 elasticsearch의 한글 블로그 검색 인덱스 구성
11668정성태8/24/201833541오류 유형: 478. 윈도우 업데이트(KB4458842) 이후 SQL Server 서비스 시작 오류
... [91]  92  93  94  95  96  97  98  99  100  101  102  103  104  105  ...