[c#] Cos'è una NullReferenceException e come risolverlo?



Answers

Eccezione NullReference - Visual Basic

L' NullReference Exception per Visual Basic non è diversa da quella in C # . Dopo tutto, entrambi riportano la stessa eccezione definita in .NET Framework che entrambi utilizzano. Le cause uniche di Visual Basic sono rare (forse solo una).

Questa risposta utilizzerà i termini, la sintassi e il contesto di Visual Basic. Gli esempi utilizzati provengono da un gran numero di domande passate di Stack Overflow. Questo per massimizzare la pertinenza utilizzando i tipi di situazioni che si vedono spesso nei post. Un po 'più di spiegazione è prevista anche per coloro che potrebbero averne bisogno. Un esempio simile al tuo è molto probabilmente elencato qui.

Nota:

  1. Questo è basato su concetti: non c'è un codice da incollare nel tuo progetto. Ha lo scopo di aiutarti a capire cosa causa una NullReferenceException (NRE), come trovarla, come risolverla e come evitarla. Un NRE può essere causato in molti modi, quindi è improbabile che sia il tuo unico incontro.
  2. Gli esempi (dai post Stack Overflow) non sempre mostrano il modo migliore per fare qualcosa in primo luogo.
  3. In genere, viene utilizzato il rimedio più semplice.

Significato di base

Il messaggio "Oggetto non impostato su un'istanza di oggetto" indica che stai tentando di utilizzare un oggetto che non è stato inizializzato. Questo si riduce a uno di questi:

  • Il tuo codice ha dichiarato una variabile oggetto, ma non l'ha inizializzata (crea un'istanza o " crea un'istanza ")
  • Qualcosa che il tuo codice supponeva avrebbe inizializzato un oggetto, no
  • Forse, un altro codice ha invalidato prematuramente un oggetto ancora in uso

Trovare la causa

Poiché il problema è un riferimento a un oggetto che è Nothing , la risposta è esaminarli per scoprire quale. Quindi determinare il motivo per cui non è inizializzato. Tieni il mouse sulle varie variabili e Visual Studio (VS) mostrerà i loro valori - il colpevole sarà Nothing .

Dovresti anche rimuovere tutti i blocchi Try / Catch dal codice rilevante, specialmente quelli in cui non c'è nulla nel blocco Catch. Ciò causerà il blocco del codice quando tenta di utilizzare un oggetto che è Nothing . Questo è ciò che desideri perché identifica l'esatta posizione del problema e ti consente di identificare l'oggetto che lo causa.

Un MsgBox nel Catch che visualizza Error while... sarà di scarso aiuto. Questo metodo porta anche a pessime domande di overflow dello stack, perché non è possibile descrivere l'eccezione effettiva, l'oggetto coinvolto o persino la riga di codice in cui si verifica.

Puoi anche usare la Locals Window ( Debug -> Windows -> Locali ) per esaminare i tuoi oggetti.

Una volta che sai cosa e dove è il problema, di solito è abbastanza facile da correggere e più veloce di pubblicare una nuova domanda.

Guarda anche:

Esempi e rimedi

Oggetti di classe / Creazione di un'istanza

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

Il problema è che Dim non crea un oggetto CashRegister; dichiara solo una variabile denominata reg di quel Tipo. Dichiarare una variabile oggetto e creare un'istanza sono due cose diverse.

Rimedio

L'operatore New può essere spesso utilizzato per creare l'istanza quando la si dichiara:

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

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

Quando è solo opportuno creare l'istanza in un secondo momento:

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

Nota: non utilizzare nuovamente Dim in una procedura, incluso il costruttore ( Sub New ):

Private reg As CashRegister
'...

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

Questo creerà una variabile locale , reg , che esiste solo in quel contesto (sotto). La variabile reg con Scope level level che userete ovunque rimane Nothing .

Manca l'operatore New è la causa n. 1 delle NullReference Exceptions viste nelle domande di Overflow dello stack esaminate.

