혼합 선언적/명령적 코드 버그(LINQ to XML)

  • 아티클

LINQ to XML에는 XML 트리를 직접 수정할 수 있는 다양한 메서드가 포함되어 있습니다. 요소를 추가 및 삭제하고, 요소의 내용을 변경하고, 특성을 추가하는 등의 작업을 수행할 수 있습니다. 이 프로그래밍 인터페이스는 xml 트리 수정에 설명되어 있습니다. Elements 같은 축 중 하나를 반복하는 경우 축을 반복할 때 XML 트리를 수정하면 이상한 버그가 발생합니다.

이 문제를 "할로윈 문제"라고도 합니다.

컬렉션을 반복하는 LINQ를 사용하여 일부 코드를 작성하면 선언적 스타일로 코드를 작성하게 됩니다. 그것은 당신이 수행하려는 방법 보다는 당신이 원하는 것이 무엇인지를 설명하는 것에 더 가깝습니다. 1) 첫 번째 요소를 가져오고 2) 특정 조건에 대해 테스트한 다음 3) 요소를 수정하고 4) 요소를 다시 목록에 배치하는 코드를 작성하는 경우 코드는 명령적 코드일 수 있습니다. 컴퓨터에서 원하는 작업을 수행하는 방법을 지시합니다.

이러한 스타일의 코드를 동일한 작업에서 혼합하면 문제가 발생할 수 있습니다. 다음을 고려하십시오.

세 항목(a, b 및 c)이 포함된 연결된 목록이 있는 경우를 생각해 보겠습니다.

a -> b -> c

