オブジェクト組み込みオブジェクト

オブジェクトHttpClient

httpクライアントオブジェクト

httpクライアントオブジェクトは、ブラウザ環境をシミュレートしてCookieをキャッシュし、アクセスしますurl対応するクッキーを運ぶとき、異なるhttpクライアントオブジェクトは互いに分離されており、httprequest、get、postおよびその他のメソッド。使用法は次のとおりです。

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

整数、クエリ、および本文の最大サイズの設定(MB単位)。デフォルトは-1で、サイズは制限されていません。

1
Integer HttpClient.maxBodySize;

userAgent

文字列、クエリ、設定 http リクエスト内のブラウザID

1
String HttpClient.userAgent;

poolSize

整数、クエリ、およびキープアライブキャッシュ接続の最大数の設定。デフォルトは128です。

1
Integer HttpClient.poolSize;

poolTimeout

整数、クエリ、およびキープアライブキャッシュ接続タイムアウト時間を設定します。デフォルトは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);

呼び出しパラメーター:

  • crtX509Cert、証明書、クライアントを検証するためにサーバーに送信するために使用されます
  • keyPKey、秘密鍵、クライアントとの会話に使用

request

送信 http 指定されたストリームオブジェクトにリクエストし、結果を返します

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

呼び出しパラメーター:

  • connStream、リクエストを処理するストリームオブジェクトを指定します
  • reqHttpRequest、送信されます HttpRequest 物体

戻り結果:


送信 http 指定されたストリームオブジェクトにリクエストし、結果を返します

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

呼び出しパラメーター:

  • connStream、リクエストを処理するストリームオブジェクトを指定します
  • reqHttpRequest、送信されます HttpRequest 物体
  • response_bodySeekableStream、response.bodyのフローを指定します

戻り結果:


指定されたリクエスト urlそして結果を返します

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

呼び出しパラメーター:

  • method:文字列、指定 http リクエストメソッド:GET、POSTなど。
  • url:文字列、指定 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、そして結果を返します。これはrequest( "GET"、...)と同等です。

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

呼び出しパラメーター:

  • url:文字列、指定 url、ホストを含​​めて完全である必要があります url
  • opts:オブジェクト、追加情報を指定

戻り結果:

optsには、要求された追加オプションが含まれており、サポートされるコンテンツは次のとおりです。

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

どこの体、json、パックを同時に表示することはできません。デフォルトは{}で、追加情報は含まれていません


post

POSTメソッドを使用して、指定されたものをリクエストします url、そして、request( "POST"、...)と同等の結果を返します。

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

呼び出しパラメーター:

  • url:文字列、指定 url、ホストを含​​めて完全である必要があります url
  • opts:オブジェクト、追加情報を指定

戻り結果:

optsには、要求された追加オプションが含まれており、サポートされるコンテンツは次のとおりです。

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

どこの体、json、パックを同時に表示することはできません。デフォルトは{}で、追加情報は含まれていません


del

DELETEメソッドを使用して、指定されたを要求します url、そして結果を返します。これはrequest( "DELETE"、...)と同等です。

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

呼び出しパラメーター:

  • url:文字列、指定 url、ホストを含​​めて完全である必要があります url
  • opts:オブジェクト、追加情報を指定

戻り結果:

optsには、要求された追加オプションが含まれており、サポートされるコンテンツは次のとおりです。

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

どこの体、json、パックを同時に表示することはできません。デフォルトは{}で、追加情報は含まれていません


put

PUTメソッドを使用して、指定されたを要求します url、そして、request( "PUT"、...)と同等の結果を返します。

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

呼び出しパラメーター:

  • url:文字列、指定 url、ホストを含​​めて完全である必要があります url
  • opts:オブジェクト、追加情報を指定

戻り結果:

optsには、要求された追加オプションが含まれており、サポートされるコンテンツは次のとおりです。

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

どこの体、json、パックを同時に表示することはできません。デフォルトは{}で、追加情報は含まれていません


patch

PATCHメソッドを使用して、指定されたを要求します url、そして、request( "PATCH"、...)と同等の結果を返します。

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

呼び出しパラメーター:

  • url:文字列、指定 url、ホストを含​​めて完全である必要があります url
  • opts:オブジェクト、追加情報を指定

戻り結果:

optsには、要求された追加オプションが含まれており、サポートされるコンテンツは次のとおりです。

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

どこの体、json、パックを同時に表示することはできません。デフォルトは{}で、追加情報は含まれていません


toString

オブジェクトの文字列表現を返します。通常は「[NativeObject]」を返します。オブジェクトは、独自の特性に従って再実装できます。

1
String HttpClient.toString();

戻り結果:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトのJSON形式の表現を返します。通常、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

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

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

  • Value、シリアル化可能なJSONを含む値を返します