4IT101 Testování a ladění, dokumentace API třídy,

Prezentace na téma: "4IT101 Testování a ladění, dokumentace API třídy,"— Transkript prezentace:

1 4IT101 Testování a ladění, dokumentace API třídy,
třída Object-některé metody, datové struktury – seznamy

2 Testování a ladění

3 Jednotkové testování Slouží k testování jednotlivých tříd.
Testuje se každá metoda (neprivátní), která vrací hodnotu. Zda při zadaných vstupech vrací odpovídající výstupy. Testuje se také, zda metoda správně vyhazuje výjimky, či zda nevyhazuje výjimky v případě správných vstupů.

4 Postup práce při vývoji podporovaném testy
navrhnout rozhraní vytvářené a testované třídy navrhnout a implementovat testy naimplementovat vytvářenou třídu spustit testy dokud neprojdou všechny testy, upravovat kód a znovu testovat

5 JUnit Testovací framework JUnit je přímo zakomponován v BlueJ ve verzi 4.8. Open Source nástroj pro testování tříd napsaných v Javě (i tento nástroj je napsán v Javě) K dispozici na ve verzi od verze 4.0 se používají anotace

6 Vytváření testů v JUnit
Testy jedné třídy se vytváří jako samostatná třída. Každý test je jedna metoda, výsledek (projde/neprojde) se zjistí: pomocí metody assertXxx – porovnávají se očekávané hodnoty a skutečné hodnoty, pomocí metody fail(String textChyby) se ohlásí chyba – používá se v případě, že nelze použít metoda assertXxx (např. při zjišťování, zda se opravdu vyskytne výjimka),

7 Metody assertXxx() assertEquals(očekávanáHodnota, skutečnáHodnota)
assertEquals(zpráva,očekávanáHodnota, skutečnáHodnota) assertFalse(podmínka) assertFalse(zpráva, podmínka)

8 Metody assertXxx() assertTrue assertNull assertNotNull assertSame
assertNotSame

9 Používané anotace @Test - označuje test, v každé testovací třídě několikrát @Before - označuje metodu spouštěnou před každým testem (testovací přípravek, setUp) @After – označuje metodu spouštěnou po každém testu (tearDown) @BeforeTest @AfterTest

10 Pořadí spouštění metod při spuštění testů
Metoda Metoda Metoda Metoda …………. Metoda

11 Importy při testování import org.junit.After; import org.junit.Before;
import org.junit.Test; import static org.junit.Assert.*;

12 Debugging Použití speciálního nástroje, který je buď samostatný nebo je součástí vývojového prostředí Pomocí zarážek (breakpointů) zastavuje provádění kódu a umožňuje krokování a prohlížení obsahu proměnných a datových atributů

13 Debugger v BlueJ Spuštění přes volbu Zobrazit
Umožňuje nastavit zarážky a krokovat kód Umožňuje prohlížení aktuálního obsahu proměnných Nastavení zařážek Kód musí být přeložený Kliknete myší na číslo řádku kódu, kde chcete provádění zastavit (objeví se značka stop)

14

15

16

17 Dokumentace

18 Druhy dokumentace Uživatelská Programátorská Help Manuál
Grafická – diagramy tříd, sekvenční diagramy, atd. Dokumentace kódu (dokumentace API) Vlastní kód (včetně případných komentářů)

19 Dokumentace API Javy Formát html
Dostupná na odkaz je i na java.vse.cz

20 Tvorba dokumentace kódu
Podpora pro tvorbu dokumentace je zabudována již přímo v jazyce. Součástí Java SE SDK je nástroj javadoc, který generuje dokumentaci přímo ze zdrojových kódů tříd opatřených strukturovanými komentáři.

