通过

关于异常的疑难解答：System.InvalidOperationException

  • 项目

当调用一个对象的一个方法且该对象的状态无法支持该方法调用时，将引发 InvalidOperationException。 当一个方法尝试从一个线程操作 UI 且该线程不是主要或 UI 线程时，也将引发该异常。

重要

由于 InvalidOperationException 可能在多种环境中引发，因此必须阅读并理解“异常助手”中显示的 Message。

本文内容

在非 UI 线程上运行的方法会更新 UI

foreach（Visual Basic 中的 For Each）块中的语句会更改其循环访问的集合。

为 null 的 Nullable<T> 转换为 T

对空集合调用了 System.Linq.Enumerable 方法

相关文章

本文中代码示例展示你的应用中可能发生的常见 InvalidOperationException 异常。 如何处理问题取决于具体情况。 如果异常对于应用的功能来说是致命的，你可能希望使用 try … catch（Visual Basic 中的 Try ..Catch）构造来捕捉异常并在退出时清理应用的状态。 但其他 InvalidOperationException 是可以预料并避免。 修改后的方法示例向你展示其中一些技巧。

在非 UI 线程上运行的方法会更新 UI

从 UI 线程进行 UI 更新引发 InvalidOperationException | 避免在非 UI 线程上引发 InvalidOperationException

大多数 .NET GUI（图形用户界面）应用框架（如 Windows 窗体和 Windows Presentation Foundation (WPF)）只允许从创建和管理 UI 的线程（主线程或 UI 线程）访问 GUI 对象。 尝试从非 UI 线程访问 UI 元素时，将引发 InvalidOperationException。

从 UI 线程进行 UI 更新引发 InvalidOperationException

备注

以下示例使用 基于任务的异步模式 (TAP) 创建非 UI 线程。但是，这些示例也与所有的 .NET 异步编程模式 相关。

在这些示例中，ThreadsExampleBtn_Click 事件处理程序两次调用 DoSomeWork 方法。 对方法的第一次调用 (DoSomeWork(20);) 同步运行并成功。 但第二次调用 (Task.Run( () => { DoSomeWork(1000);});) 在应用的线程池中的一个线程上运行。 由于此调用试图从非 UI 线程更新 UI，该语句将引发 InvalidOperationException

WPF 和 Store 应用

备注

在 Store Phone 应用中，将引发 Exception 而非更为具体的 InvalidOperationException。

异常消息：

WPF 应用

其他信息：调用线程无法访问此对象，因为它属于其他线程所有。

应用商店应用

其他信息：应用程序调用了为另一个线程封送的界面。 （HRESULT 异常：0x8001010E (RPC_E_WRONG_THREAD)）

 
private async void ThreadsExampleBtn_Click(object sender, RoutedEventArgs e)
{
    TextBox1.Text = String.Empty;

    TextBox1.Text = "Simulating work on UI thread.\n";
    DoSomeWork(20);

    TextBox1.Text += "Simulating work on non-UI thread.\n";
    await Task.Run(() => DoSomeWork(1000));

    TextBox1.Text += "ThreadsExampleBtn_Click completes. ";
}

private void DoSomeWork(int msOfWork)
{
    // simulate work
    var endTime = DateTime.Now.AddMilliseconds(msOfWork);
    while (DateTime.Now < endTime)
    {
        // spin
    };

    // report completion
    var msg = String.Format("Some work completed in {0} ms on UI thread. \n", msOfWork);
    TextBox1.Text += msg;
}

Windows 窗体应用

异常消息：

  • 其他信息：跨线程操作无效：从另一个线程访问控件“TextBox1”，该线程与在其上创建“TextBox1”的线程不同。
private async void ThreadsExampleBtn_Click(object sender, EventArgs e)
{
    TextBox1.Text = String.Empty;

    var tbLinesList = new List<string>() {"Simulating work on UI thread."};
    TextBox1.Lines = tbLinesList.ToArray();
    DoSomeWork(20, tbLinesList);

    tbLinesList.Add("Simulating work on non-UI thread.");
    TextBox1.Lines = tbLinesList.ToArray();
    await Task.Run(() => DoSomeWork(1000, tbLinesList));

    tbLinesList.Add("ThreadsExampleBtn_Click completes.");
    TextBox1.Lines = tbLinesList.ToArray();
}
private void DoSomeWork(int msOfWork, List<string> tbLinesList)
{
    // simulate work
    var endTime = DateTime.Now.AddMilliseconds(msOfWork);
    while (DateTime.Now < endTime) { };
    {
        // spin
    };

    // report completion
    var msg = String.Format("Some work completed in {0} ms on UI thread. \n", msOfWork);
    tbLinesList.Add(msg);
    TextBox1.Lines = tbLinesList.ToArray();
}

