Verwalten von Objekten in einer Container-Klasse

[Luckie]

Verwalten von Objekten in einer Container-Klasse

Abstract
Wie man OOP konform Objekte in einer Container-Klasse verwaltet.

Problemstellung
Oftmals hat man das Problem, dass man mehrere gleichartige Elemente verwalten muss - zum Beispiel Adressen in einem Adressbuch oder Spieler eines Spieles. Meist wird dann ein Record genommen und diese Records werden dann in einem dynamische Array gespeichert. Dies ist zum einem etwas umständlich und mit einem gewissen Aufwand verbunden und zum dem ist es nicht OOP konform.

Lösungsmöglichkeit
Um dies Problem OOP konform zu lösen, arbeitet man mit zwei Klassen: Einer Container-Klasse und einer Klasse für die zu verwaltenden Objekte. Anstatt eines Records wird also eine Klasse benutzt und die Objekte dieser Klasse werden nicht in einem dynamischen Array abgelegt, sondern in einer Container-Klasse. Programmiert man in Delphi, werden einem schon verschiedene Klassen angeboten, die man als Container-Klasse verwenden kann: TList, TObjectList und TCollection.

• TList ist eine einfache Liste, in der beliebige Pointer abgelegt werden können. Die Klasse bringt schon Methoden zum Hinzufügen, Löschen usw. mit.
• TObjectList ist eine Erweiterung der TList-Klasse und besonders für Objekte geeignet, da sie auch den Speicherplatz der Objekte selber verwalten kann.
• TCollection ist eine spezielle Klasse, um Objekte vom Typ TCollectionItem zu verwalten. (Näheres dazu in der Delphi-Hilfe.)

Die Container-Klasse
Die Container-Klasse kapselt eine Liste vom Typ TList. (Man könnte auch eine Liste vom Typ TObjectList nehmen, was in der Praxis wohl auch sinnvoller wäre, da man dann den Speicher nicht selber verwalten muss. Ich habe mich hier aber für die Klasse TList entschieden, um zu zeigen, wie man den Speicher selber verwalten müsste in diesem Fall.) Da man die Liste kapselt, kann man selber bestimmen, welche Methoden mit welchen Parametern sichtbar sein sollen. Somit kann man dann auch sicherstellen, dass nur Objekte einer bestimmten Klasse in der Liste aufgenommen werden können. Wir haben uns somit eine streng typisierte Liste geschaffen. Eine Container-Klasse könnte dann zum Beispiel so aussehen:

Delphi-Quellcode:

TContactList = class(TObject)
private
  FInnerList: TList;
  function GetItem(Index: Integer): TContact;
  procedure SetItem(Index: Integer; Contact: TContact);
  function GetCount: Integer;
public
  constructor Create;
  destructor Destroy; override;
  procedure Add(Contact: TContact);
  procedure Delete(Index: Integer);
  property Count: Integer read GetCount;
  property Items[Index: Integer]: TContact read GetItem write SetItem;
end;

Die Methoden der typisierte Liste
Gucken wir uns exemplarisch die Methode Add unserer List an:

Delphi-Quellcode:

procedure TContactList.Add(Contact: TContact);
begin
  FInnerList.Add(Contact);
end;

Unsere eigene Methode Add ruft also im Prinzip nur die Methode Add von unser inneren Liste FInnerList (die natürlich im Konstruktor erzeugt und im Destruktor wieder freigegeben werden muss) auf. Da man allerdings nur ein Objekt der Klasse TContact übergeben kann, kann man nur Objekte diesen Typs in die Liste aufnehmen.

Den Speicher verwalten
Wie schon gesagt muss man den Speicher selber verwalten, wenn man keine Liste vom Typ TObjectList nimmt. Da man in der Liste eine Instanz einer Klasse ablegt, die Speicher belegt, muss man diesen Speicher auch wieder freigeben, wenn man ein Objekt aus der Liste entfernt oder, wenn man die ganze Liste wieder freigibt. Löscht man einen Eintrag der Liste, sähe dies dann so aus:

Delphi-Quellcode:

procedure TContactList.Delete(Index: Integer);
begin
  // destroy object
  TObject(FInnerList.Items[Index]).Free;
  // delete object from the list
  FinnerList.Delete(Index);
end;

Erst wird das Objekt in der Liste freigegeben und dann aus der selbigen gelöscht. Ebenso verfährt man beim Freigeben der Container-Klasse:

Delphi-Quellcode:

destructor TContactList.Destroy;
var
  i                 : Integer;
begin
  if FInnerList.Count > 0 then
  begin
    for i := FInnerList.Count - 1 downto 0 do
    begin
      TObject(FInnerList.Items[i]).Free;
    end;
  end;
  FInnerList.Free;
  inherited;
end;

