Переезд на jason, десериализация тела запроса в пользовательский класс OneScript (autumn-library#110)

* Переезд на jason, наметки по поддержке типизации тела запроса в json

* Временное исправление теста на работу с соответствием

* Возвращение поддержки десериализации в структуру

* Управление чтением в структуру/соответствие

* Падающий тест на типизацию тела запроса

* Работающая десериализация в типизированный объект

* Исправлен тест ПолучениеДанныхФормы

* Исправлен тест Должен_ПроверитьПолучениеФайлаССервера

* Вынос десериализатора JSON в Парсеры, кэширование типа тела запроса

* Десериализация Тела запроса объект единожды

* Внедрение сериализатора в контроллер из примера

* Замена json->jason в dockerfile

* ТелоЗапросОбъект -> ТелоЗапросаОбъект в docs

Author: nixel2007

README.md

@@ -275,7 +275,7 @@ app/ИнтерактивныйКонтролПриветствия.os
 
 * ```ПортУдаленногоУзла``` - Порт удаленного узла.
 
-*  ```ТелоЗапросОбъект``` - Тело запроса, сериализованное из JSON. (При наличии заголовка ```"Content-Type:application/json"```)
+*  ```ТелоЗапросаОбъект``` - Тело запроса, сериализованное из JSON. (При наличии заголовка ```"Content-Type:application/json"```). Укажите аннотацию параметра ```&Тип("ИмяКласса")``` для десериализации в нужный тип.
 
 ## Еще один способ передачи параметров в строке запроса. 
 
@@ -418,13 +418,29 @@ app/ИнтерактивныйКонтролПриветствия.os
 
 Мы можем парсить самостоятельно, но можно внедрить объект ```Парсеры```, который умеет парсить параметры в таком формате ```Парсеры.ПараметрыИзТекста(<СтрокаСПараметрами>)```. Этот метод вернет соответствие со значениями, которые в последствии нужно правильно использовать.
 
-Если во входящем запросе придет заголовок ```"Content-Type:application/json"``` тогда его тело автоматом будет распарсено в структуру ```ТелоЗапросОбъект``` с которой можно работать.
+Если во входящем запросе придет заголовок ```"Content-Type:application/json"``` тогда его тело автоматом будет распарсено в структуру ```ТелоЗапросаОбъект``` с которой можно работать.
+
+Если вам нужна десериализация тела запроса сразу в экземпляр нужного класса (типизированная модель), добавьте к параметру ```ТелоЗапросаОбъект``` аннотацию ```&Тип("ИмяТипа")```, где ИмяТипа - это имя требуемого типа. Поддерживаются пользовательские классы, размеченные по правилам библиотеки [jason](https://github.com/nixel2007/jason).
 
 ```bsl
 &ТочкаМаршрута("postjsonbody")
-Процедура ПроверкаПостЗапросаКакОбъект(Ответ, ТелоЗапросОбъект, ЗаголовкиЗапроса) Экспорт
+Процедура ПроверкаПостЗапросаКакОбъект(Ответ, ТелоЗапросаОбъект, ЗаголовкиЗапроса) Экспорт
+	Ответ.УстановитьТипКонтента("txt");
+	Ответ.ТелоТекст = СтрШаблон("%1 %2", ТелоЗапросаОбъект.Имя, ТелоЗапросаОбъект.Фамилия);
+КонецПроцедуры
+```
+
+Пример типизированного тела с ```ТелоЗапросаОбъект```:
+
+```bsl
+// Класс вашей модели, на который будет маппиться JSON
+// Имя типа должно совпадать с указанным в &Тип("...")
+// Например: Имя модуля файла в src/Классы/ — "МояМодель.os" => Тип("МояМодель")
+
+&ТочкаМаршрута("postjsonbodytyped")
+Процедура ПринятьТипизированноеТело(Ответ, &Тип("МояМодель") ТелоЗапросаОбъект) Экспорт
 	Ответ.УстановитьТипКонтента("txt");
-	Ответ.ТелоТекст = СтрШаблон("%1 %2", ТелоЗапросОбъект.Имя, ТелоЗапросОбъект.Фамилия);
+	Ответ.ТелоТекст = СтрШаблон("%1 %2", ТелоЗапросаОбъект.Имя, ТелоЗапросаОбъект.Фамилия);
 КонецПроцедуры
 ```
 

docker/Dockerfile

@@ -39,7 +39,7 @@ RUN apt-get update \
 ARG OVM_REPOSITORY_OWNER=oscript-library
 ARG OVM_VERSION=v1.0.0-RC16
 ARG ONESCRIPT_VERSION=stable
-ARG ONESCRIPT_PACKAGES="autumn winow json"
+ARG ONESCRIPT_PACKAGES="autumn winow jason"
 
 RUN wget https://github.com/${OVM_REPOSITORY_OWNER}/ovm/releases/download/${OVM_VERSION}/ovm.exe \
   && mv ovm.exe /usr/local/bin/ \

docs/product/index.md

@@ -409,13 +409,13 @@ http://localhost:3333/greeter/calc/<operation>/<first>/<second>/
 
 Мы можем парсить самостоятельно, но можно внедрить объект ```Парсеры```, который умеет парсить параметры в таком формате ```Парсеры.ПараметрыИзТекста(<СтрокаСПараметрами>)```. Этот метод вернет соответствие со значениями, которые в последствии нужно правильно использовать.
 
-Если во входящем запросе придет заголовок ```"Content-Type:application/json"``` тогда его тело автоматом будет распарсено в структуру ```ТелоЗапросОбъект``` с которой можно работать.
+Если во входящем запросе придет заголовок ```"Content-Type:application/json"``` тогда его тело автоматом будет распарсено в структуру ```ТелоЗапросаОбъект``` с которой можно работать.
 
 ```bsl
 &ТочкаМаршрута("postjsonbody")
-Процедура ПроверкаПостЗапросаКакОбъект(Ответ, ТелоЗапросОбъект, ЗаголовкиЗапроса) Экспорт
+Процедура ПроверкаПостЗапросаКакОбъект(Ответ, ТелоЗапросаОбъект, ЗаголовкиЗапроса) Экспорт
 	Ответ.УстановитьТипКонтента("txt");
-	Ответ.ТелоТекст = СтрШаблон("%1 %2", ТелоЗапросОбъект.Имя, ТелоЗапросОбъект.Фамилия);
+	Ответ.ТелоТекст = СтрШаблон("%1 %2", ТелоЗапросаОбъект.Имя, ТелоЗапросаОбъект.Фамилия);
 КонецПроцедуры
 ```
 

example/hwapp/ИнтерактивныйКонтролПриветствия.os

@@ -7,9 +7,15 @@
 КонецПроцедуры
 
 &ТочкаМаршрута("postjsonbody")
-Процедура ПроверкаПостЗапросаКакОбъект(Ответ, ТелоЗапросОбъект, ЗаголовкиЗапроса) Экспорт
+Процедура ПроверкаПостЗапросаКакОбъект(Ответ, ТелоЗапросаОбъект, ЗаголовкиЗапроса) Экспорт
 	Ответ.УстановитьТипКонтента("txt");
-	Ответ.ТелоТекст = ЗаголовкиЗапроса["Content-Type"] + ТипЗнч(ТелоЗапросОбъект)// СтрШаблон("%1 %2", ТелоЗапросОбъект["Имя"], ТелоЗапросОбъект["Фамилия"]);
+	Ответ.ТелоТекст = ЗаголовкиЗапроса["Content-Type"][0] + ТипЗнч(ТелоЗапросаОбъект)// СтрШаблон("%1 %2", ТелоЗапросаОбъект["Имя"], ТелоЗапросаОбъект["Фамилия"]);
+КонецПроцедуры
+
+&ТочкаМаршрута("postjsontypedbody")
+Процедура ПроверкаПостЗапросаКакТипизированныйОбъект(Ответ, &Тип("ТестовыйОбъект") ТелоЗапросаОбъект) Экспорт
+	Ответ.УстановитьТипКонтента("txt");
+	Ответ.ТелоТекст = СтрШаблон("%1 %2", ТелоЗапросаОбъект.Имя, ТелоЗапросаОбъект.Фамилия);
 КонецПроцедуры
 
 &ТочкаМаршрута("getparamsbyname")

example/hwapp/КонтролПолученияЖСОН.os

@@ -1,8 +1,11 @@
-#Использовать json
+#Использовать jason
 
 &Пластилин
 Перем МенеджерОтображений Экспорт;
 
+&Пластилин
+Перем СериализаторJson;
+
 &Контроллер("/json")
 Процедура ПриСозданииОбъекта()
 
@@ -23,8 +26,7 @@
 	Структура.Вставить("Строка", "Привет дорогой пользователь");
 	Структура.Вставить("Массив", Массив);
 
-	Парсер = Новый ПарсерJSON();
-	СтруктураТекстом = Парсер.ЗаписатьJSON(Структура);
+	СтруктураТекстом = СериализаторJson.Сериализовать(Структура);
 
 	Ответ.УстановитьТипКонтента("json");
 	Ответ.ТелоТекст = СтруктураТекстом;

example/hwapp/СерверныеСобытия.os

@@ -61,8 +61,8 @@
 КонецПроцедуры
 
 &ТочкаМаршрута("postcomment")
-Процедура ЗапоститьКомментарий(ТелоЗапросОбъект) Экспорт
-	ДобавитьКомментарий(ТелоЗапросОбъект.name, ТелоЗапросОбъект.comment);
+Процедура ЗапоститьКомментарий(ТелоЗапросаОбъект) Экспорт
+	ДобавитьКомментарий(ТелоЗапросаОбъект.name, ТелоЗапросаОбъект.comment);
 КонецПроцедуры
 
 &ТочкаМаршрута("addLike")

example/hwapp/ТестовыйОбъект.os

@@ -0,0 +1,8 @@
+// BSLLS:MissingVariablesDescription-off
+// BSLLS:ExportVariables-off
+
+&Сериализуемое("name")
+Перем Имя Экспорт;
+
+&Сериализуемое("surname")
+Перем Фамилия Экспорт;

packagedef

@@ -72,7 +72,7 @@
 
 
 Описание.Имя("winow")
-        .Версия("0.10.0")
+        .Версия("0.11.0")
         .Автор("Никита Иванченко")
         .АдресАвтора("https://github.com/Nivanchenko")
         .Описание("Минималистичный веб-сервер на нативном OneScript")
@@ -84,7 +84,7 @@
         .ВключитьФайл("package-loader.os")
         .ЗависитОт("asserts", "1.4.0")
         .ЗависитОт("autumn", "4.3.9") 
-        .ЗависитОт("json")  
+        .ЗависитОт("jason", "0.3.0")
         .ЗависитОт("autumn-logos", "1.2.0") 
         .ЗависитОт("semaphore", "1.1.0")
         .ЗависитОт("fs")

src/Классы/ВходящийЗапрос.os

@@ -1,4 +1,4 @@
-#Использовать json
+#Использовать jason
 
 Перем Идентификатор Экспорт;
 Перем ТекстЗапроса Экспорт;
@@ -19,7 +19,6 @@
 
 Перем Куки Экспорт;
 Перем Парсеры;
-Перем Настройки;
 Перем ДанныеФормы;
 
 
@@ -28,8 +27,7 @@
 &ОсобоеОбращение(ОтключитьВсеНапильники = Истина)
 Процедура ПриСозданииОбъекта(
 	&Пластилин("Куки") _Куки,
-	&Пластилин("Парсеры") _Парсеры,
-	&Пластилин("Настройки") _Настройки
+	&Пластилин("Парсеры") _Парсеры
 )
 
 	Идентификатор = Формат(ТекущаяУниверсальнаяДатаВМиллисекундах(), "ЧГ=0") + ":" + Новый УникальныйИдентификатор();
@@ -48,18 +46,22 @@
 
 	Куки = _Куки;
 	Парсеры = _Парсеры;
-	Настройки = _Настройки;
-
+	
 КонецПроцедуры
 
-Функция ЗначенияПараметровДляТочкиМаршрута() Экспорт
+Функция ЗначенияПараметровДляТочкиМаршрута(ТипТелаЗапроса) Экспорт	
+	ТелоЗапросаОбъект = ТелоЗапросаОбъект(ТипТелаЗапроса);
+
 	Результат = Новый Соответствие();
 	Результат.Вставить("Запрос", ЭтотОбъект);
 	Результат.Вставить("ТекстЗапроса", ТекстЗапроса);
 	Результат.Вставить("ЗаголовкиЗапроса", Заголовки);
 	Результат.Вставить("ТелоЗапроса", Тело);
 	Результат.Вставить("ТелоЗапросаСоответствие", ТелоЗапросаСоответствие());
 	Результат.Вставить("ТелоЗапросаДвоичныеДанные", ТелоДвоичныеДанные);
+	// TODO: Пометить как DEPRECATED и удалить в будущих версиях
+	Результат.Вставить("ТелоЗапросОбъект", ТелоЗапросаОбъект);
+	Результат.Вставить("ТелоЗапросаОбъект", ТелоЗапросаОбъект);
 	Результат.Вставить("МетодЗапроса", Метод);
 	Результат.Вставить("ПолныйПутьЗапроса", ПолныйПуть);
 	Результат.Вставить("ПутьЗапроса", Путь);
@@ -68,7 +70,6 @@
 	Результат.Вставить("ДатаПолученияЗапроса", ДатаПолучения);
 	Результат.Вставить("ДвоичныеДанныеЗапроса", ДвоичныеДанные);
 	Результат.Вставить("КукиЗапроса", Куки);
-	Результат.Вставить("ТелоЗапросОбъект", ТелоЗапросОбъект());
 	Результат.Вставить("ДанныеФормы", ДанныеФормы());
 	Результат.Вставить("АдресУдаленногоУзла", АдресУдаленногоУзла);
 	Результат.Вставить("ПортУдаленногоУзла", ПортУдаленногоУзла);
@@ -146,16 +147,14 @@
 	Возврат Результат;
 КонецФункции
 
-Функция ТелоЗапросОбъект() Экспорт
+Функция ТелоЗапросаОбъект(ТипТелаЗапроса) Экспорт
 	Результат = Неопределено;
 
-	Если ЗначениеЗаполнено(Тело) 
-			И 
-			СтрНайти(НРег(СокрЛП(Заголовки["Content-Type"])), "application/json") > 0 Тогда
+	Если ЗначениеЗаполнено(Тело)
+			И СтрНайти(НРег(СокрЛП(Заголовки["Content-Type"])), "application/json") > 0 Тогда
 
-			Парсер = Новый ПарсерJSON();
-			Результат = Парсер.ПрочитатьJSON(Тело, Истина, Ложь, Настройки.АвтоматическиПриводитьОбъектыКСтруктуре);
-				
+		Результат = Парсеры.ДесериализоватьJson(Тело, ТипТелаЗапроса);
+	
 	КонецЕсли;
 
 	Возврат Результат;

src/Классы/ДубJason.os

@@ -0,0 +1,13 @@
+&Завязь
+Функция СериализаторJson() Экспорт
+	Возврат Новый СериализаторJson();
+КонецФункции
+
+&Завязь
+Функция ДесериализаторJson() Экспорт
+	Возврат Новый ДесериализаторJson();
+КонецФункции
+
+&Дуб
+Процедура ПриСозданииОбъекта()
+КонецПроцедуры