返回页首本文内容本节内容本文内容

避免在非 UI 线程上引发 InvalidOperationException

Windows UI 框架实现“调度程序”模式，此模式包含一种用以检查 UI 线程上当前是否正在执行对 UI 元素成员的调用的方法，还包含其他用以计划对 UI 线程的调用的方法。

WPF 应用

在 WPF 应用中，使用其中一种 Dispatcher.Invoke 在 UI 线程上执行委托。 如果必要，使用 Dispatcher.CheckAccess 方法确定一个方法是否正在非 UI 线程上运行。

private void DoSomeWork(int msOfWork)
{
    var endTime = DateTime.Now.AddMilliseconds(msOfWork);
    while (DateTime.Now < endTime)
    {
        // spin
    };

    // report completion
    var msgFormat = "Some work completed in {0} ms on {1}UI thread.\n";
    var msg = String.Empty;
    if (TextBox1.Dispatcher.CheckAccess())
    {
        msg = String.Format(msgFormat, msOfWork, String.Empty);
        TextBox1.Text += msg;
    }
    else
    {
        msg = String.Format(msgFormat, msOfWork, "non-");
        Action act = ()=> {TextBox1.Text += msg;};
        TextBox1.Dispatcher.Invoke(act);
    }
}

Windows 窗体应用

在 Windows 窗体应用中，使用 Control.Invoke 方法执行更新 UI 线程的委托。 如果必要，使用 Control.InvokeRequired 属性确定一个方法是否正在非 UI 线程上运行。

private void DoSomeWork(int msOfWork, List<string> tbLinesList)
{
    // simulate work
    var endTime = DateTime.Now.AddMilliseconds(msOfWork);
    while (DateTime.Now < endTime)
    {
        // spin
    };

    // report completion
    var msgFormat = "Some work completed in {0} ms on {1}UI thread.\n";
    var msg = String.Empty;
    if (TextBox1.InvokeRequired)
    {
        msg = String.Format(msgFormat, msOfWork, "non-");
        tbLinesList.Add(msg);
        Action act = () => TextBox1.Lines = tbLinesList.ToArray();
        TextBox1.Invoke( act );
    }
    else
    {
        msg = String.Format(msgFormat, msOfWork, String.Empty);
        tbLinesList.Add(msg);
        TextBox1.Lines = tbLinesList.ToArray();
    }
}

应用商店应用

在 Store 应用中，使用 CoreDispatcher.RunAsync 方法执行更新 UI 线程的委托。 如果必要，使用 HasThreadAccess 属性确定一个方法是否正在非 UI 线程上运行。

private void DoSomeWork(int msOfWork)
{
    // simulate work
    var endTime = DateTime.Now.AddMilliseconds(msOfWork);
    while (DateTime.Now < endTime)
    {
        // spin
    };

    // report completion
    var msgFormat = "Some work completed in {0} ms on {1}UI thread.\n";
    var msg = String.Empty;

    if (TextBox1.Dispatcher.HasThreadAccess)
    {
        msg = String.Format(msgFormat, msOfWork, String.Empty);
        TextBox1.Text += msg;
    }
    else
    {
        msg = String.Format(msgFormat, msOfWork, "non-");
        TextBox1.Dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal,  
            ()=> {TextBox1.Text += msg;});
    }
}

返回页首本文内容本节内容本文内容

foreach（Visual Basic 中的 For Each）块中的语句会更改其循环访问的集合。

使用 foreach 引发 InvalidOperationException | 在循环中避免 InvalidOperationException

foreach 语句（Visual Basic 中的 For Each）重复数组或集合中每个元素的一组嵌入语句，该数组或集合可实现 IEnumerable 或 IEnumerable 界面。 foreach 用于循环访问该集合以读取和修改元素，但它不能用于添加或删除集合中的项。 如果通过 foreach 语句从源集合添加项或删除其中的项，将引发 InvalidOperationException。

使用 foreach 引发 InvalidOperationException

在本示例中，当 numList.Add(5); 语句尝试在 foreach 块中修改列表时，将引发 InvalidOperationException。

异常消息：

  • 其他信息：集合已被修改；不能执行枚举操作。
