Probabilmente vi sarà capitato di dovere eseguire qualche azione all’interno del vostro software dipendentemente da trigger innescati da data e/o ora. Per esempio un certo processo non si scatena del week-end, oppure un altro processo deve partire solo a mezzanotte etc etc. Quando queste cose non siano attuabili esternamente con il task scheduler di sistema, sarebbe bello poter avere una libreria pronto uso in .NET. Ebbene questa libreria c’è, ed è il parser di espressioni Cron che trovate qui. Lungi dall’essere un concetto moderno, si tratta di un modo di esprimere range temporali tramite una stringa che arriva da Unix. Oggi chiamiamo una cosa simile “Domain Specific Language”, ma tant’è il concetto è il medesimo. Lungi anche dall’ essere originale il concetto in .NET, la libreria che propongo è una estrapolazione di codice dalla più completa e complessa libreria Quartz.NET, a sua volta un porting della libreria Java Quartz. Se non volete introdurre troppa complessità al vostro deploy aggiungendo una nuova libreria, potete “grabbare” le classi dalla dll di Cron.NET ( sono tre file… ) e compilarli con il vostro progetto, ed avrete a disposizione tutta la potenza delle espressioni Cron ;).

Già, ma come funzionano le espressioni Cron ? Facciamo un paio di esempi:

"* * 10-11 L * ?" = questo trigger è valido l’ultimo del mese dalle 10-11

"* * * ? * MON-FRI" = questo trigger è valido tutti i giorni, a tutte le ore, eccetto il week end.

Ok, questo da l’idea delle potezialità della cosa, ma ovviamente serivirebbe una più estesa…

Documentazione

Una espressione Cron è composta da 6 campi obbligatori, più uno opzionale. Il significato dei campi è schematizzato nella tabella qui sotto:

Il carattere jolly ‘*’ può sempre essere usato con il significato di “tutti i valori”, per esempio se metto ‘*’ nel campo minuti significa tutti i minuti.

Il carattere ‘?’ può essere usato solo come Giorno del mese o giorno della settimana. Significa “nessun valore in particolare” e serve quando devo fissare l’altro. Se per esempio fisso il giorno della settimana metterò ‘?’ nel giorno del mese, e viceversa.

Il carattere ‘-‘ lo utilizzo quando voglio specificare un range: per esempio 10-12 nel campo ora significa dalle 10 a tutte le 12.

Uso invece la ‘,’ quando voglio specificare singolarmente più valori possibili: JAN,MAR significa il mese di Gennaio e di Marzo, ma non Febbraio ( e, ovviamente, non tutti gli altri ).

Per specificare dei periodi utilizzo ‘/’: per esempio se metto 0/15 nel campo secondi, significa “ogni 15 secondi”: sarà attivo il trigger quindi ai secondi 15,30,45 etc etc.

Il carattere speciale ‘L’ significa ultimo. Nel campo mese significa semplicemente l’ultimo giorno del mese (30/31/28 o 29 ) in modo concorde con il mese / anno bisestile. Nel campo settimana significa semplicemente 7 ( cioè Sabato ), ma se preceduto da un numero significa “l’ultimo xxxx del mese”. Per esempio se scrivo 6L significa l’ultimo Venerdì del mese.

Il carettere ‘W’ può essere specificato solo nel campo giorno del mese, preceduto da un solo carattere, e significa “il giorno lavorativo più vicino a”. Per esempio se scrivo 1W significa il giorno lavorativo più vicino al primo del mese. Se scrivo LW significa l’ultimo giorno lavorativo del mese.

Per ultimo il carattere ‘#’, utilizzabile solo nel giorno della settimana, indica l’ennesimo xxxx del mese. Per esempio, se mi interessa il terzo venerdì del mese, scriverò 6#3.

Per utilizzare una cron expression basta creare un istanza dell’ogegtto CronExpression, passando la stringa sul costruttore. Ecco un esempio:

             1:  [Test]

             2: 
            public
            void LastOfTheMonth()

             3:  {

             4:  var
exp = new CronExpression("* * * L * ?");

             5:  Assert.IsTrue(exp.IsSatisfiedBy(new DateTime(2000,
1, 31)));

             6:  Assert.IsTrue(exp.IsSatisfiedBy(new DateTime(2000,
2, 29)));

             7:  Assert.IsFalse(exp.IsSatisfiedBy(new DateTime(2000,
2, 28)));

             8:  }

Può succedere di dover specificare il nome di un assembly completo, magari in un file di configurazione dell’applicativo. Sfortunatamente non si può tagliare ed incollare la stringa dalla GAC, e bisogna copiare ed incollare i vari pezzi dalla finestra property. Ecco quindi un piccolo tool che mostra tutto il contenuto della GAC e ci permette di copiare l’assembly full name. Eccolo all’opera:

Si accettano complimenti per la meravigliosa interfaccia utente ;).

