Зачем писать свой плагин
Если вы разработчик, можно написать дополнительные проверки, чтобы выполнять автоматический контроль. Также вам могут пригодиться дополнительные инструменты, которые упростят работу и разработку.
Если вы DevOps-инженер или архитектор, можно добавить собственные проверки для проведения код-ревью, команды для EDT CLI и кастомизировать технологию CI/CD.
Зачем нужна эта статья? Есть официальная документация: как говорится, бери, читай и делай. Но она очень сложная и рассчитана не на новичка, а на человека, который уже умеет разрабатывать в Eclipse. Местами документация уже неактуальна, неполна и, что хуже всего, содержит недочеты, из-за которых новички часто бросают это дело.
Подготовка
Для подготовки у нас два этапа.
Первое – установка Eclipse. Нужно поставить версию 2023-12 (4.30). Можно установить актуальную версию через EDT Starter либо скачать ее с сайта Eclipse. Подойдут конфигурации for RCP and RAP Developers https://www.eclipse.org/downloads/packages/release/2023-12/r/eclipse-ide-rcp-and-rap-developers или for Committers https://www.eclipse.org/downloads/packages/release/2023-12/r/eclipse-ide-eclipse-committers. Лично я предпочитаю вариант for Committers, хотя остальные тоже подходят. Версию из EDT Starter я оставил ради интереса, но не нашел в ней некоторых полезных инструментов, например шпионов. В целом подойдут все варианты.
Обязательно установите сторонние плагины, которые значительно упростят разработку:
-
Enhanced Class Decompiler https://marketplace.eclipse.org/content/enhanced-class-decompiler#screenshots – для декомпиляции. Все бандлы скомпилированы, поэтому их придется декомпилировать;
-
PDE Source Lookup – подкачивает из интернета исходники скомпилированных классов;
-
Eclipse Zip Editor https://marketplace.eclipse.org/content/eclipse-zip-editor#screenshots – поможет выполнять глобальный поиск по всей EDT;
-
WindowBuilder https://eclipse.dev/windowbuilder/ – потребуется для создания пользовательского интерфейса.
Обо всех этих инструментах мы еще поговорим.
Разработка
С чего начать разработку? Есть очень хороший цикл статей на Инфостарте //infostart.ru/1c/articles/1311121/. Рекомендую пройти его от начала до конца, шаг за шагом. Так вы хорошо набьете руку и поймете, как писать плагины и работать с инструментами Eclipse. Начать лучше именно с этого цикла. Он немного утратил актуальность, но вместе с этой статьей вам будет легко разобраться со всеми устаревшими моментами.
Обязательно возьмите официальный демоплагин в качестве донора https://github.com/1C-Company/dt-example-plugins/tree/master/. Оттуда мы будем забирать некоторые вещи.
Поскольку я разработчик исключительно на 1С, мне пришлось подтянуть необходимые знания. Например:
-
Классы и интерфейсы
-
Механизм наследования
-
Дженерики
-
Лямбда-выражения
-
Функциональные интерфейсы
-
Стримы
-
Синтаксический сахар
Архитектура 1С:EDT
EDT – это большой набор бандлов, своеобразных кирпичиков. Часть этих кирпичиков относится к стандартному Eclipse, а другая часть разработана вендором, компанией «1С», с учетом специфики платформы.
Важно, что во время работы EDT бандлы могут прямо на лету запускаться и останавливаться. Мы еще вернемся к этому моменту.
Каждый бандл привносит новую функциональность либо может переопределять функциональность другого бандла, если тот позволяет это делать.
Структура плагина
Давайте разберем структуру плагина в Eclipse. Плагин состоит из трех проектов.
Проект Target platform
Первый проект – Target platform, целевая платформа. Что такое целевая платформа? По сути, это EDT, то есть целевой набор бандлов, который мы собираемся расширять. Его нам и нужно описать.
Если открыть файл Target, мы попадем в форму его настройки. Здесь возникает первый камень преткновения, из-за которого многие новички бросают разработку: все сложно, нелогично, непонятно и возникают какие-то ошибки.
Я предлагаю сразу пропустить вкладку Definition и перейти на вкладку Source.
Откройте Target в демоплагине-доноре https://github.com/1C-Company/dt-example-plugins/blob/master/targets/default/default.target и скопируйте его содержимое себе.
Имейте в виду, что целевые платформы версионируются в соответствии с версиями EDT. На момент подготовки материала актуальна версия 2025.2. После сохранения файла и нажатия Reload, то есть перезагрузки целевой платформы, Eclipse подкачает из интернет-репозиториев все необходимые бандлы этой платформы в ваш workspace.
Проект Feature
Следующий проект – Feature, проект поставки. По сути, это описание состава плагина для его поставки и распространения среди конечных пользователей EDT.
Здесь мы указываем версию плагина и его название, которое увидит пользователь, а также информацию о вендоре. Для этого открываем файл feature.xml и попадаем в форму его настройки.
В ней можно указать лицензионную политику и дополнительное полезное описание.
Важная вкладка – Included Plug-ins. Здесь мы указываем комплект поставки. Плагин может состоять из нескольких бандлов. Чаще всего это один бандл, но их может быть два, три или сколько угодно.
Результат настройки этого файла можно увидеть в текстовом виде на вкладке feature.xml. По сути, это обычный текстовый документ.
Проект Plug-in
Самый главный проект – проект самого бандла, Plug-in. Он имеет комплексную структуру: три файла метаданных и функциональную часть.
Функциональная часть бандла состоит из пакетов, которых может быть несколько. Каждый пакет состоит из классов, и в одном пакете также может находиться несколько классов.
Начнем с файлов метаданных и разберемся, как их настраивать.
Первый файл – MANIFEST.MF. Здесь настраивается идентификатор бандла, класс Activator и версия Java. Сейчас мы используем Java 17.
Во время работы EDT бандлы запускаются на лету. Класс Activator можно не создавать, но он очень полезен, поэтому я советую его использовать. В нем находятся обработчики запуска и остановки бандла. При запуске мы можем указать там свою дополнительную логику.
В Activator также удобно размещать логирование бандла. Речь идет о панели ошибок EDT: именно через Activator мы обычно логируем собственные ошибки.
Следующая вкладка – Dependencies, то есть зависимости. Если мы используем функциональность других бандлов, обязательно нужно указать зависимость от них.
Зависимость может быть задана либо на уровне бандлов, либо на уровне пакетов. Как я уже говорил, бандлы состоят из пакетов, поэтому можно точнее указать, что мы зависим не от всего бандла, а только от одного его пакета.
Важно учитывать, что стандартные бандлы Eclipse версионируются на уровне бандлов. Вендор «1С» версионирует компоненты на уровне пакетов, поэтому зависимости от них я также советую добавлять попакетно.
Например, если вы хотите взять определенный класс из другого бандла, этот бандл или его пакет придется добавить в зависимости.
Результат настройки файла MANIFEST.MF – текстовый документ с параметрами.
Следующий файл метаданных – plugin.xml. После его открытия нас интересует вкладка Extensions, то есть расширения. Здесь мы описываем, к каким точкам расширения подключаемся. Обычно это точки расширения других бандлов.
Получается своеобразный конструктор LEGO: другие бандлы предоставляют точки расширения, а мы подключаемся к ним и указываем, каким образом будем их использовать.
Результатом также становится текстовый файл plugin.xml со всеми настройками.
Третий файл метаданных – build.properties, предназначенный для сборки. Он достаточно простой, и почти все параметры в нем остаются по умолчанию. Есть один нюанс, но о нем мы подробно поговорим в разделе о сборке.
Функциональность бандла, как я уже говорил, состоит из пакетов, а пакеты – из классов. Все классы относятся к определенным пакетам. Так выглядит общая структура плагина.
Исследование типового функционала 1С:EDT
Предположим, вы не хотите изобретать велосипед и планируете использовать существующую функциональность. Разберем способы исследования пользовательского интерфейса и кода.
Начнем с пользовательского интерфейса. Здесь нам помогут инструменты Eclipse – шпионы.
Запустите EDT в режиме отладки, наведите указатель на элемент пользовательского интерфейса и с помощью шпиона определите, какой бандл добавил эту функциональность. Аналогичный механизм работает для контекстного меню и слоев. Всего используются три шпиона.
Есть также рабочее место E4 Spies window. Оно помогает, например, определить, какой бандл отвечает за конкретную настройку EDT.
В запущенном в отладке сеансе 1С: EDT нажать:
-
Alt+Shift+F11 – Preference Spy – узнать какие настройки изменились при редактировании в форме
https://www.vogella.com/blog/preferences-spy-for-eclipse-ide-and-rcp/ -
Alt+Shift+F12 – Bundle Spy – состояния и версии плагинов в запущенном сеансе 1С:EDT
-
Alt+Shift+F8 – Event Spy – логирование событий в запущенном сеансе 1С:EDT
Bundle Spy показывает, какие бандлы сейчас запущены, остановлены или все еще запускаются, если у них выполняется большой обработчик старта.
Event Spy предназначен для логирования событий. Вы взаимодействуете с пользовательским интерфейсом, а инструмент сразу показывает, что происходит.
Теперь перейдем к исследованию кода типового функционала EDT и Eclipse.
Я предлагаю действовать следующим образом. Сначала зайдите на сайт официальной документации https://edt.1c.ru/dev/ru/docs/plugins/dev/edt-services/ и посмотрите, какие классы и сервисы могут быть вам полезны. Если там ничего не нашли, переходите к JavaDoc.
Для 1С:EDT ссылки:
-
https://edt.1c.ru/dev/edt/2025.2/apidocs/index.html - основной JavaDoc (на разные версии 1С:EDT)
-
https://edt.1c.ru/dev/wiring/2.5/apidocs/index-all.html - сервисы
-
https://edt.1c.ru/dev/modeling/3.3/apidocs/index-all.html - моделирование
Для Eclipse ссылки:
-
https://help.eclipse.org/latest/topic/org.eclipse.platform.doc.isv/reference/api/index.html - основной JavaDoc
Есть JavaDoc для EDT и Eclipse. У EDT существует три варианта, но основной – первый. Учтите, что документация также версионируется. На момент подготовки материала актуальна версия 2025.2. На сайте есть удобный поиск, с помощью которого можно искать интересующие вас классы.
Если вы ничего не нашли или не знаете, что именно искать, можно использовать глобальный поиск – примерно так же, как мы делаем это в EDT. Благодаря стороннему плагину Eclipse Zip Editor появляется отдельная вкладка, через которую можно найти нужное слово во всей целевой платформе.
Если вы ищете текст на кириллице, придется поэкспериментировать с кодировкой. Поиск нужно выполнять в workspace вашего плагина, а именно в папке .metadata: там хранится вся целевая платформа.
Предположим, вы что-то нашли. Здесь нам поможет другой сторонний плагин – Enhanced Class Decompiler. Все бандлы скомпилированы, поэтому без декомпиляции их содержимое будет непонятно. Плагин откроет их, и вы сможете нормально посмотреть исходный код.
Пользовательский интерфейс (UI)
Начнем с пользовательского интерфейса. Здесь есть три важных момента.
Во-первых, правилом хорошего тона считается разделение бандлов на UI-бандлы, которые вносят изменения в пользовательский интерфейс, и не-UI-бандлы, содержащие программную функциональность. Такое разделение используется и в демоплагине, и в целевой платформе – своеобразной типовой конфигурации.
Во-вторых, в Eclipse все формы приходится рисовать программным способом, то есть текстом. Это очень неудобно, особенно когда вы не знаете языка. Здесь поможет сторонний плагин WindowBuilder. После его установки появляется конструктор форм, который автоматически генерирует необходимый код.
В-третьих, вам, скорее всего, потребуется создать и где-то хранить собственные настройки плагина. Типовой функционал Eclipse позволяет добавлять глобальные настройки для всего плагина.
Для этого можно перейти на вкладку Extensions и подключиться к точке расширения стандартных настроек. Я рекомендую использовать мастер настроек: он сразу создаст шаблон, который затем останется доработать.
Если нужно создать настройки конкретного элемента управления – например, проекта, приложения или ветки, – придется использовать интерфейсы Preferences.
Для хранения паролей я рекомендую использовать ISecurePreferences, чтобы не компрометировать их. В противном случае пароли можно будет найти где-нибудь в текстовых файлах.
Учитывайте один нюанс: ISecurePreferences не поддерживает кириллицу. Пароли вы будете хранить по определенным ключам, а кириллица в них не поддерживается. Я, например, перекодировал кириллические значения в цифры – цифры этот механизм принимает.
Публичные сервисы
Перейдем к разработке кода. Здесь мы очень активно используем публичные сервисы.
Что такое публичный сервис? По сути, это класс, который вендор – например, компания «1С» – официально разрешил использовать в собственных разработках.
Если проводить аналогию с 1С, это программный интерфейс: область с доступными для использования методами. В данном случае публичным является целый класс с его свойствами и методами.
Разберемся, как с ним работать. Начнем со способов подключения.
Недостаточно просто создать переменную или свойство с типом публичного сервиса. Без инициализации оно получит значение null.
Первый способ подключения – через Google Guice. Он подходит, например, когда вы хотите добавить в интерфейс кнопку. При нажатии кнопки запускается класс-обработчик, свойства которого имеют типы публичных сервисов.
Чтобы они правильно инициализировались, нужно соответствующим образом указать класс-обработчик: сначала инжектор, затем двоеточие и класс обработчика. После этого сервисы будут инициализированы нормально. В официальной документации https://edt.1c.ru/dev/ru/docs/plugins/dev/public-services/#использование-публичных-сервисов-внутри-google-guice есть понятная инструкция, поэтому разобраться будет несложно.
Однако существует один нюанс. Например, ExportOperationFactory, который используется для выгрузки файлов проекта EDT в XML, мне не удалось подключить таким простым способом. Здесь есть особенность, указанная на изображении. Посмотрите, как это реализовано, и все станет понятно.
Следующий способ – через ServiceSupplier. Он более универсален: я не заметил у него каких-либо ограничений. Для него также есть хорошая инструкция https://edt.1c.ru/dev/ru/docs/plugins/dev/public-services/#использование-публичных-сервисов-вне-guice-окружения. Мне этот способ нравится.
Предположим, оба варианта все равно не позволили получить нужный класс. Тогда можно взять другой публичный сервис и найти у него метод, который возвращает необходимый вам класс. Я использовал именно такой вариант.
Во время глобального поиска вам часто будут попадаться классы в пакетах, в названии которых есть слово internal, то есть «внутренний». Так вендор заявляет: «Это предназначено для служебного внутреннего использования. Не нужно пытаться обращаться к этому напрямую».
В очередной версии EDT там может все кардинально поменяться. В результате ваш плагин сломается, а вам придется постоянно актуализировать его архитектуру.
Поэтому всегда используйте публичные сервисы. Они сами обращаются к internal-пакетам и используют находящуюся там функциональность.
В моем случае есть пример, когда один класс получается с помощью другого. Также в плагине я задействовал метод, о будущем удалении которого вендор предупредил заранее. В версии 2025.2 его действительно удалили, но я уже знал об этом, поэтому для меня это не стало сюрпризом. В итоге у меня появилось всего три предупреждения.
Как узнать, какие публичные сервисы существуют во всей EDT? Здесь поможет инструкция по публикации собственного бандла в качестве публичного сервиса. Классы вашего бандла тоже могут быть публичными сервисами.
По аналогии https://edt.1c.ru/dev/ru/docs/plugins/dev/public-services/#предоставление-публичных-сервисов можно открыть другие бандлы, перейти в их класс Activator, то есть обработчик старта, и посмотреть все доступные публичные сервисы.
Как определить, какие существуют точки расширения, к которым можно подключиться? Здесь все просто: перейдите в Extensions и нажмите «Добавить». Главное – снимите галочку в нижней части окна. После этого вы увидите все точки подключения, многие из которых снабжены описаниями.
Отладка
В разделе об отладке разберем инструменты и некоторые важные особенности.
Начнем с полезных инструментов.
Панель Console позволяет выводить логи во время выполнения кода. Самое важное: когда EDT запущена в режиме отладки, она передает в эту панель много полезной информации. Поэтому регулярно проверяйте, что там появляется.
Панель Debug Shell – удобная доска, куда можно добавить собственные выражения и вычислить их. Поддерживается контекстная подсказка, поэтому работать достаточно удобно.
Еще одна полезная команда – Drop to Frame. Ее не хватает, например, в 1С.
Представьте стек вызовов: вы находитесь на текущем уровне и пошагово выполняете код. Команда Drop to Frame позволяет вернуться к началу этого уровня стека.
Допустим, во время отладки вы понимаете, что в коде есть ошибка. Вы сразу исправляете ее и нажимаете «Сохранить». Затем срабатывает Drop to Frame: выполнение возвращается к началу уровня стека, и вы снова проходите его, но уже по новому коду.
Это очень удобно: не приходится постоянно перезапускать сеанс отладки. Можно исправлять и повторно запускать код прямо на лету.
Настройка конфигурации отладки
Пользователи EDT знают, что такое конфигурация отладки. Это настройки, с которыми мы запускаем 1С. Здесь же речь идет о настройках, с которыми EDT запускается в режиме отладки.
В конфигурации указывается путь к workspace. Это не workspace плагина, а workspace разрабатываемой EDT, то есть целевой платформы.
Рекомендую включить очистку при перезапуске, но оставить запрос подтверждения – параметр Ask. Если вы создадите тестовый пример, он не удалится автоматически: при необходимости можно отказаться от очистки, а в другой ситуации подтвердить ее.
Здесь возникает следующий камень преткновения, из-за которого многие новички бросают разработку: у них не получается запустить EDT в режиме отладки.
В поле Run a product может отсутствовать необходимый вариант EDT – Product Application RCP. Он будет недоступен, потому что вендор по какой-то причине не добавил в целевую платформу демоплагина еще одну строку. Эта строка приведена на изображении. Добавьте ее и сохраните файл – после этого можно будет выбрать целевую платформу.
В качестве среды указываем Java. Файл целевой платформы придется немного доработать.
Следующая вкладка – Arguments. Это еще один камень преткновения, из-за которого отладка может не запускаться.
При выходе новой версии EDT в аргументах виртуальной машины иногда что-то меняется, и прежние параметры перестают работать. В таком случае снова обращаемся к демоплагину-донору https://github.com/1C-Company/dt-example-plugins/blob/master/bundles/org.example.ui/plugin.launch, забираем оттуда все аргументы и копируем их к себе. После этого все должно заработать. Конфигурационный файл называется plugin.launch.
На вкладке Configuration установите флажок Clear, чтобы служебные файлы очищались при каждом запуске.
На вкладке Common рекомендую в качестве Shared file указывать ваш бандл. Так конфигурация отладки будет храниться не где-то отдельно, а внутри плагина. Ее можно поместить под версионный контроль Git и версионировать вместе с проектом.
Флажок Debug также полезен при запуске.
Отладка декомпилированных модулей
У отладки декомпилированных модулей есть свои нюансы. Здесь снова поможет сторонний плагин Enhanced Class Decompiler.
Не забудьте назначить его средством по умолчанию для открытия файлов классов. Тогда при переходе к методу публичного сервиса будет открываться нормальный декомпилированный код, а не стандартный декомпилятор Eclipse, с которым практически невозможно вести отладку.
Но и здесь есть особенности. Поскольку бандлы сначала компилируются, а затем декомпилируются, порядок строк нарушается.
Например, в стеке вызовов указана строка 71. Курсор формально показывает на нее, но фактически это может быть строка 111, а настоящая строка 71 находится в другом месте. Поэтому ориентируйтесь на комментарии и при пошаговой отладке смотрите именно на них.
При отладке публичных сервисов проверяйте значения через просмотр выражений. Если сервис имеет значение null, значит, он не инициализирован и вы не смогли правильно его подключить.
Если сервис инициализирован, но вызов его методов приводит к зависанию, значит, что-то также подключено неправильно.
Есть еще один важный момент, связанный с моделью EDT. Она содержит функциональность объектной СУБД: в ней есть транзакции и блокировки.
Вы можете читать объекты EDT, и часто это происходит внутри транзакций. Открывается транзакция, после чего важно обязательно довести выполнение до ее закрытия.
Если во время открытой транзакции возникнет ошибка или вы вызовете Drop to Frame и не закроете транзакцию, механизм сломается: транзакция останется незавершенной. При следующей попытке открыть транзакцию система будет постоянно сообщать, что она уже открыта. Тогда придется полностью перезапустить сеанс отладки, чтобы обнулить все транзакции.
Обязательно доводите выполнение до закрытия транзакции и не используйте Drop to Frame внутри незавершенной транзакции.
Сборка
Сборка – достаточно простой механизм, при котором мы компилируем плагин в один файл.
Я предлагаю два способа.
Первый – сборка через Eclipse. Этот вариант подходит новичкам: он максимально простой и описан в цикле статей, который я рекомендовал в качестве тренажера //infostart.ru/1c/articles/1326516/.
Единственное отличие: я выполняю сборку не в каталог, а в ZIP-архив. На выходе получается один небольшой файл, который затем можно установить в EDT.
Второй способ – сборка через Apache Maven. Это уже вариант для экспертов. Как я говорил ранее, официальная документация в большей степени рассчитана именно на экспертов, поэтому новичку этот способ пока не нужен https://github.com/1C-Company/dt-example-plugins/blob/master/pom.xml.
Есть важный нюанс, связанный с файлом build.properties. Снова откройте демоплагин-донор https://github.com/1C-Company/dt-example-plugins/blob/master/bundles/org.example.ui/build.properties, найдите нужную строку и перенесите ее в свой файл.
Если в модулях с классами используется кириллица, без этой строки компилятор преобразует текст в другую кодировку, и вместо нормальных символов появятся «крокозябры». Например, они могут возникнуть при выводе текста в пользовательском интерфейсе.
После добавления строки код будет компилироваться в UTF-8.
Также учитывайте, что EDT развивается и выходят новые версии. Поскольку зависимости версионируются на уровне бандлов и пакетов, во время сборки система может сообщить, что некоторые из них устарели. Тогда потребуется открыть настройки и, например, повысить версию зависимости, после чего сборка продолжится.
*************
Статья написана по итогам доклада (видео), прочитанного на конференции INFOSTART TEAM EVENT.
Вступайте в нашу телеграмм-группу Инфостарт