Méthodes d'extension (Guide de programmation C#)
Mise à jour : novembre 2007
Les méthodes d'extension vous permettent d'ajouter des méthodes à des types existants sans créer un type dérivé, recompiler ou modifier le type d'origine. Les méthodes d'extension sont un type particulier de méthode statique que vous appelez comme s'il s'agissait de méthodes d'instance sur le type étendu. Pour le code client écrit en C# et Visual Basic, il n'y a aucune différence apparente entre appeler une méthode d'extension et les méthodes qui sont réellement définies dans un type.
Les méthodes d'extension les plus communes sont les opérateurs de requête standard LINQ qui ajoutent des fonctionnalités de requête aux types System.Collections.IEnumerable et System.Collections.Generic.IEnumerable<T> existants. Pour utiliser les opérateurs de requête standard, mettez-les tout d'abord en portée avec une directive using System.Linq. Puis, tout type qui implémente IEnumerable<T> semble avoir des méthodes d'instance telles que GroupBy, OrderBy, Average, et ainsi de suite. Vous pouvez consulter ces méthodes supplémentaires dans la saisie semi-automatique des instructions IntelliSense lorsque vous tapez un « point » après une instance d'un type IEnumerable<T> tel que List<T> ou Array.
L'exemple suivant indique comment appeler la méthode OrderBy d'opérateur de requête standard sur un tableau d'entiers. L'expression entre parenthèses est une expression lambda. De nombreux opérateurs de requête standard prennent des expressions lambda comme paramètres, mais ce n'est pas requis pour les méthodes d'extension. Pour plus d'informations, consultez Expressions lambda (Guide de programmation C#).
class ExtensionMethods2
{
static void Main()
{
int[] ints = { 10, 45, 15, 39, 21, 26 };
var result = ints.OrderBy(g => g);
foreach (var i in result)
{
System.Console.Write(i + " ");
}
}
}
//Output: 10 15 21 26 39 45
Les méthodes d'extension sont définies comme méthodes statiques mais sont appelées en utilisant la syntaxe de méthode d'instance. Leur premier paramètre spécifie les types sur lesquels la méthode fonctionne et le paramètre est précédé par le modificateur this. Les méthodes d'extension sont uniquement dans la portée lorsque vous importez explicitement l'espace de noms dans votre code source avec une directive using.
L'exemple suivant présente une méthode d'extension définie pour la classe System.String. Notez qu'elle est définie à l'intérieur d'une classe statique non imbriquée et non générique :
namespace ExtensionMethods
{
public static class MyExtensions
{
public static int WordCount(this String str)
{
return str.Split(new char[] { ' ', '.', '?' }, StringSplitOptions.RemoveEmptyEntries).Length;
}
}
}
La méthode d'extension WordCount peut être mise à portée avec cette directive using :
using ExtensionMethods;
Elle peut être appelée à partir d'une application en utilisant cette syntaxe :
string s = "Hello Extension Methods";
int i = s.WordCount();
Dans votre code, vous appelez la méthode d'extension avec la syntaxe de méthode d'instance. Toutefois, le langage intermédiaire (IL) généré par le compilateur traduit votre code dans un appel sur la méthode statique. Par conséquent, le principe d'encapsulation n'est pas réellement violé. En fait, les méthodes d'extension ne peuvent pas accéder aux variables privées dans le type qu'elles étendent.
Pour plus d'informations, consultez Comment : implémenter et appeler une méthode d'extension personnalisée (Guide de programmation C#).
En général, vous appellerez probablement les méthodes d'extension beaucoup plus souvent que vous n'implémenterez vos propres méthodes. Comme les méthodes d'extension sont appelées en utilisant la syntaxe de méthode d'instance, aucune connaissance particulière n'est requise pour les utiliser depuis le code client. Pour activer des méthodes d'extension pour un type particulier, ajoutez simplement une directive using pour l'espace de noms dans lequel les méthodes sont définies. Par exemple, pour utiliser les opérateurs de requête standard, ajoutez cette directive using à votre code :
using System.Linq;
(Il peut également être nécessaire d'ajouter une référence à System.Core.dll.) Vous pouvez remarquer que les opérateurs de requête standard apparaissent dorénavant dans IntelliSense comme méthodes supplémentaires disponibles pour la plupart des types IEnumerable<T>.
.gif "Remarque") Remarque : |
|---|
Bien que les opérateurs de requête standard n'apparaissent pas dans IntelliSense pour String, ils sont encore disponibles. |
Liaison de méthodes d'extension à la compilation
Vous pouvez utiliser des méthodes d'extension pour étendre une classe ou une interface, mais vous ne pouvez pas les substituer. Une méthode d'extension avec le même nom et la même signature qu'une méthode d'interface ou de classe ne sera jamais appelée. À la compilation, les méthodes d'extension ont toujours la priorité la plus faible par rapport aux méthodes d'instance définies dans le type lui-même. En d'autres termes, si un type a une méthode nommée Process(int i) et que vous avez une méthode d'extension avec la même signature, le compilateur créera toujours une liaison avec la méthode d'instance. Lorsque le compilateur rencontre un appel de méthode, il recherche en premier une correspondance dans les méthodes d'instance du type. Si aucune correspondance n'est trouvée, il recherchera toutes les méthodes d'extension définies pour le type et crée une liaison avec la première méthode d'extension qu'il trouve. L'exemple suivant montre comment le compilateur détermine quelle méthode d'extension ou méthode d'instance est choisie pour créer une liaison.
Exemple
L'exemple suivant montre les règles que le compilateur C# suit pour déterminer s'il faut lier un appel de méthode à une méthode d'instance sur le type, ou à une méthode d'extension. Le classe statique Extensions contient des méthodes d'extension définies pour tout type qui implémente IMyInterface. Les classes A, B et C implémentent toutes l'interface.
La méthode MethodB n'est jamais appelée car son nom et sa signature correspondent exactement aux méthodes déjà implémentées par les classes.
Lorsque le compilateur ne peut pas trouver de méthode d'instance avec une signature correspondante, il créera si possible une liaison avec une méthode d'extension correspondante.
namespace Extensions
{
using System;
using ExtensionMethodsDemo1;
// Define extension methods for any type that implements IMyInterface.
public static class Extension
{
public static void MethodA(this IMyInterface myInterface, int i)
{
Console.WriteLine("Extension.MethodA(this IMyInterface myInterface, int i)");
}
public static void MethodA(this IMyInterface myInterface, string s)
{
Console.WriteLine("Extension.MethodA(this IMyInterface myInterface, string s)");
}
// This method is never called, because the three classes implement MethodB.
public static void MethodB(this IMyInterface myInterface)
{
Console.WriteLine("Extension.MethodB(this IMyInterface myInterface)");
}
}
}
namespace ExtensionMethodsDemo1
{
using System;
using Extensions;
public interface IMyInterface
{
void MethodB();
}
class A : IMyInterface
{
public void MethodB(){Console.WriteLine("A.MethodB()");}
}
class B : IMyInterface
{
public void MethodB() { Console.WriteLine("B.MethodB()"); }
public void MethodA(int i) { Console.WriteLine("B.MethodA(int i)"); }
}
class C : IMyInterface
{
public void MethodB() { Console.WriteLine("C.MethodB()"); }
public void MethodA(object obj) { Console.WriteLine("C.MethodA(object obj)"); }
}
class ExtMethodDemo
{
static void Main(string[] args)
{
A a = new A();
B b = new B();
C c = new C();
TestMethodBinding(a,b,c);
}
static void TestMethodBinding(A a, B b, C c)
{
// A has no methods, so each call resolves to
// the extension methods whose signatures match.
a.MethodA(1); // Extension.MethodA(object, int)
a.MethodA("hello"); // Extension.MethodA(object, string)
a.MethodB(); // A.MethodB()
// B itself has a method with this signature.
b.MethodA(1); // B.MethodA(int)
b.MethodB(); // B.MethodB()
// B has no matching method, but Extension does.
b.MethodA("hello"); // Extension.MethodA(object, string)
// In each case C has a matching instance method.
c.MethodA(1); // C.MethodA(object)
c.MethodA("hello"); // C.MethodA(object)
c.MethodB(); // C.MethodB()
}
}
}
/* Output:
Extension.MethodA(this IMyInterface myInterface, int i)
Extension.MethodA(this IMyInterface myInterface, string s)
A.MethodB()
B.MethodA(int i)
B.MethodB()
Extension.MethodA(this IMyInterface myInterface, string s)
C.MethodA(object obj)
C.MethodA(object obj)
C.MethodB()
*/
Indications générales
En général, nous vous recommandons d'implémenter des méthodes d'extension de temps en temps et uniquement lorsque cela est nécessaire. Dès que cela est possible, le code client qui doit étendre un type existant doit le faire en créant un type nouveau dérivé du type existant. Pour plus d'informations, consultez Héritage (Guide de programmation C#).
Lors de l'utilisation d'une méthode d'extension pour étendre un type dont le code source ne peut pas être modifié, vous risquez d'interrompre votre méthode d'extension en cas de modification dans l'implémentation du type.
Si vous implémentez des méthodes d'extension pour un type donné, prenez en compte les deux points suivants :
Une méthode d'extension ne sera jamais appelée si elle a la même signature qu'une méthode définie dans le type.
Les méthodes d'extension sont mises en portée au niveau de l'espace de noms. Par exemple, si vous avez plusieurs classes statiques qui contiennent des méthodes d'extension dans un espace de noms unique nommé Extensions, elles seront toutes mises en portée par la directive using Extensions;.
Les implémenteurs de bibliothèques de classes ne doivent pas utiliser de méthodes d'extension pour éviter de créer de nouvelles versions des assemblys. Si vous voulez ajouter de nouvelles fonctionnalités majeures à une bibliothèque et que vous possédez le code source, vous devez suivre les recommandations standard du .NET Framework pour le versioning des assemblys. Pour plus d'informations, consultez Versioning des assemblys.
Voir aussi
Concepts
Vue d'ensemble des opérateurs de requête standard
Référence
Expressions lambda (Guide de programmation C#)
Autres ressources
Conversion rules for Instance parameters and their impact