이제 연결된 목록을 이동하여 세 항목(a', b' 및 c')을 새로 추가한다고 가정해 보겠습니다. 다음과 같은 연결된 목록을 생성하려고 합니다.

a -> a' -> b -> b' -> c -> c'

따라서 목록을 반복하고 각 항목의 바로 뒤에 새 항목을 추가하는 코드를 작성합니다. 코드에서는 먼저 a 요소를 찾고 그 뒤에 a'를 삽입합니다. 이제 코드가 현재 a'인 목록의 다음 노드로 이동되며, 목록에 a'와 b 사이에 새 항목이 추가됩니다.

이 문제를 어떻게 해결하시겠습니까? 연결된 원래 목록의 복사본을 만들고 완전히 새로운 목록을 만들 수도 있습니다. 또는 순전히 명령적 코드를 작성하는 경우 첫 번째 항목을 찾아 새 항목을 추가한 다음 연결된 목록에서 두 번 진행하여 방금 추가한 요소를 넘어설 수 있습니다.

예: 반복하는 동안 추가

예를 들어 트리에 있는 모든 요소의 중복을 만드는 코드를 작성하려는 경우를 가정해 보겠습니다.

XElement root = new XElement("Root",
    new XElement("A", "1"),
    new XElement("B", "2"),
    new XElement("C", "3")
);
foreach (XElement e in root.Elements())
    root.Add(new XElement(e.Name, (string)e));

Dim root As XElement = _
    <Root>
        <A>1</A>
        <B>2</B>
        <C>3</C>
    </Root>
For Each e As XElement In root.Elements()
    root.Add(New XElement(e.Name, e.Value))
Next

이 코드는 무한 루프에 들어갑니다. foreach 문은 Elements() 축을 반복하여 새 요소를 doc 요소에 추가합니다. 따라서 방금 추가한 요소도 반복하게 됩니다. 루프를 반복할 때마다 새 개체를 할당하기 때문에 결국 사용 가능한 모든 메모리를 사용하게 됩니다.

다음과 같이 ToList 표준 쿼리 연산자를 사용하여 컬렉션을 메모리에 끌어오는 방법으로 이 문제를 해결할 수 있습니다.

XElement root = new XElement("Root",
    new XElement("A", "1"),
    new XElement("B", "2"),
    new XElement("C", "3")
);
foreach (XElement e in root.Elements().ToList())
    root.Add(new XElement(e.Name, (string)e));
Console.WriteLine(root);

Dim root As XElement = _
    <Root>
        <A>1</A>
        <B>2</B>
        <C>3</C>
    </Root>
For Each e As XElement In root.Elements().ToList()
    root.Add(New XElement(e.Name, e.Value))
Next
Console.WriteLine(root)

이제 코드가 제대로 작동합니다. 생성되는 XML 트리는 다음과 같습니다.

<Root>
  <A>1</A>
  <B>2</B>
  <C>3</C>
  <A>1</A>
  <B>2</B>
  <C>3</C>
</Root>

예: 반복하는 동안 삭제

특정 수준의 노드를 모두 삭제하려는 경우 다음과 같은 코드를 작성하려고 할 수 있습니다.

XElement root = new XElement("Root",
    new XElement("A", "1"),
    new XElement("B", "2"),
    new XElement("C", "3")
);
foreach (XElement e in root.Elements())
    e.Remove();
Console.WriteLine(root);

Dim root As XElement = _
    <Root>
        <A>1</A>
        <B>2</B>
        <C>3</C>
    </Root>
For Each e As XElement In root.Elements()
    e.Remove()
Next
Console.WriteLine(root)

그러나, 이것은 당신이 원하는 것을 하지 않습니다. 이 경우 첫 번째 요소 A를 제거한 후 루트에 포함된 XML 트리에서 제거되고 반복을 수행하는 Elements 메서드의 코드는 다음 요소를 찾을 수 없습니다.

이 예제는 다음과 같은 출력을 생성합니다.

<Root>
  <B>2</B>
  <C>3</C>
</Root>

여기에서도 해결 방법은 다음과 같이 ToList ¦ È£ÃâÇÏ © Äà ÇÀ» à ÈÇÏ Â ÍÀÔ Ï Ù.

XElement root = new XElement("Root",
    new XElement("A", "1"),
    new XElement("B", "2"),
    new XElement("C", "3")
);
foreach (XElement e in root.Elements().ToList())
    e.Remove();
Console.WriteLine(root);

Dim root As XElement = _
    <Root>
        <A>1</A>
        <B>2</B>
        <C>3</C>
    </Root>
For Each e As XElement In root.Elements().ToList()
    e.Remove()
Next
Console.WriteLine(root)

이 예제는 다음과 같은 출력을 생성합니다.

<Root />

또는 부모 요소에 대해 RemoveAll을 호출하여 반복을 모두 제거할 수 있습니다.

XElement root = new XElement("Root",
    new XElement("A", "1"),
    new XElement("B", "2"),
    new XElement("C", "3")
);
root.RemoveAll();
Console.WriteLine(root);

Dim root As XElement = _
    <Root>
        <A>1</A>
        <B>2</B>
        <C>3</C>
    </Root>
root.RemoveAll()
Console.WriteLine(root)

예: LINQ에서 이러한 문제를 자동으로 처리할 수 없는 이유

한 가지 방법은 지연 계산을 수행하는 대신 항상 모든 항목을 메모리에 가져오는 것입니다. 그러나 이 방법은 성능과 메모리 사용 측면에서 비용이 매우 많이 듭니다. 실제로 LINQ 및 LINQ to XML이 이 방법을 사용한다면 실제 상황에서는 실패합니다.

또 다른 가능한 방법은 일종의 트랜잭션 구문을 LINQ에 넣고 컴파일러가 코드를 분석하여 특정 컬렉션을 구체화해야 하는지 확인하는 것입니다. 그러나 의도하지 않은 결과를 발생시키는 모든 코드를 확인하는 작업은 상당히 복잡합니다. 다음 코드를 생각해 봅시다.

var z =
    from e in root.Elements()
    where TestSomeCondition(e)
    select DoMyProjection(e);

Dim z = _
    From e In root.Elements() _
    Where (TestSomeCondition(e)) _
    Select DoMyProjection(e)

이러한 분석 코드에서는 TestSomeCondition 및 DoMyProjection 메서드를 분석하고 이러한 메서드가 호출한 모든 메서드를 분석하여 의도하지 않은 결과를 발생시킨 코드가 있는지 확인해야 합니다. 그러나 이 분석 코드에서는 의도하지 않은 결과를 발생시킨 코드를 찾기만 할 수는 없으며 이 상황에서 root의 자식 요소에 의도하지 않은 결과를 발생시킨 코드를 선택해야 합니다.

LINQ to XML은 이러한 분석을 시도하지 않습니다. 이러한 문제를 피하는 것은 사용자에게 달려 있습니다.

예: 선언적 코드를 사용하여 기존 트리를 수정하는 대신 새 XML 트리 생성

이러한 문제를 방지하려면 컬렉션의 의미 체계와 XML 트리를 수정하는 메서드의 의미 체계를 정확히 알고 있더라도 선언적 코드와 명령적 코드를 혼합하지 마세요. 문제를 방지하는 코드를 작성하는 경우 나중에 다른 개발자가 코드를 유지 관리해야 하며 문제가 명확하지 않을 수 있습니다. 선언적 코딩 스타일과 명령적 코딩 스타일을 혼합하면 코드가 더욱 불안정해집니다. 이러한 문제가 방지되도록 컬렉션을 구체화하는 코드를 작성하는 경우 코드에 이 문제에 대한 주석을 삽입하여 유지 관리 프로그래머가 이 문제를 이해하도록 해야 합니다.

성능 및 기타 고려 사항이 허용되는 경우 선언적 코드만 사용합니다. 기존 XML 트리는 수정하지 말고 대신 다음 예제와 같이 새 항목을 생성합니다.

XElement root = new XElement("Root",
    new XElement("A", "1"),
    new XElement("B", "2"),
    new XElement("C", "3")
);
XElement newRoot = new XElement("Root",
    root.Elements(),
    root.Elements()
);
Console.WriteLine(newRoot);

Dim root As XElement = _
    <Root>
        <A>1</A>
        <B>2</B>
        <C>3</C>
    </Root>
Dim newRoot As XElement = New XElement("Root", _
    root.Elements(), root.Elements())
Console.WriteLine(newRoot)