SW_10. Dekorátor - Decorator Stav - State

Transkript

1 SW_10 Dekorátor - Decorator Stav - State 1

2 Úvod Dekorátor Naučíte se jak zkrášlovat (decorate) vaše třídy za běhu programu s využitím skládání objektů. Tímto způsobem budete schopni dát vašim objektům novou funkčnost bez přidávání jakéhokoli kódu do základních tříd. 2

3 Kontext: Úvod Dekorátor Malé změny chování objektu za běhu programu. Problém: Jak využít skládání pro dynamické změny chování objektu. 3

4 Řešení: Úvod Dekorátor Návrhový vzor Dekorátor, který dovoluje skládat nové varianty operace za běhu programu. 4

5 Příklad Kavárna rychle se rozvíjející obchod. Rychle rostoucí nabídka nápojů různě kombinovaných. Prvotní struktura tříd: 5

6 Příklad K vaší kávě si můžete objednat řadu přísad: vařené mléko, soju, mochu a ještě to završit se smetanou. Kavárna si účtuje zvlášť za každou položku, co si zákazník zvolí. To také potřebují zabudovat do svého systému výpočtu ceny. Jedna z možností je mít jednu třídu Nápoj a vše ostatní jako podtřídy této jedné nadtřídy. 6

7 Příklad Uvedené řešení bude působit problémy v údržbě systému. Co se stane, když se zvýší cena mléka? Co se stane, když se přidá nová karamelová příchuť? 7

8 Příklad Potřebujeme všechny ty třídy? Nestačily by pouze instanční proměnné? Boolovská hodnota pro každou přísadu. Cena se spočítá podle počtu přísad. description milk soy mocha whip Beverage getdescription() cost() hasmilk() setmilk() hassoy() setsoy() hasmocha() setmocha() haswhip() setwhip() // other methods 8

9 Příklad Cena v nadtřídě bude počítat ceny v podtřídách. Každá z podtříd spočítá hodnotu přísad a zavolá metodu pro výpočet ceny z nadtřídy. HouseBlend description milk soy mocha whip getdescription() cost() hasmilk() setmilk() hassoy() setsoy() hasmocha() setmocha() haswhip() setwhip() Beverage // other methods DarkRoast Decaf Espresso cost() cost() cost() cost() 9

10 Příklad Neřeší úplně problémy rozšiřování do budoucna. Měnící se ceny přísad nás nutí měnit kód. Nové přísady nás nutí přidat nové metody a změnit metodu cost() v nadtřídě. Pro nový nápoj nemusí být všechny z existujících přísad vhodné. Co když chce zákazník double mocha? 10

11 Princip otevření-zavření Open Closed principle Třídy by měly být otevřené pro rozšíření, ale uzavřené pro modifikaci. Našim cílem je dovolit třídám, aby byly snadno rozšiřitelné pro začlenění nového chování bez modifikace existujícího kódu. Čeho tím dosáhneme? Návrhy, které jsou odolné změnám a dostatečně flexibilní pro přijetí nové funkcionality, aby vyhověly měnícím se požadavkům. 11

12 Otevření pro změny, uzavření pro modifikace? Zní to protichůdně. Existují OOP techniky, umožňující rozšíření beze změny existujícího kódu. přidání dalších pozorovatelů Observer Ač se to může zdát protichůdné, existují techniky, kterém dovolují rozšíření kódu bez přímé modifikace. Opatrnost při výběru částí kódu, které potřebují rozšíření. Aplikace principu je všude zbytečná. 12

13 Konstrukce nápojové objednávky s Dekorátorem 1. DarkRoast dědí ze třídy Beverage metodu cost(), která počítá cenu nápoje. 2. Mocha dekorátor, ale také nápoj (podtřída Beverage) 3. Whip - dekorátor 13

14 Konstrukce nápojové objednávky s Dekorátorem 1. Volání metody cost() dekorátoru Whip. 2. Whip volá cost() na Mocha. 3. Mocha volá cost() na DarkRoast. 4. DarkRoast vrací 99 centů. 5. Mocha přidává 20 centů ($1.19). 6. Whip přidává 10 centů - ($1.29). 14

