我有一些代码,当它执行时,它会抛出NullReferenceException,说:

对象引用未设置为对象的实例。

这意味着什么,我可以做什么来修复这个错误?


当前回答

有趣的是,本页的答案中没有一个提到两种边缘情况:

边缘案例#1:对字典的并发访问

.NET中的泛型字典不是线程安全的,当您尝试从两个并发线程访问密钥时,它们有时可能会抛出NullReference,甚至(更频繁)抛出KeyNotFoundException。在这种情况下,这个例外情况很容易引起误解。

边缘案例#2:不安全代码

如果不安全代码引发NullReferenceException,您可以查看指针变量,并检查它们是否存在IntPtr.Zero或其他内容。这是同一回事(“空指针异常”),但在不安全的代码中,变量通常被转换为值类型/数组等,你会把头撞在墙上,想知道值类型如何抛出此异常。

(顺便说一句,除非您需要,否则不使用不安全代码的另一个原因。)

边缘案例3:Visual Studio多监视器设置,辅助监视器的DPI设置与主监视器不同

此边缘案例是特定于软件的,属于Visual Studio 2019 IDE(以及可能更早的版本)。

一种重现问题的方法:将任何组件从工具箱拖到非主监视器上的Windows窗体上,该窗体的DPI设置与主监视器不同,然后会弹出一个“Object reference not set to A instance of A Object”(对象引用未设置为对象的实例)。根据这个线程,这个问题已经知道了很长一段时间,在编写时仍然没有解决。

其他回答

您正在使用包含空值引用的对象。所以它给出了一个空异常。在本例中,字符串值为空,在检查其长度时发生异常。

例子:

string value = null;
if (value.Length == 0) // <-- Causes exception
{
    Console.WriteLine(value); // <-- Never reached
}

异常错误为:

未处理的异常:System.NullReferenceException:对象引用未设置为实例对象的。位于Program.Main()

虽然导致NullReferenceExceptions的原因和避免/修复此类异常的方法已经在其他答案中得到了解决,但许多程序员尚未学会的是如何在开发过程中独立调试此类异常。

在Visual Studio中,由于Visual Studio调试器,这通常很容易。


首先,确保将捕获正确的错误-请参见如何允许在VS2010中的“System.NullReferenceException”上中断?注释1

然后从调试开始(F5)或将[VS调试器]附加到正在运行的进程。有时,使用Debugger.Break可能很有用,它将提示启动调试器。

现在,当抛出(或未处理)NullReferenceException时,调试器将在发生异常的行上停止(记住上面设置的规则吗?)。有时错误很容易被发现。

例如,在下一行中,唯一可能导致异常的代码是myString求值为null。这可以通过查看观察窗口或在即时窗口中运行表达式来验证。

var x = myString.Trim();

在更高级的情况下,例如以下情况,您需要使用上述技术之一(观察或即时窗口)来检查表达式,以确定str1是否为null或str2是否为null。

var x = str1.Trim() + str2.Trim();

一旦找到了抛出异常的位置,通常很难反向推理,以找出空值被[错误]引入的位置--

花时间了解异常原因。检查空表达式。检查之前可能导致此类空表达式的表达式。根据需要添加断点并单步执行程序。使用调试器。


1如果“抛出时中断”过于激进,并且调试器在.NET或第三方库中的NPE上停止,则可以使用“用户未处理时中断”来限制捕获的异常。此外,VS2012还引入了Just My Code,我建议您也启用它。

如果您在启用“仅我的代码”的情况下进行调试,则行为略有不同。如果启用了“仅我的代码”,调试器将忽略在“我的代码外引发的、不通过“我的码”的第一次公共语言运行时(CLR)异常

原因是什么?

要旨

您正在尝试使用空值(或VB.NET中的Nothing)。这意味着您要么将其设置为空值,要么从未将其设置任何值。

和其他任何东西一样,null也会被传递。如果在方法“A”中为空,则可能是方法“B”将空传递给了方法“A)。

null可以有不同的含义:

未初始化的对象变量,因此不指向任何对象。在这种情况下,如果访问此类对象的成员,则会导致NullReferenceException。开发人员有意使用null来表示没有可用的有意义的值。注意,C#具有变量的可空数据类型的概念(比如数据库表可以有可空字段)-您可以为它们赋值null,以表示其中没有存储值,例如int?a=空;(这是Nullable<int>a=null;的快捷方式),其中问号表示允许在变量a中存储null。您可以使用if(a.HasValue){…}或if(a==null){..}进行检查。与此示例类似,Nullable变量允许显式地通过.value访问值,也可以通过a正常访问值。请注意,如果a为null,则通过.Value访问它会引发InvalidOperationException而不是NullReferenceException-您应该事先进行检查,即如果您有另一个不可为null的变量int b;那么您应该执行if(a.HasValue){b=a.Value;}或更短的赋值,如果(a!=null){b=a;}。

本文的其余部分将更详细地介绍许多程序员经常犯的错误,这些错误可能会导致NullReferenceException。

更具体地说

引发NullReferenceException的运行时总是意味着相同的事情:您正在尝试使用引用,但该引用未初始化(或者它已初始化,但不再初始化)。

这意味着引用为空,您不能通过空引用访问成员(如方法)。最简单的情况:

string foo = null;
foo.ToUpper();

这将在第二行引发NullReferenceException,因为无法对指向null的字符串引用调用实例方法ToUpper()。

调试

如何查找NullReferenceException的源?除了查看异常本身(它将被准确地抛出在发生异常的位置)之外,Visual Studio中的一般调试规则也适用:放置策略断点并检查变量,方法是将鼠标悬停在变量名称上,打开(快速)观察窗口,或使用各种调试面板(如Locals和Autos)。

