Objekt HttpClient

httpClient-Objekt

httpDas Client-Objekt simuliert die Browserumgebung, um Cookies zwischenzuspeichern, und greift aufurlBeim Tragen des entsprechenden Cookies, andershttpClient-Objekte sind voneinander isoliert und bietenhttpDie Request-, Get-, Post- und andere Methoden. Die Verwendung ist wie folgt:

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

Erbe

Konstrukteur

HttpClient

HttpClient-Konstruktor, erstellen Sie ein neues HttpClient-Objekt

1
new HttpClient();

Mitgliedsattribute

cookies

NArray, zurückhttpKlient HttpCookie Objektliste

1readonly NArray HttpClient.cookies;

timeout

Integer, Abfrage und Einstellung der Timeout-Zeit in Millisekunden

1Integer HttpClient.timeout;

enableCookie

Boolean, Cookie-Funktionsschalter, standardmäßig aktiviert

1
Boolean HttpClient.enableCookie;

autoRedirect

Boolean, automatische Umleitungsfunktionsumschaltung, standardmäßig aktiviert

1
Boolean HttpClient.autoRedirect;

enableEncoding

Boolean, automatischer Dekompressionsfunktionsschalter, standardmäßig aktiviert

1
Boolean HttpClient.enableEncoding;

maxBodySize

Integer, fragen Sie die maximale Größe des Hauptteils ab und legen Sie sie fest. In MB ist der Standardwert -1 und die Größe ist nicht begrenzt

1Integer HttpClient.maxBodySize;

userAgent

String, Abfrage und Set http Browser-ID in der Anfrage

1
String HttpClient.userAgent;

poolSize

Integer, Abfrage und Festlegen der maximalen Anzahl von Keep-Alive-Cache-Verbindungen, der Standardwert ist 128

1Integer HttpClient.poolSize;

poolTimeout

Integer, Abfrage und Einstellung der Timeout-Zeit für die Keep-Alive-Cache-Verbindung, der Standardwert ist 10000 ms

1Integer HttpClient.poolTimeout;

proxyAgent

String, Abfrage und Proxy-Server setzen

1
String HttpClient.proxyAgent;

sslVerification

Integer, Abfrage und Einstellung des Zertifikatsüberprüfungsmodus beim Herstellen einer Verbindung mit https, Referenz ssl VERIFY_* Konstanten des Moduls, der Standardwert ist ssl.verification

1Integer HttpClient.sslVerification;

Mitgliederfunktion

setClientCert

Standard-Clientzertifikat festlegen Set

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

Aufrufparameter:

crt: X509Cert, Zertifikat, wird zum Senden an den Server verwendet, um den Client zu überprüfen
key: PKey, Privater Schlüssel, wird verwendet, um mit dem Client zu sprechen

request

senden http Anfrage an das angegebene Stream-Objekt und Rückgabe des Ergebnisses

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

Aufrufparameter:

conn: Stream, Geben Sie das Stream-Objekt an, um die Anfrage zu verarbeiten
req: HttpRequest, Zu versenden HttpRequest Objekt

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

senden http Anfrage an das angegebene Stream-Objekt und Rückgabe des Ergebnisses

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

Aufrufparameter:

conn: Stream, Geben Sie das Stream-Objekt an, um die Anfrage zu verarbeiten
req: HttpRequest, Zu versenden HttpRequest Objekt
response_body: SeekableStream, Geben Sie den Antwortfluss an.body

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

Anfrage angegeben urlUnd das Ergebnis zurückgeben

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

Aufrufparameter:

method: String, spezifizieren http Anfragemethode: GET, POST usw.
url: String, spezifizieren url, Muss vollständig sein, einschließlich des Hosts url
opts: Objekt, zusätzliche Informationen angeben

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Wo Körper,json, Pack darf nicht gleichzeitig erscheinen. Der Standardwert ist {}, enthält keine zusätzlichen Informationen

get

Verwenden Sie die GET-Methode, um das angegebene anzufordern url, Und das Ergebnis zurückgeben, das äquivalent zu request("GET", ...)

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

Aufrufparameter:

url: String, spezifizieren url, Muss vollständig sein, einschließlich des Hosts url
opts: Objekt, zusätzliche Informationen angeben

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Wo Körper,json, Pack darf nicht gleichzeitig erscheinen. Der Standardwert ist {}, enthält keine zusätzlichen Informationen

post

Verwenden Sie die POST-Methode, um das angegebene . anzufordern url, Und das Ergebnis zurückgeben, das äquivalent zu request("POST", ...)

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

Aufrufparameter:

url: String, spezifizieren url, Muss vollständig sein, einschließlich des Hosts url
opts: Objekt, zusätzliche Informationen angeben

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Wo Körper,json, Pack darf nicht gleichzeitig erscheinen. Der Standardwert ist {}, enthält keine zusätzlichen Informationen

del

Verwenden Sie die DELETE-Methode, um das angegebene url, Und das Ergebnis zurückgeben, das äquivalent zu request("DELETE", ...)

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

Aufrufparameter:

url: String, spezifizieren url, Muss vollständig sein, einschließlich des Hosts url
opts: Objekt, zusätzliche Informationen angeben

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Wo Körper,json, Pack darf nicht gleichzeitig erscheinen. Der Standardwert ist {}, enthält keine zusätzlichen Informationen

put

Verwenden Sie die PUT-Methode, um das angegebene . anzufordern url, Und das Ergebnis zurückgeben, das äquivalent zu request("PUT", ...)

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

Aufrufparameter:

url: String, spezifizieren url, Muss vollständig sein, einschließlich des Hosts url
opts: Objekt, zusätzliche Informationen angeben

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Wo Körper,json, Pack darf nicht gleichzeitig erscheinen. Der Standardwert ist {}, enthält keine zusätzlichen Informationen

patch

Verwenden Sie die PATCH-Methode, um das angegebene . anzufordern url, Und das Ergebnis zurückgeben, das äquivalent zu request("PATCH", ...)

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

Aufrufparameter:

url: String, spezifizieren url, Muss vollständig sein, einschließlich des Hosts url
opts: Objekt, zusätzliche Informationen angeben

Ergebnis zurückgeben:

HttpResponse, Serverantwort zurückgeben

opts enthält zusätzliche angeforderte Optionen und der unterstützte Inhalt ist wie folgt:

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

Wo Körper,json, Pack darf nicht gleichzeitig erscheinen. Der Standardwert ist {}, enthält keine zusätzlichen Informationen

toString

Gibt die String-Darstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück, das Objekt kann entsprechend seiner eigenen Eigenschaften neu implementiert werden

1
String HttpClient.toString();

Ergebnis zurückgeben:

String, Gibt die String-Darstellung des Objekts zurück

toJSON

Gibt die Darstellung des Objekts im JSON-Format zurück, gibt im Allgemeinen eine Sammlung von lesbaren Attributen zurück, die durch das Objekt definiert sind

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

Aufrufparameter:

key: String, unbenutzt

Ergebnis zurückgeben:

Value, Gibt einen Wert zurück, der JSON serialisierbar enthält

Entwicklungsleitfaden

Basismodul

Eingebaute Objekte

Community-Modul

Objekt HttpClient

Erbe

Konstrukteur

HttpClient

Mitgliedsattribute

cookies

timeout

enableCookie

autoRedirect

enableEncoding

maxBodySize

userAgent

poolSize

poolTimeout

proxyAgent

sslVerification

Mitgliederfunktion

setClientCert

request

get

post

del

put

patch

toString

toJSON