Mojo::Message::Request

2017-09-30 本文已影响5人 JSON_NULL

简介

use Mojo::Message::Request;

# Parse
my $req = Mojo::Message::Request->new;
$req->parse("GET /foo HTTP/1.0\x0d\x0a");
$req->parse("Content-Length: 12\x0d\x0a");
$req->parse("Content-Type: text/plain\x0d\x0a\x0d\x0a");
$req->parse('Hello World!');
say $req->method;
say $req->headers->content_type;
say $req->body;

# Build
my $req = Mojo::Message::Request->new;
$req->url->parse('http://127.0.0.1/foo/bar');
$req->method('GET');
say $req->to_string;

Mojo :: Message :: Request是基于RFC 7230，RFC 7231，RFC 7235和RFC 2817的 HTTP请求的容器。

事件

Mojo :: Message :: Request继承了Mojo :: Message中的所有事件。

属性

Mojo :: Message :: Request从Mojo :: Message继承了所有属性，并实现以下属性。

env

my $env = $req->env;
$req    = $req->env({PATH_INFO => '/'});

可用于直接访问CGI或PSGI中的环境变量的哈希。

# Check CGI version
my $version = $req->env->{GATEWAY_INTERFACE};

# Check PSGI version
my $version = $req->env->{'psgi.version'};

method

my $method = $req->method;
$req       = $req->method('POST');

HTTP请求的方法，默认为GET。

proxy

my $url = $req->proxy;
$req    = $req->proxy(Mojo::URL->new('http://127.0.0.1:3000'));

请求的代理url。

reverse_proxy

my $bool = $req->reverse_proxy;
$req     = $req->reverse_proxy($bool);

请求是否已经通过反向代码执行。

url

my $url = $req->url;
$req    = $req->url(Mojo::URL->new);

HTTP请求的url，默认为Mojo::URL对象。

# Get request information
my $info = $req->url->to_abs->userinfo;
my $host = $req->url->to_abs->host;
my $path = $req->url->to_abs->path;

via_proxy

my $bool = $req->via_proxy;
$req     = $req->via_proxy($bool);

该请求是否可通过代理服务器执行。

方法

Mojo::Message::Request 从Mojo::Message继承了所有方法，并实现了以下方法。

clone

my $clone = $req->clone;

返回一个当前“请求”对象的复制，如果复制失败则返回undef。

cookies

my $cookies = $req->cookies;
$req        = $req->cookies(Mojo::Cookie::Request->new);
$req        = $req->cookies({name => 'foo', value => 'bar'});

访问当前“请求”的cookie，通常是Mojo::Cookie::Request对象。

# Names of all cookies
say $_->name for @{$req->cookies};

every_param

my $values = $req->every_param('foo');

与param方法类似，但返回的是数组引用，其中的内容是共享相同名称的所有值。

# Get first value
say $req->every_param('foo')->[0];

extract_start_line

my $bool = $req->extract_start_line(\$str);

用一个字符串设计“请求”的起始行。

fix_headers

$req = $req->fix_headers;

确保消息具有所必须的头部信息。

get_start_line_chunk

my $bytes = $req->get_start_line_chunk($offset);

从特定位置获取消息的起始行数据块。

is_handshake

my $bool = $req->is_handshake;

为websocket 检查头部字段 Upgrade 的值。

is_secure

my $bool = $req->is_secure;

检查是不是安全连接（https）。

is_xhr

my $bool = $req->is_xhr;

为 XMLHttpRequest 检查头部字段 X-Requested-With 的值。

param

my $value = $req->param('foo');

从GET或POST方法的请求体中提取application/x-www-form-urlencoded或multipart/form-data的消息体。如果遇到有多个值共享同一名称的情况，则返回这个名称对应的最后一个值；如果你想获取这个名称对应的所有值，可以使用every_param方法。

注：此方法将对会所有消息体中的数据进行缓存，以后再调用将不会重新从消息体中计算，而是使用先前的缓存；所以在所有消息头接收完成之前，不应该调用此方法。

整个消息体的需要全部加载到内存中进行解析，所以你需要确保消息体不会太大。默认情况下“请求”体被限制在16MiB 。

params

my $params = $req->params;

从GET或POST方法的请求体中提取application/x-www-form-urlencoded或multipart/form-data的消息体。返回一个 Mojo::Parameters 对象。

注：这个方法会对处理结果进行缓存，所以需要确保所有内容已经全部传输完成再调用此方法。

消息体的每一块都需要加载到内存中进行解析，所以你需要确保消息体不会太大。默认情况下“请求”体被限制在16MiB 。

# Get parameter names and values
my $hash = $req->params->to_hash;

parse

$req = $req->parse('GET /foo/bar HTTP/1.1');
$req = $req->parse({PATH_INFO => '/'});

解析HTTP请求消息块，或环境变量哗然。

query_params

my $params = $req->query_params;

解析GET方法中的“查询字符串”，通常返回一个Mojo::Parameters对象。

# Turn GET parameters to hash and extract value
say $req->query_params->to_hash->{foo};

start_line_size

my $size = $req->start_line_size;

请求行的尺寸（以字节为单位）。需要注意的是：此方法的调用会结束请求。