如果要查找引用的设置位置,请右键单击其名称并选择“查找所有引用”。然后,您可以在每个找到的位置放置一个断点,并在附加调试器的情况下运行程序。每当调试器在这样的断点上中断时,您都需要确定引用是否为非空,检查变量,并验证它是否指向您期望的实例。

通过以这种方式遵循程序流程,您可以找到实例不应为空的位置,以及为什么未正确设置。

示例

可以引发异常的一些常见情况:

通用的

ref1.ref2.ref3.member

如果ref1或ref2或ref3为空,则会得到NullReferenceException。如果要解决此问题,请通过将表达式重写为更简单的等效表达式来找出哪个为空:

var r1 = ref1;
var r2 = r1.ref2;
var r3 = r2.ref3;
r3.member

具体而言,在HttpContext.Current.User.Identity.Name中,HttpContext.CCurrent可以为null,User属性可以为null或Identity属性可以为空。

间接的

public class Person 
{
    public int Age { get; set; }
}
public class Book 
{
    public Person Author { get; set; }
}
public class Example 
{
    public void Foo() 
    {
        Book b1 = new Book();
        int authorAge = b1.Author.Age; // You never initialized the Author property.
                                       // there is no Person to get an Age from.
    }
}

如果要避免子(Person)空引用,可以在父(Book)对象的构造函数中初始化它。

嵌套对象初始化器

这同样适用于嵌套对象初始化器:

Book b1 = new Book 
{ 
   Author = { Age = 45 } 
};

这意味着:

Book b1 = new Book();
b1.Author.Age = 45;

当使用new关键字时,它只创建Book的一个新实例,而不会创建Person的新实例,因此Author属性仍然为空。

嵌套集合初始值设定项

public class Person 
{
    public ICollection<Book> Books { get; set; }
}
public class Book 
{
    public string Title { get; set; }
}

嵌套集合Initializer的行为相同:

Person p1 = new Person 
{
    Books = {
         new Book { Title = "Title1" },
         new Book { Title = "Title2" },
    }
};

这意味着:

Person p1 = new Person();
p1.Books.Add(new Book { Title = "Title1" });
p1.Books.Add(new Book { Title = "Title2" });

新Person仅创建Person的实例,但Books集合仍然为空。集合Initializer语法未创建集合对于p1.Books,它只翻译为p1.Books.Add(…)语句。

大堆

int[] numbers = null;
int n = numbers[0]; // numbers is null. There is no array to index.

数组元素

Person[] people = new Person[5];
people[0].Age = 20 // people[0] is null. The array was allocated but not
                   // initialized. There is no Person to set the Age for.

锯齿状阵列

long[][] array = new long[1][];
array[0][0] = 3; // is null because only the first dimension is yet initialized.
                 // Use array[0] = new long[2]; first.

集合/列表/字典

Dictionary<string, int> agesForNames = null;
int age = agesForNames["Bob"]; // agesForNames is null.
                               // There is no Dictionary to perform the lookup.

范围变量(间接/延迟)

public class Person 
{
    public string Name { get; set; }
}
var people = new List<Person>();
people.Add(null);
var names = from p in people select p.Name;
string firstName = names.First(); // Exception is thrown here, but actually occurs
                                  // on the line above.  "p" is null because the
                                  // first element we added to the list is null.

事件(C#)

public class Demo
{
    public event EventHandler StateChanged;
    
    protected virtual void OnStateChanged(EventArgs e)
    {        
        StateChanged(this, e); // Exception is thrown here 
                               // if no event handlers have been attached
                               // to StateChanged event
    }
}

(注意:VB.NET编译器会插入事件用法的空检查,因此不必在VB.NET中检查Nothing的事件。)

错误的命名惯例:

如果您对字段的命名与本地变量不同,您可能会意识到您从未初始化过字段。

public class Form1
{
    private Customer customer;
    
    private void Form1_Load(object sender, EventArgs e) 
    {
        Customer customer = new Customer();
        customer.Name = "John";
    }
    
    private void Button_Click(object sender, EventArgs e)
    {
        MessageBox.Show(customer.Name);
    }
}

这可以通过以下惯例来解决:在字段前加下划线:

    private Customer _customer;

ASP.NET页面生命周期:

public partial class Issues_Edit : System.Web.UI.Page
{
    protected TestIssue myIssue;

    protected void Page_Load(object sender, EventArgs e)
    {
        if (!IsPostBack)
        {
             // Only called on first load, not when button clicked
             myIssue = new TestIssue(); 
        }
    }
        
    protected void SaveButton_Click(object sender, EventArgs e)
    {
        myIssue.Entry = "NullReferenceException here!";
    }
}

ASP.NET会话值

// if the "FirstName" session value has not yet been set,
// then this line will throw a NullReferenceException
string firstName = Session["FirstName"].ToString();

ASP.NET MVC空视图模型

如果在ASP.NET MVC视图中引用@Model的属性时发生异常,则需要了解在返回视图时,Model会在操作方法中设置。当您从控制器返回一个空模型(或模型属性)时,当视图访问它时会发生异常:

// Controller
public class Restaurant:Controller
{
    public ActionResult Search()
    {
        return View();  // Forgot the provide a Model here.
    }
}

// Razor view 
@foreach (var restaurantSearch in Model.RestaurantSearch)  // Throws.
{
}
    
<p>@Model.somePropertyName</p> <!-- Also throws -->

WPF控件创建顺序和事件

WPF控件是在调用InitializeComponent期间按照它们在可视化树中的显示顺序创建的。如果使用事件处理程序等早期创建的控件在InitializeComponent过程中触发,并引用了后期创建的控件,则会引发NullReferenceException。

例如:

<Grid>
    <!-- Combobox declared first -->
    <ComboBox Name="comboBox1" 
              Margin="10"
              SelectedIndex="0" 
              SelectionChanged="comboBox1_SelectionChanged">
       <ComboBoxItem Content="Item 1" />
       <ComboBoxItem Content="Item 2" />
       <ComboBoxItem Content="Item 3" />
    </ComboBox>
        
    <!-- Label declared later -->
    <Label Name="label1" 
           Content="Label"
           Margin="10" />
</Grid>

这里,组合框1在label1之前创建。如果comboBox1_SelectionChanged尝试引用“标签1”,则尚未创建它。

private void comboBox1_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
    label1.Content = comboBox1.SelectedIndex.ToString(); // NullReferenceException here!!
}