private void AddElementsToAList()
{
    var numList = new List<int>() { 1, 2, 3, 4 };

    foreach (var num in numList)
    {
        if (num == 2)
        {
            numList.Add(5);
        }
    }

    // Display list elements
    foreach (var num in numList)
    {
        Console.Write("{0} ", num);
    }
}

返回页首本文内容本节内容本文内容

在循环中避免 InvalidOperationException

重要

在循环访问集合的同时向列表添加元素或从列表中删除元素可能导致意外的和难以预料的副作用。如果可能，应将操作移到循环访问之外。

private void AddElementsToAList ()
{
    var numList = new List<int>() { 1, 2, 3, 4 };

    var numberOf2s = 0;

    foreach (var num in numList)
    {
        if (num == 2)
        {
            numberOf2s++;
        }
    }

    for (var i = 0; i < numberOf2s; i++ ) 
    { 
        numList.Add(5); 
    }

    // Display list elements
    foreach (var num in numList)
    {
        Console.Write("{0} ", num);
    }
}

如果你的情况要求你在循环访问集合时向列表添加元素或从列表中删除元素，请使用 for（Visual Basic 中的 For）循环：

private void AddElementsToAList ()
{
    var numList = new List<int>() { 1, 2, 3, 4 };

    for (var i = 0; i < numList.Count; i++) 
    {
        if (numList[i] == 2)
        {
            numList.Add(5);
        }
    }

    // Display list elements
    foreach (var num in numList)
    {
        Console.Write("{0} ", num);
    }
}

返回页首本文内容本节内容本文内容

为 null 的 Nullable<T> 转换为 T

通过无效强制转换引发 InvalidOperationException | 避免错误的强制转换引发 InvalidOperationException

如果将 null（Visual Basic 中的 Nothing）的 Nullable 结构强制转换为其基础类型，将引发 InvalidOperationException 异常。

通过无效强制转换引发 InvalidOperationException

在此方法中，当 Select 方法将 dbQueryResults 的 null 元素强制转换为 int 时，将引发 InvalidOperationException。

异常消息：

  • 其他信息：可以为 null 的对象必须具有一个值。
private void MapQueryResults()
{
    var dbQueryResults = new int?[] { 1, 2, null, 4 };

    var ormMap = dbQueryResults.Select(nullableInt => (int)nullableInt);

    //display map list
    foreach (var num in ormMap)
    {
        Console.Write("{0} ", num);
    }
    Console.WriteLine();
}

返回页首本文内容本节内容本文内容

避免错误的强制转换引发 InvalidOperationException

若要避免 InvalidOperationException：

Nullable<T>.HasValue 示例

private void MapQueryResults()
{
    var dbQueryResults = new int?[] { 1, 2, null, 4 };

    var ormMap = dbQueryResults
        .Where(nulllableInt => nulllableInt.HasValue)
        .Select(num => (int)num);

    //display map list
    foreach (var num in ormMap)
    {
        Console.Write("{0} ", num);
    }
    Console.WriteLine();

    // handle nulls
    Console.WriteLine("{0} nulls encountered in dbQueryResults",
        dbQueryResults.Where(nullableInt => !nullableInt.HasValue).Count());
}

Nullable<T>.GetValueOrDefault 示例

在本示例中，我们使用 GetValueOrDefault(UTP) 指定一个默认值，此默认值在 dbQueryResults 返回的预期值之外。

private void MapQueryResults()
{
    var dbQueryResults = new int?[] { 1, 2, null, 4 };
    var nullFlag = int.MinValue;

    var ormMap = dbQueryResults.Select(nullableInt => nullableInt.GetValueOrDefault(nullFlag));

    // handle nulls
    Console.WriteLine("'{0}' indicates a null database value.", nullFlag);

    foreach (var num in ormMap)
    {
        Console.Write("{0} ", num);
    }
    Console.WriteLine();
}

返回页首本文内容本节内容本文内容

对空集合调用了 System.Linq.Enumerable 方法

Enumerable 方法 Aggregate、Average、Last、Max、Min、First、Single 和 SingleOrDefault 对序列执行操作并返回单一结果。

当序列为空时，这些方法的一些重载会引发 InvalidOperationException 异常（其他重载则返回 null （Visual Basic 中的 Nothing））。 当序列包含多个元素时，SingleOrDefault 也会引发 InvalidOperationException。

提示

本节中讨论的大多 Enumerable 方法都是重载方法。确保你理解你选择的重载行为。

异常消息：

Aggregate、Average、Last、Max 和 Min 方法 | First 和 FirstOrDefault 方法 | Single 和 SingleOrDefault 方法

Aggregate、Average、Last、Max 和 Min 方法

  • 其他信息：序列不包含任何元素

