/ 
Quiq-1.206
River stage zero No dependents
/ Quiq::ClassLoader

NAME

Quiq::ClassLoader - Lade Perl-Klassen automatisch

SYNOPSIS

use Quiq::ClassLoader;

my $obj = My::Class->new; # lädt My/Class.pm

DESCRIPTION

Zweck

Müde, use-Anweisungen für das Laden von Perl-Klassen zu schreiben?

Dieses Modul reduziert das Laden aller Klassen auf eine einzige Anweisung:

use Quiq::ClassLoader;

Danach werden alle Klassen automatisch mit ihrem ersten Methodenaufruf geladen. Dies geschieht bei jeder Methode, gleichgültig, ob Klassen- oder Objektmethode.

Vorteile

  • Man muss keine use-Aufrufe mehr schreiben

  • Es werden nur die Klassen geladen, die das Programm tatsächlich nutzt

  • Die Startzeit des Programms verkürzt sich, da später benötigte Klassen erst später geladen werden

  • Das Programm benötigt unter Umständen weniger Speicher, da Klassen, die nicht genutzt werden, auch nicht geladen werden

Was ist ein Klassen-Modul?

Unter einem Klassen-Modul verstehen wir eine .pm-Datei, die gemäß Perl-Konventionen eine Klasse definiert, d.h. die

  1. ein Package mit dem Namen der Klasse deklariert,

  2. unter dem Namen des Package gemäß den Perl-Konventionen im Dateisystem abgelegt ist,

  3. ihre Basisklassen (sofern vorhanden) selbständig lädt.

Beispiel

Eine Klasse My::Class wird in einer Datei mit dem Pfad My/Class.pm definiert und irgendwo unter @INC installiert. Sie hat den Inhalt:

package My::Class;
use base qw/<BASECLASSES>/;

<SOURCE>

1;

Hierbei ist <BASECLASSES> die Liste der Basisklassen und <SOURCE> der Quelltext der Klasse (einschließlich der Methodendefinitionen). Das Laden der Basisklassen-Module geschieht hier mittels use base. Es ist genauso möglich, die Basisklassen-Module per use parent oder direkt per use zu laden und ihre Namen @ISA zuzuweisen, was aber umständlicher ist.

Eine .pm-Datei, die diesen Konventionen genügt, ist ein Klassen-Modul und wird von Quiq::ClassLoader automatisch beim ersten Methodenzugriff geladen.

Wie funktioniert das?

Quiq::ClassLoader installiert sich als Basisklasse von UNIVERSAL und definiert eine Methode AUTOLOAD, bei der sämtliche Methodenaufrufe ankommen, die vom Perl-Interpreter nicht aufgelöst werden können. Die AUTOLOAD-Methode lädt das benötigte Klassen-Modul und ruft die betreffende Methode auf. Existiert das Klassen-Modul nicht oder enthält es die gerufene Methode nicht, wird eine Exception ausgelöst.

Die AUTOLOAD-Methode, die Quiq::ClassLoader definiert, ist recht einfach (Fehlerbehandlung hier vereinfacht):

sub AUTOLOAD {
    my $this = shift;
    # @_: Methodenargumente

    my ($class,$sub) = our $AUTOLOAD =~ /^(.*)::(\w+)$/;
    return if $sub !~ /[^A-Z]/;

    eval "use $class";
    if ($@) {
        die "Modul kann nicht geladen werden\n";
    }

    unless ($this->can($sub)) {
        die "Methode existiert nicht\n";
    }

    return $this->$sub(@_);
}

Lediglich der erste Methodenaufruf einer noch nicht geladenen Klasse läuft über diese AUTOLOAD-Methode. Alle folgenden Methodenaufrufe der Klasse finden direkt statt, also ohne Overhead! Methodenaufrufe einer explizit geladenen Klasse laufen von vornherein nicht über die AUTOLOAD-Methode.

Was passiert im Fehlerfall?

Schlägt das Laden des Moduls fehl oder existiert die Methode nicht, wird eine Exception ausgelöst.

Damit der Ort des Fehlers einfach lokalisiert werden kann, enthält der Exception-Text ausführliche Informationen über den Kontext des Fehlers, einschließlich Stacktrace.

Aufbau des Exception-Texts:

Exception:
    CLASSLOADER-<N>: <TEXT>
Class:
    <CLASS>
Method:
    <METHOD>()
Error:
    <ERROR>
Stacktrace:
    <STACKTRACE>

Kann eine Klasse selbst eine AUTOLOAD-Methode haben?

Ja, denn die AUTOLOAD-Methode von Quiq::ClassLoader wird vor dem Laden der Klasse angesprochen. Alle späteren Methoden-Aufrufe der Klasse werden über die Klasse selbst aufgelöst. Wenn die Klasse eine AUTOLOAD-Methode besitzt, funktioniert diese genau so wie ohne Quiq::ClassLoader.

CAVEATS

  • Der Mechanismus funktioniert nicht, wenn der Modulpfad anders lautet als die Klasse heißt. Solche Module müssen explizit per use geladen werden.

  • Sind mehrere Klassen in einer Moduldatei definiert, kann das automatische Laden logischerweise nur über eine dieser Klassen erfolgen. Am besten lädt man solche Module auch explizit.

  • Über Aufruf der Methode import() ist es nicht möglich, ein Modul automatisch zu laden, da Perl bei Nichtexistenz von import() AUTOLOAD() nicht aufruft, sondern den Aufruf ignoriert. Man kann durch $class->import() also nicht das Laden eines Klassen-Moduls auslösen.

  • Module, die nicht objektorientiert, sondern Funktionssammlungen sind, werden von Quiq::ClassLoader nicht behandelt. Diese sollten per use geladen werden. Es gibt im Perl-Core ein Pragma autouse, das alternativ zum automatischen Laden von Funktionen verwendet werden kann.

METHODS

Autoload-Methode

AUTOLOAD() - Lade Klassen-Modul

Synopsis

$this->AUTOLOAD;

Description

Die Methode lädt fehlende Klassen-Module und führt ihren ersten Methodenaufruf durch. Die Argumente und der Returnwert entsprechen denen der gerufenen Methode. Schlägt das Laden des Klassen-Moduls fehl, löst die Methode eine Exception aus (siehe oben).

Die AUTOLOAD-Methode implementiert die Funktionalität des Moduls Quiq::ClassLoader. Sie wird nicht direkt, sondern vom Perl-Interpreter gerufen, wenn eine Methode nicht gefunden wird.

VERSION

1.206

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2022 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.