15 Dekorátor Dekorátory mají stejnou nadtřídu jako objekty, které dekorují. Je možné použít jeden nebo více dekorátorů, které obalí (wrap) daný objekt. To, že dekorátor a objekt mají stejnou nadtřídu umožňuje nechat kolovat dekorátor místo dekorovaného objektu. Dekorátor přidává své vlastní chování buď před, nebo po delegování objektu, který dekoruje, aby udělal zbytek práce. 15

16 Dekorátor Objekty mohou být dekorovány kdykoli, můžeme dekorovat objekty dynamicky za běhu, tolika dekorátory, kolik se nám zlíbí. 16

17 Vzor Dekorátor Vzor Dekorátor přidává dodatečnou funkčnost (chování) objektu dynamicky. Dekorátory poskytují flexibilní alternativu k dědičnosti pro rozšíření funkcionality. 17

18 Vzor Dekorátor ConcreteComponent je objekt, jehož funkcionalitu rozšiřujeme. Component methoda() methodb() // other methods Každá component může být použita samostatně, nebo obalena dekorátorem. ConcreteComponent methoda() methodb() // other methods Decorator methoda() methodb() // other methods Dekorátory implementují stejné rozhraní abstraktní třídy, jako komponenty, které dekorují. ConcreteDecoratorA má datový atribut pro odkaz na objekt, který dekoruje. ConcreteDecoratorA Component wrappedobj methoda() methodb() newbehavior() ConcreteDecoratorB Component wrappedobj() Object newstate methoda() methodb() Dekorátor může rozšířit stav komponenty. // other method // other methods 18

19 Konkrétní příklad 19

