Perl (59) - OOP - typické použití

Perl Nyní, když už známe filozofii objektově orientovaného programování, se podíváme na to, jak napsat a používat objektově orientovaný modul.

29.6.2007 06:00 | Jiří Václavík | přečteno 16140×

V úvodním dílu o objektově orientovaném programování jsme se seznámili se základními myšlenkami a z dálky i se syntaxí. Dnes navážeme a ukážeme si postup, jak objekt, potažmo objektový program napsat.

Modul FileAccess pro snadnou práci se soubory

Vlastnosti OOP si předvedeme na třídě FileAccess, která implementuje objektové rozhraní pro práci se soubory. To znamená, že vytvoříme modul FileAccess, pomocí kterého pak budeme moct se souborem manipulovat bez starostí s vytvářením ovladačů a funkcemi, které čtení a zápis zajišťují.

Co to znamená? Uveďme si na příkladu, čeho vlastně budeme chtít dosáhnout. Nejprve vytvoříme objekt, který bude mít na starosti konkrétní soubor. Pak pro přečtení 10 znaků z daného souboru od aktuální pozice budeme psát jen toto.

$objekt->cti(10);

Podobně budeme chtít napsat metody zapis, pripis a pro nastavení pozice, kde se má číst, metodu nastav_pozici.

Narozdíl od klasických modulů nebude potřeba vytvářet rozhraní pomocí Exporteru. V objektových modulech k tomu není důvod, protože všechny podprogramy se využívají jako metody.

Celý modul se tedy bude sestávat pouze z konstruktoru a ostatních metod. Pro shrnutí uveďme předpokládanou kostru programu.

package FileAccess;
use strict;
sub new {...}
sub pripis {...}
sub zapis {...}
sub cti {...}
sub nastav_pozici {...}
1;

Konstruktor

Ze všeho nejdříve vytvoříme konstruktor. Při vytváření objektu bude třeba zadat jméno souboru. Toto jméno pak bude v proměnné @_. Společně s ním tam implicitně bude ještě na prvním místě seznamu jméno třídy (balíku) - tedy v našem případě "FileAccess". Toto jméno je sem přidáno samovolně a při volání metod se nezadává.

package FileAccess;
use strict;

sub new {
    my($self, $file) = @_;
    ...
}

V proměnné $self (to je konvenční název) budeme mít jméno balíku, tedy "FileAccess" a $file bude obsahovat název souboru, který budeme znát až v době použití souboru.

Kdybychom zapsali úvodní řádek konstruktoru následovně, tj. kdybychom nepočítali s implicitně předávaným jménem balíku, pak by v proměnné $file byla hodnota "FileAccess".

my($file) = @_;

Pojďme dokončit konstruktor. Vytvoříme hash, funkcí bless ho označíme jako objekt a poté již můžeme hash plnit výchozími hodnotami. Zatím budeme potřebovat pouze jedinou položku a to jméno souboru. Když jsme hotovi, vrátíme odkaz na hash funkcí return. Podobně vypadá většina konstruktorů.

sub new {
    my($self, $file) = @_;
    my $o = {};
    bless $o;
    $o->{"file"} = $file;
    return $o;
}

Konstruktor máme hotov. Ještě jednou si stručně uveďme, jak nám vlastně poslouží. Konstruktor bude první metoda, kterou zavoláme, až budeme modul FileAccess používat v programu. Pomocí něj vytvoříme samotný objekt, který bude asociován s konkrétním souborem.

Ostatní metody

Nyní je třeba vytvořit další 3 metody. Pro zápis, pro přípis a pro čtení.

Nejdříve implementujeme metody pro zápis a přípis. Jako argument budou obě metody přijímat nějaký řetězec, který bude zapsán, resp. připsán do souboru. Prvním argumentem bude opět odkaz na objekt, ke kterému volání metody patří. To je velmi důležité, protože právě pomocí tohoto odkazu budeme přistupovat k datům objektu, tedy k onomu hashi, který byl vytvořen konstruktorem (konkrétně pro nás to znamená, že tak získáme název souboru, kam budeme zapisovat).