通过 Average 引发 InvalidOperationException

在本示例中，当调用 Average 方法时，以下方法将引发 InvalidOperationException，因为 Linq 表达式返回一个序列，该序列中不存在大于 4 的元素。

private void FindAverageOfNumbersGreaterThan4()
{
    var dbQueryResults = new[] { 1, 2, 3, 4 };

    var avg = dbQueryResults.Where(num => num > 4).Average();

    Console.WriteLine("The average value numbers greater than 4 in the returned records is {0}", avg);
}

在不检查空序列的情况下使用这些方法中的一种时，你默认假设该序列为空且空序列是意外的匹配项。 当假设序列不为空时，可以捕捉或引发异常。

避免由空序列引发的 InvalidOperationException

使用 Enumerable.Any 方法之一检查序列是否为空。

提示

如果要平均的序列可能包含大量元素或如果生成该序列的操作十分昂贵，则使用 Any 可提高此检查的性能。

private void FindAverageOfNumbersGreaterThan4()
{
    var dbQueryResults = new[] { 1, 2, 3, 4 };

    var moreThan4 = dbQueryResults.Where(num => num > 4);

    if(moreThan4.Any())
    {
        var msgFormat = "The average value numbers greater than 4 in the returned records is {0}";
        Console.WriteLine(msgFormat, moreThan4.Average());
    }
    else
    {
        // handle empty collection 
        Console.WriteLine("There are no values greater than 4 in the ecords.");
    }
}

返回页首本文内容本节内容本文内容

First 和 FirstOrDefault 方法

First 返回序列中的第一项，如果序列为空，则引发 InvalidOperationException。 你可以调用 FirstOrDefault 方法而非 First 以返回特定值或默认值，避免引发异常。

备注

在 .NET Framework 中，类型具有默认值的概念。例如，对于任何引用类型，默认值为 null，而整型的默认值为零。请参见默认值表（C# 参考）

通过 First 引发 InvalidOperationException

First 是一种优化方法，它返回满足指定条件的序列的第一个元素。 如果找不到满足条件的元素，这些方法将引发 InvalidOperationException 异常。

在本示例中，First 方法引发异常，因为 dbQueryResults 不包含大于 4 的元素。

异常消息：

  • 其他信息：序列不包含匹配元素
private void FindANumbersGreaterThan4()
{
    var dbQueryResults = new[] { 1, 2, 3, 4 };

    var firstNum = dbQueryResults.First(n=> n > 4);

    var msgFormat = "{0} is an element of dbQueryResults that is greater than 4";
    Console.WriteLine(msgFormat, firstNum);

}

避免 FirstOrDefault 引发的异常

你可以使用 FirstOrDefault 方法之一替代 First 检查 firstNum 序列是否包含至少一个元素。 如果查询找不到满足条件的元素，它将返回指定值或默认值。 你可以检查返回值，确定是否找到任何元素。

备注

如果类型的默认值是序列中的有效元素，则要实现使用 FirstOrDefault 可能更为复杂。

private void FindANumbersGreaterThan4()
{
    var dbQueryResults = new[] { 1, 2, 3, 4 };

    // default(object) == null
    var firstNum = dbQueryResults.FirstOrDefault(n => n > 4);

    if (firstNum != 0)
    {
        var msgFormat = "{0} is an element of dbQueryResults that is greater than 4";
        Console.WriteLine(msgFormat, firstNum);
    }
    else
    {
        // handle default case
        Console.WriteLine("No element of dbQueryResults is greater than 4.");
    }
}

返回页首本文内容本节内容本文内容

Single 和 SingleOrDefault 方法

Enumerable.Single 方法返回序列的唯一元素，或者序列中满足指定测试的唯一元素。

如果序列中不存在元素，或者序列中有多个元素，该方法将引发 InvalidOperationException 异常。

当序列不包含任何元素时，可以使用 SingleOrDefault 返回指定值或默认值以避免引发异常。 但是，如果序列包含多个与选定谓词匹配的元素，SingleOrDefault 仍会引发 InvalidOperationException。

备注

在 .NET Framework 中，类型具有默认值的概念。例如，对于任何引用类型，默认值为 null，而整型的默认值为零。请参见默认值表（C# 参考）

通过 Single 引发 InvalidOperationException

在本示例中，singleObject 引发 InvalidOperationException，因为 dbQueryResults 不包含大于 4 的元素。

异常消息：

  • 其他信息：序列不包含匹配元素
