fpWeb Tutorial/ru: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		` Первоначально основано на учебнике fcl-web (в формате PDF) пользователя форума `[`Leledumbo`](https://forum.lazarus.freepascal.org/index.php?action=profile;u=7523)`.`
2	2
3	3		## Введение
4	4
5	5		fpWeb - это фреймворк веб-приложений, поставляемый FPC в своем дистрибутиве по умолчанию как часть пакета fcl-web. Сам фреймворк построен на основе функций fcl-web. Фреймворк построен с мыслью о RAD, чтобы эффективно использовать компонентность при создании динамического контента. Предоставляется пакет Lazarus, который может использовать фреймворк методом перетаскивания для управления сеансами и создания контента. В этом руководстве мы попытаемся охватить основные функции fpWeb, чтобы с его помощью можно было создать обычное веб-приложение. Обратите внимание, что это руководство не пытается научить вас HTTP-протоколу, HTML, CSS, JavaScript или манипуляциям с базой данных, поскольку владение протоколом и клиентскими языками должно быть предварительным условием работы для каждого программиста веб-приложений, а манипуляции с базой данных не отличаются от десктопной реализации.
6	6
7	7		## Архитектура (ПОЖАЛУЙСТА, прочтите)
8	8
9	9		Перед тем, как начать, необходимо знать архитектуру и поток приложения, чтобы избежать путаницы, когда определенные вещи не работают или работают неожиданно. Поэтому, пожалуйста, потратьте немного времени на чтение этого раздела.
10	10
11	11		### Приложение
12	12
13	13		Под приложением здесь понимается протокол, который будет реализовывать ваше приложение. fpWeb с радостью переключится с CGI, FCGI, с модуля Apache на встроенный сервер и т.д., если fcl-web реализует еще что- нибудь в будущем. Каждое приложение реализовано в своем собственном модуле, поэтому для переключения с одного приложения на другое, за исключением модуля Apache, нужно просто изменить соответствующий идентификатор в разделе uses. В настоящее время (по состоянию на 3.0.0 / 3.1.1) это:
14	14
15	15		- fpCGI -\> CGI
16	16		- fpFCGI -\> FastCGI
17	17		- fpApache (также требуется httpd) -\> модуль Apache
18	18		- fpHttpApp -\> встроенный сервер
19	19		- microhttpapp -\> встроенный сервер с использованием библиотеки GNU libmicrohttp.
20	20		- fphttpsys -\> поддержка системой Windows протокола HTTP.
21	21
22	22		В этом руководстве мы будем использовать встроенный сервер для простоты, потому что вам не придется иметь дело с настройкой виртуального сервера и путаницей со сложным файлом конфигурации и управлением службами. Ваше приложение будет единым переносным бинарным веб-приложением! Другая причина может заключаться в том, что существует больше, чем одно приложение веб-сервера, и каждое имеет свой способ настройки. Было бы излишним пытаться охватить их всех, пока их документация уже выполняет свою работу. Модуль Apache реализован как (динамическая) библиотека, тогда как другие протоколы являются обычным приложением. Каждое приложение может иметь определенные свойства (например, порт), доступные и значимые только для этого приложения. Вот почему, если вы посмотрите на примеры fcl-web, пары .lpi / .lpr для каждого протокола помещаются в свои собственные каталоги, только веб-модули являются общими.
23	23
24	24		### Веб-модули
25	25
26	26		![](/wiki-images/5/50/FpWeb-overview.png)
27	27
28	28		Приложения fpWeb состоят из веб-модулей, которые фактически создают контент. Веб-модуль может содержать веб-действия, которые могут еще больше разделить функциональность. Например, веб-модуль аутентификации может иметь веб-действия входа и выхода. Хотя модуль about web может вообще не нуждаться в действии и обслуживает только один контент. Веб-модуль интегрирован с fpTemplate, который можно использовать для создания динамического контента из файла шаблона. Это примерно похоже на то, что делает PHP, только разрыв между логикой и представлением скорее вынужденный, чем предполагаемый. Некоторые говорят, что fpTemplate реализует пассивное представление, в то время как PHP по умолчанию реализует шаблон проектирования активного представления.
29	29
30	30		## Установка
31	31
32	32		Пакет fpWeb для Lazarus по умолчанию не установлен (но идет в стандартной поставке). Чтобы включить fpWeb:
33	33
34	34		1. Откройте Lazarus и выберите Package-\>Install/Uninstall Package
35	35		2. В списке Available (Доступно) для установки найдите weblaz и нажмите Install selection (Установить выбранное). Нажмите Save and rebuild IDE(Сохранить и пересобрать IDE) и подтвердите, нажав Continue(Продолжить).
36	36		3. Позвольте IDE пересобраться и перезапуститься. Если все пойдет хорошо, у вас должна появиться вкладка fpWeb на палитре компонентов, как показано ниже:
37	37
38	38
39	39
40	40		![](/wiki-images/5/55/Fpwebtutorial_inst.png)
41	41
42	42		## Специализированные модули
43	43
44	44		КлассTFPWebModule (используемый ниже) - это простой пример модуля fpWEB, который можно использовать для всех видов HTTP-запросов.
45	45
46	46		Однако fpWEB поставляется с некоторыми специализированными модулями, которые имеют дополнительную поддержку для специализированных задач:
47	47
48	48		- Класс TSimpleFileModule в модуле fpwebfile.pp можно использовать для отправки файлов. Вы указываете ему каталог, и он делает все остальное.
49	49		- Класс TFPHTMLModule в модуле fphtml.pp можно использовать для создания HTML.
50	50		- Класс TProxyWebModule в модуле fpwebproxy.pp - это готовый прокси для пересылки.
51	51		- Класс TFPWebProviderDataModule в модуле fpwebdata.pp обслуживает данные в формате JSON, которые могут использоваться хранилищами ExtJS.
52	52		- Класс TSQLDBRestModule в модуле sqldbrestmodule.pp реализует полноценный сервер REST, поддерживаемый SQLDB. См. дополнительную информацию в [[SQLDBRestBridge]].
53	53		- Класс TJSONRPCModule в модуле webjsonrpc.pp реализует службу JSON-RPC.
54	54		- Класс TExtDirectModule в модуле fpextdirect.pp реализует вариант Ext.Direct службы JSON-RPC.
55	55
56	56		## Hello, World!
57	57
58	58		Создадим простое веб-приложение. Как обычно преподают при изучении программирования: "Hello, World!" будет нашим первым приложением.\
59	59
60	60		1\. Откройте Lazarus и выберите Project-\>New Project, затем выберите HTTP server Application
61	61
62	62
63	63		![Создать новое приложение HTTP-сервера](/wiki-images/5/57/Fpwebtutorial_create_app.png)\
64	64
65	65		2\. Появится другое диалоговое окно для обслуживания статических файлов, выбора порта и многопоточности. Просто используйте порт по умолчанию 8080.
66	66
67	67
68	68		``` pascal
69	69		You may skip the static files serving (go to tips and tricks section if you want to know it more).
70	70		```
71	71
72	72		(Вы можете пропустить обслуживание статических файлов (перейдите в раздел советов и рекомендаций, если хотите узнать больше))
73	73
74	74
75	75		![](/wiki-images/e/e6/Fpwebtutorial_port_selection.PNG)
76	76
77	77		:ВАЖНО!:
78	78
79	79
80	80		Если вы решите использовать потоки на *nix, не забудьте добавить cthreads в качестве первого модуля в разделе uses .lpr, в противном случае будет создан RTE 232. При запуске с консоли должно отображаться сообщение:
81	81
82	82		``` pascal
83	83		This binary has no thread support compiled in. Recompile the application with a thread-driver in the program uses clause before other units using thread.
84	84		```
85	85
86	86		(В этом двоичном файле не скомпилирована поддержка потоков. Перекомпилируйте приложение с драйвером потока в программе using предложение перед другими модулями, использующими поток)\
87	87
88	88		3\. С 14 января 2017г. (или FPC 3.0.4) вам может потребоваться открыть .lpr и добавить следующую строку в основной текст, если ее еще там нет:
89	89
90	90
91	91		``` pascal
92	92		Application.LegacyRouting := true;
93	93		```
94	94
95	95		причина будет объяснена в главе [[fpWeb Tutorial/ru\|Маршрутизация]].
96	96
97	97		4\. Что бы вы ни выбрали, нажмите "OK", и вы будете представлены в приложении fpWeb с одним модулем по умолчанию.\
98	98		5\. Переместите фокус на модуль и перейдите в Object Inspector. Не стесняйтесь переименовывать модуль, если хотите.\
99	99		6\. Выберите вкладку Events и нажмите кнопку справа от второго столбца в строкеOnRequest, чтобы создать обработчик событий.
100	100
101	101
102	102		![Создание обработчика OnRequest веб-модуля в object inspector](/wiki-images/8/8d/Fpwebtutorial_on_request.png)\
103	103
104	104
105	105		Вы будете перенаправлены в редактор исходного кода со следующим кодом:
106	106
107	107		:
108	108
109	109		``` pascal
110	110		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
111	111		AResponse: TResponse; var Handled: Boolean);
112	112		begin
113	113		\|
114	114		end;
115	115		```
116	116
117	117
118	118		Заполните событие:
119	119
120	120		:
121	121
122	122		``` pascal
123	123		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
124	124		AResponse: TResponse; var Handled: Boolean);
125	125		begin
126	126		AResponse.Content := 'Hello, World!';
127	127		Handled := true;
128	128		end;
129	129		```
130	130
131	131		7\. Теперь запустите приложение (или нажмите F9).\
132	132		8\. Откройте браузер и введите:
133	133
134	134
135	135		<http://localhost:8080/>\
136	136
137	137		9\. Вы должны увидеть отображающееся "Hello, World!".\
138	138
139	139		Если это не так, проверьте ниже:
140	140
141	141		- Фреймворк выполняет много операций по обработке исключений, и отладчик IDE может их поймать и прервать работу вашего приложения. Можно добавить большинство исключений в список игнорирования, чтобы вы могли больше сосредоточиться на потоке приложения. Продолжайте пропускать и продолжайте, пока не перестанет появляться диалоговое окно и браузер не покажет результат.
142	142
143	143		- Handled := true - это способ, которым мы сообщаем фреймворку, что запрос был обработан. Если вы не установите его (или установите для него значение false), вместо этого будет отображаться страница с ошибкой. На данный момент это не влияет на поток запросов, но будет позже. Так что держите это так, пока не придет время, чтобы использовать его с пользой.
144	144
145	145		- другой трек: тест без брандмауэра, загруженного в ОЗУ (как приложение, как сервис или демон, или как оба).
146	146
147	147		## Чтение данных GET и POST
148	148
149	149		Динамический контент, скорее всего, будет запускаться из пользовательского ввода, либо через формы, предоставляя значения в URL-адресе, и т. Д. Эти данные отправляются вместе с запросом, который представлен в методе как ARequest параметр типа TRequest.
150	150
151	151		### Чтение GET
152	152
153	153		Данные GET предоставляются как ARequest.QueryFields, который является потомком TStrings. Короче говоря, все, что вы обычно делаете с TStrings, применимо здесь, например, доступ к данным в стиле карты через свойство Values.
154	154
155	155		Повторно используя приведенный выше код, замените тело метода на:
156	156
157	157		``` pascal
158	158		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
159	159		AResponse: TResponse; var Handled: Boolean);
160	160		var
161	161		LName: String;
162	162		begin
163	163		LName := ARequest.QueryFields.Values['Name'];
164	164		if LName = EmptyStr then
165	165		with AResponse.Contents do
166	166		begin
167	167		Add('<form action="' + ARequest.URI + '" method="GET"');
168	168		Add('<label for="name">Please tell me your name:</label>');
169	169		Add('<input type="text" name="name" id="name" />');
170	170		Add('<input type="submit" value="Send" />');
171	171		Add('</form>');
172	172		end
173	173		else
174	174		AResponse.Content := 'Hello, ' + LName + '!';
175	175		Handled := true;
176	176		end;
177	177		```
178	178
179	179		ARequest.URI - это просто ссылка на текущий URI, поэтому даже когда вы меняете зарегистрированный модуль или имя действия, этот код остается прежним.
180	180
181	181		Обратите внимание, что, как и в Паскале, обращение к данным осуществляется без учета регистра.
182	182
183	183		Теперь вы можете попробовать запросить /, который отобразит
184	184
185	185		` Please tell me your name`
186	186
187	187		и /?name=\<напишите здесь что угодно, например: Bob\>, который отобразит
188	188
189	189		` Hello, Bob!`
190	190
191	191		### Чтение POST
192	192
193	193		POST на самом деле не сильно отличается от GET, отличается только тем, к какому свойству получить доступ. Если доступ к GET осуществляется через ARequest.QueryFields, доступ к POST осуществляется через ARequest.ContentFields. Стиль POST предыдущего кода:
194	194
195	195		``` pascal
196	196		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
197	197		AResponse: TResponse; var Handled: Boolean);
198	198		var
199	199		LName: String;
200	200		begin
201	201		LName := ARequest.ContentFields.Values['Name'];
202	202		if LName = EmptyStr then
203	203		with AResponse.Contents do
204	204		begin
205	205		Add('<form action="' + ARequest.URI + '" method="POST"');
206	206		Add('<label for="name">Please tell me your name:</label>');
207	207		Add('<input type="text" name="name" id="name" />');
208	208		Add('<input type="submit" value="Send" />');
209	209		Add('</form>');
210	210		end
211	211		else
212	212		AResponse.Content := 'Hello, ' + LName + '!';
213	213		Handled := true;
214	214		end;
215	215		```
216	216
217	217		### Чтение загружаемых файлов
218	218
219	219		Единственное исключение - чтение полей multipart/form-data, то есть файлов. Оно доступно в ARequest.Files как экземпляр TUploadedFiles, который является потомком TCollection. Ниже приведен общедоступный интерфейс TUploadedFiles, который вы можете использовать для доступа к файлам:
220	220
221	221		``` pascal
222	222		TUploadedFiles = Class(TCollection)
223	223		...
224	224		public
225	225		Function First: TUploadedFile;
226	226		Function Last: TUploadedFile;
227	227		Function IndexOfFile(AName: String) : Integer;
228	228		Function FileByName(AName: String) : TUploadedFile;
229	229		Function FindFile(AName: String) : TUploadedFile;
230	230		Property Files[Index: Integer] : TUploadedFile read GetFile Write SetFile; default;
231	231		end;
232	232		```
233	233
234	234		Каждый TUploadedFile сам по себе имеет несколько свойств:
235	235
236	236		``` pascal
237	237		TUploadedFile = Class(TCollectionItem)
238	238		...
239	239		Public
240	240		Destructor Destroy; override;
241	241		Property FieldName: String Read FFieldName Write FFieldName;
242	242		Property FileName: String Read FFileName Write FFileName;
243	243		Property Stream: TStream Read GetStream;
244	244		Property Size: Int64 Read FSize Write FSize;
245	245		Property ContentType: String Read FContentType Write FContentType;
246	246		Property Disposition: String Read FDisposition Write FDisposition;
247	247		Property LocalFileName: String Read FLocalFileName Write FLocalFileName;
248	248		Property Description: String Read FDescription Write FDescription;
249	249		end;
250	250		```
251	251
252	252		Они должны быть достаточно информативными, за исключением FileName и LocalFileName. FileName - это name исходного файла, загружаемого с клиента, LocalFileName - это путь к файлу на сервере, где файл временно хранится. Обратите внимание на разницу, выделенную жирным шрифтом выше.
253	253
254	254		Опять же, повторное использование того же обработчика запросов:
255	255
256	256		``` pascal
257	257		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
258	258		AResponse: TResponse; var Handled: Boolean);
259	259		var
260	260		n: Integer;
261	261		f: TUploadedFile;
262	262		i: Integer;
263	263		begin
264	264		n := ARequest.Files.Count;
265	265		if n = 0 then
266	266		with AResponse.Contents do
267	267		begin
268	268		Add('<form id="form" action="' + ARequest.URI + '" method="POST" enctype="multipart/form-data">');
269	269		Add('<label for="name">Drag n drop or click to add file:</label>');
270	270		Add('<input type="file" name="input" />');
271	271		Add('<input type="submit" value="Send" />');
272	272		Add('</form>');
273	273		end
274	274		else
275	275		begin
276	276		f := ARequest.Files[0];
277	277		AResponse.Contents.LoadFromStream(f.Stream);
278	278		end;
279	279		Handled := true;
280	280		end;
281	281		```
282	282
283	283		перетащите и бросьте файл (желательно текстовый, так как он будет отображаться как текст) в поле входного файла (или нажмите соответствующую кнопку), затем нажмите кнопку Send' (Отправить). Должно отобразиться содержимое файла.
284	284
285	285		## Cookies
286	286
287	287		### Отправка
288	288
289		-	<img src="cookie_session_Object_Pascal.png" title="Концепция «cookie», изобретенная Netscape в 1994 году, позволяет HTTP-серверу идентифицировать всех своих клиентов." width="400" alt="Концепция «cookie», изобретенная Netscape в 1994 году, позволяет HTTP-серверу идентифицировать всех своих клиентов." />\
	289	+	![Концепция «cookie», изобретенная Netscape в 1994 году, позволяет HTTP-серверу идентифицировать всех своих клиентов.](/wiki-images/5/5c/Cookie_session_Object_Pascal.png)\
290	290		Файлы cookie - небольшой фрагмент данных, отправленный веб-сервером и хранимый на компьютере пользователя. Веб-клиент (обычно веб-браузер) всякий раз при попытке открыть страницу соответствующего сайта пересылает этот фрагмент данных веб-серверу в составе HTTP-запроса ([Wiki](https://ru.wikipedia.org/wiki/Cookie)). AResponse.Cookies содержит список отправляемых файлов cookie. Это потомок TCollection, соответственно содержащийся TCookie является потомком TCollectionItem. Следовательно, вы можете использовать TCollection как способ управления элементами для управления ими.
291	291
292	292		Вот пример:
293	293
294	294		``` pascal
295	295		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
296	296		AResponse: TResponse; var Handled: Boolean);
297	297		var
298	298		C: TCookie;
299	299		begin
300	300		C := AResponse.Cookies.Add;
301	301		C.Name := 'mycookie';
302	302		C.Value := 'somevalue';
303	303		Handled := true;
304	304		end;
305	305		```
306	306
307	307		Вы не увидите никаких результатов в своем браузере. Но если вы используете какие-то инструменты разработчика (в Chrome есть встроенный) можно увидеть заголовок ответа:
308	308
309	309		![](/wiki-images/6/69/Fpwebtutorial_cookie_set.png)
310	310
311	311		Обратите внимание, что файл cookie имеет атрибуты, поэтому вы можете установить не только имя и значение. Просмотрите интерфейс TCookie, чтобы узнать, какие свойства поддерживаются.
312	312
313	313		### Получение
314	314
315	315		Как только вы укажете выше заголовок Set-Cookie, последующий запрос на ваш сайт будет содержать дополнительный заголовок, содержащий значение, которое вы просили установить ранее:
316	316
317	317		![](/wiki-images/9/93/Fpwebtutorial_cookie_get.png)
318	318
319	319		К счастью, способ чтения не отличается от данных GET и POST. Связанное свойство - ARequest.CookieFields. Чтобы прочитать ранее отправленный файл cookie:
320	320
321	321		``` pascal
322	322		procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
323	323		AResponse: TResponse; var Handled: Boolean);
324	324		begin
325	325		AResponse.Contents.Add('<p>Cookie get: ' + ARequest.CookieFields.Values['mycookie'] + '</p>');
326	326		Handled := true;
327	327		end;
328	328		```
329	329
330	330		## Сессии
331	331
332	332		TFPWebModule является потомком TSessionHTTPModule, поэтому имеет возможность управления сессией. Сессия основана на модулях, поэтому каждый модуль может выбирать, использовать или не использовать управление сессией.
333	333
334	334		Сессия реализована абстрактно. По умолчанию реализация не предусмотрена. Один пример реализации с использованием файлов .ini приведен в модуле iniwebsession. Вы должны иметь этот модуль в своем проекте или реализовать его, чтобы управление сессией работало. Если вы решите реализовать один из них, в основном вам необходимо расширить и реализовать абстрактные методы в классах TCustomSession и 'TSessionFactory'.
335	335
336	336		### Активация
337	337
338	338		Чтобы активировать управление сессией, установите для свойства CreateSession в значение true. Сессия будет запущена до обработки запроса. В случае новой сессией будет вызвано OnNewSession. Здесь инициализируйте переменные сессии.
339	339
340	340		### Управление переменными сессии
341	341
342	342		Переменные сессии представлены как Session.Variables (примечание: объект сессии является эквивалентом массива \$ _SESSION, используемого в Php). Это строка для сопоставления строк, подобная структуре, поэтому вы можете читать / писать так:
343	343
344	344		``` pascal
345	345		Session.Variables['myvar'] := myvar; // записываем
346	346		...
347	347		myvar := Session.Variables['myvar']; // читаем
348	348		```
349	349
350	350		Задание переменной пустой строки НЕ удаляет ее. Если вы действительно хотите удалить переменную, вместо этого вызовите Session.RemoveVariable.
351	351
352	352		### Завершение
353	353
354	354		Вызывайте Session.Terminate всякий раз, когда вы хотите завершить сессию (например, выход пользователя из системы). Сессия также автоматически истечет, если следующий запрос поступит после Session.TimeOutMinutes с момента последнего запроса. Когда сессия завершается, будет вызван OnSessionExpired. Сделайте там все, что вам нужно.
355	355
356	356		## Маршрутизация
357	357
358	358		Начиная с FPC 3.0.4, был реализован новый механизм маршрутизации. Вместо сохранения обратной совместимости решено, что по умолчанию будет использоваться новая маршрутизация. Таким образом, любой старый код (или новый код в зависимости от старой маршрутизации) необходимо перенести, добавив:
359	359
360	360		``` pascal
361	361		Application.LegacyRouting := true;
362	362		```
363	363
364	364		в *.lpr файле.
365	365
366	366		### Старый способ
367	367
368	368		#### Использование нескольких модулей
369	369
370	370		В вашем приложении может быть несколько модулей. Щелкните меню "File", затем щелкните "New...". В появившемся диалоговом окне выберите "Web Module" в дереве выбора модулей.
371	371
372	372		![](/wiki-images/e/e5/Fpwebtutorial_new_module.png)
373	373
374	374		затем нажмите OK.
375	375
376	376		Поскольку в вашем приложении существует несколько модулей, вы больше не можете делать запрос (request) только с использованием `/`. Платформа не сможет волшебным образом выбрать, какой модуль должен обслуживать ответ (response), поэтому есть два способа указать, какой модуль вы хотите вызвать:
377	377
378	378		- /\<module name\>
379	379		- /?module=\<module name\>
380	380
381	381		Во втором формате вы можете изменить "module" (который является значением по умолчанию) на любой допустимый ключ строки запроса, изменив Application.ModuleVariable.
382	382
383	383		#### С использованием Actions
384	384
385	385		До сих пор мы использовали только веб-модули с обработчиком единого запроса. Это не сильно масштабируется, поскольку ваше веб-приложение становится все более и более сложным. Более того, некоторые функции могут иметь общие свойства и могут быть лучше логически сгруппированы, например:
386	386
387	387		- Account module
388	388		- Login action
389	389		- Logout action
390	390		- Register action
391	391		- Product module
392	392		- Create action
393	393		- Update action
394	394		- Delete action
395	395		- Details action
396	396
397	397		##### Поток обработки запросов (request)
398	398
399	399		Прежде, чем использовать действие (action), важно знать, как обрабатывается запрос fpWeb. В противном случае ваше действие (action) может оказаться бесполезным, потому что ваш модуль данных всегда обрабатывает запрос. Как такое могло случится? Возвращаясь немного назад, вспомните Handled := true, которое мы всегда делали раньше? Теперь в игру вступает параметр Handled.
400	400
401	401		Каждый запрос сначала будет проходить через модуль OnRequest, независимо от запрошенного действия. Только если для этого не установлено значение Handled, выполняется OnRequest веб-действия.
402	402
403	403		В общем, поток запросов:
404	404
405	405		![](/wiki-images/e/ea/Fpwebtutorial_request_flow.png)
406	406
407	407		Обратите внимание на окошко "Our Concern" (наша озабоченность), это то, на что мы собираемся обратить наше внимание.
408	408
409	409		##### Добавление действий в веб-модули
410	410
411	411		Чтобы добавить действие, выберите веб-модуль и перейдите в инспектор объектов. На вкладке свойств выберите "Actions" и нажмите кнопку во втором столбце.
412	412
413	413		![](/wiki-images/9/95/Fpwebtutorial_manage_actions.png)
414	414
415	415		Появится всплывающее окно, в котором вы можете добавлять, удалять и изменять порядок действий.
416	416
417	417		![](/wiki-images/d/db/Fpwebtutorial_edit_actions.png)
418	418
419	419		Нажмите "Add", в списке появится новое действие. Выберите его, затем перейдите в инспектор объектов. В настоящее время он будет показывать свойства и события этого вновь созданного действия. Переименуйте свойство Name (это будет имя, которое вы напишете в URL-адрес, поэтому дайте ему короткое, простое, но описательное имя) как вы желаете, я выберу "Hello". Двигаемся дальше на вкладку событий, сделайте то же самое, что и OnRequest для модуля, нажмите кнопку справа от строки OnRequest, чтобы создать обработчик запросов.
420	420
421	421		![](/wiki-images/2/2e/Fpwebtutorial_action_onrequest.png)
422	422
423	423		Вы будете представлены в том же интерфейсе OnRequest, но этот обрабатывает веб-действие вместо веб-модуля. Все, что вы можете сделать в OnRequest веб-модуля, можно сделать и здесь. Скопируйте тело метода из 'Hello, World!' раздела.
424	424
425	425		Не забудьте удалить Handled := true из тела OnRequest предыдущего веб-модуля (или полностью удалить событие), чтобы действие позаботилось об обработке запроса.
426	426
427	427		Запустите свой проект и запустите браузер. Теперь, поскольку обработка запросов делегирована веб-действию, вы больше не можете просто запрашивать /, но вам нужно / \<action name\> или \<свойство ActionVar модуля\>=\<action name\>. Обратите внимание, что \<свойство ActionVar модуля\> по умолчанию имеет значение пустой строки, в отличие от Application.ModuleVariable, для которого "модуль" является значением по умолчанию. Итак, по умолчанию вы можете использовать только /\<action name\> формы.
428	428
429	429		Если у вас несколько модулей, то у вас есть множество вариантов:
430	430
431	431		- /\<module name\>/\<action name\>
432	432		- /\<module name\>?action=\<action name\>
433	433		- /\<action name\>?module=\<module name\>
434	434		- /?module=\<module name\>&action=\<action name\>
435	435
436	436		Обратите внимание, что как только у модуля есть хотя бы одно действие, /\<module или action name\> по умолчанию сопоставляется с /\<action name\>. Чтобы изменить поведение таким образом, чтобы по умолчанию оно отображалось как /\<module name\>, установите для параметра Application.PreferModuleName значение true. В случае нескольких модулей, если имя модуля не указано, модуль по умолчанию будет обрабатывать данное действие. Чтобы изменить поведение таким образом, что имя модуля задавалось явно, установите для Application.AllowDefaultModule значение false.
437	437
438	438		Следующие таблицы обобщают то, что произойдет на основе двух свойств:
439	439
440	440		<thead>
441	441
442	442		</thead>
443	443		<tbody>
444	444
445	445		</tbody>
446	446
447	447		##### Действие по умолчанию
448	448
449	449		Помните предыдущую диаграмму, "Delegate request handling to actions" (Делегировать обработку запросов действиям) на самом деле не так просто, но если мы расширим эту диаграмму, изображение будет слишком большим, чтобы поместиться. Итак, вот схема этой части:
450	450
451	451		![](/wiki-images/4/44/Fpwebtutorial_request_delegation_flow.png)
452	452
453	453		Две важные вещи из потока: DefActionWhenUnknown и действие по умолчанию. Первое является свойством веб-модуля, а второе соответствует свойству Default действия. В последнем случае, если имеется более двух действий, для которых свойство Default установлено в значение `true`, порядок действий (то, как он отображается во всплывающем окне управления действиями) будет учитываться для определения того, какое действие является действием по умолчанию. Эти два свойства определяют, что должно делать приложение, если для данного запроса не найдено подходящего действия.
454	454
455	455		Следующие таблицы обобщают то, что произойдет на основе двух свойств:
456	456
457	457		<thead>
458	458
459	459		</thead>
460	460		<tbody>
461	461
462	462		</tbody>
463	463
464	464		<thead>
465	465
466	466		</thead>
467	467		<tbody>
468	468
469	469		</tbody>
470	470
471	471		В случае приведенного выше ответа об ошибке должна следовать трассировка стека с информацией о номере строки, если вы создаете свое приложение с параметром `-gl`. Позже мы увидим, как создать собственный обработчик для этого (трассировка стека не годится для производства). Но пока убедитесь, что вы понимаете концепцию веб-модуля и веб-действия, особенно поток запросов. Играйте, пока не решите, что готовы к следующему разделу.
472	472
473	473		### Новый механизм
474	474
475	475		Новый механизм чрезвычайно гибок и работает даже без модулей данных (старый механизм работает только с модулями данных).
476	476
477	477		Выделенный модуль для этой маршрутизации предоставляется как httproute (добавьте его в пункт использования программы/модуля, где вы хотите зарегистрировать маршруты). Модуль содержит функцию HTTPouter, которая возвращает одноэлементный объект, отвечающий за управление маршрутом приложения, и имеет метод RegisterRoute для регистрации вашего маршрута.
478	478
479	479		#### Синтаксис маршрута
480	480
481	481		Первый параметр HTTPouter.RegisterRoute — это маршрут, который будет сопоставляться с входящим запросом. Это может быть как простое *** выше, что означает 0 или более путей или просто любые пути, так и сложное, как /api/v1/:resource/*, что означает, что заголовок REQUEST_URI должен начинаться с /api/v1/**, за которым следует что-то еще, что будет привязано к переменной с именем resource и заканчиваться 0 или более путями. Он будет соответствовать:
482	482
483	483		- /api/v1/products
484	484		- /api/v1/products/1
485	485		- /api/v1/products/1/clone
486	486		- /api/v1/products/something/else/that/is/really/long/and/silly
487	487
488	488		но не:
489	489
490	490		- /api/v1
491	491		- /excuse/me/api/v1/products
492	492
493	493		В основном есть только 3 специальных символа:
494	494
495	495		- * обозначает 0 или более путей
496	496
497	497		-
498	498		param обозначающий часть
499	499
500	500		- / обозначающий разделитель частей
501	501
502	502		ваш маршрут будет состоять из этих 3 символов, а также всего остального, из чего состоит маршрут.
503	503
504	504		#### Регистрация маршрута
505	505
506	506		2-й, 3-й или 4-й параметр (в зависимости от того, хотите ли вы обрабатывать конкретный метод HTTP и/или передавать ему дополнительные данные) HTTPRouter.RegisterRoute перегружен несколькими возможностями:
507	507
508	508		- Процедура обратного вызова
509	509
510	510		``` pascal
511	511		TRouteCallback = Procedure(ARequest: TRequest; AResponse);
512	512		```
513	513
514	514		- Событие обратного вызова
515	515
516	516		``` pascal
517	517		TRouteEvent = Procedure(ARequest: TRequest; AResponse) of object;
518	518		```
519	519
520	520		- Объект, удовлетворяющий интерфейсу (CORBA)
521	521
522	522		``` pascal
523	523		IRouteInterface = Interface ['{10115353-10BA-4B00-FDA5-80B69AC4CAD0}']
524	524		Procedure HandleRequest(ARequest: TRequest; AResponse: TResponse);
525	525		end;
526	526		```
527	527
528	528		- Объект, расширяющий абстрактный класс маршрутизатора
529	529
530	530		``` pascal
531	531		TRouteObject = Class(TObject, IRouteInterface)
532	532		Public
533	533		Procedure HandleRequest(ARequest: TRequest; AResponse: TResponse); virtual; abstract;
534	534		end;
535	535
536	536		TRouteObjectClass = Class of TRouteObject;
537	537		```
538	538
539	539		По умолчанию, если второй параметр не является TRouteMethod, будут совпадать все методы HTTP. Используйте один из rmUnknown, rmAll, rmGet, rmPost, rmPut, rmDelete, rmOptions, rmHead, rmTrace, чтобы соответствовать только определенному методу HTTP.
540	540
541	541		Порядок регистрации имеет значение. Если есть два или более маршрута, соответствующих текущему запросу, его обработает ранее зарегистрированный.
542	542
543	543		В этом новом механизме автономнаяй "Hello, World!"-программа может быть такой простой, как:
544	544
545	545		``` pascal
546	546		uses
547	547		fphttpapp, httpdefs, httproute;
548	548		procedure DoHello(ARequest:TRequest; AResponse : TResponse);
549	549		begin
550	550		AResponse.Content:='<html><body><h1>Hello,World!</h1></body></html>'
551	551		end;
552	552
553	553		begin
554	554		HTTPRouter.RegisterRoute('*', @DoHello);
555	555		Application.Port := 9000;
556	556		Application.Initialize;
557	557		Application.Run;
558	558		end.
559	559		```
560	560
561	561		#### Пример веб-сервера
562	562
563	563		Это пример простого кроссплатформенного многопоточного веб-сервера.
564	564
565	565		``` pascal
566	566		program webserver;
567	567
568	568		{$mode objfpc}{$H+}
569	569
570	570		uses
571	571		{$ifdef UNIX}
572	572		cthreads, cmem,
573	573		{$endif}
574	574		fphttpapp, httpdefs, httproute;
575	575
576	576		procedure route1(aReq: TRequest; aResp: TResponse);
577	577		begin
578	578		aResp.content:='<html><body><h1>Route 1 The Default</h1></body></html>'
579	579		end;
580	580
581	581		procedure route2(aReq: TRequest; aResp: TResponse);
582	582		begin
583	583		aResp.content:='<html><body><h1>Route 2</h1></body></html>'
584	584		end;
585	585
586	586		begin
587	587		HTTPRouter.registerRoute('/', @route1, true);
588	588		HTTPRouter.registerRoute('/route2', @route2);
589	589		Application.port := 8080;
590	590		Application.threaded := true;
591	591		Application.initialize;
592	592		Application.run;
593	593		end.
594	594		```
595	595
596	596		## Использование шаблонов
597	597
598	598		fpWeb имеет встроенную поддержку FPTemplate, универсального движка шаблонов Free Pascal. Его не обязательно использовать из контекста веб-приложения, но с интегрированной поддержкой все будет немного проще. По крайней мере, управление памятью можно игнорировать, так как об этом позаботится модуль.
599	599
600	600		Есть два уровня, на которых можно использовать шаблоны: действие и модуль. Полная поддержка RAD до конца не реализована, поэтому в некоторых моментах вам нужно перейти к ручному кодированию.
601	601
602	602		Существует два режима работы: непараметризованный и параметризованный. Активный режим управляется свойством AllowTagParams, которое должно быть достаточно очевидным, какое значение относится к какому режиму.
603	603
604	604		Строка шаблона может быть передана из файла через свойство FileName или прямая строка через свойство Template. `Template.Template` - я знаю, это звучит странно :) Если оба заполнены, то FileName будет иметь приоритет.
605	605
606	606		Два свойства: StartDelimiter и EndDelimiter определяют, как механизм должен распознавать тег шаблона. Например, если у вас есть:
607	607
608	608		- StartDelimiter = '{+'
609	609		- EndDelimiter = '+}'
610	610
611	611		затем строка '{+title+}' определяет тег шаблона с именем 'title'. Обратите внимание, что пробелы важны, поэтому '{+ title +}' определяет тег шаблона с именем ' title ', а не просто 'title'.
612	612
613	613		Специальные для параметризованного режима дополнительные три свойства: ParamStartDelimiter, ParamEndDelimiter и ParamValueSeparator определяют, как движок должен распознавать параметр тега шаблона. Например, если у вас есть:
614	614
615	615		- ParamStartDelimiter = '\[-'
616	616		- ParamEndDelimiter = '-\]'
617	617		- ParamValueSeparator = '='
618	618
619	619		тогда строка '{+data \[-p=v-\]\[-a=b-\] +}' определяет тег шаблона с именем 'data' с параметром 'p' значения 'v' и параметром 'a' значения ' б'. Это можно использовать для передачи параметра уровня шаблона, такого как ожидаемый формат даты, заголовок-строка-нижний колонтитул для настраиваемого выходного представления, имя файла и т. д., как вы решите.
620	620
621	621		Как следствие другого способа работы, основное событие, в котором работает шаблон, также отличается. Непараметризованный будет использовать OnGetParam, а параметризованный будет использовать OnReplaceTag. У них, конечно, другой интерфейс:
622	622
623	623		``` pascal
624	624		Type
625	625		// OnGetParam: только для поддержки простого тега шаблона (напр: {Name})
626	626		TGetParamEvent = Procedure(
627	627		Sender: TObject;
628	628		Const ParamName: String;
629	629		Out AValue: String
630	630		) Of Object;
631	631		// OnReplaceTag: для тегов с поддержкой параметров
632	632		TReplaceTagEvent = Procedure(
633	633		Sender: TObject;
634	634		Const TagString: String;
635	635		TagParams: TStringList;
636	636		Out ReplaceText: String
637	637		) Of Object;
638	638		```
639	639
640	640		В OnGetParam вы проверяете ParamName, а затем соответственно назначаете AValue, т. е. если вы хотите, чтобы тег 'title' был заменен на 'My App', тогда заполните метод следующим образом:
641	641
642	642		``` pascal
643	643		// используйте Trim(), если вы хотите, чтобы пробелы вокруг тега были незначительными
644	644		case Trim(ParamName) of
645	645		'title': AValue := 'My App';
646	646		else
647	647		AValue := 'UNKNOWN';
648	648		end;
649	649		```
650	650
651	651		В OnReplaceTag вы проверяете TagString и, возможно, TagParams, а затем соответственно назначаете ReplaceText, т.е., если вы хотите, чтобы тег 'datetime' был заменен текущим временем с параметром 'datetimeformat', чтобы указать, как следует форматировать дату и время, заполните метод следующим образом:
652	652
653	653		``` pascal
654	654		// используйте Trim(), если вы хотите, чтобы пробелы вокруг тега были незначительными
655	655		case Trim(TagString) of
656	656		'datetime': AValue := FormatDateTime(TagParams.Values['datetimeformat'],Now);
657	657		else
658	658		AValue := 'UNKNOWN';
659	659		end;
660	660		```
661	661
662	662		### На уровне действий
663	663
664	664		Создайте/выберите действие, затем перейдите в инспектор объектов. Вы увидите свойство подкомпонента с именем Template(Шаблон). Этот шаблон является обычным экземпляром TFPTemplate. Разверните его и заполните свойства, как описано выше. Теперь перейдите на вкладку Events(События), снова разверните Template, вы увидите два события. Заполните тот, который основан на вашем значении свойства AllowTagParams.
665	665
666	666		> Note: Если ваш Lazarus не может автоматически заполнять событие, попробуйте ввести имя вручную в поле редактирования, а затем нажмите кнопку "...". Это ошибка в текущем Lazarus, которая может быть исправлена в будущем.
667	667
668	668		На этом уровне шаблон с содержимым не устанавливается автоматически в качестве обработчика запроса. Это может измениться в будущем, но давайте разберемся с его текущим состоянием. Заполните событие OnRequest действия, затем заполните его:
669	669
670	670		``` pascal
671	671		with Actions.CurrentAction as TFPWebAction do
672	672		begin
673	673		AResponse.Content := Template.GetContent;
674	674		end;
675	675		Handled := true;
676	676		```
677	677
678	678		Приведение необходимо, поскольку CurrentAction имеет тип TCustomWebAction вместо TFPWebAction. Без него мы не сможем получить доступ к свойству Template.
679	679
680	680		### На уровне модуля
681	681
682	682		На уровне модуля вам в настоящее время придется делать это вручную, поскольку поддержка RAD не реализована. Связанным свойством является ModuleTemplate. Однако это не обычный экземпляр TFPTemplate, а специальный класс TFPWebTemplate, являющийся его потомком.
683	683
684	684		Идея здесь состоит в том, чтобы модуль предоставлял макет, а действия предоставляли контент с возможностью предоставления дополнительных переменных. Поэтому рекомендуется оставить AllowTagParams как есть и назначить событие OnGetParam только модуля. НЕ назначайте OnGetParam для ModuleTemplate, так как он никогда не будет вызываться.
685	685
686	686		Тег шаблона с именем 'content' будет автоматически заменен содержимым, созданным действием, все остальное заменяется либо из внутренних переменных шаблона, либо из OnGetParam.
687	687
688	688		### Использование отдельного шаблона
689	689
690	690		Несмотря на несколько неполную интеграцию, ничто не мешает вам использовать fpTemplate (или любые другие решения для шаблонов) вручную, вне встроенной поддержки. В некоторых случаях это может быть даже лучше, поскольку оно будет модульным.
691	691
692	692		## Использольвание html Producer object
693	693
694	694		Предполагая, что существует TWebAction с именем act_get_my_html, вы должны попросить написать в AResponse возврат внутреннего потока байтов: при ответе с помощью решения html Producer objects мы должны использовать методы писателя. Он управляет потоком памяти с целью ускорения. Здесь нет строкового типа, как в приведенном выше решении fpTemplate, которое использует обработку текста строки, как обычно в Php. Producer записывает в AResponse рекурсивную итерацию " foreach ", которая проходит по дереву полиморфных объектов HTML Dom, состоящему из иерархии классов `THtmlCustomElement = Class(TDOMElement)`(см. модуль `htmlelements.pp`). Итак, AResponse пишется параметром aWriter, со следующим вызовом:
695	695
696	696		``` pascal
697	697		procedure TFPWebModule1.act_get_my_htmlRequest(Sender: TObject; ARequest: TRequest; AResponse: TResponse; var Handled: Boolean);
698	698		begin
699	699		(* спрашиваем у HTMLEntityProducer1 содержимое своих html-элементов DOM: *)
700	700		HTMLEntityProducer1.HandleRequest(ARequest, AResponse, Handled);
701	701		Handled := True;
702	702		end;
703	703		```
704	704
705	705		Повторим еще раз, что работа Producer заключается в преобразовании потока внутренней памяти в текст в объекте ответа: именно так был разработан этот шаблон, хотя существует метод рендеринга text-html с именем ProduceContent только для целей отладки. Вы можете переопределить этот метод, если вы пишете или отлаживаете компонент Producer.
706	706
707	707		Вот пример с html-объектом Producer, позволяющий создать веб-приложение «способом RAD», то есть с помощью перетаскивания компонента HTMLEntityProducer из палитры:
708	708
709	709		``` pascal
710	710		procedure TFPWebModule1.HTMLEntityProducer1WriteEntity(Sender: THTMLContentProducer; aWriter: THTMLWriter);
711	711		begin
712	712
713	713		aWriter.startHeader;
714	714		aWriter.Meta('','Content-Type','text/html; charset=UTF-8');
715	715		aWriter.title('My web page');
716	716		aWriter.link('stylesheet','stylesheet.css','text/css','screen');
717	717		aWriter.EndHeader;
718	718
719	719		aWriter.Startbody;
720	720		aWriter.Startparagraph;
721	721		aWriter.heading2('Hello, world from inside §1:');
722	722		aWriter.Text('Here is text written inside the current paragraph.');
723	723		aWriter.Endparagraph;
724	724		aWriter.paragraph('This is another text written inside a self "started and ended" paragraph.');
725	725		aWriter.Startparagraph;
726	726		aWriter.heading2('Hello, world from inside §2:');
727	727		aWriter.Text('Here is the final text.');
728	728		aWriter.Image.src := 'logo.png';
729	729		AnotherProducer.WriteContent(aWriter);
730	730		aWriter.Endparagraph;
731	731		aWriter.Endbody;
732	732
733	733		end;
734	734		```
735	735
736	736		Свойство TWebAction.ContentProducer позволяет связать THTTPContentProducer с его веб-действием, предоставляемым через URI в сети.
737	737
738	738		\[ToDo: нет официальной документации о компонентах «способ RAD» fpWeb (html producer, html provider, html adapter, html formatter и т.д.)\]
739	739
740	740		## Советы и хитрости
741	741
742	742		### Возврат другого кода ответа HTTP
743	743
744	744		По умолчанию fpWeb возвращает HTTP 200 OK, чтобы указать на успешную обработку запроса. Это, конечно, не всегда так, поскольку пользовательский ввод может быть не таким, как мы ожидали. Для этого установите для параметра AResponse.Code в обработчике запроса код, который вы хотите вернуть.
745	745
746	746		### Перенаправление запроса на другой URL
747	747
748	748		Обычная практика после успешного входа в систему — перенаправление пользователя на страницу его учетной записи. Это можно сделать, вызвав AResponse.SendRedirect в обработчике запросов, указав URL-адрес для перенаправления запроса.
749	749
750	750		### Обслуживание статических файлов (встроенный веб-сервер)
751	751
752	752		Помните диалоговое окно в разделе [[fpWeb Tutorial/ru\|Hello, World!]] после выбора приложения HTTP-сервера? Если вы отметите "Register location to serve files from"(Зарегистрировать местоположение для обслуживания файлов), вы можете заполнить "Location"(Расположение) (сегмент URI, не должен содержать слэшей) и "Directory"(Каталог) (физический каталог на вашем компьютере, должен существовать во время выполнения), то мастер просто добавит:
753	753
754	754		``` pascal
755	755		RegisterFileLocation('<Location>','<Directory>');
756	756		```
757	757
758	758		в начало вашего .lpr-файла и добавит модуль fpwebfile* в раздел uses. Вы можете сделать это вручную в любое время, а также зарегистрироваться несколько раз для разных местоположений/каталогов. После этого вы можете запросить /\<Location\>/\<любое имя файла в Directory\>, и оно будет предоставлено автоматически. Обратите внимание, что mimetype файла определяется fpmimetypes. Вызовите MimeTypes.LoadFromFile с вашим файлом mime.types, чтобы указать правильный тип mimetype на основе его расширения. В противном случае файл всегда будет обслуживаться как application/octet-stream, что означает, что браузер загрузит его, а не интерпретирует (особенно важно для файлов JavaScript и CSS).
759	759
760	760		Вы можете получить полные mime.types [здесь](http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/conf/mime.types?&view=co).
761	761
762	762		В Lazarus 2.0.6 или новее вы должны добавить в начало своей программы полный путь к файлу mime.types.
763	763
764	764		``` pascal
765	765		begin
766	766		MimeTypesFile := Application.Location + 'mime.txt';
767	767		```
768	768
769	769		Примите во внимание, что путь по умолчанию, идущий с проектом, это - lib\\\$(TargetCPU)-\$(TargetOS)
770	770
771	771		Например: httpproject\lib\i386-win32\mime.txt
772	772
773	773		### Централизованное управление конфигурацией и модулями
774	774
775	775		По умолчанию программный файл (.lpr) содержит модуль протокола. Это ограничивает возможность использования объекта Application из других контекстов, таких как веб-модули. К счастью, нетрудно провести рефакторинг, чтобы получить то, что мы хотим. Мы удаляем вызовы RegisterHTTPModule из веб-модулей и не будем использовать .lpr для очистки основного блока с единственным идентификатором модуля в разделе uses, назовем его: брокер. Содержимое модуля:
776	776
777	777		``` pascal
778	778		unit Brokers;
779	779
780	780		{$mode objfpc}{$H+}
781	781
782	782		interface
783	783
784	784		{ $define cgi}
785	785		{ $define fcgi}
786	786		{$define httpapp}
787	787
788	788		uses
789	789		CustWeb;
790	790
791	791		function GetApp: TCustomWebApplication; inline;
792	792
793	793		implementation
794	794
795	795		uses
796	796		{$ifdef cgi}fpcgi{$endif}
797	797		{$ifdef fcgi}fpfcgi{$endif}
798	798		{$ifdef httpapp}fphttpapp{$endif}
799	799		,webmodule1
800	800		,webmodule2
801	801		;
802	802
803	803		function GetApp: TCustomWebApplication;
804	804		begin
805	805		Result := Application;
806	806		end;
807	807
808	808		initialization
809	809		RegisterHTTPModule('wm1', TWebModule1);
810	810		RegisterHTTPModule('wm2', TWebModule2);
811	811		{$ifndef cgi}
812	812		Application.Port := 2015;
813	813		{$endif}
814	814		Application.Initialize;
815	815		Application.Run;
816	816		end.
817	817		```
818	818
819	819		Таким образом, мы можем управлять регистрацией веб-модуля, а также предоставлять API для получения объекта Application (представленного как TCustomWebApplication), в то же время легко переключаясь между реализациями протокола в одном месте.
820	820
821	821		### Элегантное завершение (FastCGI / встроенный веб-сервер)
822	822
823	823		Вместо нажатия `Ctrl`+`C` в вашем приложении есть способ корректно завершить работу вашего приложения, выполнив необходимую очистку, вызвав Application.Terminate. Возможно, вам придется использовать предыдущий трюк, чтобы легко получить доступ к объекту Application. Распространенной реализацией является предоставление определенного защищенного паролем модуля/действия, которое вызывает метод Terminate. Впрочем, вы можете выбрать любой способ.
824	824
825	825		### Пользовательский обработчик исключений
826	826
827	827		\[отредактировано 1 мая 2020г =\> переход от указателя метода к простой процедуре..\]
828	828
829	829		Чтобы переопределить обработчик исключений по умолчанию, который выдает трассировку стека всякий раз, когда возникает исключение (например, по HTTP 404 или 500), и, следовательно, не подходит для производства, вы должны задать Application.OnShowRequestException.
830	830
831	831		Это метод, поэтому вам нужно будет предоставить свою процедуру, реализующую метод, и присвоить ее с помощью объекта, т.е.: если у вас есть MyExceptionHandler как объект TMyExceptionHandler, который имеет метод MyShowRequestException, вы можете назначить его посредством:
832	832
833	833		``` pascal
834	834		Application.OnShowRequestException := @MyExceptionHandler.MyShowRequestException;
835	835		```
836	836
837	837		не забудьте .Create() MyExceptionHandler ПЕРЕД назначением выше, иначе вы получите EAccessViolation!
838	838
839	839		Вы должны предоставить свою глобальную процедуру, которая реализует ваш собственный обработчик исключений (в рабочей среде рекомендуется заменить стек вызовов кодом состояния HTTP и его объяснением). Затем вы можете переопределить обработчик исключений по умолчанию, назначив его следующим образом:
840	840
841	841		``` pascal
842	842		Application.OnShowRequestException := @MyShowRequestException;
843	843		```
844	844
845	845		### Чисто ручное кодирование (дизайнер форм не требуется)
846	846
847	847		Нет необходимости использовать конструктор форм Lazarus для написания fpWeb-приложения. Вы можете использовать технику чисто ручного кодирования, чтобы написать его. Секрет кроется в третьем параметре RegisterHTTPModule: SkipStreaming. Если для этого параметра установлено значение true, fpWeb не будет искать ресурс .lfm. Поэтому все должно обрабатываться вручную: настройки свойств, обработчики событий, регистрация действий и т.д.
848	848
849	849		Обратите внимание, что логично делать то, что обычно делается через инспектор объектов в переопределенном конструкторе. Внутри него вызовите унаследованный конструктор, передав в качестве параметров AOwner и CreateMode. После этого вы можете установить свойства, назначить обработчики событий и т.д. Пример:
850	850
851	851		``` pascal
852	852		type
853	853		THelloWorldModule = class(TFPWebModule)
854	854		constructor CreateNew(AOwner: TComponent; CreateMode: Integer); override;
855	855		procedure Request(Sender: TObject; ARequest: TRequest;
856	856		AResponse: TResponse; var Handled: Boolean);
857	857		end;
858	858
859	859		constructor THelloWorldModule.CreateNew(AOwner: TComponent; CreateMode: Integer);
860	860		begin
861	861		inherited CreateNew(AOwner,CreateMode);
862	862		OnRequest := @Request;
863	863		end;
864	864
865	865		procedure THelloWorldModule.Request(Sender: TObject; ARequest: TRequest;
866	866		AResponse: TResponse; var Handled: Boolean);
867	867		begin
868	868		AResponse.Content := 'Hello, World!';
869	869		Handled := true;
870	870		end;
871	871		```
872	872
873	873		## См.также
874	874
875	875		- [Lazarus для Интернета (учебник)](https://www.freepascal.org/~michael/articles/#web1)
876	876		- [Lazarus для Интернета: сеансы и шаблоны (учебник))](https://www.freepascal.org/~michael/articles/#web2) В этой статье описывается класс TSQLDBSession, который управляет подключением SQL, которое наследуется от веб-сеанса (для управления историями переменных веб-сеанса в рамках сеанса подключения к базе данных, имеющей возможности блокировки строк).
877	877		- примеры - чтение текстовых файлов - в вашем каталоге ...\fpc\x.x.x\source\packages\fcl-web\examples.\
878	878
879		-	~~<img src="cgi-listrecords.png" title="Копия скриншота одного из примеров" width="50" />~~
	879	+	![](/wiki-images/c/c0/Cgi-listrecords.png)
880	880
881	881		- XML или JSON на ExtJS: если вы хотите использовать более или менее сложный движок, который очень «продвинут» в отношении аспекта рендеринга объектов Javascript на стороне браузера, в дополнение к их функциональным возможностям (например, ExtJS для отображения сетка с поддержкой базы данных, динамическая графика и т. д.), для такого решения очень часто требуется файл XML или JSON. Существуют классы Adapter и Formatter (например, классы TExtJSXMLWebdataInputAdaptor, TExtJSJSONDataFormatter).
882	882
883	883		В целом, классы Adapter адаптируют узлы входящего jSon или XML к отображению своих полей базы данных TField. А классы Formatter сопоставляют каждую запись TField с ее узлом в формате jSon или XML перед отправкой в браузер.\
884	884		* [Форматы веб-данных в Lazarus/FPC](https://www.freepascal.org/~michael/articles/#webdata)
885	885
886	886		- [Практическое построение GUI в ExtJS](https://www.freepascal.org/~michael/articles/#extjs1)
887	887		- [Смешивание веб-приложений ExtJS и Pascal: ExtPascal](https://www.freepascal.org/~michael/articles/#extpascal)
888	888
889	889		---
890	890		From the Free Pascal wiki, page "fpWeb Tutorial/ru", as it stood on 2022-06-07 after a change by Zoltanleo, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).

Back to history