Объект встроенный объект
  1. титульная страница
  2. Встроенные объекты
  3. Объект HttpClient

Объект HttpClient

httpКлиентский объект

httpКлиентский объект имитирует среду браузера для кэширования файлов cookie и обращается кurlПри переносе соответствующего файла cookie разныеhttpКлиентские объекты изолированы друг от друга, обеспечиваяhttpЗапрос, получение, публикация и другие методы. Использование следующее:

1
2
3
var http = require('http');
var httpClient = new http.Client();
httpClient.request('GET', 'http://fibjs.org');

Наследование

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<this>HttpClient|new HttpClient()|cookies;timeout;enableCookie;autoRedirect;enableEncoding;maxBodySize;userAgent;poolSize;poolTimeout;proxyAgent;sslVerification|setClientCert();request();get();post();del();put();patch()] [object] <:- [HttpClient] HttpClient new HttpClient() cookies timeout enableCookie autoRedirect enableEncoding maxBodySize userAgent poolSize poolTimeout proxyAgent sslVerification setClientCert() request() get() post() del() put() patch() object toString() toJSON()

Конструктор

HttpClient

Конструктор HttpClient, создайте новый объект HttpClient

1
new HttpClient();

Атрибуты члена

cookies

NArray, возвратhttpКлиент HttpCookie Список объектов

1
readonly NArray HttpClient.cookies;

timeout

Целое число, запрос и установка времени ожидания в миллисекундах

1
Integer HttpClient.timeout;

enableCookie

Логическое значение, переключатель функции cookie, включен по умолчанию

1
Boolean HttpClient.enableCookie;

autoRedirect

Логическое значение, переключатель функции автоматического перенаправления, включен по умолчанию

1
Boolean HttpClient.autoRedirect;

enableEncoding

Логическое значение, переключатель функции автоматической декомпрессии, включен по умолчанию

1
Boolean HttpClient.enableEncoding;

maxBodySize

Целое число, запрос и установка максимального размера тела в МБ, по умолчанию -1, и размер не ограничен.

1
Integer HttpClient.maxBodySize;

userAgent

Строка, запрос и набор http Идентификатор браузера в запросе

1
String HttpClient.userAgent;

poolSize

Целое число, запрос и установка максимального количества соединений кэша проверки активности, значение по умолчанию - 128.

1
Integer HttpClient.poolSize;

poolTimeout

Целое число, запрос и установка времени ожидания соединения с кешем keep-alive, по умолчанию 10000 мс

1
Integer HttpClient.poolTimeout;

proxyAgent

Строка, запрос и установка прокси-сервера

1
String HttpClient.proxyAgent;

sslVerification

Целое число, запрос и установка режима проверки сертификата при подключении к https, ссылка ssl VERIFY_ * константы модуля, значение по умолчанию ssl.verification

1
Integer HttpClient.sslVerification;

Функция члена

setClientCert

Установить сертификат клиента по умолчанию

1
2
HttpClient.setClientCert(X509Cert crt,
    PKey key);

Параметры звонка:

  • crt: X509Cert, Сертификат, используемый для отправки на сервер для проверки клиента.
  • key: PKey, Закрытый ключ, используемый для разговора с клиентом

request

Отправить http Запрос к указанному объекту потока и возврат результата

1
2
HttpResponse HttpClient.request(Stream conn,
    HttpRequest req) async;

Параметры звонка:

  • conn: Stream, Укажите объект потока для обработки запроса
  • req: HttpRequest, Для отправки HttpRequest Объект

Результат возврата:

Отправить http Запрос к указанному объекту потока и возврат результата

1
2
3
HttpResponse HttpClient.request(Stream conn,
    HttpRequest req,
    SeekableStream response_body) async;

Параметры звонка:

  • conn: Stream, Укажите объект потока для обработки запроса
  • req: HttpRequest, Для отправки HttpRequest Объект
  • response_body: SeekableStream, Укажите поток response.body

Результат возврата:

Указанный запрос urlИ вернуть результат

1
2
3
HttpResponse HttpClient.request(String method,
    String url,
    Object opts = {}) async;

