« Les méthodes d'extension » : différence entre les versions

De Banane Atomic
Aller à la navigationAller à la recherche
Aucun résumé des modifications
 
 
(10 versions intermédiaires par le même utilisateur non affichées)
Ligne 23 : Ligne 23 :
</kode>
</kode>


= Avec les génériques =
= Useful extension methods =
<kode lang="cs">
== CollectionExtension ==
public static class IListExtensions
<filebox fn="CollectionExtension.cs" collapsed>
/// <summary>
/// Adds each item to the list.
/// </summary>
/// <remarks>
/// The <see cref="IList{T}" /> interface does not have AddRange in its contract, contrary to the <see cref="List{T}" /> implementation.
/// The latter uses an optimized routine for adding a range of elements, and naming this extension method AddRange too would give the wrong impression of performance.
/// Additionally, for collections that notify of their changes, AddRange reads as if there would be only one notification of change after all elements have been added, when in fact there would probably by as many notifications as items being added.
/// </remarks>
public static void AddEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
{
     /// <summary>
     ArgumentNullException.ThrowIfNull(collection);
     /// Un AddRange pour IList.
     ArgumentNullException.ThrowIfNull(elements);
     /// </summary>
 
     public static void AddRange<T>(this IList<T> source, IEnumerable<T> items)
     if (collection is List<T> list)
     {
        list.AddRange(elements);
    }
    else
     {
     {
         foreach (var item in items)
         foreach (var element in elements)
         {
         {
             source.Add(item);
             collection.Add(element);
         }
         }
     }
     }
}
}


// Utilisation de la méthode d'extension :
/// <summary>
var maListe = new List<string>();
/// Removes each item from the list.
maListe.AddRange(new string[] { "1", "2", "3" });;
/// </summary>
</kode>
/// <remarks>
/// This method is not named RemoveRange, because it does not have the same purpose as <see cref="List{T}.RemoveRange" />.
/// </remarks>
public static void RemoveEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
    ArgumentNullException.ThrowIfNull(collection);
    ArgumentNullException.ThrowIfNull(elements);
 
    foreach (var element in elements)
    {
        collection.Remove(element);
    }
}
 
public static void Remove<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);
 
    collection.RemoveEach(collection.Where(predicate));
}
 
public static void RemoveSingle<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);
 
    collection.Remove(collection.Single(predicate));
}
</filebox>
 
== IEnumerableExtension ==
<filebox fn='IEnumerableExtension.cs' collapsed>
/// <summary>
/// Update all the items of the collection.
/// </summary>
public static IEnumerable<T> SetValue<T>(this IEnumerable<T> items, Action<T> updateMethod)
{
    foreach (T item in items)
    {
        updateMethod(item);
    }
 
    return items;
}
 
/// <summary>
/// Sorts the elements of a sequence according to an element's property.
/// </summary>
public static IEnumerable<T> OrderBy<T>(
    this IEnumerable<T> source,
    string propertyName,
    bool ascendingOrder)
{
    var propertyDescriptor = TypeDescriptor.GetProperties(typeof(T))
                                          .Find(propertyName, false);
 
    if (propertyDescriptor == null)
        throw new Exception($"Property '{propertyName}' not found.");
 
    return ascendingOrder ?
        source.OrderBy(x => propertyDescriptor.GetValue(x)) :
        source.OrderByDescending(x => propertyDescriptor.GetValue(x));
}
</filebox>

Dernière version du 24 mars 2024 à 15:15

Disponible à partir de C# 3, elles permettent d'ajouter des méthodes à une classe ou à une structure sans en modifier son code.

  • Les méthodes doivent être déclarées dans une classe static.
  • Les méthodes qui étendent une classe ou une structure ne peuvent accéder qu’aux membres publics.
Cs.svg
// Déclaration de la méthode d'extension dans une classe static
public static class StringExtensions
{
    /// <summary>
    /// A Contains method with a comparison type.
    /// </summary>
    public static bool Contains(this string source, string value, StringComparison comparisonType)
    {
        return source.IndexOf(value, comparisonType) >= 0;
    }
}

// Utilisation de la méthode d'extension : comparaison de string en ignorant la casse
var monString = "ASTRINGTOTEST";
monString.Contains("string", StringComparison.OrdinalIgnoreCase);

Useful extension methods

CollectionExtension

CollectionExtension.cs
/// <summary>
/// Adds each item to the list.
/// </summary>
/// <remarks>
/// The <see cref="IList{T}" /> interface does not have AddRange in its contract, contrary to the <see cref="List{T}" /> implementation.
/// The latter uses an optimized routine for adding a range of elements, and naming this extension method AddRange too would give the wrong impression of performance.
/// Additionally, for collections that notify of their changes, AddRange reads as if there would be only one notification of change after all elements have been added, when in fact there would probably by as many notifications as items being added.
/// </remarks>
public static void AddEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
    ArgumentNullException.ThrowIfNull(collection);
    ArgumentNullException.ThrowIfNull(elements);

    if (collection is List<T> list)
    {
        list.AddRange(elements);
    }
    else
    {
        foreach (var element in elements)
        {
            collection.Add(element);
        }
    }
}

/// <summary>
/// Removes each item from the list.
/// </summary>
/// <remarks>
/// This method is not named RemoveRange, because it does not have the same purpose as <see cref="List{T}.RemoveRange" />.
/// </remarks>
public static void RemoveEach<T>(this ICollection<T> collection, IEnumerable<T> elements)
{
    ArgumentNullException.ThrowIfNull(collection);
    ArgumentNullException.ThrowIfNull(elements);

    foreach (var element in elements)
    {
        collection.Remove(element);
    }
}

public static void Remove<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);

    collection.RemoveEach(collection.Where(predicate));
}

public static void RemoveSingle<T>(this ICollection<T> collection, Func<T, bool> predicate)
{
    ArgumentNullException.ThrowIfNull(collection);

    collection.Remove(collection.Single(predicate));
}

IEnumerableExtension

IEnumerableExtension.cs
/// <summary>
/// Update all the items of the collection.
/// </summary>
public static IEnumerable<T> SetValue<T>(this IEnumerable<T> items, Action<T> updateMethod)
{
    foreach (T item in items)
    {
        updateMethod(item);
    }

    return items;
}

/// <summary>
/// Sorts the elements of a sequence according to an element's property.
/// </summary>
public static IEnumerable<T> OrderBy<T>(
    this IEnumerable<T> source,
    string propertyName,
    bool ascendingOrder)
{
    var propertyDescriptor = TypeDescriptor.GetProperties(typeof(T))
                                           .Find(propertyName, false);

    if (propertyDescriptor == null)
        throw new Exception($"Property '{propertyName}' not found.");

    return ascendingOrder ?
        source.OrderBy(x => propertyDescriptor.GetValue(x)) :
        source.OrderByDescending(x => propertyDescriptor.GetValue(x));
}