Aller au menu - Aller au contenu

Icône Les méthodes d'extension

Par nico.pyright
Mise à jour : 02/02/2012
Difficulté : Facile Facile Creative Commons BY-NC-SA
22 955 visites depuis 7 jours, dont 124 sur ce chapitre classé 15/786
En général, pour ajouter des fonctionnalités à une classe, nous pourrons soit modifier le code source de la classe, soit créer une classe dérivée de notre classe et ajouter ces fonctionnalités.

Dans ce chapitre nous allons voir qu'il existe un autre moyen pour étendre une classe : ceci est possible grâce aux méthodes d'extension.
Elles sont intéressantes si nous n'avons pas la main sur le code source de la classe ou si la classe n'est pas dérivable.

Partons à la découverte de ces fameuses méthodes…
Retour en haut
Sommaire du chapitre :
Icône du chapitre
Chapitre précédent Sommaire Chapitre suivant
Retour en haut

Qu'est-ce qu'une méthode d'extension

Comme son nom l’indique, une méthode d’extension permet d’étendre une classe en lui rajoutant des méthodes.
Ceci est pratique lorsque nous ne possédons pas le code source d’une classe et qu’il s’avère difficile de la modifier.

D’une manière générale, lorsque l’on souhaite modifier une classe dont on n’a pas le code source, on utilise une classe dérivée. Ceci est impossible avec des objets qui ne sont pas dérivables, comme c’est le cas pour les structures comme int ou double. Mais également comme c’est le cas pour la classe String. En effet, String n’est pas dérivable. Nous verrons plus tard comment cela est possible, mais pour l’instant, admettons-le.

Si vous ne me croyez pas, vous pouvez toujours tenter de compiler le code suivant :

Code : C#
1
2
3
public class StringEvoluee : String
{
}


:p
Retour en haut

Créer une méthode d'extension

Si par exemple nous souhaitons créer une méthode permettant de crypter une chaine de caractères dans un format que nous seuls comprenons, il serait judicieux de créer une méthode dans une classe StringCryptee qui dérive de string.
Comme ceci n’est pas possible, la seule chose qui nous reste c’est de créer une méthode statique utilitaire faisant cet encodage :

Code : C#
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class Program
{
    static void Main(string[] args)
    {
        string chaineNormale = "Bonjour à tous";
        string chaineCryptee = Encodage.Crypte(chaineNormale);
        Console.WriteLine(chaineCryptee);
        chaineNormale = Encodage.Decrypte(chaineCryptee);
        Console.WriteLine(chaineNormale);
    }

}

public static class Encodage
{
    public static string Crypte(string chaine)
    {
        return Convert.ToBase64String(Encoding.Default.GetBytes(chaine));
    }

    public static string Decrypte(string chaine)
    {
        return Encoding.Default.GetString(Convert.FromBase64String(chaine));
    }
}


Bon, ok, notre encodage secret ne l’est pas tant que ça :D .
Il s’avère que j’utilise ici un encodage en base 64, algorithme archi connu. Mais bon, c’est pour l’exemple.
Retour en haut

Utiliser une méthode d'extension

Ces méthodes statiques jouent bien leur rôle. Mais il est possible de faire en sorte que ces deux méthodes deviennent des méthodes d’extensions de la classe string. Il suffit d’utiliser le mot-clé this devant le premier paramètre de la méthode afin de créer une méthode d’extension :

Code : C#
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
public static class Encodage
{
    public static string Crypte(this string chaine)
    {
        return Convert.ToBase64String(Encoding.Default.GetBytes(chaine));
    }

    public static string Decrypte(this string chaine)
    {
        return Encoding.Default.GetString(Convert.FromBase64String(chaine));
    }
}


Nous pourrons désormais utiliser ces méthodes comme si elles faisaient parties de la classe String :

Code : C#
1
2
3
4
5
string chaineNormale = "Bonjour à tous";
string chaineCryptee = chaineNormale.Crypte();
Console.WriteLine(chaineCryptee);
chaineNormale = chaineCryptee.Decrypte();
Console.WriteLine(chaineNormale);


Pas mal non ?
De plus, si nous regardons dans la complétion automatique, nous pourrons voir apparaître nos fameuses méthodes :

Image utilisateur


Plutôt pratique.

Évidemment, en créant une méthode d’extension, nous n’avons bien sûr pas accès aux méthodes privées ou variables membres internes à la classe. La preuve, les méthodes d’extensions sont des méthodes statiques qui travaillent hors de toute instance de classe.

Ces méthodes doivent donc être statiques et situées à l’intérieur d’une classe statique.