Erst geht man die Liste durch und gibt alle in ihr enthaltenen Objekte frei. Dann gibt man die Liste selber frei. Wichtig ist, dass die Schleife rückwärts laufen muss, da die Eingangsbedingung einer for-Schleife nur beim Eintritt in die Schleife geprüft wird, aber in der Schleife entfernen wir ja Elemente, so dass wir, wenn die Schleife vorwärts liefe, über die Anzahl der Elemente hinauslaufen würden.

Auslesen der Liste
Das Auslesen der Objekte ist dann eher trivial:

Delphi-Quellcode:

procedure TfrmMain.UpdateListBox;
var
  Contact           : TContact;
  i                 : Integer;
  s                 : string;
begin
  ListBox1.Items.Clear;
  for i := 0 to AddressBook.Contacts.Count - 1 do
  begin
    Contact := AddressBook.Contacts.Items[i];
    s := Contact.LastName + ', ' + Contact.FirstName;
    ListBox1.Items.Add(s);
  end;
end;

Wie man sieht wurde unsere Container-Klasse noch mal in einer weiteren Klasse TAddressBook gekapselt:

Delphi-Quellcode:

TAddressBook = class(TObject)
private
   FContacts: TContactList;
public
  constructor Create;
  destructor destroy; override;
  property Contacts: TContactList read FContacts;
end;

Dies dient nur dazu die Aufgaben der Klassen sauber zu trennen. Die Klasse TContactList dient nur dazu die Liste der Kontakte zu verwalten. Die Klasse TAddressBook hingegen nimmt später dann noch alle weiteren Methoden unseres Adressbuches auf.

Im Anhang das Demo-Projekt.

Edit: Vorschläge eingearbeitet.

[Luckie]

Du hast gut aufgepasst. Es war gestern schon spät und ich habe im neuen Büro acht Stunden Wände weiß angemalt, das ist nichts für Programmierer.

[bernau]

Zitat von OldGrumpy:

die Schleife könnte also genauso gut vorwärts laufen.

Prinzipiell ist es doch egal, ob die Schleife vorwärts oder rückwärts läuft. Hauptsache die Items werden freigegeben.

Es sei denn, daß die Ausführungsgeschwindigkeit ggf. schneller ist, wenn's vorwärts läuft.

Preisfrage. Wer weis es

[bernau]

Zitat von Elvis:

Delphi-Quellcode:

var
  list      : TMyListItems;
  item      : TMyListItem;
  evilValue : PInteger;
begin
  ...
  new(evilValue);
  list.Add(evilValue);

  item := list[0];

  WriteLn(item.Name); //Hmpf? Was steht denn da drin?

Ich hab'S nicht getestet, aber...

  list.Add(evilValue);
Hier müstest du eigendlich einen Compilerfehler bekommen, da die Function Add überschrieben wurde und nur noch ein Ergebnis zurückliefert und keine Parameter erwartet.



Gerd

[OldGrumpy]

@bernau, lies nochmal genau das Tutorial, dann findest Du sicher die Begründung warum es eben NICHT immer egal ist

@luckie: Ja, das kommt mir bekannt vor *g* In erster Linie gings mir darum, zu wissen ob ich was übersehen hätte oder nicht.

[bernau]

Zitat von OldGrumpy:

@bernau, lies nochmal genau das Tutorial, dann findest Du sicher die Begründung warum es eben NICHT immer egal ist

Solche Antworten veranlassen mich eigendlich immer sofort eine Diskussion abzubrechen und nicht mehr zu antworten. Ich kommer mir dabei immer vor wie im Kindergarten. Warum kann man es nicht auf den Punkt bringen und folgendermassen antworten:

Zitat von So wünsche ich mir die Antwort:

@bernau, lies nochmal genau das Tutorial, im Abschnitt "Den Speicher verwalten" im dritten Absatz steht steht die Begründung warum es eben NICHT immer egal ist

Ich kann leider keine Gedanken lesen. Deshalb kann ich nur vermuten, daß du diesen Absatz meinst.

Erst geht man die Liste durch und gibt alle in ihr enthaltenen Objekte frei. Dann gibt man die Liste selber frei. Wichtig ist, dass die Schleife rückwärts laufen muss, da die Eingangsbedingung einer for-Schleife nur beim Eintritt in die Schleife geprüft wird, aber in der Schleife entfernen wir ja Elemente, so dass wir, wenn die Schleife vorwärts liefe, über die Anzahl der Elemente hinauslaufen würden.

Nur ist diese Aussage schlichtweg falsch. In dem Beispiel werden in der Schleife lediglich die Objekte freigegeben. Die Menge der Elemente verändert sich nicht, da kein Delete aufgerufen wird. Daher ist es tatsächlich egal, ob die Schleife vorwärts oder rückwärts läuft. Wie du es ja selber geschrieben hast:

Zitat von OldGrumpy:

Du führst doch nur ein Free() aus und kein Delete()

