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

オブジェクト HttpClient

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

httpクライアント オブジェクトは、ブラウザ環境をシミュレートして Cookie をキャッシュし、url対応するクッキーを携帯すると、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

ブール、クッキー機能スイッチ、デフォルトで有効

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);

呼び出しパラメータ:

  • 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: 文字列、指定 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

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

1
String HttpClient.toString();

結果を返す:

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

toJSON

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

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

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します