Автозагрузчик

СОДЕРЖАНИЕ

ИМЯ
СИНОПСИС
ОПИСАНИЕ
ЗАМЕЧАНИЯ
СМОТРИ ТАКЖЕ
АВТОР
АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИЯ

ИМЯ

Автозагрузчик - загрузка подпрограмм только по требованию

СИНОПСИС

package Foo;
use AutoLoader 'AUTOLOAD';   # import the default AUTOLOAD subroutine

package Bar;
use AutoLoader;              # don't import AUTOLOAD, define our own
sub AUTOLOAD {
    ...
    $AutoLoader::AUTOLOAD = "...";
    goto &AutoLoader::AUTOLOAD;
}

ОПИСАНИЕ

Модуль Автозагрузчик работает с модулем Авторазделение и маркером __END__ для отсрочки загрузки некоторых подпрограмм до их использования вместо загрузки всех сразу.

Чтобы использовать Автозагрузчик, автору модуля необходимо разместить определения подпрограмм, которые должны быть загружены автоматически, после маркера __END__. (См. perldata.) Модуль Авторазделение затем может быть запущен вручную для извлечения определений в отдельные файлы auto/funcname.al.

Автозагрузчик реализует подпрограмму AUTOLOAD. Когда вызывается неопределённая подпрограмма в модуле-клиенте Автозагрузчика, подпрограмма AUTOLOAD Автозагрузчика пытается найти подпрограмму в файле с именем, связанным с расположением файла, из которого был прочитан модуль-клиент. Например, если POSIX.pm находится в /usr/local/lib/perl5/POSIX.pm, Автозагрузчик будет искать подпрограммы Perl POSIX в /usr/local/lib/perl5/auto/POSIX/*.al, где файл .al имеет то же имя, что и подпрограмма, без указания пакета. Если такой файл существует, AUTOLOAD прочитает и выполнит его, тем самым (предположительно) определив необходимую подпрограмму. Затем AUTOLOAD goto вновь определённую подпрограмму.

После завершения этого процесса для данной функции, она определяется, поэтому последующие вызовы подпрограммы обойдут механизм AUTOLOAD.

Пледы подпрограмм

Для правильной работы поиска методов объектов и/или проверки прототипов даже в тех случаях, когда методы ещё не определены, необходимо «предупредить» каждую подпрограмму (как в sub NAME;). См. "СИНОПСИС" в perlsub. Такое предварительное объявление создаёт «пледы подпрограмм», которые являются заглушками без кода.

Модули Авторазделение и Автозагрузчик автоматизируют создание предварительных объявлений. Модуль Авторазделение создаёт файл «индекса», содержащий предварительные объявления всех подпрограмм Авторазделения. Когда модуль Автозагрузчик загружается, он загружает эти объявления в пакет своего вызывающего.

Из-за этого механизма важно, чтобы Автозагрузчик всегда useлся и не requireлся.

Использование подпрограммы AUTOLOAD Автозагрузчика

Для использования подпрограммы AUTOLOAD Автозагрузчика необходимо явно импортировать её:

use AutoLoader 'AUTOLOAD';

Переопределение подпрограммы AUTOLOAD Автозагрузчика

Некоторые модули, в основном расширения, предоставляют свои собственные подпрограммы AUTOLOAD. Обычно им необходимо проверять некоторые специальные случаи (например, константы), а затем переходить к подпрограмме AUTOLOAD Автозагрузчика для остального.

Такие модули не должны импортировать подпрограмму AUTOLOAD Автозагрузчика. Вместо этого они должны определять свои собственные подпрограммы AUTOLOAD примерно так:

use AutoLoader;
use Carp;

sub AUTOLOAD {
    my $sub = $AUTOLOAD;
    (my $constname = $sub) =~ s/.*:://;
    my $val = constant($constname, @_ ? $_[0] : 0);
    if ($! != 0) {
        if ($! =~ /Invalid/ || $!{EINVAL}) {
            $AutoLoader::AUTOLOAD = $sub;
            goto &AutoLoader::AUTOLOAD;
        }
        else {
            croak "Your vendor has not defined constant $constname";
        }
    }
    *$sub = sub { $val }; # same as: eval "sub $sub { $val }";
    goto &$sub;
}

Если собственная подпрограмма AUTOLOAD любого модуля не нуждается в возврате к подпрограмме AUTOLOAD Автозагрузчика (потому что в нём нет подпрограмм Авторазделения), то этот модуль вообще не должен использовать Автозагрузчик.

Лексические единицы пакета

Лексические единицы пакета, объявленные с my в главном блоке пакета, использующего Автозагрузчик, не будут видны для автоматически загружаемых подпрограмм из-за того, что данный область видимости заканчивается на марке __END__. Модуль, использующий такие переменные как глобальные переменные пакета, не будет работать должным образом под Автозагрузчиком.

Предикат vars (см. "vars" в perlmod) может быть использован в таких ситуациях в качестве альтернативы явного указания всех глобальных переменных с именем пространства имён пакета. Переменные, предварительно объявленные с помощью этого предиката, будут видны для любых загруженных автоматически процедур (но они не будут невидимы за пределами пакета, к сожалению).

Отказ от использования Автозагрузчика

Вы можете прекратить использование Автозагрузчика, просто

no AutoLoader;

Автозагрузчик против Самозагрузчика

Автозагрузчик похож по назначению на Самозагрузчик: оба откладывают загрузку подпрограмм.

Самозагрузчик использует маркер __DATA__ вместо __END__. Хотя это позволяет избежать использования иерархии файлов на диске и связанных с ней открытий/закрытий для каждой загруженной процедуры, Самозагрузчик страдает недостатком скорости запуска при однократном анализе строк после __DATA__, после чего процедуры кешируются. Самозагрузчик также может обрабатывать несколько пакетов в одном файле.

Автозагрузчик считывает код только по запросу, и во многих случаях должен быть быстрее, но требует механизма, подобного Авторазделению, для создания отдельных файлов. ExtUtils::MakeMaker будет вызывать Авторазделение автоматически, если Автозагрузчик используется в исходном файле модуля.

Принудительная загрузка функции Автозагрузчиком

Иногда может быть необходимо или полезно убедиться, что определённая функция полностью загружается Автозагрузчиком. Это случается, например, когда вам нужно обернуть функцию, чтобы вставить в неё код отладки. Это также полезно для принудительной ранней загрузки кода перед разветвлением, чтобы использовать копирование при записи как можно полнее.

Начиная с AutoLoader 5.73, вы можете вызвать функцию AutoLoader::autoload_sub с полным квалифицированным именем функции для загрузки из файла .al. Поведение точно такое же, как если бы вы вызвали функцию, вызвав обычный механизм AUTOLOAD, но фактическое выполнение загруженной автоматически функции не происходит.

ЗАМЕЧАНИЯ

Автозагрузчики до Perl 5.002 имели немного другой интерфейс. Любые старые модули, использующие Автозагрузчик, должны быть изменены на новый стиль вызова. Обычно это означает изменение require на use, добавление явного 'AUTOLOAD' импорта, если это необходимо, и удаление Автозагрузчика из @ISA.

В системах с ограничениями на длину имени файла файл, соответствующий подпрограмме, может иметь более короткое имя, чем сама подпрограмма. Это может привести к конфликту имён файлов. Пакет AutoSplit предупреждает о потенциальных конфликтах при использовании его для разделения модуля.

Автозагрузчик может не найти файлы авторазделения (или даже найти не те) в случаях, когда @INC содержит относительные пути и программа chdir.

СМОТРИ ТАКЖЕ

Самозагрузчик - автозагрузчик, не использующий внешние файлы.

АВТОР

AutoLoader поддерживается командой perl5-porters. Пожалуйста, направляйте все вопросы на соответствующий список рассылки. Всё, что относится к выпуску CPAN, может быть отправлено его разработчику.

Автор и разработчик: Команда Perl5-Porters <perl5-porters@perl.org>

Разработчик выпуска CPAN: Steffen Mueller <smueller@cpan.org>

АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИЯ

Этот пакет входит в ядро Perl с момента первого выпуска perl5. Он был выпущен отдельно в CPAN, чтобы старые установки могли получить выгоду от исправления ошибок.

Этот пакет имеет те же авторские права и лицензию, что и ядро Perl:

             Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
        2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
	2011, 2012, 2013
        by Larry Wall and others
    
			    All rights reserved.
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of either:
    
	a) the GNU General Public License as published by the Free
	Software Foundation; either version 1, or (at your option) any
	later version, or
    
	b) the "Artistic License" which comes with this Kit.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either
    the GNU General Public License or the Artistic License for more details.
    
    You should have received a copy of the Artistic License with this
    Kit, in the file named "Artistic".  If not, I'll be glad to provide one.
    
    You should also have received a copy of the GNU General Public License
    along with this program in the file named "Copying". If not, write to the 
    Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
    MA 02110-1301, USA or visit their web page on the internet at
    http://www.gnu.org/copyleft/gpl.html.
    
    For those of you that choose to use the GNU General Public License,
    my interpretation of the GNU General Public License is that no Perl
    script falls under the terms of the GPL unless you explicitly put
    said script under the terms of the GPL yourself.  Furthermore, any
    object code linked with perl does not automatically fall under the
    terms of the GPL, provided such object code only adds definitions
    of subroutines and variables, and does not otherwise impair the
    resulting interpreter from executing any standard Perl script.  I
    consider linking in C subroutines in this manner to be the moral
    equivalent of defining subroutines in the Perl language itself.  You
    may sell such an object file as proprietary provided that you provide
    or offer to provide the Perl source, as specified by the GNU General
    Public License.  (This is merely an alternate way of specifying input
    to the program.)  You may also sell a binary produced by the dumping of
    a running Perl script that belongs to you, provided that you provide or
    offer to provide the Perl source as specified by the GPL.  (The
    fact that a Perl interpreter and your code are in the same binary file
    is, in this case, a form of mere aggregation.)  This is my interpretation
    of the GPL.  If you still have concerns or difficulties understanding
    my intent, feel free to contact me.  Of course, the Artistic License
    spells all this out for your protection, so you may prefer to use that.

© 1993–2023 Larry Wall and others
Licensed under the GNU General Public License version 1 or later, or the Artistic License.
The Perl logo is a trademark of the Perl Foundation.
https://perldoc.perl.org/5.38.0/AutoLoader