Udvidelses- og klassemetoder i C#

Jeg havde brug for at forklare forskellen på extension methods og almindelige klassemetoder idag, og det forbavsede mig i anledningen hvor længe siden det egentligt er jeg har brugt det selv i .NET sprog. Jeg bruger nemlig tit og ofte den “tilsvarende” mekanisme i JavaScript (f.eks. prototype nøgleordet).

Her er et eksempel på hvordan man kunne tælle alle ord i en streng ved brug af en almindelig klassemetode:

TestProgram.cs:

using System;
using System.Text;

namespace TestApplication
{
  public class Utilities 
  {
    public static int CountWords(String str)
    {
      return str.Split(new char[] { ' ', '.', '?' },
        StringSplitOptions.RemoveEmptyEntries).Length;
    }
  }

  class TestProgram
  {
    static void Main(string[] args)
    {
      String test = "Hello world, how are you doing?";

      Console.WriteLine(test);
      Console.WriteLine(Utilities.CountWords(test) + " words found.");
      Console.WriteLine("Press any key to quit.");
      Console.ReadKey();
    }
  }
}

Kørselsresultat:

Hello world, how are you doing?
6 words was found in the string.
Press any key to quit.

Metoden CountWords er her kun tilgængelig fra klassen Utilities. Men metoden er jo egentlig ret generel for alle instanser af String klassen, og det kunne nemt tænkes at den specielle funktion skal kaldes i fremtidige applikationer jeg laver, eller blot i andre klasser i samme applikation. Dertil kan man anvende extension methods til udvide de metoder der er tilgængelige i eksisterende klasser.

Extension methods, eller udvidelsesmetoder, implementeres ved at angive statiske metoder i en public static klasse. De klasser man har oprettet der indeholder udvidelsesmetoder skal så blot være i scopet der hvor man ønsker at anvende udvidelsesmetoderne. Dette sikres ved at benytte “using” direktivet for det namespace man har placeret klasserne for udvidelsesmetoderne i. Den første parameter i en udvidelsesmetode specificerer altid hviklen type (klasse) der udvides, og denne parameter skal altid indledes med en this modifikator, da det er denne modifikator sammen med static der får compileren til at genkende metoden som en udvidelsesmetode.   

Her et eksempel hvor Strings klassen får tilføjet en CountWords udvidelsesmetode:

MyExtensions.cs:

using System;
using System.Text;

namespace ExtensionMethods
{
  public static class MyExtensions
  {
    public static int CountWords(this String str)
    {
      return str.Split(new char[] { ' ', '.', '?' },
        StringSplitOptions.RemoveEmptyEntries).Length;
    }
  }
}

Den overstående klasse i namespacet ExtensionMethods udvider nu String klassen med metoden CountWords. Namespace navnet er ikke så vigtigt, det kan være hvad som helst faktisk. Udvidelsen af String klassen sker ved at this er angivet foran første parameter i CountWords metoden. Typen der udvides er String. Vi kan gøre brug af denne udvidelse ved at skrive “using ExtensionMethods;” i vores fremtidige applikationer, for eksempel:

TestProgram.cs:

using System;
using System.Text;
using MyExtensions;

namespace TestApplication
{
  class TestProgram
  {
    static void Main(string[] args)
    {
      String test = "Hello world, how are you doing?";

      Console.WriteLine(test);
      Console.WriteLine(test.CountWords() + " words found.");
      Console.WriteLine("Press any key to quit.");
      Console.ReadKey();
    }
  }
}

Kørselsresultat:

Hello world, how are you doing?
6 words was found in the string.
Press any key to quit.

Det er vigtigt at understrege at udvidelsen ikke finder sted på selve String klassen, men på instanser af String klassen. Helt konkret er det instansen str der modtages i selve CountWords metoden. Dette bevirker at man ikke kan lave klasse udvidelsesmetoder såsom “String.MyClassExtensionMethod” og tilsvarende. Ligeledes er adgangsniveauet for udvidelsesmetoder det samme som når man har med en given instans af en klasse at gøre. Man har således ikke adgang til protected og private metoder og egenskaber/variable på en klasse man udvider.

Microsoft Visual Studio’s Intellisense understøtter extension methods:

Der er lige et par huskeregler man bør have for øje:

  • Husk at udvidelsesmetoder kræver at der er anvendt et “using” direktiv.
  • Husk dermed at enten kildefilen eller DLL’en til ønskede udvidelsesmetoder er tilføjet projektet.
  • Endvidere skal man huske at eksisterende metoder med samme navn og signatur altid vinder over udvidelsesmetoder.
  • Tag ikke udvidelsesmetoder for givet. Anvend system metoder hvor muligt, og indfør kun udvidelsesmetoder under nøje overvejelser.

Se denne MSDN artikel, som mit eksempel herover er inspireret udfra, for flere uddybende eksempler.

Skriv et svar

Din e-mailadresse vil ikke blive offentliggjort. Krævede felter er markeret med *