オブジェクト組み込みオブジェクト
  1. ホーム
  2. 組み込みオブジェクト
  3. オブジェクトHttpClient

オブジェクトHttpClient

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

httpクライアントオブジェクトは、ブラウザ環境をシミュレートしてCookieをキャッシュし、 urlにアクセスするときに対応するCookieを伝送します。さまざまなhttpクライアントオブジェクトが互いに分離され、 http request、get、postなどのメソッドを提供します。使用法は次のとおりです。

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

継承

%0 object object toString() toJSON() HttpClient HttpClient new HttpClient() cookies timeout enableCookie autoRedirect enableEncoding maxBodySize userAgent poolSize poolTimeout proxyAgent sslVerification setClientCert() request() get() post() del() put() patch() object->HttpClient

コンストラクタ

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

呼び出しパラメーター：

  • crt ： X509Cert 、 X509Cert証明書、クライアント認証サーバーに使用
  • key ： PKey 、 PKey秘密鍵、クライアントとの通信に使用

request

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

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

呼び出しパラメーター：

  • conn ： Stream 、リクエストを処理するストリームオブジェクトを指定します
  • req ： HttpRequest 、送信されるHttpRequestオブジェクト

戻り結果：

指定された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
{
    "query": {},
    "body": SeekedStream | Buffer | String | {},
    "json": {},
    "headers": {}
}

bodyと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
{
    "query": {},
    "body": SeekedStream | Buffer | String | {},
    "json": {},
    "headers": {}
}

bodyと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
{
    "query": {},
    "body": SeekedStream | Buffer | String | {},
    "json": {},
    "headers": {}
}

bodyと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
{
    "query": {},
    "body": SeekedStream | Buffer | String | {},
    "json": {},
    "headers": {}
}

bodyと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
{
    "query": {},
    "body": SeekedStream | Buffer | String | {},
    "json": {},
    "headers": {}
}

bodyと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
{
    "query": {},
    "body": SeekedStream | Buffer | String | {},
    "json": {},
    "headers": {}
}

bodyとjsonが同時に表示されてはなりません。デフォルトは{}で、追加情報はありません

toString

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

1
String HttpClient.toString();

戻り結果：

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

toJSON

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

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

呼び出しパラメーター：

  • key ：文字列、未使用

戻り結果：

  • Value 、シリアル化可能なJSONを含む値を返します
©Copyright2014-Present fibjs.org |サポートしてください