更改XAML中声明的顺序(即,在comboBox1之前列出label1,忽略设计理念的问题)至少可以解决此处的NullReferenceException。

使用铸造

var myThing = someObject as Thing;

这不会引发InvalidCastException,但在强制转换失败时(以及someObject本身为null时)返回null。所以要注意这一点。

LINQ FirstOrDefault()和SingleOrDefault(

普通版本First()和Single()在没有异常时抛出异常。在这种情况下,“OrDefault”版本返回null。所以要注意这一点。

前肢

foreach在尝试迭代null集合时抛出。通常由返回集合的方法的意外空结果引起。

List<int> list = null;    
foreach(var v in list) { } // NullReferenceException here

更现实的例子是从XML文档中选择节点。如果未找到节点,但初始调试显示所有财产都有效,则将引发:

foreach (var node in myData.MyXml.DocumentNode.SelectNodes("//Data"))

避免的方法

显式检查空值并忽略空值。

如果希望引用有时为空,可以在访问实例成员之前检查引用是否为空:

void PrintName(Person p)
{
    if (p != null) 
    {
        Console.WriteLine(p.Name);
    }
}

显式检查null并提供默认值。

您调用的方法期望实例可以返回null,例如,当找不到要查找的对象时。在这种情况下,您可以选择返回默认值:

string GetCategory(Book b) 
{
    if (b == null)
        return "Unknown";
    return b.Category;
}

显式检查方法调用中的null并引发自定义异常。

您还可以抛出自定义异常,只在调用代码中捕获它:

string GetCategory(string bookTitle) 
{
    var book = library.FindBook(bookTitle);  // This may return null
    if (book == null)
        throw new BookNotFoundException(bookTitle);  // Your custom exception
    return book.Category;
}

如果值永远不应为空,请使用Debug.Assert,以便在异常发生之前捕获问题。

当您在开发过程中知道一个方法可以返回null,但不应该返回null时,可以使用Debug.Assert()在发生时尽快中断:

string GetTitle(int knownBookID) 
{
    // You know this should never return null.
    var book = library.GetBook(knownBookID);  

    // Exception will occur on the next line instead of at the end of this method.
    Debug.Assert(book != null, "Library didn't return a book for known book ID.");

    // Some other code

    return book.Title; // Will never throw NullReferenceException in Debug mode.
}

尽管此检查不会在您的发布版本中结束,但会导致在运行时book==null处于发布模式时再次引发NullReferenceException。

对可为null的值类型使用GetValueOrDefault(),以在它们为null时提供默认值。

DateTime? appointment = null;
Console.WriteLine(appointment.GetValueOrDefault(DateTime.Now));
// Will display the default value provided (DateTime.Now), because appointment is null.

appointment = new DateTime(2022, 10, 20);
Console.WriteLine(appointment.GetValueOrDefault(DateTime.Now));
// Will display the appointment date, not the default

使用空合并运算符:??[C#]或If()[VB]。

遇到null时提供默认值的简写:

IService CreateService(ILogger log, Int32? frobPowerLevel)
{
   var serviceImpl = new MyService(log ?? NullLog.Instance);
 
   // Note that the above "GetValueOrDefault()" can also be rewritten to use
   // the coalesce operator:
   serviceImpl.FrobPowerLevel = frobPowerLevel ?? 5;
}

使用空条件运算符:?。或[x] 对于数组(在C#6和VB.NET 14中可用):

这有时也被称为安全导航或猫王(以其形状命名)操作员。如果运算符左侧的表达式为null,则不会对右侧求值,而是返回null。这意味着这样的情况:

var title = person.Title.ToUpper();

如果此人没有标题,这将引发异常,因为它试图对具有空值的属性调用ToUpper。

在C#5及以下版本中,可通过以下方式进行防护:

var title = person.Title == null ? null : person.Title.ToUpper();

现在title变量将为null,而不是引发异常。C#6为此引入了更短的语法:

var title = person.Title?.ToUpper();

这将导致title变量为空,如果person.title为空,则不会调用ToUpper。

当然,您仍然需要检查null的标题,或者将null条件运算符与null合并运算符(??)一起使用以提供默认值:

// regular null check
int titleLength = 0;
if (title != null)
    titleLength = title.Length; // If title is null, this would throw NullReferenceException
    
// combining the `?` and the `??` operator
int titleLength = title?.Length ?? 0;

同样,对于可以使用的阵列?[i] 如下所示:

int[] myIntArray = null;
var i = 5;
int? elem = myIntArray?[i];
if (!elem.HasValue) Console.WriteLine("No value");

这将执行以下操作:如果myIntArray为null,则表达式返回null,您可以安全地检查它。如果它包含数组,则其操作与:elem=myIntArray[i];并返回第i个元素。

使用空上下文(在C#8中可用):

在C#8中引入了空上下文和可空引用类型,它们对变量执行静态分析,并在值可能为空或已设置为空时提供编译器警告。可为null的引用类型允许显式地允许类型为null。

可以使用csproj文件中的nullable元素为项目设置可为null的注释上下文和可为null警告上下文。此元素配置编译器如何解释类型的可空性以及生成什么警告。有效设置为:

enable:启用可为null的注释上下文。已启用可为null的警告上下文。例如,引用类型(字符串)的变量不可为空。所有可为空警告都已启用。disable:禁用可为null的注释上下文。禁用了可为null的警告上下文。引用类型的变量是不可见的,就像早期版本的C#一样。禁用所有可为null的警告。safeonly:启用了可为null的注释上下文。可为null的警告上下文是安全的。引用类型的变量不可为空。启用所有安全可为零警告。警告:禁用了可为null的注释上下文。已启用可为null的警告上下文。引用类型的变量是不可见的。所有可为空警告都已启用。safetonlywarnings:禁用了可为null的注释上下文。可为null的警告上下文是安全的。引用类型的变量是不可见的。启用所有安全可为零警告。

可为null的引用类型使用与可为null值类型相同的语法进行标注:A?附加到变量的类型。

调试和修复迭代器中的空derefs的特殊技术

C#支持“迭代器块”(在其他一些流行语言中称为“生成器”)。由于延迟执行,在迭代器块中调试NullReferenceException可能特别棘手:

public IEnumerable<Frob> GetFrobs(FrobFactory f, int count)
{
    for (int i = 0; i < count; ++i)
    yield return f.MakeFrob();
}
...
FrobFactory factory = whatever;
IEnumerable<Frobs> frobs = GetFrobs();
...
foreach(Frob frob in frobs) { ... }

如果结果为空,则MakeFrob将抛出。现在,你可能认为正确的做法是:

// DON'T DO THIS
public IEnumerable<Frob> GetFrobs(FrobFactory f, int count)
{
   if (f == null) 
      throw new ArgumentNullException("f", "factory must not be null");
   for (int i = 0; i < count; ++i)
      yield return f.MakeFrob();
}

为什么这是错误的?因为迭代器块直到foreach!对GetFrobs的调用只返回一个对象,当迭代时,该对象将运行迭代器块。

通过编写这样的空检查,可以防止NullReferenceException,但可以将NullArgumentException移动到迭代点,而不是调用点,这对调试来说非常混乱。

正确的修复方法是:

// DO THIS
public IEnumerable<Frob> GetFrobs(FrobFactory f, int count)
{
   // No yields in a public method that throws!
   if (f == null) 
       throw new ArgumentNullException("f", "factory must not be null");
   return GetFrobsForReal(f, count);
}
private IEnumerable<Frob> GetFrobsForReal(FrobFactory f, int count)
{
   // Yields in a private method
   Debug.Assert(f != null);
   for (int i = 0; i < count; ++i)
        yield return f.MakeFrob();
}

也就是说,创建一个具有迭代器块逻辑的私有助手方法和一个执行空检查并返回迭代器的公共表面方法。现在,当调用GetFrobs时,立即执行空检查,然后在序列迭代时执行GetFrobsForReal。

如果您检查LINQ to Objects的参考源,您将看到整个过程中都使用了这种技术。它编写起来稍显笨拙,但它使调试无效错误变得更加容易。优化代码是为了方便调用者,而不是作者。

关于不安全代码中空引用的注释

C#有一种“不安全”模式,顾名思义,这种模式非常危险,因为提供内存安全和类型安全的正常安全机制没有得到强制执行。除非您对内存的工作原理有透彻深入的了解,否则不应该编写不安全的代码。

在不安全模式下,您应该了解两个重要事实:

取消引用空指针会产生与取消引用空引用相同的异常在某些情况下,取消引用无效的非空指针可能会产生该异常

要理解这一点,首先要了解.NET如何生成NullReferenceException。(这些详细信息适用于在Windows上运行的.NET;其他操作系统使用类似的机制。)

内存在Windows中虚拟化;每个进程都会获得一个由操作系统跟踪的许多“页面”内存组成的虚拟内存空间。内存的每一页上都设置了标志,以确定如何使用:读取、写入、执行等等。最低的一页被标记为“如果以任何方式使用都会产生错误”。

C#中的空指针和空引用在内部都表示为数字零,因此任何试图将其解引用到相应的内存存储中的尝试都会导致操作系统产生错误。然后,.NET运行时检测到此错误并将其转换为NullReferenceException。

这就是为什么取消引用空指针和空引用会产生相同的异常。

第二点呢?取消引用位于虚拟内存最低页的任何无效指针都会导致相同的操作系统错误,从而导致相同的异常。

为什么这有意义?好吧,假设我们有一个包含两个int的结构和一个等于null的非托管指针。如果我们尝试取消引用结构中的第二个int,CLR将不会尝试访问位置0处的存储;它将访问位置4处的存储器。但从逻辑上讲,这是一个空的解引用,因为我们是通过空来到达那个地址的。

如果您使用的是不安全的代码,并且得到了NullReferenceException,请注意,有问题的指针不必为null。它可以是最低页面中的任何位置,将生成此异常。

NullReference异常-Visual Basic

Visual Basic的NullReference异常与C#中的异常没有区别。毕竟,它们都报告了各自使用的.NET Framework中定义的相同异常。Visual Basic特有的原因很少(可能只有一个)。

此答案将使用Visual Basic术语、语法和上下文。所使用的示例来自过去的大量堆栈溢出问题。这是为了通过使用帖子中经常出现的各种情况来最大限度地提高相关性。还为可能需要的人提供了更多的解释。这里很可能列出了一个类似于您的示例。

注:

这是基于概念的:没有代码可以粘贴到项目中。它旨在帮助您了解导致NullReferenceException(NRE)的原因,如何查找它,如何修复它,以及如何避免它。NRE可以通过多种方式导致,因此这不可能是您唯一的遭遇。这些例子(来自StackOverflow文章)并不总是首先展示了做某事的最佳方式。通常,使用最简单的补救方法。

基本含义

消息“Object not set to a instance of Object”表示您正在尝试使用尚未初始化的对象。这归结为以下之一:

您的代码声明了一个对象变量,但它没有初始化它(创建一个实例或“实例化”它)您的代码假设会初始化对象,而不是可能是其他代码过早地使仍在使用的对象无效

查找原因

由于问题是一个Nothing的对象引用,所以答案是检查它们以找出哪一个。然后确定未初始化的原因。将鼠标放在各种变量上,VisualStudio(VS)将显示它们的值——罪魁祸首将是Nothing。

您还应该从相关代码中删除任何Try/Catch块,尤其是Catch块中没有任何内容的代码。这将导致代码在尝试使用Nothing对象时崩溃。这是您想要的,因为它将确定问题的确切位置,并允许您确定导致问题的对象。

Catch中显示Error while…的MsgBox。。。不会有什么帮助。这种方法也会导致非常糟糕的堆栈溢出问题,因为您无法描述实际的异常、所涉及的对象,甚至无法描述发生异常的代码行。

您还可以使用Locals窗口(Debug->Windows->Locals)来检查对象。

一旦你知道问题是什么和在哪里,通常很容易解决,而且比发布新问题更快。

另请参见:

断点MSDN:如何:使用Try/Catch块捕获异常MSDN:异常的最佳实践

示例和补救措施

类对象/创建实例

Dim reg As CashRegister
...
TextBox1.Text = reg.Amount         ' NRE

问题是Dim没有创建CashRegister对象;它只声明该类型的名为reg的变量。声明对象变量和创建实例是两件不同的事情。

救济

在声明实例时,通常可以使用New运算符创建实例:

Dim reg As New CashRegister        ' [New] creates instance, invokes the constructor

' Longer, more explicit form:
Dim reg As CashRegister = New CashRegister

当稍后才适合创建实例时:

Private reg As CashRegister         ' Declare
  ...
reg = New CashRegister()            ' Create instance

注意:不要在过程中再次使用Dim,包括构造函数(Sub New):

Private reg As CashRegister
'...

Public Sub New()
   '...
   Dim reg As New CashRegister
End Sub

这将创建一个局部变量reg,它仅存在于该上下文(sub)中。您将在其他地方使用的具有模块级作用域的reg变量仍然为Nothing。

缺少New运算符是出现NullReference异常的头号原因,在所审查的堆栈溢出问题中可以看到。Visual Basic尝试使用New反复使过程清晰:使用New运算符创建一个新对象,并调用Sub New(构造函数),对象可以在其中执行任何其他初始化。

明确地说,Dim(或Private)只声明变量及其类型。变量的作用域(是否存在于整个模块/类或过程的本地)由其声明的位置决定。Private | Friend | Public定义访问级别,而不是Scope。

有关详细信息,请参阅:

新建操作员Visual Basic中的范围Visual Basic中的访问级别值类型和引用类型


阵列

数组也必须实例化:

Private arr as String()

此数组仅声明,未创建。有几种方法可以初始化数组:

Private arr as String() = New String(10){}
' or
Private arr() As String = New String(10){}

' For a local array (in a procedure) and using 'Option Infer':
Dim arr = New String(10) {}

注意:从VS 2010开始,当使用文本和Option Infer初始化本地数组时,As<Type>和New元素是可选的:

Dim myDbl As Double() = {1.5, 2, 9.9, 18, 3.14}
Dim myDbl = New Double() {1.5, 2, 9.9, 18, 3.14}
Dim myDbl() = {1.5, 2, 9.9, 18, 3.14}

数据类型和数组大小是从分配的数据中推断出来的。类/模块级声明仍然需要具有Option Strict的As<Type>:

Private myDoubles As Double() = {1.5, 2, 9.9, 18, 3.14}

示例:类对象数组

Dim arrFoo(5) As Foo

For i As Integer = 0 To arrFoo.Count - 1
   arrFoo(i).Bar = i * 10       ' Exception
Next

数组已创建,但其中的Foo对象尚未创建。

救济

For i As Integer = 0 To arrFoo.Count - 1
    arrFoo(i) = New Foo()         ' Create Foo instance
    arrFoo(i).Bar = i * 10
Next

使用List(Of T)将使元素很难没有有效对象:

Dim FooList As New List(Of Foo)     ' List created, but it is empty
Dim f As Foo                        ' Temporary variable for the loop

For i As Integer = 0 To 5
    f = New Foo()                    ' Foo instance created
    f.Bar =  i * 10
    FooList.Add(f)                   ' Foo object added to list
Next

有关详细信息,请参阅:

期权推断声明Visual Basic中的范围Visual Basic中的数组


列表和集合

还必须实例化或创建.NET集合(其中有许多种类-列表、字典等)。

Private myList As List(Of String)
..
myList.Add("ziggy")           ' NullReference

由于相同的原因,您会得到相同的异常-仅声明了myList,但未创建实例。补救方法相同:

myList = New List(Of String)

' Or create an instance when declared:
Private myList As New List(Of String)

一个常见的监督是使用集合类型的类:

Public Class Foo
    Private barList As List(Of Bar)

    Friend Function BarCount As Integer
        Return barList.Count
    End Function

    Friend Sub AddItem(newBar As Bar)
        If barList.Contains(newBar) = False Then
            barList.Add(newBar)
        End If
    End Function

任何一个过程都将导致NRE,因为barList只声明,而不是实例化。创建Foo的实例不会同时创建内部barList的实例。可能是为了在构造函数中执行此操作:

Public Sub New         ' Constructor
    ' Stuff to do when a new Foo is created...
    barList = New List(Of Bar)
End Sub

与之前一样,这是不正确的:

Public Sub New()
    ' Creates another barList local to this procedure
     Dim barList As New List(Of Bar)
End Sub

有关详细信息,请参见列表(T类)。


数据提供程序对象

使用数据库为NullReference提供了许多机会,因为可以同时使用许多对象(命令、连接、事务、数据集、数据表、数据行……)。注意:无论您使用哪种数据提供程序(MySQL、SQL Server、OleDB等),概念都是相同的。

示例1

Dim da As OleDbDataAdapter
Dim ds As DataSet
Dim MaxRows As Integer

con.Open()
Dim sql = "SELECT * FROM tblfoobar_List"
da = New OleDbDataAdapter(sql, con)
da.Fill(ds, "foobar")
con.Close()

MaxRows = ds.Tables("foobar").Rows.Count      ' Error

与之前一样,声明了ds-Dataset对象,但从未创建实例。DataAdapter将填充现有数据集,而不是创建数据集。在这种情况下,由于ds是一个局部变量,IDE警告您可能会发生这种情况:

当声明为模块/类级变量时,就像con的情况一样,编译器无法知道对象是否由上游过程创建。不要忽略警告。

救济

Dim ds As New DataSet

示例2

ds = New DataSet
da = New OleDBDataAdapter(sql, con)
da.Fill(ds, "Employees")

txtID.Text = ds.Tables("Employee").Rows(0).Item(1)
txtID.Name = ds.Tables("Employee").Rows(0).Item(2)

这里有一个错别字:员工与员工。未创建名为“Employee”的DataTable,因此尝试访问该DataTable时会出现NullReferenceException。另一个潜在问题是,假设SQL包含WHERE子句时,存在可能不是这样的Item。

救济

由于这使用一个表,因此使用表(0)将避免拼写错误。检查Rows.Count也可以帮助:

If ds.Tables(0).Rows.Count > 0 Then
    txtID.Text = ds.Tables(0).Rows(0).Item(1)
    txtID.Name = ds.Tables(0).Rows(0).Item(2)
End If

Fill是一个返回受影响行数的函数,也可以进行测试:

If da.Fill(ds, "Employees") > 0 Then...

示例3

Dim da As New OleDb.OleDbDataAdapter("SELECT TICKET.TICKET_NO,
        TICKET.CUSTOMER_ID, ... FROM TICKET_RESERVATION AS TICKET INNER JOIN
        FLIGHT_DETAILS AS FLIGHT ... WHERE [TICKET.TICKET_NO]= ...", con)
Dim ds As New DataSet
da.Fill(ds)

If ds.Tables("TICKET_RESERVATION").Rows.Count > 0 Then

DataAdapter将提供TableNames,如前一个示例所示,但它不会从SQL或数据库表中解析名称。因此,ds.Tables(“TICKET_RESERVATION”)引用了一个不存在的表。

补救措施相同,请按索引参考表格:

If ds.Tables(0).Rows.Count > 0 Then

另请参见DataTable类。


对象路径/嵌套

If myFoo.Bar.Items IsNot Nothing Then
   ...

代码只测试Items,而myFoo和Bar也可能是Nothing。补救方法是一次测试一个对象的整个链或路径:

If (myFoo IsNot Nothing) AndAlso
    (myFoo.Bar IsNot Nothing) AndAlso
    (myFoo.Bar.Items IsNot Nothing) Then
    ....

而且也很重要。一旦遇到第一个False条件,将不会执行后续测试。这允许代码一次安全地“钻取”对象一个“级别”,仅在myFoo被确定为有效之后(并且如果)才计算myFoo.Bar。对复杂对象进行编码时,对象链或路径可能会很长:

myBase.myNodes(3).Layer.SubLayer.Foo.Files.Add("somefilename")

不能引用空对象的任何“下游”。这也适用于控制:

myWebBrowser.Document.GetElementById("formfld1").InnerText = "some value"

此处,myWebBrowser或Document可能为Nothing或formfld1元素可能不存在。


用户界面控件

Dim cmd5 As New SqlCommand("select Cartons, Pieces, Foobar " _
     & "FROM Invoice where invoice_no = '" & _
     Me.ComboBox5.SelectedItem.ToString.Trim & "' And category = '" & _
     Me.ListBox1.SelectedItem.ToString.Trim & "' And item_name = '" & _
     Me.ComboBox2.SelectedValue.ToString.Trim & "' And expiry_date = '" & _
     Me.expiry.Text & "'", con)

除其他外,此代码不预期用户可能没有在一个或多个UI控件中选择某些内容。ListBox1.SelectedItem很可能是Nothing,因此ListBox1.SelectedItem.ToString将导致NRE。

救济

在使用数据之前验证数据(同时使用Option Strict和SQL参数):

Dim expiry As DateTime         ' for text date validation
If (ComboBox5.SelectedItems.Count > 0) AndAlso
    (ListBox1.SelectedItems.Count > 0) AndAlso
    (ComboBox2.SelectedItems.Count > 0) AndAlso
    (DateTime.TryParse(expiry.Text, expiry) Then

    '... do stuff
Else
    MessageBox.Show(...error message...)
End If

或者,您可以使用(ComboBox5.SelectedItem IsNot Nothing)AndAlso。。。


Visual Basic窗体

Public Class Form1

    Private NameBoxes = New TextBox(5) {Controls("TextBox1"), _
                   Controls("TextBox2"), Controls("TextBox3"), _
                   Controls("TextBox4"), Controls("TextBox5"), _
                   Controls("TextBox6")}

    ' same thing in a different format:
    Private boxList As New List(Of TextBox) From {TextBox1, TextBox2, TextBox3 ...}

    ' Immediate NRE:
    Private somevar As String = Me.Controls("TextBox1").Text

这是获得NRE的一种相当常见的方式。在C#中,根据其编码方式,IDE将报告控件在当前上下文中不存在,或者“无法引用非静态成员”。因此,在某种程度上,这是一种只使用VB的情况。它也很复杂,因为它可能导致故障级联。

无法以这种方式初始化数组和集合。此初始化代码将在构造函数创建窗体或控件之前运行。因此:

列表和集合将为空数组将包含五个Nothing元素somevar赋值将导致立即NRE,因为Nothing没有.Text属性

稍后引用数组元素将导致NRE。如果您在Form_Load中执行此操作,则由于一个奇怪的错误,IDE可能不会在发生异常时报告异常。稍后当代码尝试使用数组时,将弹出异常。这一“沉默的例外”将在本文中详细介绍。就我们的目的而言,关键是当创建表单时发生灾难性事件(Sub New或form Load事件)时,异常可能会被报告,代码将退出过程并只显示表单。

由于Sub New或Form Load事件中的其他代码都不会在NRE之后运行,因此许多其他代码都可以保持未初始化状态。

Sub Form_Load(..._
   '...
   Dim name As String = NameBoxes(2).Text        ' NRE
   ' ...
   ' More code (which will likely not be executed)
   ' ...
End Sub

请注意,这适用于任何和所有使其非法的控件和组件引用:

Public Class Form1

    Private myFiles() As String = Me.OpenFileDialog1.FileName & ...
    Private dbcon As String = OpenFileDialog1.FileName & ";Jet Oledb..."
    Private studentName As String = TextBox13.Text

部分补救措施

很奇怪,VB没有提供警告,但补救方法是在表单级别声明容器,但当控件确实存在时,在表单加载事件处理程序中初始化它们。只要代码在InitializeComponent调用之后,就可以在Sub New中执行此操作:

' Module level declaration
Private NameBoxes as TextBox()
Private studentName As String

' Form Load, Form Shown or Sub New:
'
' Using the OP's approach (illegal using OPTION STRICT)
NameBoxes = New TextBox() {Me.Controls("TextBox1"), Me.Controls("TestBox2"), ...)
studentName = TextBox32.Text           ' For simple control references

阵列代码可能还没有脱离险境。在Me.controls中找不到容器控件(如GroupBox或Panel)中的任何控件;它们将位于该Panel或GroupBox的Controls集合中。当控件名称拼写错误(“TeStBox2”)时,也不会返回控件。在这种情况下,Nothing将再次存储在这些数组元素中,当您尝试引用它时,将产生NRE。

既然您知道自己在寻找什么,这些应该很容易找到:

“Button2”位于面板上

救济

使用控件引用,而不是使用窗体的Controls集合按名称间接引用:

' Declaration
Private NameBoxes As TextBox()

' Initialization -  simple and easy to read, hard to botch:
NameBoxes = New TextBox() {TextBox1, TextBox2, ...)

' Initialize a List
NamesList = New List(Of TextBox)({TextBox1, TextBox2, TextBox3...})
' or
NamesList = New List(Of TextBox)
NamesList.AddRange({TextBox1, TextBox2, TextBox3...})

函数不返回任何内容

Private bars As New List(Of Bars)        ' Declared and created

Public Function BarList() As List(Of Bars)
    bars.Clear
    If someCondition Then
        For n As Integer = 0 to someValue
            bars.Add(GetBar(n))
        Next n
    Else
        Exit Function
    End If

    Return bars
End Function

在这种情况下,IDE会警告您“并非所有路径都返回值,可能会导致NullReferenceException”。您可以通过将Exit Function替换为Return Nothing来抑制警告,但这并不能解决问题。当someCondition=False时,任何试图使用返回的都将导致NRE:

bList = myFoo.BarList()
For Each b As Bar in bList      ' EXCEPTION
      ...

救济

用Return bList替换函数中的Exit Function。返回空列表与返回Nothing不同。如果返回的对象可能是Nothing,请在使用它之前进行测试:

 bList = myFoo.BarList()
 If bList IsNot Nothing Then...

Try/Catch执行不佳

实施不当的Try/Catch可能会隐藏问题所在并导致新的问题:

Dim dr As SqlDataReader
Try
    Dim lnk As LinkButton = TryCast(sender, LinkButton)
    Dim gr As GridViewRow = DirectCast(lnk.NamingContainer, GridViewRow)
    Dim eid As String = GridView1.DataKeys(gr.RowIndex).Value.ToString()
    ViewState("username") = eid
    sqlQry = "select FirstName, Surname, DepartmentName, ExtensionName, jobTitle,
             Pager, mailaddress, from employees1 where username='" & eid & "'"
    If connection.State <> ConnectionState.Open Then
        connection.Open()
    End If
    command = New SqlCommand(sqlQry, connection)

    'More code fooing and barring

    dr = command.ExecuteReader()
    If dr.Read() Then
        lblFirstName.Text = Convert.ToString(dr("FirstName"))
        ...
    End If
    mpe.Show()
Catch

Finally
    command.Dispose()
    dr.Close()             ' <-- NRE
    connection.Close()
End Try

这是一个对象未按预期创建的情况,但也证明了空Catch的反作用。

SQL中有一个额外的逗号(在“mailaddress”之后),导致.ExecuteReader处出现异常。Catch不执行任何操作后,Finally尝试执行清理,但由于无法关闭空DataReader对象,因此会产生一个全新的NullReferenceException。

一个空的Catch街区是魔鬼的游乐场。这位OP很困惑,为什么他在Finally街区获得NRE。在其他情况下,一个空的Catch可能会导致下游更进一步的事情失控,并导致您花费时间在错误的地方查找错误的问题。(上述“无声例外”提供了相同的娱乐价值。)

救济

不要使用空的Try/Catch块-让代码崩溃,以便a)确定原因b)确定位置c)应用适当的补救措施。Try/Catch块并不是为了向唯一有资格修复异常的人(开发人员)隐藏异常。


DBNull与Nothing不同

For Each row As DataGridViewRow In dgvPlanning.Rows
    If Not IsDBNull(row.Cells(0).Value) Then
        ...

IsDBNull函数用于测试值是否等于System.DBNull:来自MSDN:

System.DBNull值表示Object表示缺少或不存在的数据。DBNull与Nothing不同,这表示变量尚未初始化。

救济

If row.Cells(0) IsNot Nothing Then ...

与之前一样,您可以测试Nothing,然后测试特定值:

If (row.Cells(0) IsNot Nothing) AndAlso (IsDBNull(row.Cells(0).Value) = False) Then

示例2

Dim getFoo = (From f In dbContext.FooBars
               Where f.something = something
               Select f).FirstOrDefault

If Not IsDBNull(getFoo) Then
    If IsDBNull(getFoo.user_id) Then
        txtFirst.Text = getFoo.first_name
    Else
       ...

FirstOrDefault返回第一个项或默认值,对于引用类型为Nothing,从不为DBNull:

If getFoo IsNot Nothing Then...

控制

Dim chk As CheckBox

chk = CType(Me.Controls(chkName), CheckBox)
If chk.Checked Then
    Return chk
End If

如果找不到具有chkName的CheckBox(或存在于GroupBox中),则chk将为Nothing,并且尝试引用任何属性将导致异常。

救济

If (chk IsNot Nothing) AndAlso (chk.Checked) Then ...

DataGridView

DGV有一些周期性的怪癖:

dgvBooks.DataSource = loan.Books
dgvBooks.Columns("ISBN").Visible = True       ' NullReferenceException
dgvBooks.Columns("Title").DefaultCellStyle.Format = "C"
dgvBooks.Columns("Author").DefaultCellStyle.Format = "C"
dgvBooks.Columns("Price").DefaultCellStyle.Format = "C"

如果dgvBooks的AutoGenerateColumns=True,它将创建列,但不会命名列,因此当按名称引用列时,上述代码将失败。

救济

手动命名列,或按索引引用:

dgvBooks.Columns(0).Visible = True

示例2-当心NewRow

xlWorkSheet = xlWorkBook.Sheets("sheet1")

For i = 0 To myDGV.RowCount - 1
    For j = 0 To myDGV.ColumnCount - 1
        For k As Integer = 1 To myDGV.Columns.Count
            xlWorkSheet.Cells(1, k) = myDGV.Columns(k - 1).HeaderText
            xlWorkSheet.Cells(i + 2, j + 1) = myDGV(j, i).Value.ToString()
        Next
    Next
Next

当DataGridView将AllowUserToAddRows设置为True(默认值)时,底部空白/新行中的单元格将全部包含Nothing。大多数使用内容(例如ToString)的尝试都会导致NRE。

救济

使用For/Each循环并测试IsNewRow属性以确定它是否是最后一行。无论AllowUserToAddRows是否为真,这都有效:

For Each r As DataGridViewRow in myDGV.Rows
    If r.IsNewRow = False Then
         ' ok to use this row

如果确实使用For n循环,请在IsNewRow为true时修改行计数或使用Exit For。


My.Settings(StringCollection)

在某些情况下,尝试使用My.Settings中的StringCollection项可能会在第一次使用它时导致NullReference。解决方案是相同的,但不是很明显。考虑:

My.Settings.FooBars.Add("ziggy")         ' foobars is a string collection

由于VB正在为您管理设置,因此期望它初始化集合是合理的。它会,但前提是您之前已经向集合中添加了初始条目(在设置编辑器中)。由于集合在添加项时(显然)已初始化,因此当“设置”编辑器中没有要添加的项时,集合将保持为“无”。

救济

如果需要,请在表单的Load事件处理程序中初始化设置集合:

If My.Settings.FooBars Is Nothing Then
    My.Settings.FooBars = New System.Collections.Specialized.StringCollection
End If

通常,“设置”集合只需要在应用程序首次运行时初始化。另一种补救方法是在Project->Settings|FooBars中向集合添加初始值,保存项目,然后删除假值。


要点

你可能忘记了New操作符。

or

您假设会完美地执行某些操作,将初始化的对象返回到代码中,但没有。

不要忽略编译器警告(永远)并使用Option Strict On(永远)。


MSDN NullReference异常

另一个可能收到此异常的一般情况是在单元测试期间模拟类。无论使用何种模拟框架,您都必须确保正确模拟类层次结构的所有适当级别。特别是,被测试代码引用的HttpContext的所有财产都必须进行模拟。

请参阅“测试自定义AuthorizationAttribute时引发的NullReferenceException”,以获取一些详细的示例。