Создаём систему плагинов, часть 2

В предыдущий раз мы рассмотрели несколько возможных вариантов для системы плагинов. Самое время заняться реализацией.

Итак, наш плагин будет представлять собой bpl-пакет в смысле Delphi, а с точки зрения любого другого языка - DLL. Причём взаимодействие между плагинами и ядром должно идти через интерфейсы.

Для начала, нам потребуется минимальная точка входа - т.е. некая функция, которую будет экспортировать каждый плагин. Функция должна быть только одна. Всё, что она должна делать - инициализировать взаимодействие с плагином на уровне интерфейсов (или простыми словами: возвращать интерфейс):

type
  TExportEntryPointProc = function: IInit; stdcall;

const
  ExportEntryPointName = '_GetPluginInitInterface'; // Do Not Localize

Интерфейс IInit мы опишем позже - пока скажем, что в нём должно быть как минимум два метода: инициализации и финализации (например Init и Done). Обратите внимание, что здесь используется тип вызова stdcall - это тип-вызова по-умолчанию для Windows. Для какого-нибудь Linux это вполне мог бы быть cdecl. Тип вызова нужно указать явно, поскольку тип вызова по-умолчанию в Delphi - это register. Указывая stdcall, мы снимаем проблему межязыковой совместимости.

Далее, имя функции имеет достаточно длинное имя, начинающееся с подчёркивания. Этим мы гарантируем, что имя функции случайно не совпадёт с названием какой-нибудь служебной функции (например, пакеты Delphi экспортируют функции с именами Initialize/Finalize). По-хорошему, для каждой новой программы нужно менять это имя. Если вас действительно заботит проблема коллизий имён - выберите в качестве имени функции строковое представление GUID (получить уникальный GUID можно, нажав в редакторе среды Delphi комбинацию Ctrl + Shift + G), например: '_6A3CF67EEA284145829B51BB371454CF'. Сильно желательно использовать в имени минимальный набор символов (например, только латиницу, цифры и знак подчёркивания).

Итак, каждый плагин должен экспортировать такую функцию:

function GetPluginEntryPoint: IInit; stdcall;
begin
  ...
end;

exports
  GetPluginEntryPoint name ExportEntryPointName;

Что мы будем делать, если в этой функции возникнет ошибка? Договоримся, что в этом случае мы должны будем вернуть nil (NULL в С) и установить стандартный код ошибки Windows с помощью SetLastError. Конечно, это очень ограниченное взаимодействие - но примем во внимание, что это будет единственная функция в плагине (причём чрезвычайно простая, с минимальной возможностью возникновения ошибки).

Что должна делать эта функция? Разумеется, создать объект, реализующий интерфейс IInit и вернуть его. Объект вполне можно удалять при удалении ссылки на интерфейс IInit, а вызывающая сторона (т.е. ядро) должно обязоваться обнулить интерфейс перед вызовом FreeLibrary для плагина. Например, возможная реализация могла бы выглядеть так:

function GetPluginEntryPoint: IInit; stdcall;
begin
  try
    // Это просто ремень безопасности. Если кто-то создал плагин в виде DLL, а не пакета, то это условие откажется загружать плагин.
    // Если вы собираетесь делать плагин в виде обычной DLL, а не пакета-как-DLL (что мы обсуждаем здесь), то эту проверку нужно убрать
    if not ModuleIsPackage then 
    begin
      SetLastError(E_UNEXPECTED);
      Result := nil;
      Exit;
    end;

    // Создаём объект, реализующий интерфейс, и возвращаем интерфейс.
    _Init;                    // инициализация пакета
    if FInit = nil then
      FInit := TInit.Create;  // объект будет освобождён, когда интерфейс освободят в ядре
    Result := FInit;
  except
    SetLastError(E_UNEXPECTED);
    Result := nil;
  end;
end;

Как видите, всё довольно просто. Чтобы понять, что же тут написано (а, главное, зачем), давайте рассмотрим порядок работы с плагином:

1. Вызов ядром LoadLibrary для файла плагина.
2. Выполнение DLLMain файла. Для пакета здесь производятся минимальные действия (наш случай). Для DLL здесь идёт инициализация - под вашу ответственность.
3. Поиск функции с именем ExportEntryPointName. Если она не найдена - переход на пункт 10.
4. Вызов функции с именем ExportEntryPointName и занесение интерфейса в переменную, скажем, Init. Если интерфейс пуст (равен nil/NULL), то генерируем ошибку и переходим на пункт 10.
5. Инициализируем плагин вызовом Init.Init.
6. ... здесь идёт работа с плагином.
7. Финализируем плагин вызовом Init.Done.
8. Обнуляем Init := nil;
9. Выполнение DLLMain файла. Для пакета здесь вообще нет действий. Для DLL здесь идёт очистка ресурсов.
10. Вызываем FreeLibrary для освобождения файла плагина.

Вот. Вопрос: где необходимо размещать инициализацию модуля плагина (вызов того кода, который лежит в initialization/finalization модулей плагина)? У нас есть два места: в пункте 4 или в пункте 5. А освобождение - в 7 или в 8. С точки зрения ядра разница никакой - главное, чтобы эта инициализация не попала в DLLMain.

Так вот, в случае Delphi придётся делать инициализацию в пункте 4 (где делать очистку - не столь важно, на ваш вкус). Почему? Потому что в п4 мы создаём объект, реализующий интерфейс. Создание объекта требует манипуляций с менеджером памяти, который... правильно, не инициализирован. Именно поэтому сначала нам нужно инициализировать пакет, а лишь затем делать любую работу. Именно этим и занимается вызов _Init в нашем коде.

Читать далее.