21 Javadoc Do zdrojového kódu se na určená místa připisují komentáře uvozené /** Komentáře, které budou součástí dokumentace, mohou obsahovat i html kód pro formátování. V komentářích se používají speciální značky pro javadoc, které se pak příslušným způsobem promítají do dokumentace.

22 Značky pro javadoc @author jméno @version označení @param název popis
@return popis @throws název popis @exception název popis @deprecated komentář @since verze @see odkaz link název text}

23 Komentář k celé třídě /**
* Tato třída implementuje interface Kalkulator, které představuje komunikační rozhraní * mezi logikou a grafikou jednoduché celočíselné kalkulačky. * Třída implementující toto rozhraní představuje logiku aplikace. * Rozhraní má tři skupiny metod: * a) pomocí metody getHodnotaKZobrazeni grafická třída zjišťuje co má zobrazit na * displeji, * b) metody cislice, plus, minus, rovnaSe a vymaz se volají při stisknutí příslušné * klávesy na kalkulačce, * c) metody getAutor a getVerze jsou informační * Jarmila Pavlíčková */ public class MujKalkulator implements Kalkulator {

24 Vygenerovaná dokumentace

25 Komentáře k jednotlivým metodám
/** * Metoda vrací hodnotu, která se má zobrazit na displayi kalkulacky. Tato metoda * se obvykle volá po zavolání metody odpovídající stisku tlačítka. * hodnota k zobrazení */ public int getHodnotaKZobrazeni() { return 0; } * metoda se volá při stisknutí tlačítka s číslicí na kalkulačce. Parametrem * je hodnota na stisknuté klávese. hodnota hodnota na stisknutém tlačítku, hodnota je v rozsahu * od 0 do 9 public void cislice(int hodnota) { Komentáře k jednotlivým metodám

26 Vygenerovaná dokumentace

27 Třída Object

28 protected a clone()

29 Metoda toString() public String toString()
Překrývání této metody je doporučeno Metoda je použita automaticky kdykoli je instance třídy parametrem metody System.out.println() nebo použijete operátor + a druhý operand je typu String Když metodu ve Vaší třídě nepřekryjete, bude výpis obsahovat jméno třídy a hashCode např.

30 Metoda toString() ve třídě Ucet
public class Ucet { private int cislo; private String vlastnik; private double stav; @Override public String toString() { return ("Ucet cislo: "+cislo+",vlastnik: "+vlastnik); }

31 Tato anotace je kontrolovaná překladačem a nedovolí metodu přetížit pouze překrýt (nedovolí vám napsat jinak hlavičku metody)

32 Metoda equals() public boolean equals( Object o)
je reflexivní, tj. x.equals(x) = true je symetrická, tj. x.equals(y)= true pouze tehdy když y.equals(x)=true je tranzitivní, tj. když x.equals(y)=true a y.equals(z) = true tak x.equals(z) musí vrátit také true je konzistentní, tj. pro nezměněné instance vrací vždy stejnou hodnotu pro všechny hodnoty, které nejsou null, vrací x.equals(null) false metoda equals() by měla záviset na datových atributech, které se v průběhu života instance nemění

33 Metoda equals() Ucet ucet1 =new Ucet(1,"Dana",10);
boolean rovnost = (ucet1==ucet2); boolean rovnost2 = ucet1.equals(ucet2); ucet1 reference ucet2 1,"Dana",10.0 1,"Dana",10.0

34 Kdy nepřekrývat equals()
Každá instance dané třídy je svou podstatou jedinečná, to platí pro třídy, které představují aktivní jednotky např. třída Thread představující vlákno aplikace. Porovnání dvou instancí je pro aplikaci nepodstatné, např. porovnání dvou generátorů náhodných čísel.

35 Kdy nepřekrývat equals()
Metoda equals() je již překrytá u předka a implementace vyhovuje i u potomka (blížší informace při výkladu dědičnosti). Daná třída je soukromou vnitřní třídou a metodu equals() nebude nikdo moci „z venku“ zavolat a mi ji nepotřebujeme

36 Postup při překrývání equals
Porovnáme odkazy, pokud jsou shodné vrátíme hodnotu true. Pomocí operátoru instanceof ověříme, za parametr je správného typu. Pokud parametr není odpovídajícího typu, vrátíme hodnotu false. V dalším kroku převedeme (přetypujeme) parametr na odpovídající typ. Pro každý „významný” atribut (atribut, který jste se rozhodli zařadit do porovnávání) zjistíme rovnost.

37 Zjišťování rovnosti datových atributů
Pro zjišťování rovnosti datových atributů, které jsou primitivního typu, použijeme ==. Pro porovnání referenčních typů metodu equals(). U hodnot referenčních typů je třeba ještě před porovnáváním zjistit, zda neobsahují hodnotu null, protože by při volání metody equals() byla vyhozena výjimka NullPointerException.

38 Metoda equals() ve třídě Prostor
public class Prostor { private String nazev; …………………………………………… @Override public boolean equals(Object o) { if (this == o) { return true; } if (!(o instanceof Prostor)) { return false; Prostor druhy = (Prostor) o;

39 Metoda equals() ve třídě Prostor
if (this.nazev != null && druhy.nazev != null && this.nazev.equals(druhy.nazev)) { return true; } else { if (this.nazev == null && druhy.nazev == null) { }   else { return false; //return (java.util.Objects.equals(this.nazev, druhy.nazev));

40 Datové struktury

41 Datové struktury jaro Pepa Jarmila léto Jakub podzim Honza zima Filip
Lukáš Tomáš ... jaro léto podzim zima Kolekce Seznamy Množiny Fronty Pole Jednorozměrná vícerozměrná Mapy Výčtový typ

42 Pepa Vašek Dušan Luboš Jarmila Renata 5806 pondělí úterý středa čtvrtek pátek

43 Kolekce Rozhraní Implementace Algoritmy Generické typy Collections
vysvětlit i rozhraní Collections

44 Základní vlastnosti seznamů (List)
Libovolný počet prvků Udržuje pořadí Může obsahovat více prvků stejné hodnoty Lze používat indexy

45 Operátor diamand, novinka Javy 7.0
Vytvoření seznamu List <Ucet> seznamUctu = new ArrayList<Ucet>(); List <Ucet> seznamUctu = new ArrayList<>(); List<String> seznam = new ArrayList<String>(); List<String> seznam = new ArrayList<>(); List<Integer> seznamCisel = new ArrayList<Integer>(); List<Integer> seznamCisel = new ArrayList<>(); Operátor diamand, novinka Javy 7.0

46 Vkládání položek do seznamu
Metoda add(E prvek) seznamUctu.add(new Ucet (1,“Pepa“, ); seznam.add(“pes”); seznam.add(“kočka”);

47 Základní vlastnosti množin (Set)
Libovolný počet prvků Neudržuje pořadí Nemůže obsahovat více prvků stejné hodnoty Nelze používat indexy

48 Vkládání položek do množiny
Metoda add(E prvek) Set<String> mnozina = new HashSet<String>(); Set<String> mnozina = new HashSet<>(); mnozina.add("pes"); mnozina.add("kočka"); mnozina.add("morče");

49 Metody rozhraní Collection<E>
Metoda Užití boolean add (E element) Přidá do kolekce prvek typu E. Pokud se operace nepodaří, vrací false. void clear( ) Zruší všechny prvky v kolekci. boolean contains(Object o) Vrací true, jestliže kolekce obsahuje prvek uvedený jako argument metody. boolean isEmpty( ) Vrací true, jestliže je kolekce prázdná. boolean remove(Object o) Jestliže kolekce obsahuje argument, je odpovídající prvek zrušen. Vrací true, když je prvek zrušen. int size( ) Vrací počet prvků uložených v kolekci. Iterator <E>iterator() Vrací instanci rozhraní Iterator, pomocí které je možno procházet tuto kolekci

50 Procházení kolekce - “for each”
for (typ identifikátor : kolekce) { příkaz; } for (String zvire : seznam){ System.out.println(zvire); } Připomenout typ z deklarace kolekce !!! for (String zvire : mnozina){ System.out.println(zvire); }

51 Metody rozhraní List<E>
Metoda Užití void add (int index, E element) Přidá do kolekce na zadanou pozici prvek typu E. E get(int index) Získání prvku na zadané pozici v seznamu. E remove(int index) Zruší prvek ze zadané pozice seznamu, tento prvek vrací jako návratovou hodnotu.

52 Vkládání položky do seznamu na zadanou pozici
Metoda add(int pozice, E prvek) seznam.add(0, “morče”);

53 Rušení položky na zadané pozici seznamu
Metoda remove(int pozice) seznam.remove(1);

54 Procházení seznamu s využitím indexů
for (int i = 0; i < seznam.size(); i++) { System.out.println ("" + i + ". " + seznam.get(i)); } 0. morče 1. kočka 2. pes

55 HashSet – vkládání prvků a jejich shodnost
Jestli jsou dvě instance jedné třídy shodné, je dáno implementací metody equals() Pro vkládání do HashSetu se využívá i metoda hashCode()

56 2 Set<Pes> seznamPsu = new HashSet<>();
public class Pes { private String jmeno; private String rasa; public Pes(String jmeno, String rasa) { this.jmeno = jmeno; this.rasa = rasa; } public String getJmeno() { return jmeno; public String getRasa() { return rasa; Set<Pes> seznamPsu = new HashSet<>(); seznamPsu.add(new Pes("Alík", "voříšek")); System.out.println(seznamPsu.size()); 2

57 2 @Overiide public boolean equals(Object obj) { if (this == obj)
return true; if (obj == null) return false; if (obj instanceof Pes){ Pes druhy = (Pes) obj; return (java.util.Objects.equals(this.jmeno, druhy.jmeno)); } else{ } Set<Pes> seznamPsu = new HashSet<>(); seznamPsu.add(new Pes("Alík", "voříšek")); System.out.println(seznamPsu.size()); 2

58 Metoda hashCode() public int hashCode()
Metoda pro vytvoření vnitřního kódu pro každou instanci. Pro správné fungování např. v HashTable musí splňovat tato pravidla: Je konzistentní, tj. pro nezměněné instance vrací vždy stejnou hodnotu. Pro dvě instance, které jsou si rovny na základě použití metody equals() vrací stejnou hodnotu. Nemusí platit obráceně

59 Jak překrývat hashCode()
Do proměnné result typu int uložíme nějakou nenulovou hodnotu Pro každý datový atribut, který byl použit pro určování rovnosti v metodě equals(), vypočtěte jeho hešovací kód. Pro každý datový atribut přidejte jeho hodnotu do proměnné result takto: result = 37 * result + hashAtributu; Nakonec vrátíme hodnotu proměnné result.

60 hashCode() datových atributů
Pro typ boolean pro hodnotu false je hešovací kód 0 pro hodnotu true 1 Pro číselné typy a typ char je hešovací kód hodnota atributu přetypovaná na int. Pro objektové typy zavolejte metodu java.Objects.hashCode(datovyAtribut) Pro datové atributy, které jsou kontejnerového typu, sečtěte dohromady hešovací kódy každého prvku

61 1 @Override public int hashCode(){ int result = 3;
int hashJmena = java.util.Objects.hashCode(this.jmeno); result = 37 * result + hashJmena; return result; } Set<Pes> seznamPsu = new HashSet<>(); seznamPsu.add(new Pes("Alík", "voříšek")); System.out.println(seznamPsu.size()); 1

62 Co někdy příště o kolekcích
procházení pomocí iterátoru třídění kolekcí složitější vyhledávání v kolekci vyhledávání - seznam účtů, vyhledání dle čísla účtu či dle vlastníka

63 Použité zdroje java.sun.com Pavlíčková, Pavlíček : Úvod do Javy
Pecinovský: Myslíme objektově v jazyku Java 5.0 Eckel: Myslíme v jazyku Java, dva díly – Grada