ОбъектHttpResponse
HttpResponse — это объект ответа HTTP, использующийHttpRequest.responseОбъект завершает ответ данных HTTP-сервера илиhttp.requestДанные ответа запроса, возвращаемые с сервера
В следующем примере показано, какhttp.ServerИспользуемый пример кода выглядит следующим образом:
1
2
3
4
5
6
7
8
9
10
11
12
13
14const http = require('http');
const server = new http.Server(8080, (request) => {
// retreive the response object
const response = request.response;
// set the status code
response.statusCode = 200;
// set the content type to text/plain
response.setHeader('Content-Type', 'text/plain');
// write the response body
response.write('ok');
});
server.start();
отношения наследства
Конструктор
HttpResponse
Конструктор HttpResponse создает новый объект HttpResponse.
1new HttpResponse();
постоянный
TEXT
Укажите тип сообщения 1, который представляет тип текста.
1const HttpResponse.TEXT = 1;
BINARY
Укажите тип сообщения 2, представляющий двоичный тип.
1const HttpResponse.BINARY = 2;
свойства члена
statusCode
Целое число, запрос и установка статуса возврата ответного сообщения
1Integer HttpResponse.statusCode;
statusMessage
Строка, запрос и установка возвращаемого сообщения ответного сообщения.
1String HttpResponse.statusMessage;
status
Целое число, запросите и установите возвращаемый статус ответного сообщения, эквивалентный statusCode.
1Integer HttpResponse.status;
ok
Логическое значение, запрос, является ли текущий ответ нормальным
1readonly Boolean HttpResponse.ok;
cookies
NArray, возвращает текущее сообщениеHttpCookieсписок объектов
1readonly NArray HttpResponse.cookies;
protocol
Строка, информация о версии протокола, разрешенный формат: HTTP/#.#.
1String HttpResponse.protocol;
headers
HttpCollection, включенный в сообщениеhttpКонтейнер для заголовков сообщений, свойство только для чтения.
1readonly HttpCollection HttpResponse.headers;
keepAlive
Логическое значение, запрос и установка, поддерживать ли соединение
1Boolean HttpResponse.keepAlive;
upgrade
Логическое значение, запрос и установка, является ли это протоколом обновления.
1Boolean HttpResponse.upgrade;
maxHeadersCount
Целое число, запросите и установите максимальное количество заголовков запроса, значение по умолчанию — 128.
1Integer HttpResponse.maxHeadersCount;
maxHeaderSize
Целое число, запросите и установите максимальную длину заголовка запроса, значение по умолчанию — 8192.
1Integer HttpResponse.maxHeaderSize;
maxBodySize
Целое число, запрос и установка максимального размера тела в МБ, значение по умолчанию — 64.
1Integer HttpResponse.maxBodySize;
socket
Stream, Запросить исходный сокет текущего объекта
1readonly Stream HttpResponse.socket;
value
Строка, основное содержание сообщения.
1String HttpResponse.value;
params
NArray, основные параметры сообщения
1readonly NArray HttpResponse.params;
type
Целое число, тип сообщения
1Integer HttpResponse.type;
data
Значение, запрос данных сообщения. Этот атрибут будет возвращать разные данные в зависимости от типа контента. Если это текст, будет возвращен текст.jsonвернуться, когдаjson, в противном случае возвращается двоичный файл
1readonly Value HttpResponse.data;
body
SeekableStream, объект потока, содержащий часть данных сообщения
1SeekableStream HttpResponse.body;
length
Long, длина части данных сообщения.
1readonly Long HttpResponse.length;
stream
Stream, объект потока при запросе сообщения readFrom
1readonly Stream HttpResponse.stream;
lastError
Строка, запрос и установка последней ошибки обработки сообщения
1String HttpResponse.lastError;
функция-член
writeHead
Установите статус возврата ответного сообщения, верните сообщение и добавьте заголовок ответа.
1
2
3HttpResponse.writeHead(Integer statusCode,
String statusMessage,
Object headers = {});
Параметры звонка:
- statusCode: целое число, указывает статус возврата ответного сообщения.
- statusMessage: строка, указывает ответное сообщение ответного сообщения.
- headers: Объект, указывает заголовок ответа, добавленный к ответному сообщению.
Установите статус возврата ответного сообщения, верните сообщение и добавьте заголовок ответа.
1
2HttpResponse.writeHead(Integer statusCode,
Object headers = {});
Параметры звонка:
- statusCode: целое число, указывает статус возврата ответного сообщения.
- headers: Объект, указывает заголовок ответа, добавленный к ответному сообщению.
addCookie
Добавить один в файлы cookieHttpCookieобъект
1HttpResponse.addCookie(HttpCookie cookie);
Параметры звонка:
- cookie:HttpCookie, укажитеHttpCookieобъект
redirect
Отправить перенаправление клиенту
1HttpResponse.redirect(String url);
Параметры звонка:
- url: строка, адрес перенаправления
Отправить перенаправление клиенту
1
2HttpResponse.redirect(Integer statusCode,
String url);
Параметры звонка:
- statusCode: целое число, указывает статус возврата ответного сообщения, принятый статус: 301, 302, 307.
- url: строка, адрес перенаправления
sendHeader
Отправлять только в форматеhttpПерейдите к данному объекту потока
1HttpResponse.sendHeader(Stream stm) async;
Параметры звонка:
- stm:Stream, указывает объект потока, который получает форматированное сообщение
hasHeader
Проверьте, существует ли заголовок сообщения с указанным значением ключа.
1Boolean HttpResponse.hasHeader(String name);
Параметры звонка:
- name: строка, указывает значение ключа, которое необходимо проверить.
Результаты возврата:
- Boolean, возвращает, существует ли значение ключа
firstHeader
Запросить заголовок первого сообщения указанного значения ключа
1String HttpResponse.firstHeader(String name);
Параметры звонка:
- name: строка, укажите значение ключа, которое будет запрошено.
Результаты возврата:
- String, возвращает значение, соответствующее значению ключа, если оно не существует, возвращает неопределенное значение
allHeader
Запросить все заголовки сообщений указанного значения ключа
1NObject HttpResponse.allHeader(String name = "");
Параметры звонка:
- name: строка, укажите значение ключа для запроса, передайте пустую строку, чтобы вернуть результаты всех значений ключа.
Результаты возврата:
- NObject, возвращает массив всех значений, соответствующих значению ключа. Если данные не существуют, возвращает ноль.
addHeader
Добавьте заголовок сообщения, добавьте данные и не изменяйте заголовок сообщения существующего значения ключа.
1HttpResponse.addHeader(Object map);
Параметры звонка:
- map: Объект, указывает добавляемый словарь данных «ключ-значение».
Добавляет набор заголовков с указанным именем. Добавление данных не изменяет заголовки существующих значений ключей.
1
2HttpResponse.addHeader(String name,
Array values);
Параметры звонка:
- name: строка, указывает добавляемое значение ключа.
- values: Массив, определяет набор добавляемых данных.
Добавьте заголовок сообщения, добавьте данные и не изменяйте заголовок сообщения существующего значения ключа.
1
2HttpResponse.addHeader(String name,
String value);
Параметры звонка:
- name: строка, указывает добавляемое значение ключа.
- value: Строка, укажите данные, которые необходимо добавить.
setHeader
Установите заголовок сообщения. Установка данных приведет к изменению первого значения, соответствующего значению ключа, и очистке остальных заголовков сообщений с тем же значением ключа.
1HttpResponse.setHeader(Object map);
Параметры звонка:
- map: Объект, указывает словарь данных «ключ-значение», который будет установлен.
Задайте набор заголовков сообщений с указанным именем. Установка данных приведет к изменению значения, соответствующего значению ключа, и очистке остальных заголовков сообщений с тем же значением ключа.
1
2HttpResponse.setHeader(String name,
Array values);
Параметры звонка:
- name: Строка, укажите значение ключа, которое будет установлено.
- values: Массив, определяет набор данных для установки.
Установите заголовок сообщения. Установка данных приведет к изменению первого значения, соответствующего значению ключа, и очистке остальных заголовков сообщений с тем же значением ключа.
1
2HttpResponse.setHeader(String name,
String value);
Параметры звонка:
- name: Строка, укажите значение ключа, которое будет установлено.
- value: Строка, укажите данные для установки.
removeHeader
Удалить все заголовки сообщений с указанным значением ключа
1HttpResponse.removeHeader(String name);
Параметры звонка:
- name: строка, указывает значение ключа, которое необходимо удалить.
read
Чтение данных указанного размера из потока.Этот метод является псевдонимом соответствующего метода тела.
1Buffer HttpResponse.read(Integer bytes = -1) async;
Параметры звонка:
- bytes: целое число, указывает объем считываемых данных.По умолчанию считываются блоки данных случайного размера.Размер считываемых данных зависит от устройства.
Результаты возврата:
- Buffer, возвращает данные, считанные из потока. Если данных для чтения нет или соединение прервано, возвращается значение null.
readAll
Считайте все оставшиеся данные из потока.Этот метод является псевдонимом соответствующего метода тела.
1Buffer HttpResponse.readAll() async;
Результаты возврата:
- Buffer, возвращает данные, считанные из потока. Если данных для чтения нет или соединение прервано, возвращается значение null.
write
Запишите данные.Этот метод является псевдонимом соответствующего метода в теле.
1HttpResponse.write(Buffer data) async;
Параметры звонка:
- data:Buffer, учитывая данные, которые нужно записать
json
Записывает данные в кодировке JSON.
1Value HttpResponse.json(Value data);
Параметры звонка:
- data: Значение, учитывая данные для записи.
Результаты возврата:
- Value, этот метод не возвращает данные
Разобрать данные в сообщении как кодировку JSON.
1Value HttpResponse.json();
Результаты возврата:
- Value, возвращает результат анализа
pack
кmsgpackКодирование записывает данные данные
1Value HttpResponse.pack(Value data);
Параметры звонка:
- data: Значение, учитывая данные для записи.
Результаты возврата:
- Value, этот метод не возвращает данные
кmsgpackКодирование и анализ данных в сообщении
1Value HttpResponse.pack();
Результаты возврата:
- Value, возвращает результат анализа
end
Установить окончание обработки текущего сообщения,ChainПроцессор не продолжает выполнение последующих транзакций
1HttpResponse.end();
isEnded
Запросить, закончилось ли текущее сообщение
1Boolean HttpResponse.isEnded();
Результаты возврата:
- Boolean, возвращает true по завершении
clear
Очистить содержимое сообщения
1HttpResponse.clear();
sendTo
Отправляет форматированное сообщение данному объекту потока.
1HttpResponse.sendTo(Stream stm) async;
Параметры звонка:
- stm:Stream, указывает объект потока, который получает форматированное сообщение
readFrom
Считывает отформатированное сообщение из заданного объекта потока кэша и анализирует заполненный объект.
1HttpResponse.readFrom(Stream stm) async;
Параметры звонка:
- stm:Stream, указывает объект потока для чтения форматированных сообщений
toString
Возвращает строковое представление объекта. Обычно возвращается «[Native Object]». Объект может быть повторно реализован в соответствии с его собственными характеристиками.
1String HttpResponse.toString();
Результаты возврата:
- String, возвращает строковое представление объекта
toJSON
Возвращает представление объекта в формате JSON, обычно возвращая коллекцию читаемых свойств, определенных объектом.
1Value HttpResponse.toJSON(String key = "");
Параметры звонка:
- key: Строка, не используется.
Результаты возврата:
- Value, возвращает значение, содержащее сериализуемый JSON