Felsökning. Översikt. Felsökning (debugging) Kodstandard. Kommentarer. Kommentarer. Praktiska råd

Transkript

1 Översikt Felsökning Praktiska råd Felsökning i IDE Javadoc Kommersiella mjukvaruprojekt Allmänt om felhantering i Java Catch - throw Systematisk testning av större system Programmering tillämpningar och datastrukturer 2 Felsökning (debugging) Kodstandard Kan följa programmet steg för steg Syftet med kodstandard Step into Step over Andra programmerare ska kunna känna igen sig i koden Regler för Breakpoints Watch Variabelnamn Indentering Placering av klammer Kommentarer TODO Var konsekvent Följ gärna Skansholm Programmering tillämpningar och datastrukturer 3 Programmering tillämpningar och datastrukturer 4 Kommentarer Kommentarer Viktigt att dokumentera För sig själv, för medarbetare, utomstående Hur tänkte jag här» Vilket problem löste jag och hur Hur koden är tänkt att användas/anropas TODO (saker som ska åtgärdas) Underlättar framtida underhåll Hjälper utomstående Förstå koden Bra verktyg i NetBeans: Tools Auto Comment Hjälper till med de olika delarna av Javadoc-kommentarer Build Generate Javadoc Genererar html-dokumentation Använda koden på rätt sätt! Programmering tillämpningar och datastrukturer 5 Programmering tillämpningar och datastrukturer 6 1