Obě metody budou, pomineme-li názvy metod, až na jediný znak (režim otevření souboru) úplně stejné. Uvnitř podprogramu se neděje nic převratného. Vytvoří se pouze ovladač souboru, zapíše se do něj a zase se uzavře. Pokud otevření selže, vykonávání podprogramu přerušíme, takže k zápisu nedojde. Uvedme si obě metody.

sub zapis {
    my($self, $text) = @_;
    my $f = open FILE, ">", $self->{"file"} or return;
    print FILE $text;
    close FILE;
    return 1;
}

sub pripis {
    my($self, $text) = @_;
    my $f = open FILE, ">>", $self->{"file"} or return;
    print FILE $text;
    close FILE;
    return 1;
}

Metoda pro čtení bude nejsložitější, ale jen z technického hlediska. Musíme brát ohled na počet znaků, které chce uživatel přečíst a také na startovní pozici. Právě kvůli pozici budeme potřebovat ještě další metodu nastavPozici a do hashe s daty objektu musíme přidat položku pozice. Počáteční pozice bude 0, takže do konstruktoru připíšeme následující řádek.

    $o->{"pozice"} = 0;

Nyní můžeme napsat metodu pro nastavení pozice.

sub nastavPozici {
    my($self, $pozice) = @_;
    $self->{"pozice"} = $pozice;
}

To je velmi jednoduchá metoda a právě na ní je hezky vidět jak se s objektem pracuje. Zavoláním této metody nad příslušným objektem dojde ke změně položky "pozice" v tomto objektu (tedy hashi).

A jako poslední metodu napíšeme již zmiňovaný podprogram cti. Jako argument přijme počet znaků od dané pozice v souboru, které budou vráceny. Takže otevřeme soubor, funkcí seek nastavíme pozici na hodnotu, kterou uchováváme v hashi, od této pozice přečteme daný počet znaků a tyto znaky vrátíme funkcí return.

sub cti {
    my($self, $pocet_znaku) = @_;
    my $precteno;
    my $f = open FILE, $self->{"file"} or return;
    seek FILE, $self->{"pozice"}, 0;
    read FILE, $precteno, $pocet_znaku;
    $self->{"pozice"} += $pocet_znaku;
    return $precteno;
    close $f;
}

Použití modulu

Soubor FileAccess.pm je hotov. Nyní ho můžeme používat jako modul v jiných programech. Pokud je umístěn v některé z lokací v @INC.

use FileAccess;

Zavoláme konstruktor, který vrací odkaz na objekt. Jako parametr bere jméno souboru.

my $soubor1 = FileAccess->new("data1");

Tímto způsobem můžeme vytvořit libovolné množství instancí třídy FileAccess (tj. objektů). Pro každý soubor se vytvoří jedna.

my $soubor2 = FileAccess->new("data2");

A teď můžeme zapisovat a číst soubor data1 resp. data2 pomocí objektu $soubor1 resp. $soubor2, jak potřebujeme. Uveďme několik ukázkových volání.

$soubor1->zapis("Zapisuji text do souboru data1\n");
$soubor1->pripis("Pripisuji text do souboru data1\n");
$soubor2->zapis("Zapisuji text do souboru data2\n");
$soubor2->zapis("Zapisuji novy text do souboru data2\n");
print "1. cteni:", $soubor1->cti(10), "\n"; #cteme 10 znaku z data1 od pozice 0
print "2. cteni:", $soubor1->cti(30), "\n"; #cteme 30 znaku z data1 od pozice 10
print "3. cteni:", $soubor2->cti(10), "\n"; #cteme 10 znaku z data2 od pozice 0
$soubor1->nastavPozici(5);                   #pozice pro data1 je 40, zmenime na 5
print "4. cteni:", $soubor1->cti(15), "\n"; #cteme 15 znaku z data1 od pozice 5

Na okraj poznamenejme, že pro každý zápis je soubor otevírán stále znovu. To je neefektivní v případech, kdy je zapisováno (nebo čteno) opakovaně z jednoho souboru (například v nekonečném cyklu). Nicméně je to pohodlné pro uživatele modulu.

Online verze článku: http://www.linuxsoft.cz/article.php?id_article=1474