You've already forked fluent-request-schema-1c
mirror of
https://github.com/zerobig/fluent-request-schema-1c.git
synced 2025-08-09 21:27:11 +02:00
first commit
This commit is contained in:
Ilya Bushin
123
README.md
Normal file
123
README.md
Normal file
@@ -0,0 +1,123 @@
|
||||
# 1С Предприятие. Fluent схема запроса
|
||||
|
||||
## Мотивация
|
||||
|
||||
Смотрел я на запросы в 1С, потом смотрел на то как народ создаёт библиотеки с API в "текучем" стиле. И решил это совместить. Ведь есть же такой замечательный продукт от Microsoft - [Linq](https://learn.microsoft.com/ru-ru/dotnet/csharp/linq/standard-query-operators/)! Сначала подумал что буду первопроходцем. Но оказывается всё уже придумано до нас: [Раз](https://github.com/KalyakinAG/query-model), [Два](https://infostart.ru/1c/articles/1991009/). Может быть ещё что есть, а я не нашел.
|
||||
|
||||
## Описание
|
||||
|
||||
Библиотека позволяет писать запросы 1С Предприятия в функциональном стиле. Например, вот такой код:
|
||||
```bsl
|
||||
ТаблицаЗначений = СЗ_Запрос.НовыйЗапрос("Справочник.Номенклатура").ВТаблицуЗначений();
|
||||
```
|
||||
будет аналогичен:
|
||||
```bsl
|
||||
Запрос = Новый Запрос;
|
||||
Запрос.Текст = "ВЫБРАТЬ
|
||||
| Номенклатура.Ссылка КАК Ссылка
|
||||
|ИЗ
|
||||
| Справочник.Номенклатура КАК Номенклатура";
|
||||
|
||||
ТаблицаЗначений = Запрос.Выполнить().Выгрузить();
|
||||
```
|
||||
|
||||
### Преимущества такого подхода:
|
||||
|
||||
* уменьшение количества кода при той же читабельности / наглядности;
|
||||
* избавление от уродских конструкций типа:
|
||||
```bls
|
||||
Запрос.ТекстЗапроса = СтрЗаменить(Запрос.ТекстЗапроса, "&Условие", "Номенклатура.ЭтоГруппа = ЛОЖЬ");
|
||||
```
|
||||
|
||||
### У существующих решений есть ряд недостатков:
|
||||
|
||||
* излишне многословны;
|
||||
* не готовы к применению в рабочих конфигурациях;
|
||||
* не соответствуют стандартам разработки;
|
||||
* статья на инфостарте так и осталась лишь статьёй, не вылившись в какую-то готовую разработку
|
||||
|
||||
### У моего решения тоже есть недостатки:
|
||||
|
||||
* отсутствует автодополнение кода;
|
||||
|
||||
### Личные переживания и сомнения в процессе разработки
|
||||
|
||||
Сначала я был полон энтузиазма. Потом, по мере написания кода, начали появляться сомнения. Нужно ли это? Верной ли дорогой иду? Но когда я увидел как вот это:
|
||||
```bsl
|
||||
Функция ТаблицаАдресныхСокращений(НаименованияАдресныхОбъектов)
|
||||
|
||||
Запрос = Новый Запрос;
|
||||
Запрос.Текст =
|
||||
"ВЫБРАТЬ
|
||||
| УровниСокращенийАдресныхСведений.Значение КАК Наименование,
|
||||
| УровниСокращенийАдресныхСведений.Сокращение КАК Сокращение
|
||||
|ИЗ
|
||||
| РегистрСведений.УровниСокращенийАдресныхСведений КАК УровниСокращенийАдресныхСведений
|
||||
|ГДЕ
|
||||
| &Условие
|
||||
|
|
||||
|СГРУППИРОВАТЬ ПО
|
||||
| УровниСокращенийАдресныхСведений.Значение,
|
||||
| УровниСокращенийАдресныхСведений.Сокращение
|
||||
|
|
||||
|УПОРЯДОЧИТЬ ПО
|
||||
| Наименование";
|
||||
|
||||
Если ТипЗнч(НаименованияАдресныхОбъектов) = Тип("Массив") И НаименованияАдресныхОбъектов.Количество() > 0 Тогда
|
||||
Условие = "ИСТИНА";
|
||||
Иначе
|
||||
Условие = "УровниСокращенийАдресныхСведений.Значение В(&АдресныеСокращения)";
|
||||
Запрос.УстановитьПараметр("АдресныеСокращения", НаименованияАдресныхОбъектов);
|
||||
КонецЕсли;
|
||||
Запрос.Текст = СтрЗаменить(Запрос.Текст, "&Условие", Условие);
|
||||
|
||||
Возврат Запрос.Выполнить().Выгрузить();
|
||||
|
||||
КонецФункции
|
||||
```
|
||||
превратилось вот в это:
|
||||
```bsl
|
||||
Функция ТаблицаАдресныхСокращений(НаименованияАдресныхОбъектов)
|
||||
|
||||
Запрос = СЗ_Запрос.НовыйЗапрос("РегистрСведений.УровниСокращенийАдресныхСведений")
|
||||
.Выбрать("Значение КАК Наименование, Сокращение")
|
||||
.Сгруппировать("Значение, Сокращение")
|
||||
.Упорядочить("Наименование");
|
||||
|
||||
Если ТипЗнч(НаименованияАдресныхОбъектов) = Тип("Массив") И НаименованияАдресныхОбъектов.Количество() > 0 Тогда
|
||||
Запрос = Запрос
|
||||
.Где(СЗ_Запрос.Предикат()
|
||||
.Реквизит("Значение").В(НаименованияАдресныхОбъектов));
|
||||
КонецЕсли;
|
||||
|
||||
Возврат Запрос.ВТаблицуЗначений();
|
||||
|
||||
КонецФункции
|
||||
```
|
||||
все сомнения отпали! 16 строк вместо 30-ти при сохранении общей читабельности. И качество кода улучшилось за счет отказа от конструкции `СтрЗаменить()`.
|
||||
|
||||
По-моему это заявка на успех!
|
||||
|
||||
## Документация
|
||||
|
||||
// TODO:
|
||||
|
||||
## Как запустить
|
||||
|
||||
* Вариант 1: скачать файл с расширением cf из раздела [Releases]() и объединить со своей конфигурацией;
|
||||
* Вариант 2: скачать файл с расширением cfe из раздела [Releases]() и установить это расширение в свою базу данных;
|
||||
* Вариант 3: скачать исходники из репозитория, собрать при помощи команды `npm run build` (потребуется установленная NodeJS) и использовать результаты сборки по своему усмотрению;
|
||||
|
||||
## Идеи по дальнейшему развитию
|
||||
|
||||
- [ ] расширение API методов:
|
||||
- [ ] вложенные запросы;
|
||||
- [ ] пакетные запросы;
|
||||
- [ ] // TODO:
|
||||
- [ ] увеличение полноты покрытия тестами;
|
||||
- [ ] обработка-конструктор, которая преобразует обычный запрос 1С в "текучие" выражения и обратно;
|
||||
|
||||
## Благодарности
|
||||
|
||||
* [YAxUnit](https://github.com/bia-technologies/yaxunit) - ребята, вы лучшие!
|
||||
* [1CFilesConverter](https://github.com/arkuznetsov/1CFilesConverter) - давно пользуюсь этими скриптами. Очень помогают.
|
||||
0
docs/.gitkeep
Normal file
0
docs/.gitkeep
Normal file
10
package.json
Normal file
10
package.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"name": "fluent-request-schema-1c",
|
||||
"version": "0.0.1",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"build": "",
|
||||
"build:config": "",
|
||||
"build:extension": "cd scripts && ext2cfe.cmd ../src ../dist/request_schema.cfe СхемаЗапроса"
|
||||
}
|
||||
}
|
||||
1
scripts/.env
Normal file
1
scripts/.env
Normal file
@@ -0,0 +1 @@
|
||||
V8_VERSION=8.3.25.1336
|
||||
167
scripts/ext2cfe.cmd
Normal file
167
scripts/ext2cfe.cmd
Normal file
@@ -0,0 +1,167 @@
|
||||
@rem ----------------------------------------------------------
|
||||
@rem This Source Code Form is subject to the terms of the
|
||||
@rem Mozilla Public License, v.2.0. If a copy of the MPL
|
||||
@rem was not distributed with this file, You can obtain one
|
||||
@rem at http://mozilla.org/MPL/2.0/.
|
||||
@rem ----------------------------------------------------------
|
||||
@rem Codebase: https://github.com/ArKuznetsov/1CFilesConverter/
|
||||
@rem ----------------------------------------------------------
|
||||
|
||||
@ECHO OFF
|
||||
|
||||
SETLOCAL
|
||||
|
||||
set CONVERT_VERSION=UNKNOWN
|
||||
IF exist "..\VERSION" FOR /F "usebackq tokens=* delims=" %%i IN ("..\VERSION") DO set CONVERT_VERSION=%%i
|
||||
echo 1C files converter v.%CONVERT_VERSION%
|
||||
echo ===
|
||||
echo Convert 1C configuration extension to binary format ^(*.cfe^)
|
||||
|
||||
set ERROR_CODE=0
|
||||
|
||||
IF not defined V8_VERSION set V8_VERSION=8.3.20.2290
|
||||
IF not defined V8_TEMP set V8_TEMP=%TEMP%\1c
|
||||
|
||||
IF not "%V8_CONVERT_TOOL%" equ "designer" IF not "%V8_CONVERT_TOOL%" equ "ibcmd" set V8_CONVERT_TOOL=designer
|
||||
set V8_TOOL="C:\Program Files\1cv8\%V8_VERSION%\bin\1cv8.exe"
|
||||
set IBCMD_TOOL="C:\Program Files\1cv8\%V8_VERSION%\bin\ibcmd.exe"
|
||||
IF not defined V8_RING_TOOL (
|
||||
FOR /F "usebackq tokens=1 delims=" %%i IN (`where ring`) DO (
|
||||
set V8_RING_TOOL="%%i"
|
||||
)
|
||||
)
|
||||
|
||||
set LOCAL_TEMP=%V8_TEMP%\%~n0
|
||||
set IB_PATH=%LOCAL_TEMP%\tmp_db
|
||||
set XML_PATH=%LOCAL_TEMP%\tmp_xml
|
||||
set WS_PATH=%LOCAL_TEMP%\edt_ws
|
||||
|
||||
set ARG=%1
|
||||
IF defined ARG set ARG=%ARG:"=%
|
||||
IF "%ARG%" neq "" set V8_SRC_PATH=%ARG%
|
||||
set ARG=%2
|
||||
IF defined ARG set ARG=%ARG:"=%
|
||||
IF "%ARG%" neq "" set V8_DST_PATH=%ARG%
|
||||
set V8_DST_FOLDER=%~dp2
|
||||
set V8_DST_FOLDER=%V8_DST_FOLDER:~0,-1%
|
||||
set ARG=%3
|
||||
IF defined ARG set ARG=%ARG:"=%
|
||||
IF "%ARG%" neq "" set V8_EXT_NAME=%ARG%
|
||||
set ARG=%4
|
||||
IF defined ARG set ARG=%ARG:"=%
|
||||
IF "%ARG%" neq "" set V8_BASE_CONFIG=%ARG%
|
||||
|
||||
IF not defined V8_SRC_PATH (
|
||||
echo [ERROR] Missed parameter 1 - "path to folder contains 1C extension in 1C:Designer XML format or EDT project"
|
||||
set ERROR_CODE=1
|
||||
) ELSE (
|
||||
IF not exist "%V8_SRC_PATH%" (
|
||||
echo [ERROR] Path "%V8_SRC_PATH%" doesn't exist ^(parameter 1^).
|
||||
set ERROR_CODE=1
|
||||
)
|
||||
)
|
||||
IF not defined V8_DST_PATH (
|
||||
echo [ERROR] Missed parameter 2 - "path to 1C configuration extension file (*.cfe)"
|
||||
set ERROR_CODE=1
|
||||
)
|
||||
IF not defined V8_EXT_NAME (
|
||||
echo [ERROR] Missed parameter 3 - "configuration extension name"
|
||||
set ERROR_CODE=1
|
||||
)
|
||||
IF not exist "%V8_BASE_CONFIG%" (
|
||||
echo [INFO] Path "%V8_BASE_CONFIG%" doesn't exist ^(parameter 4^), empty infobase will be used.
|
||||
set V8_BASE_CONFIG=
|
||||
)
|
||||
IF %ERROR_CODE% neq 0 (
|
||||
echo ===
|
||||
echo [ERROR] Input parameters error. Expected:
|
||||
echo %%1 - path to folder contains 1C extension in 1C:Designer XML format or EDT project
|
||||
echo %%2 - path to 1C configuration extension file ^(*.cfe^)
|
||||
echo %%3 - configuration extension name
|
||||
echo %%4 - ^(optional^) path to 1C configuration ^(binary ^(*.cf^), 1C:Designer XML format or 1C:EDT project^)
|
||||
echo or folder contains 1C infobase used for convertion
|
||||
echo.
|
||||
exit /b %ERROR_CODE%
|
||||
)
|
||||
|
||||
echo [INFO] Clear temporary files...
|
||||
IF exist "%LOCAL_TEMP%" rd /S /Q "%LOCAL_TEMP%"
|
||||
md "%LOCAL_TEMP%"
|
||||
IF not exist "%V8_DST_FOLDER%" md "%V8_DST_FOLDER%"
|
||||
|
||||
echo [INFO] Set infobase for export data processor/report...
|
||||
|
||||
set V8_BASE_CONFIG_DESCRIPTION=configuration from "%V8_BASE_CONFIG%"
|
||||
|
||||
IF "%V8_BASE_CONFIG%" equ "" (
|
||||
md "%IB_PATH%"
|
||||
echo [INFO] Creating infobase "%IB_PATH%"...
|
||||
set V8_BASE_CONFIG_DESCRIPTION=empty configuration
|
||||
%V8_TOOL% CREATEINFOBASE File=%IB_PATH%; /DisableStartupDialogs
|
||||
goto export
|
||||
)
|
||||
IF exist "%V8_BASE_CONFIG%\1cv8.1cd" (
|
||||
echo [INFO] Basic config source type: Infobase
|
||||
set V8_BASE_CONFIG_DESCRIPTION=existed configuration
|
||||
set IB_PATH=%V8_BASE_CONFIG%
|
||||
goto export
|
||||
)
|
||||
md "%IB_PATH%"
|
||||
call %~dp0conf2ib.cmd "%V8_BASE_CONFIG%" "%IB_PATH%"
|
||||
IF ERRORLEVEL 0 goto export
|
||||
|
||||
echo [ERROR] Error cheking type of basic configuration "%V8_BASE_CONFIG%"!
|
||||
echo Infobase, configuration file ^(*.cf^), 1C:Designer XML, 1C:EDT project or no configuration expected.
|
||||
exit /b 1
|
||||
|
||||
:export
|
||||
|
||||
echo [INFO] Checking 1C extension source type...
|
||||
|
||||
IF exist "%V8_SRC_PATH%\DT-INF\" (
|
||||
IF exist "%V8_SRC_PATH%\src\Configuration\Configuration.mdo" (
|
||||
FOR /F "delims=" %%t IN ('findstr /r /i "<objectBelonging>" "%V8_SRC_PATH%\src\Configuration\Configuration.mdo"') DO (
|
||||
echo [INFO] Source type: 1C:EDT project
|
||||
md "%XML_PATH%"
|
||||
md "%WS_PATH%"
|
||||
goto export_edt
|
||||
)
|
||||
)
|
||||
)
|
||||
IF exist "%V8_SRC_PATH%\Configuration.xml" (
|
||||
FOR /F "delims=" %%t IN ('findstr /r /i "<objectBelonging>" "%V8_SRC_PATH%\Configuration.xml"') DO (
|
||||
echo [INFO] Source type: 1C:Designer XML files
|
||||
set XML_PATH=%V8_SRC_PATH%
|
||||
goto export_xml
|
||||
)
|
||||
)
|
||||
|
||||
echo [ERROR] Wrong path "%V8_SRC_PATH%"!
|
||||
echo Folder containing configuration extension in 1C:Designer XML format or 1C:EDT project expected.
|
||||
exit /b 1
|
||||
|
||||
:export_edt
|
||||
|
||||
echo [INFO] Export configuration extension from 1C:EDT format "%V8_SRC_PATH%" to 1C:Designer XML format "%XML_PATH%"...
|
||||
call %V8_RING_TOOL% edt workspace export --project "%V8_SRC_PATH%" --configuration-files "%XML_PATH%" --workspace-location "%WS_PATH%"
|
||||
|
||||
:export_xml
|
||||
|
||||
echo [INFO] Loading configuration extension from XML-files "%XML_PATH%" to infobase "%IB_PATH%"...
|
||||
IF "%V8_CONVERT_TOOL%" equ "designer" (
|
||||
%V8_TOOL% DESIGNER /IBConnectionString File=%IB_PATH%; /DisableStartupDialogs /LoadConfigFromFiles %XML_PATH% -Extension %V8_EXT_NAME%
|
||||
) ELSE (
|
||||
%IBCMD_TOOL% infobase config import --db-path="%IB_PATH%" --extension=%V8_EXT_NAME% "%XML_PATH%"
|
||||
)
|
||||
|
||||
:export_ib
|
||||
|
||||
echo [INFO] Export configuration extension from infobase "%IB_PATH%" configuration to "%V8_DST_PATH%"...
|
||||
IF "%V8_CONVERT_TOOL%" equ "designer" (
|
||||
%V8_TOOL% DESIGNER /IBConnectionString File=%IB_PATH%; /DisableStartupDialogs /DumpCfg %V8_DST_PATH% -Extension %V8_EXT_NAME%
|
||||
) ELSE (
|
||||
%IBCMD_TOOL% infobase config save --db-path="%IB_PATH%" --extension=%V8_EXT_NAME% "%V8_DST_PATH%"
|
||||
)
|
||||
|
||||
echo [INFO] Clear temporary files...
|
||||
IF exist "%LOCAL_TEMP%" rd /S /Q "%LOCAL_TEMP%"
|
||||
Reference in New Issue
Block a user