ObjectHttpResponse
HttpResponse ist ein HTTP-Antwortobjekt, das verwendetHttpRequest.responseDas Objekt vervollständigt die Datenantwort des HTTP-Servers, oderhttp.requestVom Server zurückgegebene Anforderungsantwortdaten
Das folgende Beispiel zeigt, wie das gehthttp.ServerDer Beispielcode lautet wie folgt:
1
2
3
4
5
6
7
8
9
10
11
12
13
14const http = require('http');
const server = new http.Server(8080, (request) => {
// retreive the response object
const response = request.response;
// set the status code
response.statusCode = 200;
// set the content type to text/plain
response.setHeader('Content-Type', 'text/plain');
// write the response body
response.write('ok');
});
server.start();
Erbschaftsverhältnis
Konstrukteur
HttpResponse
Der HttpResponse-Konstruktor erstellt ein neues HttpResponse-Objekt
1new HttpResponse();
Konstante
TEXT
Geben Sie den Nachrichtentyp 1 an, der einen Texttyp darstellt
1const HttpResponse.TEXT = 1;
BINARY
Geben Sie den Nachrichtentyp 2 an, der einen Binärtyp darstellt
1const HttpResponse.BINARY = 2;
Mitgliedereigenschaften
statusCode
Ganzzahl, Abfrage und Festlegung des Rückgabestatus der Antwortnachricht
1Integer HttpResponse.statusCode;
statusMessage
Zeichenfolge, Abfrage und Festlegung der Antwortnachricht
1String HttpResponse.statusMessage;
status
Ganzzahl, Abfrage und Festlegung des Rückgabestatus der Antwortnachricht, äquivalent zu statusCode
1Integer HttpResponse.status;
ok
Boolescher Wert, fragen Sie ab, ob die aktuelle Antwort normal ist
1readonly Boolean HttpResponse.ok;
cookies
NArray, gibt die aktuelle Nachricht zurückHttpCookieObjektliste
1readonly NArray HttpResponse.cookies;
protocol
Zeichenfolge, Protokollversionsinformationen, zulässiges Format ist: HTTP/#.#
1String HttpResponse.protocol;
headers
HttpCollection, in der Nachricht enthaltenhttpContainer für Nachrichtenkopfzeilen, schreibgeschützte Eigenschaft
1readonly HttpCollection HttpResponse.headers;
keepAlive
Boolescher Wert, Abfrage und Festlegung, ob die Verbindung aufrechterhalten werden soll
1Boolean HttpResponse.keepAlive;
upgrade
Boolescher Wert, Abfrage und Festlegung, ob es sich um ein Upgrade-Protokoll handelt
1Boolean HttpResponse.upgrade;
maxHeadersCount
Geben Sie eine Ganzzahl ein, fragen Sie ab und legen Sie die maximale Anzahl von Anforderungsheadern fest. Der Standardwert ist 128
1Integer HttpResponse.maxHeadersCount;
maxHeaderSize
Geben Sie eine Ganzzahl ein, fragen Sie ab und legen Sie die maximale Länge des Anforderungsheaders fest. Der Standardwert ist 8192
1Integer HttpResponse.maxHeaderSize;
maxBodySize
Geben Sie eine Ganzzahl ein, fragen Sie die maximale Körpergröße in MB ab und legen Sie sie fest. Der Standardwert ist 64
1Integer HttpResponse.maxBodySize;
socket
Stream, Fragen Sie den Quell-Socket des aktuellen Objekts ab
1readonly Stream HttpResponse.socket;
value
String, der grundlegende Inhalt der Nachricht
1String HttpResponse.value;
params
NArray, die Grundparameter der Nachricht
1readonly NArray HttpResponse.params;
type
Ganzzahl, Nachrichtentyp
1Integer HttpResponse.type;
data
Wert: Fragen Sie die Daten der Nachricht ab. Dieses Attribut gibt je nach Inhaltstyp unterschiedliche Daten zurück. Wenn es sich um Text handelt, wird der Text zurückgegeben.jsonwann zurückkommenjson, andernfalls wird binär zurückgegeben
1readonly Value HttpResponse.data;
body
SeekableStream, ein Stream-Objekt, das den Datenteil der Nachricht enthält
1SeekableStream HttpResponse.body;
length
Long, die Länge des Nachrichtendatenteils
1readonly Long HttpResponse.length;
stream
Stream, das Stream-Objekt beim Abfragen der Nachricht readFrom
1readonly Stream HttpResponse.stream;
lastError
String, Abfrage und Setzen des letzten Fehlers der Nachrichtenverarbeitung
1String HttpResponse.lastError;
Mitgliedsfunktion
writeHead
Legen Sie den Rückgabestatus der Antwortnachricht fest, geben Sie die Nachricht zurück und fügen Sie den Antwortheader hinzu
1
2
3HttpResponse.writeHead(Integer statusCode,
String statusMessage,
Object headers = {});
Aufrufparameter:
- statusCode: Ganzzahl, gibt den Rückgabestatus der Antwortnachricht an
- statusMessage: String, gibt die Antwortnachricht der Antwortnachricht an
- headers: Objekt, gibt den Antwortheader an, der der Antwortnachricht hinzugefügt wird
Legen Sie den Rückgabestatus der Antwortnachricht fest, geben Sie die Nachricht zurück und fügen Sie den Antwortheader hinzu
1
2HttpResponse.writeHead(Integer statusCode,
Object headers = {});
Aufrufparameter:
- statusCode: Ganzzahl, gibt den Rückgabestatus der Antwortnachricht an
- headers: Objekt, gibt den Antwortheader an, der der Antwortnachricht hinzugefügt wird
addCookie
Fügen Sie einen zu Cookies hinzuHttpCookieObjekt
1HttpResponse.addCookie(HttpCookie cookie);
Aufrufparameter:
- cookie:HttpCookie, Präzisiere dasHttpCookieObjekt
redirect
Senden Sie eine Weiterleitung an den Client
1HttpResponse.redirect(String url);
Aufrufparameter:
- url: String, umgeleitete Adresse
Senden Sie eine Weiterleitung an den Client
1
2HttpResponse.redirect(Integer statusCode,
String url);
Aufrufparameter:
- statusCode: Ganzzahl, gibt den Rückgabestatus der Antwortnachricht an. Der akzeptierte Status ist: 301, 302, 307
- url: String, umgeleitete Adresse
sendHeader
Nur formatiert sendenhttpGehen Sie zum angegebenen Stream-Objekt
1HttpResponse.sendHeader(Stream stm) async;
Aufrufparameter:
- stm:Stream, gibt das Stream-Objekt an, das die formatierte Nachricht empfängt
hasHeader
Prüfen Sie, ob ein Nachrichtenheader mit dem angegebenen Schlüsselwert vorhanden ist
1Boolean HttpResponse.hasHeader(String name);
Aufrufparameter:
- name: String, gibt den zu prüfenden Schlüsselwert an
Rückgabeergebnisse:
- Boolean, gibt zurück, ob der Schlüsselwert existiert
firstHeader
Fragen Sie den ersten Nachrichtenheader des angegebenen Schlüsselwerts ab
1String HttpResponse.firstHeader(String name);
Aufrufparameter:
- name: String, geben Sie den Schlüsselwert an, der abgefragt werden soll
Rückgabeergebnisse:
- StringGibt den Wert zurück, der dem Schlüsselwert entspricht. Wenn er nicht existiert, wird undefiniert zurückgegeben
allHeader
Fragen Sie alle Nachrichtenheader des angegebenen Schlüsselwerts ab
1NObject HttpResponse.allHeader(String name = "");
Aufrufparameter:
- name: Zeichenfolge, geben Sie den abzufragenden Schlüsselwert an, übergeben Sie eine leere Zeichenfolge, um die Ergebnisse aller Schlüsselwerte zurückzugeben
Rückgabeergebnisse:
- NObjectGibt ein Array aller Werte zurück, die dem Schlüsselwert entsprechen. Wenn die Daten nicht vorhanden sind, wird Null zurückgegeben.
addHeader
Fügen Sie einen Nachrichtenkopf hinzu, fügen Sie Daten hinzu und ändern Sie den Nachrichtenkopf des vorhandenen Schlüsselwerts nicht
1HttpResponse.addHeader(Object map);
Aufrufparameter:
- map: Objekt, gibt das hinzuzufügende Schlüsselwert-Datenwörterbuch an
Fügt eine Reihe von Headern mit dem angegebenen Namen hinzu. Durch das Hinzufügen von Daten werden die Header vorhandener Schlüsselwerte nicht geändert.
1
2HttpResponse.addHeader(String name,
Array values);
Aufrufparameter:
- name: String, gibt den hinzuzufügenden Schlüsselwert an
- values: Array, gibt einen hinzuzufügenden Datensatz an
Fügen Sie einen Nachrichtenkopf hinzu, fügen Sie Daten hinzu und ändern Sie den Nachrichtenkopf des vorhandenen Schlüsselwerts nicht
1
2HttpResponse.addHeader(String name,
String value);
Aufrufparameter:
- name: String, gibt den hinzuzufügenden Schlüsselwert an
- value: Zeichenfolge, geben Sie die hinzuzufügenden Daten an
setHeader
Legen Sie einen Nachrichtenkopf fest. Durch das Festlegen der Daten wird der erste Wert geändert, der dem Schlüsselwert entspricht, und die verbleibenden Nachrichtenkopfzeilen mit demselben Schlüsselwert werden gelöscht.
1HttpResponse.setHeader(Object map);
Aufrufparameter:
- map: Objekt, gibt das festzulegende Schlüsselwert-Datenwörterbuch an
Legen Sie einen Satz Nachrichtenkopfzeilen mit dem angegebenen Namen fest. Durch Festlegen der Daten wird der dem Schlüsselwert entsprechende Wert geändert und die verbleibenden Nachrichtenkopfzeilen mit demselben Schlüsselwert gelöscht.
1
2HttpResponse.setHeader(String name,
Array values);
Aufrufparameter:
- name: String, geben Sie den festzulegenden Schlüsselwert an
- values: Array, gibt einen festzulegenden Datensatz an
Legen Sie einen Nachrichtenkopf fest. Durch das Festlegen der Daten wird der erste Wert geändert, der dem Schlüsselwert entspricht, und die verbleibenden Nachrichtenkopfzeilen mit demselben Schlüsselwert werden gelöscht.
1
2HttpResponse.setHeader(String name,
String value);
Aufrufparameter:
- name: String, geben Sie den festzulegenden Schlüsselwert an
- value: Zeichenfolge, geben Sie die festzulegenden Daten an
removeHeader
Löschen Sie alle Nachrichtenkopfzeilen mit dem angegebenen Schlüsselwert
1HttpResponse.removeHeader(String name);
Aufrufparameter:
- name: String, gibt den zu löschenden Schlüsselwert an
read
Liest Daten der angegebenen Größe aus dem Stream. Diese Methode ist ein Alias der entsprechenden Methode von body.
1Buffer HttpResponse.read(Integer bytes = -1) async;
Aufrufparameter:
- bytes: Ganzzahl, gibt die Menge der zu lesenden Daten an. Standardmäßig werden Datenblöcke zufälliger Größe gelesen. Die Größe der gelesenen Daten hängt vom Gerät ab.
Rückgabeergebnisse:
- Buffer, gibt die aus dem Stream gelesenen Daten zurück. Wenn keine Daten zum Lesen vorhanden sind oder die Verbindung unterbrochen ist, wird null zurückgegeben.
readAll
Liest alle verbleibenden Daten aus dem Stream. Diese Methode ist ein Alias der entsprechenden Methode von body.
1Buffer HttpResponse.readAll() async;
Rückgabeergebnisse:
- Buffer, gibt die aus dem Stream gelesenen Daten zurück. Wenn keine Daten zum Lesen vorhanden sind oder die Verbindung unterbrochen ist, wird null zurückgegeben.
write
Schreiben Sie die angegebenen Daten. Diese Methode ist ein Alias der entsprechenden Methode im Hauptteil.
1HttpResponse.write(Buffer data) async;
Aufrufparameter:
- data:Buffer, angesichts der zu schreibenden Daten
json
Schreibt die angegebenen Daten in JSON-Codierung
1Value HttpResponse.json(Value data);
Aufrufparameter:
- data: Wert angesichts der zu schreibenden Daten
Rückgabeergebnisse:
- Value, diese Methode gibt keine Daten zurück
Analysieren Sie die Daten in der Nachricht als JSON-Codierung
1Value HttpResponse.json();
Rückgabeergebnisse:
- Value, gibt das analysierte Ergebnis zurück
pack
vonmsgpackBeim Codieren werden die angegebenen Daten geschrieben
1Value HttpResponse.pack(Value data);
Aufrufparameter:
- data: Wert angesichts der zu schreibenden Daten
Rückgabeergebnisse:
- Value, diese Methode gibt keine Daten zurück
vonmsgpackCodieren und Parsen der Daten in der Nachricht
1Value HttpResponse.pack();
Rückgabeergebnisse:
- Value, gibt das analysierte Ergebnis zurück
end
Legen Sie das Ende der aktuellen Nachrichtenverarbeitung fest.ChainDer Prozessor fährt mit nachfolgenden Transaktionen nicht fort
1HttpResponse.end();
isEnded
Abfrage, ob die aktuelle Nachricht beendet ist
1Boolean HttpResponse.isEnded();
Rückgabeergebnisse:
- Boolean, gibt true zurück, wenn es fertig ist
clear
Klarer Nachrichteninhalt
1HttpResponse.clear();
sendTo
Sendet eine formatierte Nachricht an das angegebene Stream-Objekt
1HttpResponse.sendTo(Stream stm) async;
Aufrufparameter:
- stm:Stream, gibt das Stream-Objekt an, das die formatierte Nachricht empfängt
readFrom
Liest die formatierte Nachricht aus dem angegebenen Cache-Stream-Objekt und analysiert das aufgefüllte Objekt
1HttpResponse.readFrom(Stream stm) async;
Aufrufparameter:
- stm:Stream, gibt das Stream-Objekt zum Lesen formatierter Nachrichten an
toString
Gibt die Zeichenfolgendarstellung des Objekts zurück. Im Allgemeinen wird „[Native Object]“ zurückgegeben. Das Objekt kann gemäß seinen eigenen Eigenschaften neu implementiert werden.
1String HttpResponse.toString();
Rückgabeergebnisse:
- String, gibt die Zeichenfolgendarstellung des Objekts zurück
toJSON
Gibt eine Darstellung des Objekts im JSON-Format zurück und gibt im Allgemeinen eine Sammlung lesbarer Eigenschaften zurück, die vom Objekt definiert werden.
1Value HttpResponse.toJSON(String key = "");
Aufrufparameter:
- key: Zeichenfolge, nicht verwendet
Rückgabeergebnisse:
- Value, gibt einen Wert zurück, der JSON serialisierbar enthält