Разработка внешней компоненты по технологии Native API. Мониторинг файловой системы в 1С
Пример разработки внешней компоненты по технологии Native API для мониторинга выбранной папки файловой системы (изменение, переименование, удаление) файлов.
- Описание
- Подробнее
Описание
Рано или поздно приходится сталкиваться с задачами, которые на 1С решить невозможно или это будет крайне неэффективно.
Тут на помощь приходит технология внешних компонент. Внешние компоненты открывают широкие возможности по расширению возможностей 1С, возможности которые зачастую невозможно реализовать иным способом.
В статье разработаем внешнюю компоненту которая позволила бы производить мониторинг выбранной папки.
Несмотря на кажущуюся сложность в разработке внешней компоненты нет ничего сложного, благодаря шаблону достаточно просто разработать собственную компоненту.
Внешние компоненты помогают решать ряд задач, среди них:
- подключение и работа с различного рода оборудованием;
- доступ к аппартным средствам ОС и компьютера;
- написание эффективного кода, который будет выполняться гораздо быстрее, который не достичь на языке 1С.
Требования для разработки внешних компонент — базовые знания на языке С++, хотя бы на уровне общего курса программы высшего учебного заведения.
В статье я пыпытась показать, что разработка компоненты не такая сложная задача.
Итак для реализации поставленной задачи нам необходимо:
1. Разработать способ получения изменений файловой системы для передачи в 1С. Будем отлавливать события: добавление новых файлов , изменение файлов, переименование файлов.
2. Разработать компоненту внешней разработки по технологии Native API. Для реализации возьмём пример скачанные с сайта ИТС.
3. Подключить компоненту к 1С.
1. Получение изменений файловой системы.
Для реализации поставленной задачи предлагаю воспользоваться проектом на GitHub. с проектом вы можете ознакомиться с по ссылке FileWatch. Единственная проблема с которой столкнулся — это некорректная работа с кириллическими символами Проблема была в данной функции:
void convert_wstring(const std::wstring& wstr, std::string& out)
{
int size_needed = WideCharToMultiByte(CP_UTF8, 0, &wstr[0], (int)wstr.size(), NULL, 0, NULL, NULL);
out.resize(size_needed, '\0');
WideCharToMultiByte(CP_UTF8, 0, &wstr[0], (int)wstr.size(), &out[0], size_needed, NULL, NULL);
}К счастью проблему достаточно просто решить с помощью изменения функции следующим образом:
std::string ws2s(const std::wstring& s)
{
int len;
int slength = (int)s.length() + 1;
len = WideCharToMultiByte(CP_ACP, 0, s.c_str(), slength, 0, 0, 0, 0);
char* buf = new char[len];
WideCharToMultiByte(CP_ACP, 0, s.c_str(), slength, buf, len, 0, 0);
std::string r(buf);
delete[] buf;
return r;
}
void convert_wstring(const std::wstring& wstr, std::string& out)
{
out = ws2s(wstr);
}Данные код необходимо внести в файл FileWatch.hpp.
В остальном код проекта работает отлично. С примером использования можно ознакомиться либо на странице проекта или в приложенной к статье коду внешней компоненты.
Подключение библиотеки к проекту очень простое, достаточно лишь подключить заголовочный файл FileWatch.hpp.
2. Разработка компоненты внешней разработки по технологии Native API
Разрабатывать компоненту будем на примере внешней компоненты взятой с сайта 1С. Скачать шаблон и примеры разработки внешних компонент для различных платформ, а также прочитать подробное руководство по разработке внешних компонент можно по ссылке: https://its.1c.ru/db/metod8dev#content:3221:1:TI000001195
Следует немного поподробнее остановиться о том как развернуть проект из скачанно архива. В качестве основы для разработки, я взял не пустой шаблон, а готовый пример — это еще больше упрощает задачу. Все взаимодействие между 1С и компонентой уже реализовано, достаточно лишь добавить наш функционал.
Пару слов, о том как развернуть примеры компоненты с сайта ИТС. Распакуем скачанный архив, скопируем папку example со всеми
подпапками в папку будущего проекта.
Разрабатывать будем с помощью бсплатной среды разработки Visual Studio 2022 Community.
Примеры с сайта собираются с помощью CMake, поэтому для сборки примеров в Visual Studio Community нам потребуется доустановить или убедиться что они установлена "Cредства сборки Cmake для Windows", для этого нужно запустить Visual Studio Installer и в отдельные компоненты отметить средства CMake.
Запустим среду разработки, откажемся от создания нового проекта, нажав ссылку продолжить без кода.
В Visual Studio выбрать CMake
Будем считать что все прошло удачно и у вас есть, готовый к дальнейшим действиям проект.
Обязательно попытайтесь собрать проект, перед началом работы, из всех примеров нас интересует только NativeAPI, собирать через файлы CMake лучше из корня папки с примерами, при сборке одного только Native API возникает огромное количество ошибок, не разбирался гораздо проще собирать из корня проекта. При сборке возникла одна ошибка связанная со сборкой примера COM компоненты, но этот пример нам не нужен, поэтому можно удалить вместе с остальными неиспользуемыми.
Будем считать что теперь сборка прошла успешно, можно начать добавлять код в шаблон.
Не буду вдаваться в детали работы внешней компоненты, многие функции обеспечивающие функционирование компоненты в примере уже реализованы и прекрасно работают.
Для более подробного знакомства с работой компоненты, предлагаю ознакомиться со следующими статьями:
//sale.itcity.ru/public/184119/
https://habr.com/ru/post/191014/
В них более подробно рассмотрено внутренее устройство компоненты и взаимодействие компоненты при подключении к 1С.
Переходим к знакомству c подготовленным примером и добавлению нашего функционала.
Изменить код придется совсем немного:
Первое что можно изменить этоимя компоненты, под которым внешняя компонента будет подключаться к 1С, имя указывается в процедуре RegisterExtensionAs
bool CAddInNative::RegisterExtensionAs(WCHAR_T** wsExtensionName)
{
const wchar_t *wsExtension = L"AddInNativeExtension";
size_t iActualSize = ::wcslen(wsExtension) + 1;
WCHAR_T* dest = 0;
if (m_iMemory)
{
if(m_iMemory->AllocMemory((void**)wsExtensionName, (unsigned)iActualSize * sizeof(WCHAR_T)))
::convToShortWchar(wsExtensionName, wsExtension, iActualSize);
return true;
}
return false;
}В дальнейшем при создании объекта внешней компоненты мы укажем его так:
Следующий важный шаг добавим нашу функцию в массивах g_MethodNames и g_MethodNamesRu в файле AddInNative.cpp
static const wchar_t *g_MethodNames[] = {
L"Enable",
L"Disable",
L"ShowInStatusLine",
L"StartTimer",
L"StopTimer",
L"LoadPicture",
L"ShowMessageBox",
L"Loopback",
L"StartMonitor",
L"StopMonitor",
};
static const wchar_t *g_MethodNamesRu[] = {
L"Включить",
L"Выключить",
L"ПоказатьВСтрокеСтатуса",
L"СтартТаймер",
L"СтопТаймер",
L"ЗагрузитьКартинку",
L"ПоказатьСообщение",
L"Петля",
L"СтартМонитор",
L"СтопМонитор"
};
В этих массивах прописываются имена процедур, которые экспортирует компонента и которые можно будет вызывать из 1С.
Добавлять код мы будем в следующую процедуру:
bool CAddInNative::CallAsProc(const long lMethodNum,
tVariant* paParams, const long lSizeArray)
Согласно документации:
bool CallAsProc(const long lMethodNum, tVariant* paParams, const long lSizeArray)
Параметры:
- <lMethodNum> Тип: const long. Порядковый номер метода.
- <paParams> Тип: tVariant* Указатель на массив структур tVariant, содержащий значения параметров метода. Если метод не имеет параметров, то содержит NULL.
- <lSizeArray> Тип: const long. Размер массива paParams.
Возвращаемое значение:
- true – соответствующий метод вызван, ошибок не произошло.
- false – отсутствует метод или произошла ошибка времени исполнения (runtime error).
В первом параметре в функцию передается номер метода, по полученному номеру в процедуре необходимо найти и выполнить код соответствующей функции. Для большего удобства, чтобы не оперировать непонятными номерами, в шаблоне используется перечисление для идентификации процедур и функций. Перечисление объявлено в заголовочном файле AddInNative.h, обратите внимание в данном перечислении, eMethLast должно оставаться последним, так как последнее имя в перечислении указывает не на
реальную процедуру или функцию, а нужно для опеределения количества процедур объекта компонента при опросе 1С компоненты в процедуре GetNMethods
class CAddInNative : public IComponentBase
{
public:
enum Props
{
ePropIsEnabled = 0,
ePropIsTimerPresent,
ePropLocale,
ePropLast // Always last
};
enum Methods
{
eMethEnable = 0,
eMethDisable,
eMethShowInStatusLine,
eMethStartTimer,
eMethStopTimer,
eMethLoadPicture,
eMethShowMsgBox,
eLoopback,
eStartMonitor,
eStopMonitor,
eMethLast // Always last
};Итак теперь добавим код в процедуру CallAsProc
case eStartMonitor:
if (m_iConnect && lSizeArray && TV_VT(paParams) == VTYPE_PWSTR)
{
tVariant* var = paParams;
pAsyncEvent = m_iConnect;
WCHAR_T* val = var->pwstrVal;
wchar_t* wcPath;
long strlen = var->strLen;
wcPath = new wchar_t[strlen];
::convFromShortWchar(&wcPath, TV_WSTR(paParams));
std::wstring wstring{ wcPath };
delete[] wcPath;
std::string path{wstring.begin(), wstring.end()};
if (FileWatch) {
delete FileWatch;
}
FileWatch = new filewatch::FileWatch<std::string>{
path,
[&](const std::string& path, const filewatch::Event event) {
std::string eventlog, eventstr;
switch (event) {
case filewatch::Event::renamed_old:
eventstr = "переименован";
break;
case filewatch::Event::added:
eventstr = "добавлен";
break;
case filewatch::Event::modified:
eventstr = "изменен";
break;
case filewatch::Event::removed:
eventstr = "удален";
break;
case filewatch::Event::renamed_new:
eventstr = "изменен (новое имя)";
break;
}
eventlog = path + " событие: " + eventstr;
std::wstring widestr = to_wide(eventlog);
const wchar_t* widecstr = widestr.c_str();
WCHAR_T* wc16path = 0;
size_t iActualSize = ::wcslen(widecstr) + 1;
convToShortWchar(&wc16path, widecstr, iActualSize);
std::cout << path << ' ' << filewatch::event_to_string(event) << '\n';
if (!pAsyncEvent)
return;
DWORD dwTime = 0;
WCHAR_T* who = u"ComponentNative", * what = u"Timer";
wchar_t* wstime = new wchar_t[TIME_LEN];
if (wstime)
{
wmemset(wstime, 0, TIME_LEN);
time_t vtime;
time(&vtime);
::_ui64tow_s(vtime, wstime, TIME_LEN, 10);
pAsyncEvent->ExternalEvent(who, what, (char16_t*)wc16path);
delete[] wstime;
}
}
};
} В ветке switch для идентификатора нашего метода, сперва проверяем что передан верный параметр. В lSizeArray передается количество методов, в paParams массив структур Variant — проверяем что передан строковой параметр. Если параметр передан верно, создаем объект FileWatch, готовим параметр для нашего объекта — путь к папке который собираемся мониторить. 1С передает и принимает строки типа WCHAR_T, но в объект FileWatch нужно передать тип стандартной библиотеки С++ stl::string, конвертируем из WCHAR_T в string и создаем объект FileWatch, в конструктор которого передается лямбда функция которая будет вызываться каждый раз при изменении в выбранной папке. Лямбда функция содержит вызов
pAsyncEvent->ExternalEvent(who, what, (char16_t*)wc16path);который посылает событие вида Внешнее событие в 1С
&НаКлиенте
Процедура ВнешнееСобытие(Источник, Событие, Данные)
Если Источник = "ComponentNative" Тогда
Сообщить(данные);
КонецЕсли;
КонецПроцедурыНаш код готов, осталось собрать и подключить её к 1С. Пример подключения компоненты приложен к статье.
Готово.
Подведем итоги:
Создать внешнюю компоненту не составляет большого труда, однако необходимо знание языка С++, хотя для этого и не нужно быть опытным разработчиком С++. При умелом и аккуратном использовании внешние компоненты предоставляют мощное средство расширения возможностей 1С, а создание внешней компоненты не такое сложное дело, как может показаться.
Внешняя компонента тестировалась на номера релиза платформы 8.3.22.1704.
