Queryable.SingleOrDefault 方法

定義

命名空間:

System.Linq

組件:

System.Linq.Queryable.dll

傳回序列的單一特定項目；如果找不到任何項目，則傳回預設值。

多載

SingleOrDefault<TSource>(IQueryable<TSource>, TSource)	傳回序列的唯一一個項目，如果序列是空白，則為預設值，如果序列中有一個以上的項目，這個方法就會擲回例外狀況。
SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, TSource)	傳回序列中符合指定之條件的唯一一個元素，如果沒有這類元素，則為預設值，如果有一個以上的元素符合條件，這個方法就會擲回例外狀況。
SingleOrDefault<TSource>(IQueryable<TSource>)	傳回序列的唯一一個項目，如果序列是空白，則為預設值，如果序列中有一個以上的項目，這個方法就會擲回例外狀況。
SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)	傳回序列中符合指定之條件的唯一一個元素，如果沒有這類元素，則為預設值，如果有一個以上的元素符合條件，這個方法就會擲回例外狀況。

SingleOrDefault<TSource>(IQueryable<TSource>, TSource)

來源:

Queryable.cs

傳回序列的唯一一個項目，如果序列是空白，則為預設值，如果序列中有一個以上的項目，這個方法就會擲回例外狀況。

C#

public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, TSource defaultValue);

類型參數

TSource

source 項目的類型。

參數

source

IQueryable<TSource>

要傳回單一項目的 IEnumerable<T>。

defaultValue

TSource

如果序列是空的，則傳回的預設值。

傳回

TSource

輸入序列的單一元素，如果序列不包含任何專案，則 defaultValue 為 。

例外狀況

ArgumentNullException

source 為 null。

InvalidOperationException

輸入序列包含一個以上的項目。

SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>, TSource)

來源:

Queryable.cs

傳回序列中符合指定之條件的唯一一個元素，如果沒有這類元素，則為預設值，如果有一個以上的元素符合條件，這個方法就會擲回例外狀況。

C#

public static TSource SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate, TSource defaultValue);

類型參數

TSource

source 項目的類型。

參數

source

IQueryable<TSource>

要傳回單一項目的來源 IEnumerable<T>。

predicate

Expression<Func<TSource,Boolean>>

用來測試項目是否符合條件的函式。

defaultValue

TSource

如果序列是空的，則傳回的預設值。

傳回

TSource

符合條件之輸入序列的單一元素，如果 defaultValue 找不到這類專案，則為 。

例外狀況

ArgumentNullException

source 或 predicate 為 null。

InvalidOperationException

超過一個項目符合 predicate 中的條件。

SingleOrDefault<TSource>(IQueryable<TSource>)

來源:

Queryable.cs

傳回序列的唯一一個項目，如果序列是空白，則為預設值，如果序列中有一個以上的項目，這個方法就會擲回例外狀況。

C#

public static TSource? SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source);

類型參數

TSource

source 項目的類型。

參數

source

IQueryable<TSource>

要傳回單一項目的 IQueryable<T>。

傳回

TSource

輸入序列的單一項目；如果序列沒有包含任何項目，則為 default(TSource)。

例外狀況

ArgumentNullException

source 為 null。

InvalidOperationException

source 具有多個項目。

範例

下列程式代碼範例示範如何使用 SingleOrDefault<TSource>(IQueryable<TSource>) 來選取陣列的唯一元素。 第二個查詢示範 SingleOrDefault<TSource>(IQueryable<TSource>) 當序列未只包含一個專案時，傳回預設值。

C#

// Create two arrays. The second is empty.
string[] fruits1 = { "orange" };
string[] fruits2 = { };

// Get the only item in the first array, or else
// the default value for type string (null).
string fruit1 = fruits1.AsQueryable().SingleOrDefault();
Console.WriteLine("First Query: " + fruit1);

// Get the only item in the second array, or else
// the default value for type string (null).
string fruit2 = fruits2.AsQueryable().SingleOrDefault();
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: orange
    Second Query: No such string!
*/

有時候，如果集合不包含任何元素，則的值 default(TSource) 不是您想要使用的預設值。 您可以改用 DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 方法指定您想要使用之預設值的預設值，而不是檢查不需要的預設值，然後視需要變更它。 然後，呼叫 Single<TSource>(IQueryable<TSource>) 以取得 專案。 如果頁碼集合是空的，下列程式代碼範例會使用這兩種技術來取得預設值 1。 因為整數的預設值是 0，這通常不是有效的頁碼，所以預設值必須改為指定為 1。 第一個結果變數會在查詢完成之後檢查是否有不必要的預設值。 第二個結果變數是藉由呼叫 DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 來指定預設值 1 來取得。