Visual Basic tenta di rendere chiaro il processo ripetutamente utilizzando New : Using the New Operator crea un nuovo oggetto e chiama Sub New - the constructor - dove l'oggetto può eseguire qualsiasi altra inizializzazione.

Per essere chiari, Dim (o Private ) dichiara solo una variabile e il suo Type . L' ambito della variabile, indipendentemente dal fatto che esista per l'intero modulo / classe o sia locale per una procedura, è determinato dalla posizione in cui è dichiarato. Private | Friend | Public Private | Friend | Public definisce il livello di accesso, non Ambito .

Per ulteriori informazioni, vedere:

Array

Le matrici devono anche essere istanziate:

Private arr as String()

Questo array è stato dichiarato, non creato. Esistono diversi modi per inizializzare un array:

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) {}

Nota: a partire da VS 2010, quando si inizializza un array locale utilizzando un valore letterale e Option Infer , gli elementi As <Type> e New sono facoltativi:

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}

Il tipo di dati e la dimensione dell'array sono dedotti dai dati che vengono assegnati. Le dichiarazioni di livello di classe / modulo richiedono ancora As <Type> con Option Strict :

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

Esempio: matrice di oggetti di classe

Dim arrFoo(5) As Foo

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

L'array è stato creato, ma gli oggetti Foo in esso non ce l'hanno.

Rimedio

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

L'uso di una List(Of T) renderà piuttosto difficile avere un elemento senza un oggetto valido:

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

Per ulteriori informazioni, vedere:

Elenchi e collezioni

Le raccolte .NET (di cui ci sono molte varietà - Liste, Dizionario, ecc.) Devono anche essere istanziate o create.

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

Si ottiene la stessa eccezione per lo stesso motivo: myList stato dichiarato solo, ma nessuna istanza creata. Il rimedio è lo stesso:

myList = New List(Of String)

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

Una svista comune è una classe che utilizza un Type raccolta:

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

Entrambe le procedure generano un NRE, perché la barList è solo dichiarata, non istanziata. La creazione di un'istanza di Foo non creerà anche un'istanza della barList interna. Potrebbe essere stato l'intento di farlo nel costruttore:

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

Come prima, questo non è corretto:

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

Per ulteriori informazioni, vedere List(Of T) Class .

Oggetti del fornitore di dati

Lavorare con i database presenta molte opportunità per un NullReference perché ci possono essere molti oggetti ( Command , Connection , Transaction , Dataset , DataTable , DataRows ....) in uso contemporaneamente. Nota: non importa quale fornitore di dati si sta utilizzando - MySQL, SQL Server, OleDB, ecc. - i concetti sono gli stessi.

Esempio 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

Come prima, l'oggetto dataset ds stato dichiarato, ma non è mai stata creata un'istanza. DataAdapter riempie un DataSet esistente, non ne crea uno. In questo caso, poiché ds è una variabile locale, l'IDE avverte che ciò potrebbe accadere:

Quando viene dichiarato come variabile di modulo / classe, come sembra essere il caso di con , il compilatore non può sapere se l'oggetto è stato creato da una procedura upstream. Non ignorare gli avvertimenti.

Rimedio

Dim ds As New DataSet

Esempio 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)

Un errore di battitura è un problema qui: Employees vs Employee . Non è stata creata alcuna DataTable denominata "Employee", quindi una NullReferenceException risulta provante ad accedervi. Un altro potenziale problema è supponendo che ci saranno Items che potrebbero non essere così quando l'SQL include una clausola WHERE.

Rimedio

Poiché utilizza una tabella, l'utilizzo di Tables(0) eviterà errori di ortografia. Esaminando Rows.Count può anche aiutare:

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 è una funzione che restituisce il numero di Rows interessate che possono anche essere testate:

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

Esempio 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 fornirà TableNames come mostrato nell'esempio precedente, ma non analizza i nomi dalla tabella SQL o database. Di conseguenza, ds.Tables("TICKET_RESERVATION") riferimento a una tabella inesistente.

