10. díl - Vlastnosti

C# .NET Objektově orientované programování Vlastnosti American English version English version

V minulém dílu seriálu tutoriálů o C# jsem si vysvětlili statiku. Dnes se podíváme na další prvky tříd, které ještě neznáme. Začněme slíbenými vlastnostmi.

Vlastnosti

Velmi často se nám stává, že chceme mít kontrolu nad změnami nějakého atributu objektu zvenčí. Budeme chtít atribut nastavit jako read-only nebo reagovat na jeho změny. Založme si nový projekt (název Vlastnosti) a vytvořme následující třídu Student, která bude reprezentovat studenta v nějakém informačním systému.

class Student
{
        public string jmeno;
        public bool muz;
        public int vek;
        public bool plnolety;

        public Student(string jmeno, bool pohlavi, int vek)
        {
                this.jmeno = jmeno;
                this.muz = pohlavi;
                this.vek = vek;
                plnolety = true;
                if (vek < 18)
                        plnolety = false;
        }

        public override string ToString()
        {
                string jsemPlnolety = "jsem";
                if (!plnolety)
                        jsemPlnolety = "nejsem";
                string pohlavi = "muž";
                if (!muz)
                        pohlavi = "žena";
                return String.Format("Jsem {0}, {1}. Je mi {2} let a {3} plnoletý.", jmeno, pohlavi, vek, jsemPlnolety);
        }

}

Třída je velmi jednoduchá, student se nějak jmenuje, je nějakého pohlaví a má určitý věk. Podle tohoto věku se nastavuje atribut plnolety pro pohodlnější vyhodnocování plnoletosti na různých místech systému. K uložení pohlaví používáme hodnotu bool, zda je student muž. Konstruktor dle věku určí, zda je student plnoletý. Metoda ToString() je navržena pro potřeby tutoriálu tak, aby nám vypsala všechny informace. V reálu by vrátila pravděpodobně jen jméno studenta. Pomocí konstruktoru si nějakého studenta vytvořme:

Student s = new Student("Pavel Hora", true, 20);
Console.WriteLine(s);

Výstup:

Jsem Pavel Hora, muž. Je mi 20 let a jsem plnoletý.

Vše vypadá hezky, ale atributy jsou přístupné jak ke čtení, tak k zápisu. Objekt tedy můžeme rozbít například takto (hovoříme o nekonzistentním vnitřním stavu):

Student s = new Student("Pavel Hora", true, 20);
s.vek = 15;
s.muz = false;
Console.WriteLine(s);
Console.ReadKey();

Výstup:

Vlastnosti tedy gettery a settery C#

Určitě musíme ošetřit, aby se plnoletost obnovila při změně věku. Když se zamyslíme nad ostatními atributy, není nejmenší důvod, abychom je taktéž umožňovali modifikovat. Student si za normálních okolností asi jen stěží změní pohlaví nebo jméno. Bylo by však zároveň vhodné je vystavit ke čtení, nemůžeme je tedy pouze pouze nastavit jako private. V dřívějších dílech seriálu jsme k tomuto účelu používali metody, které sloužily ke čtení privátních atributů. Jejich název jsme volili jako VratVek() a podobně. Ke čtení vybraných atributů vytvoříme také metody a atributy označíme jako privátní, aby se nedaly modifikovat zvenčí. Třída by nově vypadala např. takto (vynechal jsem konstruktor a ToString()):

class Student
{
        private string jmeno;
        private bool muz;
        private int vek;
        private bool plnolety;

        ...

        public string VratJmeno()
        {
                return jmeno;
        }

        public bool VratPlnoletost()
        {
                return plnolety;
        }

        public int VratVek()
        {
                return vek;
        }

        public bool Muz()
        {
                return muz;
        }

        public void NastavVek(int hodnota)
        {
                vek = hodnota;
                // přehodnocení plnoletosti
                plnolety = true;
                if (vek < 18)
                        plnolety = false;
        }


}

Metody, co hodnoty jen vracejí, jsou velmi jednoduché. Nastavení věku má již nějakou vnitřní logiku, při jeho změně musíme totiž přehodnotit atribut plnolety. Zajistili jsme, že se do proměnných nedá zapisovat jinak, než my chceme. Máme tedy pod kontrolou všechny změny atributů a dokážeme na ně reagovat. Nemůže se stát, že by nám někdo vnitřní stav nekontrolovaně měnil a rozbil.

Metodám k navrácení hodnoty se říká gettery a metodám pro zápis settery. Pro editaci ostatních atributů bychom udělali jednu metodu EditujStudenta, která by byla podobná konstruktoru. Jméno, věk a podobně by se tedy měnily pomocí této metody, tam bychom mohli např. kontrolovat, zda hodnoty dávají smysl, opět bychom odchytili všechny pokusy o změnu na jediném místě. Ruční psaní getterů a setterů je jistě velmi pracné. Nemohl by to udělat někdo za nás? Ano, C# nám je umí vygenerovat. Poté již nehovoříme o atributech, ale o vlastnostech.