C#

int[] pageNumbers = { };

// Setting the default value to 1 after the query.
int pageNumber1 = pageNumbers.AsQueryable().SingleOrDefault();
if (pageNumber1 == 0)
{
    pageNumber1 = 1;
}
Console.WriteLine("The value of the pageNumber1 variable is {0}", pageNumber1);

// Setting the default value to 1 by using DefaultIfEmpty() in the query.
int pageNumber2 = pageNumbers.AsQueryable().DefaultIfEmpty(1).Single();
Console.WriteLine("The value of the pageNumber2 variable is {0}", pageNumber2);

/*
 This code produces the following output:

 The value of the pageNumber1 variable is 1
 The value of the pageNumber2 variable is 1
*/

備註

方法 SingleOrDefault<TSource>(IQueryable<TSource>) 會產生 ， MethodCallExpression 表示 SingleOrDefault<TSource>(IQueryable<TSource>) 呼叫本身做為建構的泛型方法。 然後，它會將 傳遞MethodCallExpression至 Execute<TResult>(Expression) 參數的 屬性所Provider表示的 source 方法IQueryProvider。

執行表示呼叫 SingleOrDefault<TSource>(IQueryable<TSource>) 的表達式樹狀結構所產生的查詢行為，取決於參數類型的 source 實作。 預期的行為是它會傳回 中 source唯一的專案，如果 source 是空的，則傳回預設值。

方法 SingleOrDefault 不提供指定預設值的方法。 如果您想要指定 以外的 default(TSource)預設值，請使用 DefaultIfEmpty<TSource>(IQueryable<TSource>, TSource) 範例 一節中所述的方法。

SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>)

來源:

Queryable.cs

傳回序列中符合指定之條件的唯一一個元素，如果沒有這類元素，則為預設值，如果有一個以上的元素符合條件，這個方法就會擲回例外狀況。

C#

public static TSource? SingleOrDefault<TSource> (this System.Linq.IQueryable<TSource> source, System.Linq.Expressions.Expression<Func<TSource,bool>> predicate);

類型參數

TSource

source 項目的類型。

參數

source

IQueryable<TSource>

要傳回單一項目的來源 IQueryable<T>。

predicate

Expression<Func<TSource,Boolean>>

用來測試項目是否符合條件的函式。

傳回

TSource

輸入序列中符合 條件 predicate的單一元素，如果 default 找不到這類專案，則 () TSource 。

例外狀況

ArgumentNullException

source 或 predicate 為 null。

InvalidOperationException

超過一個項目符合 predicate 中的條件。

範例

下列程式代碼範例示範如何使用 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 來選取符合條件之陣列的唯一元素。 第二個查詢示範 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 當序列未只包含一個符合條件的專案時，傳回預設值。

C#

string[] fruits = { "apple", "banana", "mango",
                      "orange", "passionfruit", "grape" };

// Get the single string in the array whose length is greater
// than 10, or else the default value for type string (null).
string fruit1 =
    fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 10);
Console.WriteLine("First Query: " + fruit1);

// Get the single string in the array whose length is greater
// than 15, or else the default value for type string (null).
string fruit2 =
   fruits.AsQueryable().SingleOrDefault(fruit => fruit.Length > 15);
Console.WriteLine("Second Query: " +
    (String.IsNullOrEmpty(fruit2) ? "No such string!" : fruit2));

/*
    This code produces the following output:

    First Query: passionfruit
    Second Query: No such string!
*/

備註

這個方法至少有一個類型 Expression<TDelegate> 參數，其類型自變數為其中一個 Func<T,TResult> 型別。 針對這些參數，您可以傳入 Lambda 運算式，並將它編譯為 Expression<TDelegate>。

方法 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 會產生 ， MethodCallExpression 表示 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 呼叫本身做為建構的泛型方法。 然後，它會將 傳遞MethodCallExpression至 Execute<TResult>(Expression) 參數的 屬性所Provider表示的 source 方法IQueryProvider。

執行表示呼叫 SingleOrDefault<TSource>(IQueryable<TSource>, Expression<Func<TSource,Boolean>>) 的表達式樹狀結構所產生的查詢行為，取決於參數類型的 source 實作。 預期的行為是它會傳回 中符合 所predicate指定條件的唯一元素source，如果沒有這類專案，則會傳回預設值。