2 Eclipse Javadoc för hand Bra verktyg i Eclipse: Skriv in dina kommentarer i filen Project Generate Javadoc Genererar html-dokumentation Debug perspective Variables Show logical structure Tasks-fliken Expressions Watch Sedan >> javadoc MinKlass.java Om du vill att även privata variabler och metoder ska dokumenteras: >> javadoc -private MinKlass.java Programmering tillämpningar och datastrukturer 7 Programmering tillämpningar och datastrukturer 8 Kommentarer Kommentarer Exempel på Javadoc kommentar: /** * Creates an iterator for LinkedList objects. the new iterator object. */ public MyListIterator iterator() { return new MyListIterator(0); Exempel på kommentar som inte kommer att tas med i Javadoc: /* Checks that there is at least one element in the list * */ Kortkommando i Eclipse: Alt-Shift-J else { // we are now at the beginning of the list first = lastret.next; Programmering tillämpningar och datastrukturer 9 Programmering tillämpningar och datastrukturer 10 Kommersiella mjukvaruprojekt Större projekt Mjukvaror har lång livscykel Måste kunna förändras (p.g.a. förändrade krav) Underhållas (fel rättas) Oftast inte av samma team som utvecklade systemet! Programmering tillämpningar och datastrukturer 12 2

3 Systemets livscykel Aktiviteter som ingår Olika faser Vattenfallsmodellen (waterfall model) Steg-för-steg progression Moment 1 avslutas innan moment 2 Unified software lifecycle model Överlappande arbetsflöden (workflows) Kravspecifikation Design Systemarkitektur Komponentnivå (paket) Detaljerad nivå (individuella klasser) Implementation Test Enhets integrations systemtest Installation (utbildning av användare) Underhåll Programmering tillämpningar och datastrukturer 13 Programmering tillämpningar och datastrukturer 14 Kravspecifikation Design Analys av kundens krav på systemet Typer av användare Datorvan teknisk personal Administratörer Användningsfall Use cases, dvs. hur en typisk sekvens av interaktion med systemet kan se ut Från användarhåll Önskemål om funktioner som systemet ska tillhandahålla På olika nivåer Systemarkitektur Delsystem Programenheter Kan implementeras av en eller ett par programmerare Ex. abstrakta datastrukturen lista Funktioner eller klasser Kommunikation mellan dessa Programmering tillämpningar och datastrukturer 15 Programmering tillämpningar och datastrukturer 16 Structured design Objektorienterad design (OOD) Fokus på vad ska utföras (actions) Dela upp i delproblem Delarna är lättare att lösa var för sig Modellering av ingående objekt (t.ex. klasser) och deras metoder Substantiv i kravspec objekt Fokus på data-enheter Vilka enheter som behövs Verb i kravspec metoder Vad som ska kunna utföras på dessa enheter Programmering tillämpningar och datastrukturer 17 Programmering tillämpningar och datastrukturer 18 3

4 Implementering Programfel Förverkliga de klasser och metoder som ska finnas enligt designen Kommentera koden Syfte med koden, dess funktion Vilka argument (namn, beskrivning) Vilket resultat (namn, beskrivning) Ytterligare kommentarer om hur koden är tänkt att IllegalArgumentException om Syntaktiska fel Upptäcks av kompilatorn Fel under körning (exceptions) Upptäcks när programmet kraschar Logiska fel Upptäcks kanske aldrig! Leder kanske inte till krasch, utan till konstigt beteende Ex. avslutar loop efter ett varv Programmering tillämpningar och datastrukturer 19 Programmering tillämpningar och datastrukturer 20 Exempel på logiskt fel Exempel på logiskt fel public boolean containselement(el el, MyList lista) { while (i<lista.size()) { if (lista.get(i)==el) { return true; else { return false; public boolean containselement(el el, MyList lista) { while (i<lista.size()) { if (lista.get(i)==el) { return true; return false; Programmering tillämpningar och datastrukturer 21 Programmering tillämpningar och datastrukturer 22 Syntaktiska fel Fel under körning Glömda eller felaktigt placerade { ; Använt fel operator på primitiva datatyper Kan orsakas av dels yttre, dels inre omständigheter Yttre orsaker Ex. if (sträng == Kalle ) istf sträng.equals( Kalle ) Användaren ger felaktigt in-argument Glömt return ; i en metod Odeklarerade, oinstansierade variabler Filen finns inte Inre orsaker Loop över array Index hamnat utanför Oändlig loop har ätit upp allt minne Programmering tillämpningar och datastrukturer 23 Programmering tillämpningar och datastrukturer 24 4

5 Fel under körning Exeptions Bearbetningen stoppas Exceptions genereras genom throw JVM skapar ett exception-objekt Info om typ av fel Sträng-meddelande Var felet uppstod Kedjan av anrop som ledde hit (stack trace) Variabelbindningar i detta ögonblick else { throw new NoSuchElementException(); Programmering tillämpningar och datastrukturer 25 Programmering tillämpningar och datastrukturer 26 Typer av exceptions Exceptions Checked (utanför din kontroll) Beror på yttre omständigheter File not found Unexpected end of file (EOF) IO (t.ex. fel vid inmatning) Unchecked (ofta självförvållat) Mildare programmeringsfel Index out of bounds Totalkrasch Out of memory Checked (tom fil, IO-fel, inmatningsfel) Måste hanteras av programmeraren Unchecked (null pointer, index out of ) Behöver inte hanteras Unchecked (out of memory) Bör inte hanteras! Ytterligare körning av programmet kan förvärra läget Programmering tillämpningar och datastrukturer 27 Programmering tillämpningar och datastrukturer 28 Hantering av exceptions Exceptions-hierarkin Try catch try { // fråga efter och läs in ålder från inputfönster catch(ioexception ex) { System.err.println( Inmatningsfel ); // informera användaren ålder = DEFAULT_ÅLDER; // sätt till defaultvärde Programmering tillämpningar och datastrukturer 29 Programmering tillämpningar och datastrukturer 30 5

6 Multipla catch Multipla catch try { // fråga efter och läs in filnamn catch(ioexception ex) { catch(filenotfoundexception ex) { Går ej att nå! (ger syntax error) try { // fråga efter och läs in filnamn catch(filenotfoundexception ex) { catch(ioexception ex) { Programmering tillämpningar och datastrukturer 31 Programmering tillämpningar och datastrukturer 32 Finally Throw try { // fråga efter och läs in antal catch(numberformatexception ex) { // var ej positivt heltal finally { if (antal > MAX) { // se till att antal alltid < MAX antal = MAX; public void lägginnamn(string namn) { if (!rättformat(namn)) { throw new IllegalArgumentException(<meddelande>); // annars utför metod Ett eget fel(meddelande) genereras Programmering tillämpningar och datastrukturer 33 Programmering tillämpningar och datastrukturer 34 Mer om catch Throws Hierarki av catch-klausuler i anropskedjan Ska helst fånga upp felet där orsaken finns Störst chans att kunna åtgärda problemet där det uppstod Ex. anrop av metod med argument utanför tillåtet intervall Bäst att hantera detta hos anroparen Kanske felet orsakades högre upp i anropshierarkin? Throws: sätt att låta någon annan (t.ex anroparen till anroparen) hantera en exception public void läsdata throws IOException, EOFException { Felet uppstår här, men public void initieradata() { kastas vidare upp till try { ;.läsdata(); anroparens anropare catch (EOFxception ex) { ex.printstacktrace(); catch (IOException ex) { System.err.println(... ); Programmering tillämpningar och datastrukturer 35 Programmering tillämpningar och datastrukturer 36 6

7 Logiska fel i programmet Logiska fel Målet med testning En satellit störtade p.g.a. följande fel Försöka upptäcka alla logiska fel Upptäcks kanske aldrig om det ligger i en del av programmet som inte körs igenom if (höjd > maxhöjd) skickameddelandeomattmaxhöjdenäröverskriden(); Men det är ju lika bra att justera höjden på en gång, tyckte någon annan i teamet if (höjd > maxhöjd) skickameddelandeomattmaxhöjdenäröverskriden(); höjd = höjd - 1; Programmering tillämpningar och datastrukturer 37 Programmering tillämpningar och datastrukturer 38 Lärdom Strukturerad genomgång Använd alltid klammer för att markera blocken i villkorssatser Även om just nu bara en sats i blocket Designern förklarar algoritmen för andra team-medlemmar Handsimulerar programmet inför andra team-medlemmar Programmering tillämpningar och datastrukturer 39 Programmering tillämpningar och datastrukturer 40 Enhetstest (unit testing) Integrationstest Test av enskilda moduler Hur modulerna interagerar Klass Komplex metod I ett större projekt: Den kod som en enskild programmerare har skrivit Hur anrop exekveras (vad som returneras) Hur kod från olika programmerare fungerar tillsammans Testfall baseras ofta på use-cases Test av interaktion med användaren och externa enheter för specifika användningssekvenser Programmering tillämpningar och datastrukturer 41 Programmering tillämpningar och datastrukturer 42 7

8 Systemtest Acceptanstest Test av hela systemet som ska levereras Program ingår ofta i ett större sammanhang Ska fungera tillsammans med andra program MPEG decoder Drivrutiner Mjukvara för redigering av video Filhantering i operativsystemet Filhantering på DVD-skivan Utförs oftast hos kunden efter installation Test om systemet uppfyller funktionskraven Innehåller de funktioner som utlovats till kunden Fungerar i den miljö som kunden har (Windows) Programmering tillämpningar och datastrukturer 43 Programmering tillämpningar och datastrukturer 44 Testmetoder Metoder för att testa Blackbox-testning (funktionell testning) Testar input output relationen Tar inte hänsyn till programstrukturen White-box testning (coverage testing) Testar olika vägar i programmet Programmering tillämpningar och datastrukturer 46 White-box testning White-box (coverage) testning Målet är att testa så många alternativa vägar som möjligt men kombinationen av olika utfall på if-satser, etc. är för stort Statement coverage Alla satser ska köras under testning åtminstone en gång Tar inte hänsyn till vilken väg fram till denna programsats, dvs. hur variabler är satta Branch coverage Alla grenar (if-satser, switch, loops) körs åtminstone en gång Testar alla kombinationer på sats-nivå Path coverage (i praktiken omöjligt) Testar alla kombinationer av grenar (= alla vägar genom programmet) n grenar ger 2 n vägar för n if-satser Programmering tillämpningar och datastrukturer 47 Programmering tillämpningar och datastrukturer 48 8

9 Förbereda testing Förbereda testning (forts) Testdata bör bestämmas redan under analys- och design-fasen Testplan ska upprättas tidigt under design-fasen (ex.vis) strukturerad genomgång med teamet kan pågå delvis parallellt med designen Defensiv programmering underlättar Inkludera kod som upptäcker och hanterar ogiltiga data Om en metod förutsätter n > 0, testa för detta i början av metoden och generera en Exception Annars kan felet propageras, och orsaka konstigt beteende någon annanstans i programmet Kan vara svårt att spåra felet tillbaks till ursprunget Programmering tillämpningar och datastrukturer 49 Programmering tillämpningar och datastrukturer 50 Leta fel Vanliga fel (forts) Randvillkor Om n ska ligga mellan 0 och 10, testa vad som händer när n = -1 (utanför listan) 0 (i början på listan) 5 (inne i listan) 10 (i slutet på listan) 11 (utanför listan) Blir det körningsfel eller oväntade, konstiga svar från metoden? Arrayer Om element med en viss egenskap söks i array a, testa vad som händer när det sökta elementet är Först (index 0) Sist (index a.length-1) Finns ej med Fler än ett element har sökta egenskapen a är tom (har inga element) Programmering tillämpningar och datastrukturer 51 Programmering tillämpningar och datastrukturer 52 Vanliga fel (forts) Extrem programmering Loopar Kolla vad som händer om while-testet är falskt från början (= 0 loopar körs) En loop körs Om for-loopen körs till slutet Pinsamt (ibland farligt) fel: Loopen stannar aldrig Programmerare jobbar i par Den ena programmerar Den andra utvecklar testfall (utifrån kravspec) Turas om Undviker fällan att man inte ser sina egna misstag Att man inte testar de självklara fallen Programmering tillämpningar och datastrukturer 53 Programmering tillämpningar och datastrukturer 54 9

10 Stubs Stubs (forts) Fusk-kod innan den riktiga koden är klar Används för att simulera svar från metod i en annan modul Stub = fusk-kod för den anropade metoden Samma header som metoden kommer att ha, men förenklad kod Ex. skriv ut att du har blivit anropad, med vilka argument Returnera enkla, förutsägbara värden Sätt interna variabler enligt förenklad regel Programmering tillämpningar och datastrukturer 55 Programmering tillämpningar och datastrukturer 56 Drivers Tester Speciell anropare av en modul Testfall Deklarerar variabler, skapar och initierar objekt Anropar metoden med lämpliga argument Registrerar (och/eller skriver ut) alla output-värden Uppsättning av en miljö (variabler) + ett anrop Testsvit En samling testfall Kan köra igenom en testsvit och automatiskt jämföra resultatet Korrekt/felaktigt svar från programmet Programmering tillämpningar och datastrukturer 57 Programmering tillämpningar och datastrukturer 58 Testramverk JUnit Mjukvarumiljö för att köra igenom testsviter Bra för bl.a. regressionstest Har ändrat i en modul, hur påverkas resten av programmet? Kan köra igenom en lagrad testsvit och automatiskt registrera (rätt/fel) på varje gammalt testfall Testramverk för Java Levereras med NetBeans och JBuilder Kan även laddas ner separat från junit.org Programmering tillämpningar och datastrukturer 59 Programmering tillämpningar och datastrukturer 60 10