Il rimedio è lo stesso, fare riferimento alla tabella per indice:

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

Vedi anche DataTable Class .

Percorsi oggetto / nidificati

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

Il codice sta testando solo gli Items mentre sia myFoo che Bar potrebbero anche essere Nothing. Il rimedio consiste nel testare l'intera catena o il percorso degli oggetti uno alla volta:

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

AndAlso è anche importante. I test successivi non verranno eseguiti una volta rilevata la prima condizione False . Ciò consente al codice di "perforare" in sicurezza l'oggetto (i) di un "livello" alla volta, valutando myFoo.Bar solo dopo (e se) myFoo è determinato a essere valido. Catene o percorsi di oggetti possono diventare piuttosto lunghi durante la codifica di oggetti complessi:

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

Non è possibile fare riferimento a qualcosa 'downstream' di un oggetto null . Questo vale anche per i controlli:

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

Qui, myWebBrowser o Document potrebbero essere Nothing o l'elemento formfld1 potrebbe non esistere.

Controlli dell'interfaccia utente

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)

Tra le altre cose, questo codice non prevede che l'utente non abbia selezionato qualcosa in uno o più controlli dell'interfaccia utente. ListBox1.SelectedItem potrebbe essere Nothing , quindi ListBox1.SelectedItem.ToString genererà un NRE.

Rimedio

