Enumerable.OrderBy 方法

定义

命名空间:

System.Linq

程序集:

System.Linq.dll

按升序对序列的元素进行排序。

重载

OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)	根据键按升序对序列的元素进行排序。
OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)	使用指定的比较器按升序对序列的元素进行排序。

OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)

Source:

OrderBy.cs

根据键按升序对序列的元素进行排序。

C#

public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);

类型参数

TSource

source 的元素类型。

TKey

keySelector 返回的键的类型。

参数

source

IEnumerable<TSource>

一个要排序的值序列。

keySelector

Func<TSource,TKey>

用于从元素中提取键的函数。

返回

IOrderedEnumerable<TSource>

一个 IOrderedEnumerable<TElement>，将根据键对其元素排序。

例外

ArgumentNullException

source 或 keySelector 为 null。

示例

下面的代码示例演示如何使用 OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>) 对序列的元素进行排序。

C#

class Pet
{
    public string Name { get; set; }
    public int Age { get; set; }
}

public static void OrderByEx1()
{
    Pet[] pets = { new Pet { Name="Barley", Age=8 },
                   new Pet { Name="Boots", Age=4 },
                   new Pet { Name="Whiskers", Age=1 } };

    IEnumerable<Pet> query = pets.OrderBy(pet => pet.Age);

    foreach (Pet pet in query)
    {
        Console.WriteLine("{0} - {1}", pet.Name, pet.Age);
    }
}

/*
 This code produces the following output:

 Whiskers - 1
 Boots - 4
 Barley - 8
*/

注解

此方法通过使用延迟执行来实现。 即时返回值是一个对象，用于存储执行操作所需的所有信息。 在通过直接调用GetEnumerator其方法或在 C# For Each 或 foreach Visual Basic 中使用 来枚举对象之前，不会执行此方法表示的查询。

若要按元素本身的值对序列进行排序，请在 C# 或 Function(x) x Visual Basic) 中指定标识函数 (。x => xkeySelector

定义了两种方法来扩展 类型 IOrderedEnumerable<TElement>，这是此方法的返回类型。 这两种方法（即 ThenBy 和 ThenByDescending）使你可以指定其他排序条件来对序列进行排序。 ThenBy和 ThenByDescending 还返回 ，IOrderedEnumerable<TElement>这意味着可以对 或 ThenByDescending 进行任意次数的连续调用ThenBy。

备注

由于 IOrderedEnumerable<TElement> 继承自 IEnumerable<T>，因此可以在对 、 OrderByDescendingThenBy 或 OrderByDescending 的调用结果中调用 OrderByOrderBy或 ThenByDescending。 这样做会引入一个新的主排序，该排序会忽略以前建立的排序。

此方法使用默认比较器 Default来比较键。

此方法执行稳定的排序;也就是说，如果两个元素的键相等，则保留元素的顺序。 相比之下，不稳定排序不会保留具有相同键的元素的顺序。

在查询表达式语法中， orderby (C#) 或 Order By (Visual Basic) 子句将转换为 的调用 OrderBy。

另请参阅

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)
• orderby 子句（C# 参考）
• Order By 子句 (Visual Basic)

OrderBy<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)

Source:

OrderBy.cs

使用指定的比较器按升序对序列的元素进行排序。

C#

public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector, System.Collections.Generic.IComparer<TKey>? comparer);

类型参数

TSource

source 的元素类型。

TKey

keySelector 返回的键的类型。

参数

source

IEnumerable<TSource>

一个要排序的值序列。

keySelector

Func<TSource,TKey>

用于从元素中提取键的函数。

comparer

IComparer<TKey>

用于比较键的 IComparer<T>。

返回

IOrderedEnumerable<TSource>

一个 IOrderedEnumerable<TElement>，将根据键对其元素排序。

例外

ArgumentNullException

source 或 keySelector 为 null。

注解

此方法通过使用延迟执行来实现。 即时返回值是一个对象，用于存储执行操作所需的所有信息。 在通过直接调用GetEnumerator其方法或在 C# For Each 或 foreach Visual Basic 中使用 来枚举对象之前，不会执行此方法表示的查询。

若要按元素本身的值对序列进行排序，请在 C# 或 Function(x) x Visual Basic) 中指定标识函数 (。x => xkeySelector

定义了两种方法来扩展 类型 IOrderedEnumerable<TElement>，这是此方法的返回类型。 这两种方法（即 ThenBy 和 ThenByDescending）使你可以指定其他排序条件来对序列进行排序。 ThenBy和 ThenByDescending 还返回 ，IOrderedEnumerable<TElement>这意味着可以对 或 ThenByDescending 进行任意次数的连续调用ThenBy。

备注

由于 IOrderedEnumerable<TElement> 继承自 IEnumerable<T>，因此可以在对 、 OrderByDescendingThenBy 或 OrderByDescending 的调用结果中调用 OrderByOrderBy或 ThenByDescending。 这样做会引入一个新的主排序，该排序会忽略以前建立的排序。

如果 comparer 为 null，则使用默认比较器 Default 来比较键。

此方法执行稳定的排序;也就是说，如果两个元素的键相等，则保留元素的顺序。 相比之下，不稳定排序不会保留具有相同键的元素的顺序。

另请参阅

• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>)
• OrderByDescending<TSource,TKey>(IEnumerable<TSource>, Func<TSource,TKey>, IComparer<TKey>)