ObjectHttpRequest
HttpRequest és una classe que s'utilitza per gestionar sol·licituds HTTP. Us permet crear sol·licituds HTTP i interactuar amb el servidor. Podeu utilitzar-lo per enviar sol·licituds GET, POST i altres tipus de sol·licituds HTTP al servidor web
Suposem que tenim un paràmetre de consulta amb el nom de la clau i tornem diferents resultats de processament basats en aquest paràmetre: si el paràmetre està buit, retorna "Hola món!", si el paràmetre és "fibjs", retorna "Hola fibjs!"; en cas contrari torna "Hola algun cos!".
El codi s'implementa de la següent manera:
1
2
3
4
5
6
7
8
9
10const http = require('http');
var svr = new http.Server(8080, (req) => {
var name = req.query.get('name');
var msg = name ? `Hello ${name}!` : 'Hello world!';
req.response.write(msg);
});
svr.start();
Aquí fem servir req.query
aquest tipus de col·lecció, que representa els paràmetres de consulta a l'URL de sol·licitud HTTP.
Accedim a http://127.0.0.1:8080/?name=fibjs a través del navegador al programa de servei i obtenim el contingut de resposta del servidor Hello fibjs!
.
relació hereditària
Constructor
HttpRequest
El constructor HttpRequest, crea un nou objecte HttpRequest
1new HttpRequest();
constant
TEXT
Especifiqueu el tipus de missatge 1, que representa un tipus de text
1const HttpRequest.TEXT = 1;
BINARY
Especifiqueu el tipus de missatge 2, que representa un tipus binari
1const HttpRequest.BINARY = 2;
propietats dels membres
response
HttpResponse, Obteniu l'objecte de missatge de resposta
1readonly HttpResponse HttpRequest.response;
method
Mètodes de sol·licitud de cadena, consulta i conjunt
1String HttpRequest.method;
address
Cadena, consulta i adreça de sol·licitud establerta
1String HttpRequest.address;
queryString
String, query i set request query string
1String HttpRequest.queryString;
cookies
HttpCollection, obteniu el contenidor que conté galetes de missatges
1readonly HttpCollection HttpRequest.cookies;
form
HttpCollection, obteniu el contenidor que conté el formulari del missatge
1readonly HttpCollection HttpRequest.form;
query
HttpCollection, obteniu el contenidor que conté la consulta del missatge
1readonly HttpCollection HttpRequest.query;
protocol
La cadena, la informació de la versió del protocol, el format permès és: HTTP/#.#
1String HttpRequest.protocol;
headers
HttpCollection, inclòs al missatgehttpContenidor per a les capçaleres dels missatges, propietat de només lectura
1readonly HttpCollection HttpRequest.headers;
keepAlive
Booleà, consulteu i definiu si voleu mantenir la connexió
1Boolean HttpRequest.keepAlive;
upgrade
Boolean, consulteu i configureu si es tracta d'un protocol d'actualització
1Boolean HttpRequest.upgrade;
maxHeadersCount
Enter, consulteu i estableixi el nombre màxim de capçaleres de sol·licitud, el valor predeterminat és 128
1Integer HttpRequest.maxHeadersCount;
maxHeaderSize
Enter, consulteu i estableixi la longitud màxima de la capçalera de la sol·licitud, el valor per defecte és 8192
1Integer HttpRequest.maxHeaderSize;
maxBodySize
Enter, consulteu i configureu la mida màxima del cos en MB, el valor predeterminat és 64
1Integer HttpRequest.maxBodySize;
socket
Stream, Consulta el sòcol d'origen de l'objecte actual
1readonly Stream HttpRequest.socket;
value
String, el contingut bàsic del missatge
1String HttpRequest.value;
params
NArray, els paràmetres bàsics del missatge
1readonly NArray HttpRequest.params;
type
Sencer, tipus de missatge
1Integer HttpRequest.type;
data
Valor, consulta les dades del missatge. Aquest atribut retornarà dades diferents segons el tipus de contingut. Quan sigui text, es retornarà el text.jsontornar quanjson, en cas contrari, retorna binari
1readonly Value HttpRequest.data;
body
SeekableStream, un objecte de flux que conté la part de dades del missatge
1SeekableStream HttpRequest.body;
length
Long, la longitud de la part de dades del missatge
1readonly Long HttpRequest.length;
stream
Stream, l'objecte de flux quan es consulta el missatge readFrom
1readonly Stream HttpRequest.stream;
lastError
Encadena, consulta i defineix l'últim error de processament del missatge
1String HttpRequest.lastError;
funció de membre
hasHeader
Comproveu si hi ha una capçalera de missatge amb el valor de clau especificat
1Boolean HttpRequest.hasHeader(String name);
Paràmetres de trucada:
- name: Cadena, especifica el valor de la clau que cal comprovar
Resultats de retorn:
- Boolean, retorna si el valor de la clau existeix
firstHeader
Consulteu la primera capçalera del missatge del valor de clau especificat
1String HttpRequest.firstHeader(String name);
Paràmetres de trucada:
- name: Cadena, especifiqueu el valor de la clau que s'ha de consultar
Resultats de retorn:
- String, retorna el valor corresponent al valor de la clau, si no existeix, retorna sense definir
allHeader
Consulteu totes les capçaleres de missatges del valor de clau especificat
1NObject HttpRequest.allHeader(String name = "");
Paràmetres de trucada:
- name: Cadena, especifiqueu el valor de la clau a consultar, passeu una cadena buida per retornar els resultats de tots els valors de la clau
Resultats de retorn:
- NObject, retorna una matriu de tots els valors corresponents al valor de la clau. Si les dades no existeixen, retorna null.
addHeader
Afegiu una capçalera de missatge, afegiu dades i no modifiqueu la capçalera del missatge del valor de clau existent
1HttpRequest.addHeader(Object map);
Paràmetres de trucada:
- map: Objecte, especifica el diccionari de dades clau-valor que cal afegir
Afegeix un conjunt de capçaleres amb el nom especificat. Afegir dades no modifica les capçaleres dels valors de clau existents.
1
2HttpRequest.addHeader(String name,
Array values);
Paràmetres de trucada:
- name: Cadena, especifica el valor de la clau que cal afegir
- values: Matriu, especifica un conjunt de dades que cal afegir
Afegiu una capçalera de missatge, afegiu dades i no modifiqueu la capçalera del missatge del valor de clau existent
1
2HttpRequest.addHeader(String name,
String value);
Paràmetres de trucada:
- name: Cadena, especifica el valor de la clau que cal afegir
- value: Cadena, especifiqueu les dades a afegir
setHeader
Estableix una capçalera de missatge. Si estableixes les dades, es modificarà el primer valor corresponent al valor de la clau i esborrarà les capçaleres de missatge restants amb el mateix valor de clau.
1HttpRequest.setHeader(Object map);
Paràmetres de trucada:
- map: Objecte, especifica el diccionari de dades clau-valor que s'ha d'establir
Estableix un conjunt de capçaleres de missatge amb el nom especificat. Si estableixes les dades, es modificarà el valor corresponent al valor de la clau i esborrarà les capçaleres de missatge restants amb el mateix valor de clau.
1
2HttpRequest.setHeader(String name,
Array values);
Paràmetres de trucada:
- name: Cadena, especifiqueu el valor de la clau que s'ha d'establir
- values: Matriu, especifica un conjunt de dades a establir
Estableix una capçalera de missatge. Si estableixes les dades, es modificarà el primer valor corresponent al valor de la clau i esborrarà les capçaleres de missatge restants amb el mateix valor de clau.
1
2HttpRequest.setHeader(String name,
String value);
Paràmetres de trucada:
- name: Cadena, especifiqueu el valor de la clau que s'ha d'establir
- value: Cadena, especifiqueu les dades a establir
removeHeader
Suprimeix totes les capçaleres dels missatges amb el valor de clau especificat
1HttpRequest.removeHeader(String name);
Paràmetres de trucada:
- name: Cadena, especifica el valor de la clau que s'ha de suprimir
read
Llegeix dades de la mida especificada del flux. Aquest mètode és un àlies del mètode corresponent del cos.
1Buffer HttpRequest.read(Integer bytes = -1) async;
Paràmetres de trucada:
- bytes: Sencer, especifica la quantitat de dades que s'han de llegir. El valor predeterminat és llegir blocs de dades de mida aleatòria. La mida de les dades llegides depèn del dispositiu.
Resultats de retorn:
- Buffer, retorna les dades llegides del flux. Si no hi ha dades per llegir o la connexió s'interromp, es retorna null.
readAll
Llegeix totes les dades restants del flux. Aquest mètode és un àlies del mètode corresponent de body.
1Buffer HttpRequest.readAll() async;
Resultats de retorn:
- Buffer, retorna les dades llegides del flux. Si no hi ha dades per llegir o la connexió s'interromp, es retorna null.
write
Escriu les dades donades. Aquest mètode és un àlies del mètode corresponent al cos.
1HttpRequest.write(Buffer data) async;
Paràmetres de trucada:
- data:Buffer, donades les dades a escriure
json
Escriu les dades proporcionades en codificació JSON
1Value HttpRequest.json(Value data);
Paràmetres de trucada:
- data: Valor, tenint en compte les dades a escriure
Resultats de retorn:
- Value, aquest mètode no retorna dades
Analitzeu les dades del missatge com a codificació JSON
1Value HttpRequest.json();
Resultats de retorn:
- Value, retorna el resultat analitzat
pack
permsgpackLa codificació escriu les dades donades
1Value HttpRequest.pack(Value data);
Paràmetres de trucada:
- data: Valor, tenint en compte les dades a escriure
Resultats de retorn:
- Value, aquest mètode no retorna dades
permsgpackCodificació i anàlisi de les dades del missatge
1Value HttpRequest.pack();
Resultats de retorn:
- Value, retorna el resultat analitzat
end
Establir el final del processament del missatge actual,ChainEl processador no continua amb les transaccions posteriors
1HttpRequest.end();
isEnded
Consulta si el missatge actual ha acabat
1Boolean HttpRequest.isEnded();
Resultats de retorn:
- Boolean, torna veritable quan s'hagi acabat
clear
Esborra el contingut del missatge
1HttpRequest.clear();
sendTo
Envia un missatge amb format a l'objecte de flux donat
1HttpRequest.sendTo(Stream stm) async;
Paràmetres de trucada:
- stm:Stream, especifica l'objecte de flux que rep el missatge amb format
readFrom
Llegeix el missatge amb format de l'objecte del flux de memòria cau donat i analitza l'objecte emplenat
1HttpRequest.readFrom(Stream stm) async;
Paràmetres de trucada:
- stm:Stream, especifica l'objecte de flux per llegir missatges amb format
toString
Retorna la representació de cadena de l'objecte. En general, es retorna "[Objecte natiu]". L'objecte es pot tornar a implementar segons les seves pròpies característiques.
1String HttpRequest.toString();
Resultats de retorn:
- String, retorna la representació de cadena de l'objecte
toJSON
Retorna una representació en format JSON de l'objecte, generalment retornant una col·lecció de propietats llegibles definides per l'objecte.
1Value HttpRequest.toJSON(String key = "");
Paràmetres de trucada:
- key: Corda, no utilitzada
Resultats de retorn:
- Value, retorna un valor que conté JSON serializable