private void FindTheOnlyNumberGreaterThan4()
{
    var dbQueryResults = new[] { (object)1, (object)2, (object)3, (object)4 };

    var singleObject = dbQueryResults.Single(obj => (int)obj > 4);

    // display results
    var msgFormat = "{0} is the only element of dbQueryResults that is greater than 4";
    Console.WriteLine(msgFormat, singleObject);
}

通过 Single 或 SingleOrDefault 引发 InvalidOperationException

在本示例中，singleObject 引发 InvalidOperationException，因为 dbQueryResults 包含多个大于 2 的元素。

异常消息：

  • 其他信息：序列包含多个匹配元素
private void FindTheOnlyNumberGreaterThan2()
{
    var dbQueryResults = new[] { (object)1, (object)2, (object)3, (object)4 };

    var singleObject = dbQueryResults.SingleOrDefault(obj => (int)obj > 2);

    if (singleObject != null)
    {
        var msgFormat = "{0} is the only element of dbQueryResults that is greater than 2";
        Console.WriteLine(msgFormat, singleObject);
    }
    else
    {
        // handle empty collection
        Console.WriteLine("No element of dbQueryResults is greater than 2.");
    }
}

避免 Single 引发的 InvalidOperationException

使用 Single 和 SingleOrDefault 也可作为对你目的的记录。 Single 强烈暗示，在该条件下你预计仅返回一个结果。 SingleOrDefault 声明你预计返回一个或零个结果，但不会有更多。 当这些条件无效时，可以引发或捕捉 InvalidOperationException。 但是，如果你预计这些无效的条件将以某种频率发生，你应该考虑使用其他 Enumerable 方法（如 First 或 Where）来生成你的结果。

开发过程中，你可以使用其中一种 Assert 方法来核实你的假设。 在本示例中，突出显示的代码导致调试器在开发期间中断进程并显示一个断言对话框。 该断言在发行代码中被删除，如果结果无效，则将引发 Single。

备注

使用 Take``1 并将其 count 参数设定为 2 会使返回的序列数目最多包含两个元素。此序列包含你需要检查的所有情况（0 个、1 个和多个元素），并且当序列可能包含大量元素或生成的序列很昂贵时，它可以改善检查的性能。

private void FindTheOnlyNumberGreaterThan4()
{
    var dbQueryResults = new[] { (object)1, (object)2, (object)3, (object)4 };
    var moreThan4 = dbQueryResults.Where(obj => (int)obj > 4).Take(2);

    System.Diagnostics.Debug.Assert(moreThan4.Count() == 1, 
        String.Format("moreThan4.Count() == 1; Actual count: {0}", moreThan4.Count()));

    // do not handle exceptions in release code
    Console.WriteLine("{0} is the only element of dbQueryResults that is greater than 4", 
        moreThan4.Single());
}

如果你希望避免异常的同时仍在发行代码中处理无效状态，你可以修改上述技巧。 在此示例中，方法对应于 switch 语句中 moreThan2 返回的元素数目。

private void FindTheOnlyNumberGreaterThan2()
{
    var dbQueryResults = new[] { (object)1, (object)2, (object)3, (object)4 };

    var moreThan2 = dbQueryResults.TakeWhile(obj => (int)obj > 2).Take(2);

    switch(moreThan2.Count())
    { 
        case 1:
            // success
            var msgFormat = "{0} is the only element of dbQueryResults that is greater than 2";
            Console.WriteLine(msgFormat, moreThan2.Single());
            break;
        case 0:
            // handle empty collection
            Console.WriteLine("No element of the dbQueryResults are greater than 4.");
            break;
        default: // count > 1
            // handle more than one element
            Console.WriteLine("More than one element of dbQueryResults is greater than 4");
            break;
    }
}

返回页首本文内容本节内容本节内容

相关文章

异常的设计准则（.NET Framework 设计准则）

处理和引发异常（.NET Framework 应用程序 Essentials）

如何：接收首次异常通知（.NET Framework 开发指南）

如何：处理 PLINQ 查询中的异常（.NET Framework 开发指南）

托管线程中的异常（.NET Framework 开发指南）

异常和异常处理（C# 编程指南）

异常处理语句（C# 参考）

Try...Catch...Finally 语句 (Visual Basic)

异常处理 (F#)

C++/CLI 中的异常

异常处理（任务并行库）

异常处理（调试）

演练：处理并发异常（在 Visual Studio 中访问数据）

如何：处理因数据绑定而发生的错误和异常（Windows 窗体）

处理网络应用中的异常 (XAML) (Windows)

返回页首本文内容