Nondimeno importante segnalare lo snapshot di codice che consente con facilità di maneggiare la GAC run-time.

Può essere interessante, quando si sviluppano e si utilizzano in modalità test servizi di windows, avere una modalità di funzionamento “Console”, che ci permetta di lanciare il nostro servizio come una console application per vedere “cosa fa” senza stare lì ad aprire ogni secondo il file di log. Ovviamente dobbiamo prevedere un sistema di logging che scriva anche sulla console  (se per loggare usate log4net, allora basta mettere un ConsoleAppender, o meglio ancora, un ColoredConsoleAppender). Per farlo basta creare la solita WindowsServiceApplication, avendo però cura di impostare il progetto come console:

Il main dovrà essere modificato in questoi modo

             1: 
            static
            void Main(string[]
args)

             2:  {

             3: 
            if (!Environment.UserInteractive)

             4:  {

             5:  log.Info("Starting
as a service...");

             6:  ServiceBase[] ServicesToRun;

             7:  ServicesToRun
= new ServiceBase[] 

             8:  { 

             9: 
            new Service1() 

             10:  };

             11:  ServiceBase.Run(ServicesToRun);

             12:  }

             13: 
            else
          

             14:  {

             15:  log.Info("Starting
as a console...");

             16:  var s = new Service1(log);

             17:  s.GetType().GetMethod( "OnStart"

             18:  ,BindingFlags.Instance|BindingFlags.NonPublic

             19:  ).Invoke(s,newobject[]{args});

             20:  Console.WriteLine("Press
enter to exit the console mode");

             21:  Console.ReadLine();

             22:  s.GetType().GetMethod( "OnStop"

             23:  ,
BindingFlags.Instance | BindingFlags.NonPublic

             24:  ).Invoke(s, null);

             25:  }

             26:  }

Quando andiamo in deploy con un servizio C# abbiamo l’opzione di utilizzare installutil.exe per “installare” il servizio, ovvero far si che compaia nel Service Control Manager. Tuttavia è possibile fare la stessa cosa programmaticamente, e farlo semplifica la vita a chi installera il vostro servizio. L’idea è che il main del servizio risponda a dei comandi sulla cmd line, per esempio “—install” o “—uninstall” in modo  che l’unico strumento che serve in fase di deploy sia il servizio stesso.

Ecco dunque la ricetta: si deve intendere “ricetta” come un segmento di codice troppo piccolo da essere messo in una libreria, ma troppo importante per essere dimenticato :-)

La ricetta in oggetto è quindi composta di due funzioni:

Install()

             1: 
            private
            static
            void Install()

             2:  {

             3:  ServiceProcessInstaller
ProcesServiceInstaller = new ServiceProcessInstaller();

             4:  ProcesServiceInstaller.Account
= ServiceAccount.LocalSystem;

             5: 
          

             6:  ServiceInstaller
ServiceInstallerObj = new ServiceInstaller();

             7:  InstallContext
Context = new System.Configuration.Install.InstallContext();

             8:  String
path = String.Format("/assemblypath={0}", Assembly.GetExecutingAssembly().Location);

             9:  String[]
cmdline = { path };

             10:  

             11:  Context
= new System.Configuration.Install.InstallContext("",
cmdline);

             12:  ServiceInstallerObj.Context =
Context;

             13:  ServiceInstallerObj.DisplayName
= "Nome da visualizzare in SCM";

             14:  ServiceInstallerObj.Description
= "Descrizione del servizio";

             15:  ServiceInstallerObj.ServiceName
= "NomeDelServizio";

             16:  ServiceInstallerObj.StartType
= ServiceStartMode.Automatic;

             17:  ServiceInstallerObj.Parent
= ProcesServiceInstaller;

             18:  

             19:  System.Collections.Specialized.ListDictionary
state = new System.Collections.Specialized.ListDictionary();

             20: 
          

             21:  ServiceInstallerObj.Install(state);

             22:  }

Uninstall()

             1: 
            private
            static
            void Uninstall()

             2:  {

             3:  ServiceProcessInstaller
ProcesServiceInstaller = new ServiceProcessInstaller();

             4:  ProcesServiceInstaller.Account
= ServiceAccount.LocalSystem;

             5:  

             6:  ServiceInstaller
ServiceInstallerObj = new ServiceInstaller();

             7:  InstallContext
Context = new System.Configuration.Install.InstallContext();

             8:  String
path = String.Format("/assemblypath={0}", Assembly.GetExecutingAssembly().Location);

             9:  String[]
cmdline = { path };

             10:  

             11:  Context
= new System.Configuration.Install.InstallContext("",
cmdline);

             12:  ServiceInstallerObj.Context =
Context;

             13:  ServiceInstallerObj.ServiceName
= "ServiceName";

             14:  ServiceInstallerObj.Uninstall(null);

             15:  

             16:  }

Importante: Per entrambe le funzioni, ServiceName deve essere uguale alla proprietà ServiceName del servizio che si vuole installare.