Convalidare i dati prima di utilizzarli (utilizzare anche i parametri Option Strict e 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

In alternativa, puoi usare (ComboBox5.SelectedItem IsNot Nothing) AndAlso...

Form di 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

Questo è un modo abbastanza comune per ottenere un NRE. In C #, a seconda di come è codificato, l'IDE segnalerà che i Controls non esistono nel contesto corrente, o "non può fare riferimento a membri non statici". Quindi, in una certa misura, questa è una situazione VB-only. È anche complesso perché può causare una cascata di errori.

Gli array e le raccolte non possono essere inizializzati in questo modo. Questo codice di inizializzazione verrà eseguito prima che il costruttore crei il Form oi Controls . Di conseguenza:

  • Gli elenchi e le raccolte saranno semplicemente vuoti
  • L'array conterrà cinque elementi di Nothing
  • Il somevar assegnerà un NRE immediato perché Nothing non ha una proprietà .Text

Il riferimento agli elementi dell'array in seguito comporterà un NRE. Se lo fai in Form_Load , a causa di un bug strano, l'IDE potrebbe non segnalare l'eccezione quando ciò accade. L'eccezione verrà visualizzata più tardi quando il codice tenta di utilizzare l'array. Questa "eccezione silenziosa" è dettagliata in questo post . Per i nostri scopi, la chiave è che quando accade qualcosa di catastrofico durante la creazione di un modulo (evento Sub New o Form Load ), le eccezioni possono non essere segnalate, il codice esce dalla procedura e visualizza solo il modulo.

Poiché nessun altro codice nell'evento Sub New o Form Load verrà eseguito dopo l'NRE, molte altre cose possono essere lasciate non inizializzate.

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

Nota questo vale per tutti i riferimenti di controllo e componente che rendono questi illegali dove sono:

Public Class Form1

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

Rimedio parziale

È curioso che VB non fornisca un avvertimento, ma il rimedio consiste nel dichiarare i contenitori a livello di modulo, ma inizializzarli nel gestore di eventi di caricamento dei moduli quando i controlli esistono. Questo può essere fatto in Sub New fino a quando il tuo codice è dopo la chiamata InitializeComponent :

' 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

Il codice dell'array non può ancora essere fuori dal bosco. Tutti i controlli che si trovano in un controllo contenitore (come un GroupBox o un Panel ) non saranno trovati in Me.Controls ; saranno nella collezione Controls di quel Panel o GroupBox. Né verrà restituito un controllo quando il nome del controllo è errato ( "TeStBox2" ). In questi casi, Nothing verrà nuovamente memorizzato in quegli elementi dell'array e verrà generato un NRE quando si tenta di fare riferimento a esso.

Questi dovrebbero essere facili da trovare ora che sai cosa stai cercando:

"Button2" risiede su un Panel

Rimedio

Invece di riferimenti indiretti per nome utilizzando la raccolta Controls del modulo, utilizzare il riferimento di controllo:

' 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...})

Funzione che non restituisce nulla

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

Questo è un caso in cui l'IDE ti avviserà che " non tutti i percorsi restituiscono un valore e può risultare una NullReferenceException ". È possibile sopprimere l'avviso, sostituendo Exit Function con Return Nothing , ma ciò non risolve il problema. Tutto ciò che cerca di utilizzare il ritorno quando someCondition = False comporterà una NRE:

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

Rimedio

Sostituisci Exit Function nella funzione con Return bList . Restituire una List vuota non equivale a restituire Nothing . Se esiste la possibilità che un oggetto restituito possa essere Nothing , prova prima di usarlo:

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

Prova / catture implementate in modo errato

Una Prova / Catch mal implementata può nascondere dove si trova il problema e generarne di nuovi:

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

This is a case of an object not being created as expected, but also demonstrates the counter usefulness of an empty Catch .

There is an extra comma in the SQL (after 'mailaddress') which results in an exception at .ExecuteReader . After the Catch does nothing, Finally tries to perform clean up, but since you cannot Close a null DataReader object, a brand new NullReferenceException results.

An empty Catch block is the devil's playground. This OP was baffled why he was getting an NRE in the Finally block. In other situations, an empty Catch may result in something else much further downstream going haywire and cause you to spend time looking at the wrong things in the wrong place for the problem. (The "silent exception" described above provides the same entertainment value.)

Remedy

Don't use empty Try/Catch blocks - let the code crash so you can a) identify the cause b) identify the location and c) apply a proper remedy. Try/Catch blocks are not intended to hide exceptions from the person uniquely qualified to fix them - the developer.

DBNull is not the same as Nothing

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

The IsDBNull function is used to test if a value equals System.DBNull : From MSDN:

The System.DBNull value indicates that the Object represents missing or non-existent data. DBNull is not the same as Nothing, which indicates that a variable has not yet been initialized.

Remedy

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

As before, you can test for Nothing, then for a specific value:

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

Example 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 returns the first item or the default value, which is Nothing for reference types and never DBNull :

If getFoo IsNot Nothing Then...

Controls

Dim chk As CheckBox

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

If a CheckBox with chkName can't be found (or exists in a GroupBox ), then chk will be Nothing and be attempting to reference any property will result in an exception.

Remedy

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

The DataGridView

The DGV has a few quirks seen periodically:

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"

If dgvBooks has AutoGenerateColumns = True , it will create the columns, but it does not name them, so the above code fails when it references them by name.

Remedy

Name the columns manually, or reference by index:

dgvBooks.Columns(0).Visible = True

Example 2 — Beware of the 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

When your DataGridView has AllowUserToAddRows as True (the default), the Cells in the blank/new row at the bottom will all contain Nothing . Most attempts to use the contents (for example, ToString ) will result in an NRE.

Remedy

Use a For/Each loop and test the IsNewRow property to determine if it is that last row. This works whether AllowUserToAddRows is true or not:

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

If you do use a For n loop, modify the row count or use Exit For when IsNewRow is true.

My.Settings (StringCollection)

Under certain circumstances, trying to use an item from My.Settings which is a StringCollection can result in a NullReference the first time you use it. The solution is the same, but not as obvious. Prendere in considerazione:

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

Since VB is managing Settings for you, it is reasonable to expect it to initialize the collection. It will, but only if you have previously added an initial entry to the collection (in the Settings editor). Since the collection is (apparently) initialized when an item is added, it remains Nothing when there are no items in the Settings editor to add.

Remedy

Initialize the settings collection in the form's Load event handler, if/when needed:

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

Typically, the Settings collection will only need to be initialized the first time the application runs. An alternate remedy is to add an initial value to your collection in Project -> Settings | FooBars , save the project, then remove the fake value.

Key Points

You probably forgot the New operator.

o

Something you assumed would perform flawlessly to return an initialized object to your code, did not.

Don't ignore compiler warnings (ever) and use Option Strict On (always).

MSDN NullReference Exception

Question

Ho del codice e quando viene eseguito, lancia una NullReferenceException , dicendo:

Il riferimento non impostato su un'istanza di un oggetto.

Cosa significa questo e cosa posso fare per correggere questo errore?




It means that the variable in question is pointed at nothing. I could generate this like so:

SqlConnection connection = null;
connection.Open();

That will throw the error because while I've declared the variable " connection ", it's not pointed to anything. When I try to call the member " Open ", there's no reference for it to resolve, and it will throw the error.

To avoid this error:

  1. Always initialize your objects before you try to do anything with them.
  2. If you're not sure whether the object is null, check it with object == null .

JetBrains' Resharper tool will identify every place in your code that has the possibility of a null reference error, allowing you to put in a null check. This error is the number one source of bugs, IMHO.




You are using the object that contains the null value reference. So it's giving a null exception. In the example the string value is null and when checking its length, the exception occurred.

Esempio:

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

The exception error is:

Unhandled Exception:

System.NullReferenceException: Object reference not set to an instance of an object. at Program.Main()




Literally the easiest way to fix a NullReferenceExeption has two ways. If you have a GameObject for example with a script attached and a variable named rb (rigidbody) this variable will start null when you start your game.
This is why you get a NullReferenceExeption because the computer does not have data stored in that variable.

I'll be using a RigidBody variable as an example.
We can add data really easily actually in a few ways:

  1. Add a RigidBody to your object with AddComponent > Physics > Rigidbody
    Then go into your script and type rb = GetComponent<Rigidbody>();
    This line of code works best under your Start() or Awake() functions.
  2. È possibile aggiungere un componente a livello di codice e assegnare la variabile allo stesso tempo con una riga di codice: rb = AddComponent<RigidBody>();

Ulteriori note: Se vuoi che l'unità aggiunga un componente al tuo oggetto e potresti aver dimenticato di aggiungerne uno, puoi digitare [RequireComponent(typeof(RigidBody))]sopra la dichiarazione della classe (lo spazio sotto tutti i tuoi usi).
Divertiti e divertiti a creare giochi!




Be aware that regardless of the scenario, the cause is always the same in .NET:

You are trying to use a reference variable whose value is Nothing / null . When the value is Nothing / null for the reference variable, that means it is not actually holding a reference to an instance of any object that exists on the heap.

You either never assigned something to the variable, never created an instance of the value assigned to the variable, or you set the variable equal to Nothing / null manually, or you called a function that set the variable to Nothing / null for you.




On the matter of "what should I do about it" , there can be many answers.

A more "formal" way of preventing such error conditions while developing is applying design by contract in your code. This means you need to set class invariants , and/or even function/method preconditions and postconditions on your system, while developing.

In short, class invariants ensure that there will be some constraints in your class that will not get violated in normal use (and therefore, the class will not get in an inconsistent state). Preconditions mean that data given as input to a function/method must follow some constraints set and never violate them, and postconditions mean that a function/method output must follow the set constraints again without ever violating them. Contract conditions should never be violated during execution of a bug-free program, therefore design by contract is checked in practice in debug mode, while being disabled in releases , to maximize the developed system performance.

This way, you can avoid NullReferenceException cases that are results of violation of the constraints set. For example, if you use an object property X in a class and later try to invoke one of its methods and X has a null value, then this will lead to NullReferenceException :

public X { get; set; }

public void InvokeX()
{
    X.DoSomething(); // if X value is null, you will get a NullReferenceException
}

But if you set "property X must never have a null value" as method precondition, then you can prevent the scenario described before:

//Using code contracts:
[ContractInvariantMethod]
protected void ObjectInvariant () 
{
    Contract.Invariant ( X != null );
    //...
}

For this cause, Code Contracts project exists for .NET applications.

Alternatively, design by contract can be applied using assertions .

UPDATE: It is worth mentioning that the term was coined by Bertrand Meyer in connection with his design of the Eiffel programming language .




Another general case where one might receive this exception involves mocking classes during unit testing. Regardless of the mocking framework being used, you must ensure that all appropriate levels of the class hierarchy are properly mocked. In particular, all properties of HttpContext which are referenced by the code under test must be mocked.

See " NullReferenceException thrown when testing custom AuthorizationAttribute " for a somewhat verbose example.




You can fix NullReferenceException in a clean way using Null-conditional Operators in c#6 and write less code to handle null checks.

It's used to test for null before performing a member access (?.) or index (?[) operation.

Esempio

  var name = p?.Spouse?.FirstName;

è equivalente a:

    if (p != null)
    {
        if (p.Spouse != null)
        {
            name = p.Spouse.FirstName;
        }
    }

The result is that the name will be null when p is null or when p.Spouse is null.

Otherwise, the variable name will be assigned the value of the p.Spouse.FirstName.

For More details : Null-conditional Operators




While what causes a NullReferenceExceptions and approaches to avoid/fix such an exception have been addressed in other answers, what many programmers haven't learned yet is how to independently debug such exceptions during development.

In Visual Studio this is usually easy thanks to the Visual Studio Debugger .

First, make sure that the correct error is going to be caught - see How do I allow breaking on 'System.NullReferenceException' in VS2010? Note 1

Then either Start with Debugging (F5) or Attach [the VS Debugger] to Running Process . On occasion it may be useful to use Debugger.Break , which will prompt to launch the debugger.

Now, when the NullReferenceException is thrown (or unhandled) the debugger will stop (remember the rule set above?) on the line on which the exception occurred. Sometimes the error will be easy to spot.

For instance, in the following line the only code that can cause the exception is if myString evaluates to null. This can be verified by looking at the Watch Window or running expressions in the Immediate Window .

var x = myString.Trim();

In more advanced cases, such as the following, you'll need to use one of the techniques above (Watch or Immediate Windows) to inspect the expressions to determine if str1 was null or if str2 was null.

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

Once where the exception is throw has been located, it's usually trivial to reason backwards to find out where the null value was [incorrectly] introduced --

Take the time required to understand the cause of the exception. Inspect for null expressions. Inspect the previous expressions which could have resulted in such null expressions. Add breakpoints and step through the program as appropriate. Use the debugger.

1 If Break on Throws is too aggressive and the debugger stops on an NPE in the .NET or 3rd-party library, Break on User-Unhandled can be used to limit the exceptions caught. Additionally, VS2012 introduces Just My Code which I recommend enabling as well.

If you are debugging with Just My Code enabled, the behavior is slightly different. With Just My Code enabled, the debugger ignores first-chance common language runtime (CLR) exceptions that are thrown outside of My Code and do not pass through My Code




Reference types default to null to indicate that they are not referencing any object. Hence, if you try and access the object that is being referenced and there isn't one, you will get a NullReferenceException .

For Ex:

SqlConnection connection = null;
connection.Open();

When you run this code, you will get :

System.NullReferenceException: Object reference not set to an instance of an object.

You can avoid this error by coding like this:

if (connection != null){
    connection.Open();
}

Note: In order to avoid this error you should always initialize your objects before you try to do anything with them.




If one is getting this message during saving or compiling the build, just close all the files and then open any file to compile and save.

For me the reason was that I had rename the file and old file was still open.




TL;DR: Try using Html.Partial instead of Renderpage

I was getting Object reference not set to an instance of an object when I tried to render a View within a View by sending it a Model, like this:

@{
    MyEntity M = new MyEntity();
}
@RenderPage("_MyOtherView.cshtml", M); // error in _MyOtherView, the Model was Null

Debugging showed the model was Null inside MyOtherView. Until I changed it to:

@{
    MyEntity M = new MyEntity();
}
@Html.Partial("_MyOtherView.cshtml", M);

And it worked.

Furthermore, the reason I didn't have Html.Partial to begin with was because Visual Studio sometimes throws error-looking squiggly lines under Html.Partial if it's inside a differently constructed foreach loop, even though it's not really an error:

@inherits System.Web.Mvc.WebViewPage
@{
    ViewBag.Title = "Entity Index";
    List<MyEntity> MyEntities = new List<MyEntity>();
    MyEntities.Add(new MyEntity());
    MyEntities.Add(new MyEntity());
    MyEntities.Add(new MyEntity());
}
<div>
    @{
        foreach(var M in MyEntities)
        {
            // Squiggly lines below. Hovering says: cannot convert method group 'partial' to non-delegate type Object, did you intend to envoke the Method?
            @Html.Partial("MyOtherView.cshtml");
        }
    }
</div>

But I was able to run the application with no problems with this "error". I was able to get rid of the error by changing the structure of the foreach loop to look like this:

@foreach(var M in MyEntities){
    ...
}

Although I have a feeling it was because Visual Studio was misreading the ampersands and brackets.




Well, in simple terms:

You are trying to access an object that isn't created or currently not in memory.

So how to tackle this:

  1. Debug and let the debugger break... It will directly take you to the variable that is broken... Now your task is to simply fix this.. Using the new keyword in the appropriate place.

  2. If it is caused on some database commands because the object isn't present then all you need to do is do a null check and handle it:

    if (i == null) {
        // Handle this
    }
    
  3. The hardest one .. if the GC collected the object already... This generally occurs if you are trying to find an object using strings... That is, finding it by name of the object then it may happen that the GC might already cleaned it up... This is hard to find and will become quite a problem... A better way to tackle this is do null checks wherever necessary during the development process. This will save you a lot of time.

By finding by name I mean some framework allow you to FIndObjects using strings and the code might look like this: FindObject("ObjectName");




Interestingly, none of the answers on this page mention the two edge cases, hope no one minds if I add them:

Edge case #1: concurrent access to a Dictionary

Generic dictionaries in .NET are not thread-safe and they sometimes might throw a NullReference or even (more frequent) a KeyNotFoundException when you try to access a key from two concurrent threads. The exception is quite misleading in this case.

Edge case #2: unsafe code

If a NullReferenceException is thrown by unsafe code, you might look at your pointer variables, and check them for IntPtr.Zero or something. Which is the same thing ("null pointer exception"), but in unsafe code, variables are often cast to value-types/arrays, etc., and you bang your head against the wall, wondering how a value-type can throw this exception.

(Another reason for non-using unsafe code unless you need it, by the way)




If you have not initialized a reference type, and you want to set or read one of its properties, it will throw a NullReferenceException .

Esempio:

Person p = null;
p.Name = "Harry"; // NullReferenceException occurs here.

You can simply avoid this by checking if the variable is not null:

Person p = null;
if (p!=null)
{
    p.Name = "Harry"; // Not going to run to this point
}

To fully understand why a NullReferenceException is thrown, it is important to know the difference between value types and reference types .

So, if you're dealing with value types , NullReferenceExceptions can not occur. Though you need to keep alert when dealing with reference types !

Only reference types, as the name is suggesting, can hold references or point literally to nothing (or 'null'). Whereas value types always contain a value.

Reference types (these ones must be checked):

  • dynamic
  • oggetto
  • stringa

Value types (you can simply ignore these ones):

  • Numeric types
  • Integral types
  • Floating-point types
  • decimal
  • bool
  • User defined structs



Related