Es ist schon klar, daß man eine Schleife nicht vorwärts laufen lassen darf, wenn in der schleife die Elemente durch ein Delete entfernt werden.

Aber ich habe mich ja auf das Beispiel von Luckie bezogen. Und bei diesem Beispiel ist es tatsächlich egal ob vorwärts oder rückwärts. Einen Fehler wird's nicht geben. Mich hat eben nur interessiert ob es für dieses Beispiel tatsächlich einen Grund geben könnte, die Schleife in eine bestimmte Richtung laufen zu lassen.

Der einzige Grund hierbei rückwärts zu zählen ist IMHO, daß eine Prüfung des Schleifenzählers auf 0 schneller verarbeitet wird, als die Prüfung, ob der Schleifenzähler eine bestimmte Zahl erreicht hat. Aber ob daß tatsächlich ein ausschlaggebender Punkt ist, bezweifele ich.

Aber vieleicht gibt's ja tatsächlich noch andere Gründe.


Gerd

[OldGrumpy]

@bernau:

Erstens: War schon spät
Zweitens: Warum soll ich Dir alles vorkauen, hast doch die Stelle auch selber gefunden. Ich unterstütze Denkfaulheit nicht.
Drittens: Ich schrieb "nicht *immer*" - Luckie hatte ja bereits geschrieben dass das etwas anders geplant war, und weiter oben im Tutorial gibts genau so eine Stelle wo alle Objekte abgeräumt werden - "schlicht falsch" ist meilenweit daneben.
Viertens: Damit Du nicht wieder ne Beschwerde posten musst, hier noch die Info dass ich mich auf TContactList.Delete() aus dem Tutorial beziehe.
Fünftens: Schönen Sonntag noch!

[bernau]

Zitat von OldGrumpy:

Zweitens: Warum soll ich Dir alles vorkauen, hast doch die Stelle auch selber gefunden. Ich unterstütze Denkfaulheit nicht.

Das hat nichts mit Denkfaulheit zu tun. Es hilft nur ungemein, wenn man weis worauf sich ein Kommentar bezieht.

Zitat von OldGrumpy:

Viertens: Damit Du nicht wieder ne Beschwerde posten musst, hier noch die Info dass ich mich auf TContactList.Delete() aus dem Tutorial beziehe.

Was allerdings nichts mit der besagten Schleife zu tun hat.

Zitat von OldGrumpy:

Fünftens: Schönen Sonntag noch!

Jo. Lass uns wieder Freunde sein.

[SvB]

Hallo,

sehr interessant, da ich auch gerade so was brauche und auch einiges schon selbst sehr ähnlich gemacht habe.
Um mein Verständnis etwas zu erweitern, bzw. Euren Rat einzuholen folgende Frage / Erweiterung - ist das so OK:
Kann ich Methode wie folgt implementieren. Alles was im Beispiel gleich ist, habe ich jetzt hier nicht mehr reingepakt.

Delphi-Quellcode:

TContactList = class(TObject)
private
  FOnContactAdded: TNotifyEvent;
public
  destructor Destroy; override;
  function AddContact: TContact;
  procedure DeleteAllItems;
end;

TContactList.AddContact: TContact;
begin
  Result := TContact.Create(self);
  FInnerList.Add(Result);
  if Assigned(FOnContactAdded) then FOnContactAdded(Result);
end;

TContactList.DeleteAllItems;
var
  i : Integer;
begin
  if FInnerList.Count > 0 then begin
    for i := FInnerList.Count - 1 downto 0 do begin
      TObject(FInnerList.Items[i]).Free;
    end;
  end;
  FInnerList.Clear;
  // Würde FInnerList.Clear nicht auch alle Objekte freigeben?
end;

destructor TContactList.Destroy;
begin
  DeleteAllItems;
  FInnerList.Free;
  inherited;
end;

Was meint Ihr?

Grüße
Sven

[bernau]

Zitat von SvB:

// Würde FInnerList.Clear nicht auch alle Objekte freigeben?

Nur wenn FInnerList.OwnsObjects = true. Ansonstem muss man sich selber um die Freigabe der Objekte kümmern.


GErd

[Elvis]

Nimm' als InnerList eine TobjectList mit OwnsObject = true.
Und zum löschen, rufst du einfach ihr Clear auf. (Du nennst es dann natürlich auch Clear ).
Falls du einen event auslösen willst, der dich darüber informiert, dass ein Item entfernt wurde, müsste du natürlich wieder rückwärts durchlaufen und alles selbst rauswerfen.
Der Cast zu TObject ist natürlich witzlos, wenn es eine TObjectList ist.

btw: Dupliziere nix was bereits TObjectList implementiert hat, reiche es nur durch.
Code, den du nicht geschrieben hast, musst du auch nicht testen. (wenn er so oft benutzt wird wie TObjectList.Xyz, ist ja fast wie TObject.Free() )