Enumerable.OrderBy 方法

定义

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

重载

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

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

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderBy(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector);
public static System.Linq.IOrderedEnumerable<TSource> OrderBy<TSource,TKey> (this System.Collections.Generic.IEnumerable<TSource> source, Func<TSource,TKey> keySelector);
static member OrderBy : seq<'Source> * Func<'Source, 'Key> -> System.Linq.IOrderedEnumerable<'Source>
<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey)) As IOrderedEnumerable(Of TSource)

类型参数

TSource

source 的元素类型。

TKey

keySelector 返回的键的类型。

参数

source
IEnumerable<TSource>

一个要排序的值序列。

keySelector
Func<TSource,TKey>

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

返回

IOrderedEnumerable<TSource>

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

例外

sourcekeySelectornull

示例

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

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
*/
Structure Pet
    Public Name As String
    Public Age As Integer
End Structure

Sub OrderByEx1()
    ' Create an array of Pet objects.
    Dim pets() As Pet = {New Pet With {.Name = "Barley", .Age = 8},
                     New Pet With {.Name = "Boots", .Age = 4},
                     New Pet With {.Name = "Whiskers", .Age = 1}}

    ' Order the Pet objects by their Age property.
    Dim query As IEnumerable(Of Pet) =
    pets.OrderBy(Function(pet) pet.Age)

    Dim output As New System.Text.StringBuilder
    For Each pt As Pet In query
        output.AppendLine(pt.Name & " - " & pt.Age)
    Next

    ' Display the output.
    Console.WriteLine(output.ToString())
End Sub

' This code produces the following output:
'
' Whiskers - 1
' Boots - 4
' Barley - 8

注解

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

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

定义了两种方法来扩展类型 IOrderedEnumerable<TElement>,即此方法的返回类型。 这两种方法(即ThenBy``ThenByDescending,可以指定其他排序条件)对序列进行排序。 ThenByThenByDescending返回一个IOrderedEnumerable<TElement>,这意味着对或ThenByDescending可以进行任意数量的连续调用ThenBy

备注

由于IOrderedEnumerable<TElement>继承自IEnumerable<T>,因此可以调用或OrderByDescending调用OrderBy结果 ThenBy OrderByOrderByDescending,或ThenByDescending调用结果。 执行此操作会引入一个新的主排序,忽略以前建立的排序。

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

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

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

另请参阅

适用于

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

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

public:
generic <typename TSource, typename TKey>
[System::Runtime::CompilerServices::Extension]
 static System::Linq::IOrderedEnumerable<TSource> ^ OrderBy(System::Collections::Generic::IEnumerable<TSource> ^ source, Func<TSource, TKey> ^ keySelector, System::Collections::Generic::IComparer<TKey> ^ comparer);
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);
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);
static member OrderBy : seq<'Source> * Func<'Source, 'Key> * System.Collections.Generic.IComparer<'Key> -> System.Linq.IOrderedEnumerable<'Source>
<Extension()>
Public Function OrderBy(Of TSource, TKey) (source As IEnumerable(Of TSource), keySelector As Func(Of TSource, TKey), comparer As IComparer(Of TKey)) As IOrderedEnumerable(Of TSource)

类型参数

TSource

source 的元素类型。

TKey

keySelector 返回的键的类型。

参数

source
IEnumerable<TSource>

一个要排序的值序列。

keySelector
Func<TSource,TKey>

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

comparer
IComparer<TKey>

用于比较键的 IComparer<T>

返回

IOrderedEnumerable<TSource>

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

例外

sourcekeySelectornull

注解

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

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

定义了两种方法来扩展类型 IOrderedEnumerable<TElement>,即此方法的返回类型。 这两种方法(即ThenBy``ThenByDescending,可以指定其他排序条件)对序列进行排序。 ThenByThenByDescending返回一个IOrderedEnumerable<TElement>,这意味着对或ThenByDescending可以进行任意数量的连续调用ThenBy

备注

由于IOrderedEnumerable<TElement>继承自IEnumerable<T>,因此可以调用或OrderByDescending调用OrderBy结果 ThenBy OrderByOrderByDescending,或ThenByDescending调用结果。 执行此操作会引入一个新的主排序,忽略以前建立的排序。

null如果是comparer,则默认比较器Default用于比较键。

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

另请参阅

适用于