ObjectHttpClient

HttpClient is een klassenbibliotheek die is ontworpen voor HTTP-clientfuncties en die basis-HTTP/HTTPS-verzoeken, proxytoegang, cookiebeheer en andere functies biedt

U kunt webpagina's eenvoudig openen en bedienen met HttpClient. Hier is een eenvoudig voorbeeld: het afdrukken van de broncode op een webpagina:

1
2
3
4
5
const http = require('http');

const res = http.get('http://www.example.com/');

console.log(res.body.readAll().toString());

In dit voorbeeld geïntroduceerd via requirehttpmodule en vervolgens gebruikenhttp.getStart een get-verzoek, waarurlDe parameter specificeert de aangevraagde URL. omdathttp.getDe methode retourneert aHttpResponseObject, zodat u via de body-eigenschap toegang kunt krijgen tot de hoofdinhoud die door de aanvraag wordt geretourneerd en deze via de toString-methode naar een tekenreeks kunt converteren.

wanneer gevraagdurlHet is https-type in plaats vanhttptype, hoeft de code alleen maar te veranderenhttpVerander het gewoon in https:

1
2
3
4
5
const http = require('http');

const res = http.get('https://www.example.com/');

console.log(res.body.readAll().toString());

Daarnaast zijn er voorbeelden van het rechtstreeks initiëren van POST-verzoeken en het instellen van User-Agent via HttpClient:

1
2
3
4
5
6
7
8
9
10
11
const http = require('http');

const httpClient = new http.Client();
httpClient.userAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36';
const res = httpClient.post('http://www.example.com/post', {
    json: {
        name: 'fibjs',
        version: '0.31.0'
    }
});
console.log(res.body.readAll().toString());

In dit voorbeeld wordt eerst een HttpClient-object httpClient gemaakt en wordt de userAgent ervan ingesteld op de User-Agent van de browser. Start vervolgens een postverzoek via de postmethode, waarbij de parameters naam en versie de hoofdinhoud van het verzoek specificeren. Ten slotte wordt de hoofdinhoud van de geretourneerde waarde uitgevoerd.

erfenis relatie

Constructeur

HttpClient

HttpClient-constructor, maakt een nieuw HttpClient-object

1
new HttpClient();

eigenschappen van leden

cookies

NArray, terughttpcliëntHttpCookieobjecten lijst

1readonly NArray HttpClient.cookies;

timeout

Geheel getal, opvragen en time-outeenheid milliseconden instellen

1Integer HttpClient.timeout;

enableCookie

Boolean, cookiefunctieschakelaar, standaard ingeschakeld

1
Boolean HttpClient.enableCookie;

autoRedirect

Booleaanse, automatische omleidingsfunctieschakelaar, standaard ingeschakeld

1
Boolean HttpClient.autoRedirect;

enableEncoding

Booleaanse, automatische decompressiefunctieschakelaar, standaard ingeschakeld

1
Boolean HttpClient.enableEncoding;

maxHeadersCount

Geheel getal, query en stel het maximale aantal verzoekheaders in, de standaardwaarde is 128

1Integer HttpClient.maxHeadersCount;

maxHeaderSize

Geheel getal, query en stel de maximale lengte van de aanvraagheader in, de standaardwaarde is 8192

1Integer HttpClient.maxHeaderSize;

maxBodySize

Geheel getal, query en stel de maximale grootte van de hoofdtekst in, in MB, de standaardwaarde is -1, geen limiet voor de grootte

1Integer HttpClient.maxBodySize;

userAgent

String, query en sethttpDe browser-ID in het verzoek

1
String HttpClient.userAgent;

poolSize

Integer, query en stel het maximale aantal keep-alive cache-verbindingen in, standaard 128

1Integer HttpClient.poolSize;

poolTimeout

Geheel getal, query uitvoeren en de keep-alive cache-verbindingstime-out instellen, standaard 10.000 ms

1Integer HttpClient.poolTimeout;

http_proxy

String, query en sethttpVerzoekagent, ondersteuninghttp/https/socks5-proxy

1
String HttpClient.http_proxy;

https_proxy

Tekenreeks, query en stel https-verzoekproxy in, ondersteuninghttp/https/socks5 proxy, indien niet ingesteld of leeg ingesteld, wordt http_proxy hergebruikt.

1
String HttpClient.https_proxy;

sslVerification

