mandag 30. januar 2012 NNUG OO Patterns C#
I foredraget mitt på NNUG Bergen i januar tok jeg for meg noen utvalgte design patterns, viste noen objektorienterte eksempelimplementasjoner i C#, for så å sammenligne dette med tilsvarende løsninger i F# hvor jeg kun brukte funksjoner. Dette er første blogpost i en serie på fire hvor jeg vil gå gjennom ett av mønstrene jeg brukte – nemlig Template Method design pattern.
(Koden er noe endret i forhold til det som ble vist i foredraget.)
I denne første blogposten vil jeg vise en typisk løsning implementert i C# – designet er slik du ofte finner det i statisk typede språk. I del 2 vil jeg gjøre visse endringer i C#-løsningen for å vise hvordan jeg kan gjøre designet mere fleksibelt ved å bevege meg mot en funksjonell tankegang.
I del 3 vil du få se min F#-løsning. Da vil du forhåpentligvis se hvor mye enklere og mere fleksibel koden blir når man dropper de tyngste abstraksjonene og bare bruker funksjoner. I den siste delen vil jeg vise en implementasjon i Common Lisps fleksible objektsystem, hvor jeg blant annet vil utnytte multippel arv.
Poenget her er altså å studere ulike måter å løse et problem rent designmessig – og hvordan ulike programmeringsspråk tilbyr ulike hjelpemidler.
Problemet jeg skal modellere ved hjelp av Template Method pattern dreier seg om prosessering av loggfiler. Template Method er en mønster hvor man definerer skjelettet til en algoritme, men gir andre (sub-klasser) mulighet til å definere eller endre enkelte av stegene i algoritmen. Jeg har identifisert at jeg alltid prosesserer loggfiler omtrent på samme måte, men at enkelte av stegene endrer seg fra gang til gang. Template Method er altså en god kandidat å bruke her.
Nedenfor ser du koden som definerer selve templaten. Det er en abstrakt klasse, hvor definisjonen av detaljene i hvert steg av algoritmen er overlatt til en fremtidig, konkret implementasjon:
10 public abstract class LogProcessor 11 { 12 public void Execute() 13 { 14 Initialize(); 15 IEnumerable<string> log = ReadLog(); 16 foreach (var line in log) 17 ProcessLine(line); 18 Cleanup(); 19 } 20 21 protected abstract void Initialize(); 22 protected abstract IEnumerable<string> ReadLog(); 23 protected abstract void ProcessLine(string line); 24 protected abstract void Cleanup(); 25 }
Hvis jeg så har behov for å f.eks. skrive ut alle linjene i en loggfil som inneholder feilmeldinger så kan jeg lage en ErrorReporter som arver fra LogProcessor-templaten min:
30 public class ErrorReporter : LogProcessor 31 { 32 protected override void Initialize() 33 { 34 Console.WriteLine("Errors:"); // just a header for the report 35 } 36 37 protected override IEnumerable<string> ReadLog() 38 { 39 // Simulating reading a file: 40 yield return "20120125180000000 DEBUG Tick!"; 41 yield return "20120125180100000 DEBUG Tick!"; 42 yield return "20120125180132112 ERROR Some error occurred"; 43 yield return "20120125180133056 ERROR Some other error..."; 44 yield return "20120125180200000 DEBUG Tick!"; 45 } 46 47 protected override void ProcessLine(string line) 48 { 49 var regex = new Regex("^(\\d{17})\\s(\\w+)\\s(.+)$"); 50 var match = regex.Match(line); 51 if (match.Success && match.Groups[2].Value == "ERROR") 52 { 53 Console.WriteLine("{0}: {1}", 54 match.Groups[1].Value, 55 match.Groups[3].Value); 56 } 57 } 58 59 protected override void Cleanup() // No cleanup needed 60 { 61 } 62 }
Som du ser gjør jeg eksempelet litt enklere ved å lure meg unna selve lesingen av loggfilen.
ErrorReport-klassen kan brukes direkte, men i tillegg ønsker jeg at programmet mitt skal hente loggfilen fra en FTP-server når rapporten skal kjøres. Når jeg er ferdig skal filen arkiveres, og filen på FTP-serveren skal slettes. Derfor lager jeg et nytt nivå – en klasse som arver fra ErrorReport, som re-definerer Initialize- og Cleanup-stegene:
66 public class FtpErrorReporter : ErrorReporter 67 { 68 private readonly string _url; 69 public FtpErrorReporter(string url) 70 { 71 _url = url; 72 } 73 74 protected override void Initialize() 75 { 76 Console.WriteLine("Fetching log file from {0}", _url); 77 base.Initialize(); 78 } 79 80 protected override void Cleanup() 81 { 82 base.Cleanup(); 83 Console.WriteLine("Archiving local log copy..."); 84 Console.WriteLine("Deleting log file on {0}", _url); 85 } 86 }
Designet jeg har laget ser altså ut som dette:
Med følgende program kan jeg teste ut koden min:
90 public class Program 91 { 92 public static void Main() 93 { 94 LogProcessor errorReporter = 95 new FtpErrorReporter("ftp://foobar.com/logs/my.log"); 96 97 errorReporter.Execute(); 98 } 99 }
Og output ser slik ut:
Fetching log file from ftp://foobar.com/logs/my.log Errors: 20120125180132112: Some error occurred 20120125180133056: Some other error... Archiving local log copy... Deleting log file on ftp://foobar.com/logs/my.log
Designet jeg har valgt løser oppgaven på en tilsynelatende grei måte. De tre klassene har fått hvert sitt tydelig definerte ansvarsområde: LogProcessor definerer en generell algoritme som kan gjenbrukes. ErrorReporter definerer hvordan jeg finner feilene i loggfilen og skriver dem ut. FtpErrorReporter håndterer henting og sletting av loggfiler over FTP.
Dette er altså del 1 i min behandling av Template Method, og er som en introduksjon å regne. Men det er allerede nå verdt å legge merke til at at template method har gjort designet mitt ganske så regid. Hva må jeg f.eks. gjøre om jeg vil rapportere på andre ting enn errors, men fortsatt hente filene over FTP? Skal jeg følge designet må jeg opprette to nye klasser, hvor den ene stort sett vil være en kopi av FtpErrorReporter. Det er ikke bra! Jeg står heller ikke fritt til å gjenbruke bare deler av enten ErrorReporter eller FtpErrorReporter.
I del 2 vil du få se hva jeg kan gjøre med dette.