Ohjelmistokehitys

Näin lähellä vuoden 2011 loppua on hyvä hengähtää hetki ja samalla pohtia pian alkavaa uutta vuotta. Vuoden vaihtumiseen liittyy monella jonkinlainen uudenvuodenlupaus, jota sitten yritetään noudattaa ainakin tammikuun pari ensimmäistä viikkoa. Yhtä kaikki, näihin lupauksiin kuuluu keskeisesti toive tehdä seuraavana vuonna jotakin paremmin kuin kuluneena vuonna. Koodarin työlupaus liittyy usein tehokkaampaan työskentelyyn, parempaan tiimityöhön ja virheiden välttämiseen. Mitä Visual Studio -kehittäjä voisi sitten luvata tekevänsä vuonna 2012 aiempaa paremmin?

Ideoita on varmasti yhtä monta kuin kehittäjiäkin, mutta yksi ajatus voisi olla koodin testattavuuden parantaminen ja sitä kautta korkeamman laadun tuottaminen pienemmällä vaivalla. Tässä hengessä otetaan esille .NET 4.0:aan parisen vuotta sitten ilmestynyt ominaisuus nimeltä Code Contracts, vapaasti suomennettuna koodisopimukset.  Tekniikan käyttöönotto voisi siis olla yksi kehittäjän lupauksista alkavalle vuodelle.

Koodisopimusten ideana on tarjota kehittäjälle mahdollisuus ilmaista paremmin luokkien ja metodien ennakkovaatimukset, tulokset sekä olettamukset kenttien ja ominaisuuksien arvoista ohjelman suorituksen aikana. Englanniksi näistä asioista käytetään nimityksiä precondition, postcondition ja invariant.

Code Contracts on nykyisin vakio-osa .NET 4.0:aa, ja siihen liittyvät luokat löytyvät nimiavaruudesta System.Diagnostics.Contracts mscorlib-koonnista. Keskeihin luokka on nimeltään Contract, jolla on useita staattisia metodeja tarkkailemaan esimerkiksi metodin parametreja tai luokan ominaisuuksien sallittuja arvoja. Erityisellä erikseen asennettavalla lisäosalla näitä koodiin kirjoitettuja ehtoja voidaan verifioida myös staattisella koodianalyysillä, joskaan tämä ei ole läheskään aukotonta.

Jos haluat kokeilla Code Contractsia, ota ensin käyttöön mainittu Contract-luokka. Yksinkertaisimmillaan voidaan käyttää esimerkiksi parametrien validiointiin Assert-metodia, joka on monelle jo tuttu Debug-luokasta. Contract-luokan Assert-metodi toimii samalla idealla, mutta mahdollistaa paremman staattisen analyysin.

Tässä pieni koodiesimerkki luokasta, joka käyttää kyseistä toimintoa:

using System.Diagnostics.Contracts;
...

public class MyLogic
{
  public int Level { get; set; }

  public void StoreObject(object something)
  {
    Contract.Assert(something != null);
    if (Level == 0)
    {
      // ...
    }
    else if (Level == 1)
    {

      // ...

      Level = 2;
    }
  }

  [ContractInvariantMethod]
  private void CheckInvariants()
  {
    Contract.Invariant(Level == 0 && Level == 1);
  }
}

Kyseessä on yksinkertainen fiktiivinen luokka jolla on kuitenkin tausta-olettamus: Level-ominaisuuden arvo on oltava aina nolla tai yksi. Tätä varten luokassa on metodi nimeltä CheckInvariants, jolle on erillisellä ContractInvariantMethod-attribuutilla kerrottu, että tätä metodia kutsutaan automaattisesti aina, kun luokan julkisia metodeita käytetään.

Lisäksi StoreObject-metodissa käytetään Assert-metodia tarkistamaan, että parametrina annetun olion arvo on eri kuin null.

Staattinen analyysi

Jos Visual Studion asennusta terästää sopivalla lisäosalla (lisäosasta on kaksi eri versiota, toinen Visual Studion Professional-versiolle ja toinen Premium- ja Ultimate-versioille), päästään koodisopimuksia tarkastelemaan jo käännösaikana.

Kun lisäosa on asennettu, projektin asetuksiin ilmaantuu uusi välilehti, jossa on paljon koodin analysointiin liittyviä asetuksia. Laittamalla päälle staattisen analyysin (Perform Static Code Checking) saadaan käännöksen yhteydessä tulokset tuttuun Error List -ikkunaan:

Tässä esimerkissä nähdään kolme varoitusta, koska StoreObject-metodissa Level-ominaisuuden arvo asetetaan vahingossa virheelliselle alueelle, eli kahteen kun sallitut arvot ovat nolla ja yksi. Huomaa, että pienelläkin sovelluksella tämän analyysin laskeminen kestää helposti kymmenenkin sekuntia, joten tulokset tulevat Error List -ikkunaan viiveellä.

Lisäosa tuo mukanaan myös C#- ja Visual Basic -kielisiä koodinpätkiä (code snippets), joita voi käyttää koodisopimusten kirjoittamisen apuna.

Jos haluat tarkempaa tietoa Code Contracts -toiminnoista, lukaise ihmeessä läpi kattava dokumentaatio.

Parempaa koodausvuotta 2012 kaikille!