Параметры звонка:

  • method: String, укажите http Метод запроса: GET, POST и т. Д.
  • url: String, укажите url, Должен быть полным, включая хост url
  • opts: Объект, укажите дополнительную информацию

Результат возврата:

opts содержит запрошенные дополнительные параметры, а поддерживаемое содержимое выглядит следующим образом:

1
2
3
4
5
6
7
8
{
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {},
    "response_body": SeekableStream // 指定接受 resposne 数据的流
}

Где тело,json, Пак не должен появляться одновременно. По умолчанию {}, не содержит дополнительной информации.

get

Используйте метод GET для запроса указанного url, И вернуть результат, эквивалентный запросу ("GET", ...)

1
2
HttpResponse HttpClient.get(String url,
    Object opts = {}) async;

Параметры звонка:

  • url: String, укажите url, Должен быть полным, включая хост url
  • opts: Объект, укажите дополнительную информацию

Результат возврата:

opts содержит запрошенные дополнительные параметры, а поддерживаемое содержимое выглядит следующим образом:

1
2
3
4
5
6
7
{
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Где тело,json, Пак не должен появляться одновременно. По умолчанию {}, не содержит дополнительной информации.

post

Используйте метод POST для запроса указанного url, И вернуть результат, эквивалентный запросу ("POST", ...)

1
2
HttpResponse HttpClient.post(String url,
    Object opts = {}) async;

Параметры звонка:

  • url: String, укажите url, Должен быть полным, включая хост url
  • opts: Объект, укажите дополнительную информацию

Результат возврата:

opts содержит запрошенные дополнительные параметры, а поддерживаемое содержимое выглядит следующим образом:

1
2
3
4
5
6
7
{
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Где тело,json, Пак не должен появляться одновременно. По умолчанию {}, не содержит дополнительной информации.

del

Используйте метод DELETE для запроса указанного url, И вернуть результат, эквивалентный запросу ("УДАЛИТЬ", ...)

1
2
HttpResponse HttpClient.del(String url,
    Object opts = {}) async;

Параметры звонка:

  • url: String, укажите url, Должен быть полным, включая хост url
  • opts: Объект, укажите дополнительную информацию

Результат возврата:

opts содержит запрошенные дополнительные параметры, а поддерживаемое содержимое выглядит следующим образом:

1
2
3
4
5
6
7
{
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Где тело,json, Пак не должен появляться одновременно. По умолчанию {}, не содержит дополнительной информации.

put

Используйте метод PUT для запроса указанного url, И вернуть результат, эквивалентный запросу ("PUT", ...)

1
2
HttpResponse HttpClient.put(String url,
    Object opts = {}) async;

Параметры звонка:

  • url: String, укажите url, Должен быть полным, включая хост url
  • opts: Объект, укажите дополнительную информацию

Результат возврата:

opts содержит запрошенные дополнительные параметры, а поддерживаемое содержимое выглядит следующим образом:

1
2
3
4
5
6
7
{
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Где тело,json, Пак не должен появляться одновременно. По умолчанию {}, не содержит дополнительной информации.

patch

Используйте метод PATCH для запроса указанного url, И вернуть результат, эквивалентный запросу ("ПАТЧ", ...)

1
2
HttpResponse HttpClient.patch(String url,
    Object opts = {}) async;

Параметры звонка:

  • url: String, укажите url, Должен быть полным, включая хост url
  • opts: Объект, укажите дополнительную информацию

Результат возврата:

opts содержит запрошенные дополнительные параметры, а поддерживаемое содержимое выглядит следующим образом:

1
2
3
4
5
6
7
{
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Где тело,json, Пак не должен появляться одновременно. По умолчанию {}, не содержит дополнительной информации.

toString

Возвращает строковое представление объекта, обычно возвращает «[Native Object]», объект может быть повторно реализован в соответствии с его собственными характеристиками.

1
String HttpClient.toString();

Результат возврата:

  • String, Возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает набор читаемых атрибутов, определенных объектом.

1
Value HttpClient.toJSON(String key = "");

Параметры звонка:

  • key: Строка, не используется

Результат возврата:

  • Value, Возвращает значение, содержащее сериализуемый JSON
© Copyright 2012-2021 fibjs.org | Поддержите нас