Syntaxe vlastnosti je velmi podobná atributu:

public string Jmeno { get; set; }

Zprvu to vypadá, jako bychom deklarovali atribut. Jméno vlastnosti je však velkým písmenem, jedná se totiž o metodu (přesněji 2 metody). Ve složených závorkách poté specifikujeme, které metody si přejeme vygenerovat. Za vlastností nepíšeme středník! V ukázce výše se vygeneruje setter i getter, vlastnost půjde tedy normálně číst i modifikovat:

Console.WriteLine(objekt.Jmeno); // číst
objekt.Jmeno = "Jan Malý"; // zapisovat

Jediný rozdíl oproti atributu je zvenčí v tom, že počáteční písmeno je velké. C# ve skutečnosti vygeneruje privátní atribut a k němu dvě metody, které podle kontextu volá (pozná dle situace zda čteme nebo zapisujeme). Když do vlastnosti nevygenerujeme setter, nepůjde měnit ani zevnitř, ani zvenčí. Pokud si přejeme, aby vlastnost nešla mimo třídu měnit, označíme setter jako privátní:

public string Jmeno { get; private set; }

Tohoto budeme hojně využívat a právě takto bude vypadat většina vlastností našich budoucích tříd.

Pokud si přejeme, aby se v getteru nebo setteru dělo více, než jen načtení/zápis hodnoty, můžeme si ho definovat ručně. Ukažme si to na našem příkladu s plnoletostí, která se musí po změně věku přehodnotit:

private int vek;
public int Vek
{
        get
        {
                return vek;
        }
        set
        {
                vek = value;
                // kontrola plnoletosti
                Plnolety = true;
                if (vek < 18)
                        Plnolety = false;
        }
}

Zprvu je nutné si vytvořit privátní atribut vek s malým písmenem, ve které bude hodnota ve skutečnosti uložena. V getteru a setteru poté pracujeme s tímto atributem, pokud použijete v get nebo set Vek, program se zacyklí!. Není možné definovat jen getter nebo setter, buď se oba vygenerují samy nebo oba definujeme ručně. Pro přístup k zadané hodnotě je nám v setteru k dispozici klíčové slovo value. Takto se v C# do verze 3.0 musely definovat všechny vlastnosti, až poté Microsoft zavedl tzv. autoimplementaci a zkrácený zápis, jaký jsme si uvedli výše. u drtivé většiny vlastností totiž v metodách nepotřebujeme žádnou logiku. S Vek nyní pracujeme opět stejně, jako s atributem, jen s velkým písmenem. Nenápadné přiřazení do věku vnitřně spustí další logiku k přehodnocení vlastnosti Plnolety:

objekt.Vek = 15; // nyní se změní i plnoletost

Stejně můžeme pochopitelně implementovat i getter a například něco někam logovat.

Upravíme si naši třídu Student tak, aby používala vlastnosti. Vypadala by takto:

class Student
{
        public string Jmeno { get; private set; }
        public bool Muz { get; private set; }
        public bool Plnolety { get; private set; }
        private int vek;
        public int Vek
        {
                get
                {
                        return vek;
                }
                set
                {
                        vek = value;
                        // kontrola plnoletosti
                        Plnolety = true;
                        if (vek < 18)
                                Plnolety = false;
                }
        }

        public Student(string jmeno, bool pohlavi, int vek)
        {
                EditujStudenta(jmeno, pohlavi, vek);
        }

        public void EditujStudenta(string jmeno, bool pohlavi, int vek)
        {
                Jmeno = jmeno;
                Muz = pohlavi;
                Vek = vek;
        }

        public override string ToString()
        {
                string jsemPlnolety = "jsem";
                if (!Plnolety)
                        jsemPlnolety = "nejsem";
                string pohlavi = "muž";
                if (!Muz)
                        pohlavi = "žena";
                return String.Format("Jsem {0}, {1}. Je mi {2} let a {3} plnoletý.", Jmeno, pohlavi, Vek, jsemPlnolety);
        }

}

To je o hodně lepší, že? Vlastnosti budeme odteď používat stále, umožňují nám totiž objekty dokonale zapouzdřit. V .NET jsou všechny veřejné atributy tříd vlastnosti (např. nám známá vlastnost Length na stringu), platí pravidlo, že co jde ven je vlastnost, co se používá jen uvnitř je privátní atribut. Veřejný atribut se defakto příliš nepoužívá. Celou třídu i s ukázkovým programem si samozřejmě opět můžete stáhnout pod článkem. Kontrolu plnoletosti můžeme z konstruktoru nyní vyjmout, jakmile totiž dosadíme do vlastnosti Vek, nastaví se plnoletost sama. Ještě si opět vyzkoušejme problémový příklad:

Student s = new Student("Pavel Hora", true, 20);
s.Vek = 15;
s.Muz = false; // tento řádek nyní způsobí chybu a musí být odebrán
Console.WriteLine(s);

A výstup:

Vlastnosti tedy gettery a settery C#

Pokud celou vlastnost označíme jako private, nelze poté settery nebo gettery označit jako public.

Příště se podíváme, jak se v .NET pracuje s datem a časem.


 

Stáhnout

Staženo 1015x (26.85 kB)
Aplikace je včetně zdrojových kódů v jazyce C#

 

  Aktivity (4)

Článek pro vás napsal David Čápka
Avatar
Autor pracuje jako softwarový architekt a pedagog na projektu ITnetwork.cz (a jeho zahraničních verzích). Velmi si váží svobody podnikání v naší zemi a věří, že když se člověk neštítí práce, tak dokáže úplně cokoli.
Unicorn College Autor se informační technologie naučil na Unicorn College - prestižní soukromé vysoké škole IT a ekonomie.

Jak se ti líbí článek?
Celkem (14 hlasů) :
4.785714.785714.785714.785714.78571


 


Miniatura
Předchozí článek
Cvičení k 9. lekci OOP v C# .NET
Miniatura
Následující článek
Datum a čas v C#

 

 

Komentáře
Zobrazit starší komentáře (38)

Avatar
Skelag
Člen
Avatar
Skelag:

Nechci vypadat jako někdo kdo kontroluje každé slovo ale tohle mě trošku zmátlo :)

Pokud si přejeme, aby vlastnost nešla mimo třídu měnit, označíme getter jako privátní

public string Jmeno { get; private set; }

Neměl by být privátní ten getter? 8|

 
Odpovědět 17.2.2015 15:49
Avatar
David Čápka
Tým ITnetwork
Avatar
Odpovídá na Skelag
David Čápka:

Mělo tam být setter, díky, opravil jsem to :)

Odpovědět 17.2.2015 15:56
Miluji svou práci a zdejší komunitu, baví mě se rozvíjet, děkuji každému členovi za to, že zde působí.
Avatar
David Čápka
Tým ITnetwork
Avatar
David Čápka:

Je, díky, opravil jsem to :)

Odpovědět 17.2.2015 15:57
Miluji svou práci a zdejší komunitu, baví mě se rozvíjet, děkuji každému členovi za to, že zde působí.
Avatar
Skelag
Člen
Avatar
Skelag:

Jo ono se vlastně nezapisuje přes getter :o já jsem ale blbec

 
Odpovědět 17.2.2015 16:09
Avatar
Kafac
Člen
Avatar
Kafac:

Ahoj,pořád nechápu,proč tam nemůže být this?

Odpovědět 27.2.2015 21:24
"Lepší, než předpovídat budoucnost, je vytvořit ji." Bill Gates
Avatar
Migi
Člen
Avatar
Odpovídá na Kafac
Migi:

Podle mě, je to vlastnost a ne promenna, proto je na to napsana metoda a prirazujes pres konstruktor a metodu neco do vlastnosti.

Toto asi nejde..

this.Jmeno = jmeno;
Odpovědět 5. ledna 20:14
I ta nejhorsi hodina v zivote trva jen 60 minut...
Avatar
Migi
Člen
Avatar
Odpovídá na Migi
Migi:

Tak to jde, tak spis, ze bude lepsi mit metodu, ktere umi editovat informace o uzivateli? Dve mouchy jednou ranou? :-)

Odpovědět 6. ledna 18:06
I ta nejhorsi hodina v zivote trva jen 60 minut...
Avatar
Lukáš Hypša:

V prvním příkladě je vlastnost Jmeno public. Nepostrácí u ní getter a setter trochu smysl?

Odpovědět 5. března 16:51
I když se programování učím jenom z interetu, velmi mě baví a doufám, že se tím jednou budu i živit.
Avatar
ostrozan
Redaktor
Avatar
Odpovídá na Lukáš Hypša
ostrozan:

Nějak nerozumím tomu, na co se ptáš
V prvním příkladu (úplně na začátku) to není vlastnost .
Vlastnosti už z principu musí být public, jinak by postrádaly smysl

 
Odpovědět  +2 6. března 8:49
Avatar
Odpovědět 6. března 14:55
I když se programování učím jenom z interetu, velmi mě baví a doufám, že se tím jednou budu i živit.
Děláme co je v našich silách, aby byly zdejší diskuze co nejkvalitnější. Proto do nich také mohou přispívat pouze registrovaní členové. Pro zapojení do diskuze se přihlas. Pokud ještě nemáš účet, zaregistruj se, je to zdarma.

Zobrazeno 10 zpráv z 48. Zobrazit vše