Geheel getal, query en stel de certificaatverificatiemodus in bij verbinding met https, referentiesslVERIFY_* constanten van de module, de standaardwaarde isssl.verification

1Integer HttpClient.sslVerification;

lid functie

setClientCert

Stel het standaardclientcertificaat in

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

Oproepparameters:

crt:X509Cert, certificaat, gebruikt om naar de server te verzenden om de client te verifiëren
key:PKey, privésleutel, gebruikt om met de klant te praten

request

versturenhttpVraag het opgegeven streamobject op en retourneer het resultaat

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

Oproepparameters:

conn:Stream, specificeert het streamobject dat het verzoek moet afhandelen
req:HttpRequest, om verzonden te wordenHttpRequestvoorwerp

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

versturenhttpVraag het opgegeven streamobject op en retourneer het resultaat

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

Oproepparameters:

conn:Stream, specificeert het streamobject dat het verzoek moet afhandelen
req:HttpRequest, om verzonden te wordenHttpRequestvoorwerp
response_body:SeekableStream, geef de stroom van response.body op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

verzoek gespecificeerdurlen retourneer het resultaat

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

Oproepparameters:

method: Tekenreeks, specificeerhttpVerzoekmethode: GET, POST, etc.
url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {},
    "response_body": SeekableStream // specify the response.body stream
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

Gebruik de GET-methode om het opgegevenurl, en retourneert het resultaat, dat gelijk is aan request("GET", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

Verzoekopties gespecificeerdurlen retourneer het resultaat

1
HttpResponse HttpClient.request(Object opts) async;

Oproepparameters:

opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

get

Gebruik de GET-methode om het opgegevenurl, en retourneert het resultaat, dat gelijk is aan request("GET", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

post

Gebruik de POST-methode om het opgegeven bestand op te vragenurl, en retourneert het resultaat, dat gelijk is aan request("POST", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

del

Gebruik de DELETE-methode om het opgegeven bestand op te vragenurl, en retourneert het resultaat, dat gelijk is aan request("DELETE", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

put

Gebruik de PUT-methode om het opgegeven op te vragenurl, en retourneert het resultaat, dat gelijk is aan request("PUT", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

patch

Gebruik de PATCH-methode om het opgegevenurl, en retourneert het resultaat, dat gelijk is aan request("PATCH", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

head

Gebruik de HEAD-methode om het opgegeven bestand op te vragenurl, en retourneert het resultaat, dat gelijk is aan request("PATCH", ...)

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

Oproepparameters:

url: Tekenreeks, specificeerurl, moet de volledige bevattende host zijnurl
opts: Object, geef aanvullende informatie op

Resultaten retourneren:

HttpResponse, retourneert het serverantwoord

opts bevat extra opties voor het verzoek, die als volgt worden ondersteund:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15{
    "method": "GET", // specify the http request method: GET, POST, etc, default: GET.
    "protocol": "http",
    "slashes": true,
    "username": "",
    "password": "",
    "hostname": "",
    "port": "",
    "pathname": "",
    "query": {},
    "body": SeekableStream | Buffer | String | {},
    "json": {},
    "pack": {},
    "headers": {}
}

Onder hen lichaam,json, pakket mag niet tegelijkertijd verschijnen. De standaardwaarde is {}, die geen aanvullende informatie bevat

toString

Retourneert de tekenreeksweergave van het object. Over het algemeen wordt '[Native Object]' geretourneerd. Het object kan opnieuw worden geïmplementeerd op basis van zijn eigen kenmerken.

1
String HttpClient.toString();

Resultaten retourneren:

String, retourneert de tekenreeksrepresentatie van het object

toJSON

Retourneert een weergave in JSON-indeling van het object, waarbij doorgaans een verzameling leesbare eigenschappen wordt geretourneerd die door het object zijn gedefinieerd.

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

Oproepparameters:

key: Tekenreeks, niet gebruikt

Resultaten retourneren:

Value, retourneert een waarde die JSON-serialiseerbaar bevat

Ontwikkelingsgids

Basismodule

ingebouwde objecten

gemeenschapsmodule

ObjectHttpClient

erfenis relatie

Constructeur

HttpClient

eigenschappen van leden

cookies

timeout

enableCookie

autoRedirect

enableEncoding

maxHeadersCount

maxHeaderSize

maxBodySize

userAgent

poolSize

poolTimeout

http_proxy

https_proxy

sslVerification

lid functie

setClientCert

request

get

post

del

put

patch

head

toString

toJSON