Entity Framework 4.1 - CodeFirst 개체의 직렬화 시 순환 참조 해결하는 방법

우선, 순환 참조가 직렬화 시에 어떻게 발생할 수 있는지 다음의 글을 한번 읽어보시고 시작하는 것도 좋겠습니다. ^^

순환참조와 XmlSerializer
; https://www.sysnet.pe.kr/2/0/751

위의 XmlSerializer에서는 순환참조가 발생하는 경우 System.StackOverflowException 예외가 발생하지만 WCF의 경우에는 System.Runtime.Serialization.SerializationException 수준에서 끝납니다. 아마도 내부적인 threshold 값의 제약으로 스레드의 스택이 바닥나기 전에 중지되기 때문인 것 같습니다. (정확히 어떤 threshold 값에 해당하는지 아직 잘 모르겠습니다. ^^)

본론으로 들어가서, 이번에는 Entity Framework의 CodeFirst에서 순환참조가 발생하는 경우를 살펴볼 텐데요. 실제로 예제를 만들어서 재현을 하고 문제를 해결하는 식으로 진행해 보겠습니다.

우선, 예제 코드는 지난번 글에서 만들어 둔 EF + WCF 프로젝트로 만들어 두었던 것을 재사용할 텐데요, 아래의 글에서 다운로드하시면 됩니다.

Entity Framework 4.1 - Code First + WCF 서비스 시 EndpointNotFoundException 오류 - 두 번째 이야기
; https://www.sysnet.pe.kr/2/0/1085

codefirst_example.zip
; https://www.sysnet.pe.kr/bbs/DownloadAttachment.aspx?fid=613&boardid=331301885

이제, MyEntity의 목록을 반환하는 WCF 메서드를 한번 볼까요?

public MyEntity [] GetMyEntities()
{
    using (DBContext db = new DBContext())
    {
        var items = from record in db.MyEntities
                    select record;

        var list = items.ToArray();
        return list;
    }
}

짐작하시겠지만, 이렇게 반환된 MyEntity는 SubEntities 속성이 null로 되어 있습니다. 만약, 그 속성값을 채우고 싶다면 Linq 쿼리를 다음과 같이 변경해 주어야 합니다.

public MyEntity [] GetMyEntities()
{
    using (DBContext db = new DBContext())
    {
        var items = from record in db.MyEntities.Include("SubEntities")
                    select record;

        var list = items.ToArray();
        return list;
    }
}

자, 이렇게 코드를 변경하고 WCF 서비스를 사용하면 여지없이 클라이언트 측에서 다음과 같은 예외를 받게 됩니다.



보는 바와 같이, 클라이언트 측에서의 오류 메시지로는 저번에 다룬 DynamicProxies 직렬화 오류와 비교해서 차이가 없습니다. 다시 한번 이 오류의 정확한 원인을 알기 위해서 DataContractSerializer를 이용하여 직접 직렬화 시도를 하고 예외 메시지를 출력하도록 합니다.

public MyEntity [] GetMyEntities()
{
    ...[생략]...
    try
    {
        MemoryStream ms = new MemoryStream();
        DataContractSerializer dcs = new DataContractSerializer(typeof(MyEntity[]));
        dcs.WriteObject(ms, list);
    }
    catch (Exception ex)
    {
        System.Diagnostics.Debug.WriteLine(ex.ToString());
    }

    return list;
}

실행해 보면, 아래와 같이 순환 참조에 걸렸음을 알려주는 오류 메시지가 발견됩니다.

System.Runtime.Serialization.SerializationException: Object graph for type 'System.Collections.Generic.HashSet`1[[SubEntity, App_Code.xdcj8jsd, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]]' contains cycles and cannot be serialized if reference tracking is disabled. 
    at System.Runtime.Serialization.XmlObjectSerializerWriteContext.OnHandleReference(XmlWriterDelegator xmlWriter, Object obj, Boolean canContainCyclicReference) 
    at System.Runtime.Serialization.XmlObjectSerializerWriteContext.InternalSerializeReference(XmlWriterDelegator xmlWriter, Object obj, Boolean isDeclaredType, Boolean writeXsiType, Int32 declaredTypeID, RuntimeTypeHandle declaredTypeHandle) 
    at WriteEventSourceToXml(XmlWriterDelegator , Object , XmlObjectSerializerWriteContext , ClassDataContract ) 
    at System.Runtime.Serialization.ClassDataContract.WriteXmlValue(XmlWriterDelegator xmlWriter, Object obj, XmlObjectSerializerWriteContext context) 
    ...[이하, 순환 참조로 인한 한참 동안의 예외 메시지 콜 스택 출력]...

이에 대한 원인은 MyEntity, SubEntity 정의를 보면 쉽게 찾을 수 있습니다.

public class MyEntity
{
    [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
    public int Id { get; set; }
    public string Description { get; set; }

    public ICollection<SubEntity> SubEntities { get; set; }
}

public class SubEntity
{
    [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
    public int Id { get; set; }
    public string Description { get; set; }

    public int MyEntityId { get; set; }
    public MyEntity MyEntity { get; set; }
}

전형적인 순환 참조의 예인데요. 하지만, Entity Framework이 데이터베이스에 대한 OR-Mapping 도구임을 감안하면 위의 코드처럼 나와야 하는 것이 너무나 당연한 것도 사실입니다. 단지, 이렇게 정의된 DbContext가 지난번 DbContext.Configuration.ProxyCreationEnabled 속성 관련한 문제에서와 마찬가지로 WCF 서비스로 내보내기 하는 용도로는 적합하지 않다는 점입니다.

그럼 어떻게 해결해야 할까요? 2가지 방법이 있는데, 첫 번째로는 다음과 같이 코드를 변경함으로써 쉽게 해결이 가능합니다.

public MyEntity [] GetMyEntities()
{
    using (DBContext db = new DBContext())
    {
        var items = from record in db.MyEntities.Include("SubEntities")
                    select record;

        foreach (var item in items)
        {
            foreach (var subEntity in item.SubEntities)
            {
                subEntity.MyEntity = null;
            }
        }

        return items.ToArray();
    }
}

음... 일단은 너무나 쉬운 방법이라서 적용하기에 좋겠지만, 왠지 프로그래머의 직감으로 볼 때 뭔가 꺼림직한 면이 있습니다. 이를 해결할 수 있는 두 번째 방법은... ^^ 아쉽지만 지면(?) 관계상 다음에 살펴보도록 하겠습니다.

첨부된 파일은 여기까지 변경된 코드를 포함하고 있습니다.

---

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

[최초 등록일: 7/14/2011]
[최종 수정일: 6/27/2021]


이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.

by SeongTae Jeong, mailto:techsharer at outlook.com