20 public abstract class Beverage { String description = "Unknown Beverage"; Poznámky public String getdescription() { return description; public abstract double cost();

21 public abstract class CondimentDecorator extends Beverage { public abstract String getdescription(); Poznámky 21

22 public class Espresso extends Beverage { Poznámky public Espresso() { description = "Espresso"; public double cost() { return 1.99; 22

23 public class HouseBlend extends Beverage { public HouseBlend() { description = "House Blend Coffee"; Poznámky public double cost() { return.89; 23

24 public class Mocha extends CondimentDecorator { Beverage beverage; public Mocha(Beverage beverage) { this.beverage = beverage; Poznámky Implementace konkrétního dekorátoru public String getdescription() { return beverage.getdescription() + ", Mocha"; public double cost() { return.20 + beverage.cost(); 24

25 public class StarbuzzCoffee { Poznámky public static void main(string args[]) { Beverage beverage = new Espresso(); System.out.println(beverage.getDescription() + " $" + beverage.cost()); Beverage beverage2 = new DarkRoast(); beverage2 = new Mocha(beverage2); beverage2 = new Mocha(beverage2); beverage2 = new Whip(beverage2); System.out.println(beverage2.getDescription() + " $" + beverage2.cost()); Beverage beverage3 = new HouseBlend(); beverage3 = new Soy(beverage3); beverage3 = new Mocha(beverage3); beverage3 = new Whip(beverage3); System.out.println(beverage3.getDescription() + " $" + beverage3.cost()); Espresso $1.99 Dark Roast Coffee, Mocha, Mocha, Whip $1.49 House Blend Coffee, Soy, Mocha, Whip $

26 Reálné dekorátory Java I/O Java I/O třídy využívají dekorátory. Dva dekorátory a jeden objekt. 26

27 import java.io.*; public class LowerCaseInputStream extends FilterInputStream { public LowerCaseInputStream(InputStream in) { super(in); Poznámky FileInputStream je abstraktní dekorátor pro pšechny InputStreamy. public int read() throws IOException { int c = super.read(); return (c == -1? c : Character.toLowerCase((char)c)); public int read(byte[] b, int offset, int len) throws IOException { int result = super.read(b, offset, len); for (int i = offset; i < offset+result; i++) { b[i] = (byte)character.tolowercase((char)b[i]); return result; Potřebujeme dvě metody read(). Jednu pro byty a druhou pro pole bytů. 27

28 import java.io.*; Poznámky public class InputTest { public static void main(string[] args) throws IOException { int c; try { InputStream in = new LowerCaseInputStream( new BufferedInputStream( new FileInputStream("test.txt"))); while((c = in.read()) >= 0) { System.out.print((char)c); in.close(); catch (IOException e) { e.printstacktrace(); 28

29 Shrnutí - Dekorátor Vzor Dekorátor můžeme použít všude tam, kde by řešení rozšíření funkcionality děděním přinášelo problémy se vznikem kombinací výsledných řešení, to je problémy se statickou neměnnou vazbou. Příklady využití uvedeného vzoru můžeme nalézt v javovské knihovně pro práci se streamy. Tam můžeme využívat vkládání instancí do sebe. 29

30 Shrnutí - Dekorátor Vzor Dekorátor poskytuje flexibilní návrh v případech, kdy potřebujeme kombinovat různé implementace operací za běhu programu. 30

31 Kontext: Vzor Stav - State Stav objektu je dán kombinací aktuálních hodnot jeho datových atributů. Hodnoty těchto atributů měníme pomocí metod set(). Při zaslání zprávy set() objektu, se přiřadí nějaká hodnota příslušnému atributu objektu. Tím se změnil jeho stav. Objekty obyčejně mění své vlastní stavy, při vykonání jejich metod. 31

32 Problém: Stav V některých případech však jednoduchá implementace tohoto principu pomocí if nebo switch příkazů může vést k velmi nepřehledným konstrukcím a jejich obtížné údržbě. 32

33 Schematické zobrazení Stavový diagram činnost prodejního automatu se žvýkačkami. 33

34 public class GumballMachine { Poznámky final static int SOLD_OUT = 0; final static int NO_QUARTER = 1; final static int HAS_QUARTER = 2; final static int SOLD = 3; int state = SOLD_OUT; int count = 0; public GumballMachine(int count) { this.count = count; if (count > 0) { state = NO_QUARTER; 34

35 public void insertquarter() { if (state == HAS_QUARTER) { System.out.println("You can't insert another quarter"); else if (state == NO_QUARTER) { state = HAS_QUARTER; System.out.println("You inserted a quarter"); else if (state == SOLD_OUT) { System.out.println("You can't insert a quarter, the machine is sold out"); else if (state == SOLD) { System.out.println("Please wait, we're already giving you a gumball"); Poznámky public void ejectquarter() { if (state == HAS_QUARTER) { System.out.println("Quarter returned"); state = NO_QUARTER; else if (state == NO_QUARTER) { System.out.println("You haven't inserted a quarter"); else if (state == SOLD) { System.out.println("Sorry, you already turned the crank"); else if (state == SOLD_OUT) { System.out.println("You can't eject, you haven't inserted a quarter yet"); 35

36 public void turncrank() { if (state == SOLD) { System.out.println("Turning twice doesn't get you another gumball!"); else if (state == NO_QUARTER) { System.out.println("You turned but there's no quarter"); else if (state == SOLD_OUT) { System.out.println("You turned, but there are no gumballs"); else if (state == HAS_QUARTER) { System.out.println("You turned..."); state = SOLD; dispense(); Poznámky 36

37 public void dispense() { if (state == SOLD) { System.out.println("A gumball comes rolling out the slot"); count = count - 1; if (count == 0) { System.out.println("Oops, out of gumballs!"); state = SOLD_OUT; else { state = NO_QUARTER; else if (state == NO_QUARTER) { System.out.println("You need to pay first"); else if (state == SOLD_OUT) { System.out.println("No gumball dispensed"); else if (state == HAS_QUARTER) { System.out.println("No gumball dispensed"); Poznámky 37

38 public void refill(int numgumballs) { this.count = numgumballs; state = NO_QUARTER; Poznámky public String tostring() { StringBuffer result = new StringBuffer(); result.append("\nmighty Gumball, Inc."); result.append("\njava-enabled Standing Gumball Model #2004\n"); result.append("inventory: " + count + " gumball"); if (count!= 1) { result.append("s"); result.append("\nmachine is "); if (state == SOLD_OUT) { result.append("sold out"); else if (state == NO_QUARTER) { result.append("waiting for quarter"); else if (state == HAS_QUARTER) { result.append("waiting for turn of crank"); else if (state == SOLD) { result.append("delivering a gumball"); result.append("\n"); return result.tostring(); 38

39 public class GumballMachineTestDrive { public static void main(string[] args) { GumballMachine gumballmachine = new GumballMachine(5); Poznámky Zkouška System.out.println(gumballMachine); gumballmachine.insertquarter(); gumballmachine.turncrank(); System.out.println(gumballMachine); gumballmachine.insertquarter(); gumballmachine.ejectquarter(); gumballmachine.turncrank(); System.out.println(gumballMachine); gumballmachine.insertquarter(); gumballmachine.turncrank(); gumballmachine.insertquarter(); gumballmachine.turncrank(); gumballmachine.ejectquarter(); System.out.println(gumballMachine); 39

40 Zhodnocení postupu Tento kód neodpovídá principu Open Closed (Otevřený pro rozšíření, uzavřený pro modifikace). Přechody stavů nejsou explicitní; jsou uloženy někde uvnitř podmínkových příkazů. Další rozšiřování bude způsobovat chyby v kódu. 40

41 Nový návrh Přepracovat zapouzdřené stavové objekty do vlastních tříd a delegovat aktuální stav, když akce nastane. Postup: 1. Definovat rozhraní State, které obsahuje metodu pro každou akci Gumball Machine. 2. Implementovat rozhraní State pro každý definovaný stav. Tyto třídy budou zodpovědné za chování prodejního automatu, když je v odpovídajícím stavu. 41

42 Nový návrh 3. Zbavit se všeho podmínkového kódu a místo něho delegovat činnosti na třídy stavů. 42

43 Definování rozhraní a tříd Každý stav mapujeme přímo do třídy. 4 stavy = 4 třídy 43

44 Popis stavů NoQuarterState jde na stav HasQuarterState. Říká zákazníkovi, že nevložil minci. HasQuarterState jde na stav SoldState. SoldState říká zákazníkovi ať počká, že dostane žvýkačku. Vydá žvýkačku, zkontroluje jejich stav if > 0, jde na stav NoQuarterState, jinak jde na stav SoldOutState. SoldOutState říká zákazníkovi, že nemá žvýkačky. 44

45 public class NoQuarterState implements State { GumballMachine gumballmachine; Poznámky public NoQuarterState(GumballMachine gumballmachine) { this.gumballmachine = gumballmachine; Datový atribut pro odkaz na gumballmachine. public void insertquarter() { System.out.println("You inserted a quarter"); gumballmachine.setstate(gumballmachine.gethasquarterstate()); public void ejectquarter() { System.out.println("You haven't inserted a quarter"); public void turncrank() { System.out.println("You turned, but there's no quarter"); public void dispense() { System.out.println("You need to pay first"); public String tostring() { return "waiting for quarter";

46 public class GumballMachine { Poznámky State soldoutstate; State noquarterstate; State hasquarterstate; State soldstate; State state = soldoutstate; int count = 0; public GumballMachine(int numbergumballs) { soldoutstate = new SoldOutState(this); noquarterstate = new NoQuarterState(this); hasquarterstate = new HasQuarterState(this); soldstate = new SoldState(this); this.count = numbergumballs; if (numbergumballs > 0) { state = noquarterstate;

47 public void insertquarter() { state.insertquarter(); Poznámky public void ejectquarter() { state.ejectquarter(); public void turncrank() { state.turncrank(); state.dispense(); void setstate(state state) { this.state = state; void releaseball() { System.out.println("A gumball comes rolling out the slot..."); if (count!= 0) { count = count - 1; int getcount() { return count;

48 void refill(int count) { this.count = count; state = noquarterstate; Poznámky public State getstate() { return state; public State getsoldoutstate() { return soldoutstate; public State getnoquarterstate() { return noquarterstate; public State gethasquarterstate() { return hasquarterstate; public State getsoldstate() { return soldstate;

49 public String tostring() { StringBuffer result = new StringBuffer(); result.append("\nmighty Gumball, Inc."); result.append("\njava-enabled Standing Gumball Model #2004"); result.append("\ninventory: " + count + " gumball"); if (count!= 1) { result.append("s"); result.append("\n"); result.append("machine is " + state + "\n"); return result.tostring(); Poznámky

50 public class HasQuarterState implements State { GumballMachine gumballmachine; Poznámky public HasQuarterState(GumballMachine gumballmachine) { this.gumballmachine = gumballmachine; public void insertquarter() { System.out.println("You can't insert another quarter"); public void ejectquarter() { System.out.println("Quarter returned"); gumballmachine.setstate(gumballmachine.getnoquarterstate()); public void turncrank() { System.out.println("You turned..."); gumballmachine.setstate(gumballmachine.getsoldstate()); public void dispense() { System.out.println("No gumball dispensed"); public String tostring() { return "waiting for turn of crank";

51 ublic class SoldState implements State { Poznámky GumballMachine gumballmachine; public SoldState(GumballMachine gumballmachine) { this.gumballmachine = gumballmachine; public void insertquarter() { System.out.println("Please wait, we're already giving you a gumball"); public void ejectquarter() { System.out.println("Sorry, you already turned the crank"); public void turncrank() { System.out.println("Turning twice doesn't get you another gumball!"); public void dispense() { gumballmachine.releaseball(); if (gumballmachine.getcount() > 0) { gumballmachine.setstate(gumballmachine.getnoquarterstate()); else { System.out.println("Oops, out of gumballs!"); gumballmachine.setstate(gumballmachine.getsoldoutstate());

52 public String tostring() { return "dispensing a gumball"; Poznámky

53 Definice vzoru Stav - State Vzor Stav dovoluje objektu měnit své chování, když se změní interní stavy. Zdá se, že objekt změnil svoji třídu. Context request() handle() State ConcreteStateA ConcreteStateB state.handle() handle() handle() 53

54 public class WinnerState implements State { GumballMachine gumballmachine; public WinnerState(GumballMachine gumballmachine) { this.gumballmachine = gumballmachine; Poznámky Rozšíření vzoru public void insertquarter() { System.out.println("Please wait, we're already giving you a Gumball"); public void ejectquarter() { System.out.println("Please wait, we're already giving you a Gumball"); public void turncrank() { System.out.println("Turning again doesn't get you another gumball!");

55 public void dispense() { System.out.println("YOU'RE A WINNER! You get two gumballs for your quarter"); gumballmachine.releaseball(); if (gumballmachine.getcount() == 0) { gumballmachine.setstate(gumballmachine.getsoldoutstate()); else { gumballmachine.releaseball(); if (gumballmachine.getcount() > 0) { gumballmachine.setstate(gumballmachine.getnoquarterstate()); else { System.out.println("Oops, out of gumballs!"); gumballmachine.setstate(gumballmachine.getsoldoutstate()); Poznámky public String tostring() { return "despensing two gumballs for your quarter, because YOU'RE A WINNER!";

56 public class HasQuarterState implements State { Random randomwinner = new Random(System.currentTimeMillis()); GumballMachine gumballmachine; Poznámky public HasQuarterState(GumballMachine gumballmachine) { this.gumballmachine = gumballmachine; public void insertquarter() { System.out.println("You can't insert another quarter"); public void ejectquarter() { System.out.println("Quarter returned"); gumballmachine.setstate(gumballmachine.getnoquarterstate()); public void turncrank() { System.out.println("You turned..."); int winner = randomwinner.nextint(10); if ((winner == 0) && (gumballmachine.getcount() > 1)) { gumballmachine.setstate(gumballmachine.getwinnerstate()); else { gumballmachine.setstate(gumballmachine.getsoldstate());

57 public void dispense() { System.out.println("No gumball dispensed"); Poznámky public String tostring() { return "waiting for turn of crank";

58 public class GumballMachineTestDrive { Poznámky public static void main(string[] args) { GumballMachine gumballmachine = new GumballMachine(10); System.out.println(gumballMachine); gumballmachine.insertquarter(); gumballmachine.turncrank(); gumballmachine.insertquarter(); gumballmachine.turncrank(); System.out.println(gumballMachine); gumballmachine.insertquarter(); gumballmachine.turncrank(); gumballmachine.insertquarter(); gumballmachine.turncrank(); System.out.println(gumballMachine);

59 Shrnutí Stav zapouzdřuje chování, které se mění a používá delegování k rozhodnutí, které chování použít. Návrhový vzor State využívá ker své činnosti polymorfismu. Mezi vlastní třídou a jednotlivými stavy, reprezentovanými také třídami zavedeme buď rozhraní, nebo abstraktní třídu. Vlastní třídy dílčích stavů jsou pak buď podtřídami abstraktní třídy, nebo implementují metody rozhraní. 59

60 Shrnutí Výhodou tohoto vzoru je snadná manipulace se stavy ve smyslu jejich modifikace, tedy přidávání dalších stavů nebo jejich rušení (odebírání). Úpravy jsou přehledné a snadno proveditelné. 60