Par contre, il faut faire attention à l’espace de nom où se situent nos méthodes d’extensions. Si le using correspondant n’est pas inclus, nous ne verrons pas les méthodes d’extension.

Remarquez que les méthodes d’extension fonctionnent aussi avec les interfaces. Plus précisément, elles viennent étendre toutes les classes qui implémentent une interface.
Par exemple, avec deux classes implémentant l’interface IVolant :

Code : C#
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
public interface IVolant
{
    void Voler();
}

public class Oiseau : IVolant
{
    public void Voler()
    {
        Console.WriteLine("Je vole");
    }
}

public class Avion : IVolant
{
    public void Voler()
    {
        Console.WriteLine("Je vole");
    }
}


si je crée une méthode d’extension prenant en paramètres un IVolant, préfixé par this :

Code : C#
1
2
3
4
5
6
7
public static class Extentions
{
    public static void Atterir(this IVolant volant)
    {
        Console.WriteLine("J'attéris");
    }
}


je pourrais accéder à cette méthode pour les objets Avion et Oiseau :

Code : C#
1
2
3
4
Avion a = new Avion();
Oiseau b = new Oiseau();
a.Atterir();
b.Atterir();


À noter que le framework .NET se sert de ceci pour proposer un grand nombre de méthodes d’extension sur les objets implémentant IEnumerable, nous les étudierons un peu plus tard.
Retour en haut

Q.C.M.

Qu'est-ce que sont les méthodes d'extensions ?
Quel est le mot clé utilisé devant un type pour indiquer que l'on souhaite faire une méthode d'extension ?
Que produit le code suivant :

Code : C#
1
2
3
4
5
6
7
public static class Extentions
{
    public static void Init(this IEnumerable enumerable)
    {
        Console.WriteLine("Initialisation");
    }
}

Statistiques de réponses au QCM

Retour en haut

En résumé


  • Une méthode d'extension permet d'étendre une classe en lui rajoutant des méthodes.
  • Il n'est pas recommandé d'utiliser des méthodes d'extension lorsqu'on dispose déjà du code source de la classe ou qu'on peut facilement en créer un type dérivé.
  • On utilise le mot-clé this en premier paramètre d'une classe statique pour étendre une classe.
Chapitre précédent Sommaire Chapitre suivant
Retour en haut

Partager

Retour en haut
8 commentaires pour "Les méthodes d'extension"
Note moyenne : 3.05 / 4 (230 votes)
Pseudo Commentaire
Hors ligne nico.pyright # Posté le 24/02/2012 à 09:05:47
Groupe : Auteurs

Bonjour,

ce n'est pas du tout la même chose, j'ai donc dû mal expliquer la différence.

Quand tu redéfinies une méthode une méthode, tu créés une nouvelle classe qui dérive de la première et tu redéfinis un comportement pour une méthode qui s'est déclarée ouverte à cette redéfinition.

Une méthode d'extension permet de rajouter des méthodes statiques à une classe sans posséder le code source de la classe.
Mon livre pour apprendre le C#
 
Hors ligne gfox78 # Posté le 30/04/2012 à 18:48:03
Avatar

Avis : Très bon

Ville : Marcq
Pays : France métropolitaine

 Mieux vaut écrire 'j'atterris' plutôt que 'j'attéris'.
Amicalement.
Hors ligne gfox78 # Posté le 30/04/2012 à 20:09:43
Avatar

Avis : Très bon

Ville : Marcq
Pays : France métropolitaine

 Je suis intrigué par l'identificateur 'volant' de 'IVolant':
Code : PHP
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<?php

 public static class Extentions                      // classe étendant l'interface
    {
        public static void Atterrir(this IVolant volant)     // 'this' comme ci-dessus
        {
            Console.WriteLine("J'atterris");
        }
    }
?>


Visiblement, il est nécessaire pour la compilation mais comment peut-on utiliser cet identificateur ensuite ? Merci.
Hors ligne Eagleseb # Posté le 11/05/2012 à 17:07:28
Avatar

Avis : Décevant

"À noter que le framework .NET se sert de ceci pour proposer un grand nombre de méthodes d’extension sur les objets implémentant IEnumerable, nous les étudierons un peu plus tard."

C'est ce genre de phrase qui fait que je n'aime pas ce tutoriel car nous ne les verrons pas plus tard, du moins pas avec toi.
Hors ligne nico.pyright # Posté le 11/05/2012 à 18:04:06
Groupe : Auteurs

Aurais-tu préféré une formulation du genre :

Nous en reparlerons plus tard dans le chapitre sur LINQ http://www.siteduzero.com/tutoriel-3-5 [...] n-a-linq.html ?
Mon livre pour apprendre le C#
 

Voir tous les commentaires