fpWeb Tutorial/ru: what changed

Revision 3 to 4. Removed lines have a minus sign; added lines have a plus sign.

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