C#开发OneNote插件：如何防止全局变量AllPageXML被函数修改？

我正在开发一款OneNote插件，声明了全局变量AllPageXML，窗口首次加载时初始化赋值，之后希望它的值不再改变。但用户在文本框输入关键词时，将AllPageXML传入FilterXml函数后，它的值被修改了。尝试用ICloneable克隆后问题仍存在，请问如何保持AllPageXML的值不变？

初始代码片段 #

internal partial class NaviPages : LocalizableForm
{
    public XElement AllPageXML;
    public NaviPages()
    {
        InitializeComponent();
    }
    protected override void OnLoad(EventArgs e)
    {
        base.OnLoad(e);
        using var one = new OneNote();
        var AllPageXML = one.GetAllPages();
        //...//
    }
    
    private void tBoxKw_TextChanged(object sender, EventArgs e)
    {
        try
        {
            string strKeyWords = tBoxKw.Text.ToLower();
            FilteredPageXml = FilterXml(AllPageXML, strKeyWords);           
        }
        catch
        {
            MessageBox.Show("Failed to filter!");
        }
    }
    public XElement FilterXml(XElement inXML, string strKeyWords)
    {
        string strSecKw, strPageKw;
        XElement root = inXML;
        ///...///
        //delete empty notebook
        foreach (var child1 in root.Elements().Reverse())
        {
            if (!child1.HasElements) child1.Remove();
        }
        return root;
    }
}

尝试使用ICloneable的代码片段 #

namespace OneNoteAddIn
{
    internal partial class NaviPages : LocalizableForm
    {
        public NaviPages()
        {
            InitializeComponent();
        }
        public MyPages xml1;
        protected override void OnLoad(EventArgs e)
        {
            base.OnLoad(e);
            using var one = new OneNote();
            xml1= new MyPages();
            xml1.AllPageXML= one.GetAllPages();   
        }

        public XElement FilterXml(XElement inXML, string strKeyWords)
        {
            XElement root = inXML; // xml2.AllPageXML;
            //delete empty notebook
            foreach (var child1 in root.Elements().Reverse())
            {
                if (!child1.HasElements) child1.Remove();
            }
            return root;
        }

        private void tBoxKw_TextChanged(object sender, EventArgs e)
        {
            XElement FilteredPageXml;
            MyPages xml2 = new MyPages();
            xml2 = (MyPages)xml1.Clone();
            XElement AllPageXML1 = xml2.AllPageXML;
            try
            {
                string strKeyWords = tBoxKw.Text.ToLower();
                FilteredPageXml = FilterXml(AllPageXML1, strKeyWords);      
            }
            catch
            {
                MessageBox.Show("Failed to filter!");
            }
        }
    }
    class MyPages : ICloneable
    {
        public XElement AllPageXML;
        public object Clone()
        {
            return this.MemberwiseClone();
        }
    }
}

问题根源 #

1. 初始代码的问题：FilterXml函数直接操作传入的XElement对象——因为XElement是引用类型，root = inXML只是复制了对象引用，后续调用child1.Remove()会直接修改原对象的结构，导致全局AllPageXML被改动。另外，OnLoad方法里的var AllPageXML是局部变量，根本没给全局的AllPageXML赋值，这是隐藏的赋值错误。

2. ICloneable尝试失败的原因：MemberwiseClone()是浅拷贝，只会复制MyPages对象的字段值。AllPageXML作为XElement引用类型，浅拷贝后xml2.AllPageXML和xml1.AllPageXML指向同一个对象，所以FilterXml操作时还是会修改原XElement。

正确解决方法 #

方法1：传入XElement的深拷贝到过滤函数

每次调用FilterXml前，创建原AllPageXML的深拷贝，让函数操作拷贝后的对象，不影响原数据：

private void tBoxKw_TextChanged(object sender, EventArgs e)
{
    try
    {
        string strKeyWords = tBoxKw.Text.ToLower();
        // 创建原XML的深拷贝
        XElement xmlCopy = new XElement(AllPageXML);
        FilteredPageXml = FilterXml(xmlCopy, strKeyWords);           
    }
    catch
    {
        MessageBox.Show("过滤失败！");
    }
}

同时修正OnLoad里的赋值错误：

protected override void OnLoad(EventArgs e)
{
    base.OnLoad(e);
    using var one = new OneNote();
    // 去掉var，赋值给全局变量
    AllPageXML = one.GetAllPages();
    //...//
}

方法2：修改FilterXml函数，返回新的XElement

重构过滤逻辑，不直接修改传入的XElement，而是基于原对象生成新的节点结构返回：

public XElement FilterXml(XElement inXML, string strKeyWords)
{
    // 创建根节点的副本，只保留符合条件的子元素
    XElement filteredRoot = new XElement(inXML.Name);
    // 遍历原节点的子元素，筛选后添加到新根节点
    foreach (var child in inXML.Elements())
    {
        if (child.HasElements) // 保留非空的笔记本节点
        {
            // 其他过滤逻辑可在此添加
            filteredRoot.Add(child);
        }
    }
    return filteredRoot;
}

这种方式不需要拷贝原对象，函数完全基于原数据生成新结构，不会修改原AllPageXML。

方法3：实现MyPages的深拷贝

如果要继续使用ICloneable，需要在Clone方法里对XElement进行深拷贝：

class MyPages : ICloneable
{
    public XElement AllPageXML;
    public object Clone()
    {
        MyPages cloned = (MyPages)this.MemberwiseClone();
        // 对XElement进行深拷贝
        cloned.AllPageXML = new XElement(AllPageXML);
        return cloned;
    }
}

这样xml2.AllPageXML是独立对象，修改它不会影响原xml1.AllPageXML。

内容的提问来源于stack exchange，提问作者Valuex