请求

请求对象

think\Request类，不需要实例化，通常使用依赖注入

think\face\Request类，可应用于模板输出等场合，静态类操作

一、请求对象调用

1.构造方法注入

<?php

namespace app\index\controller;

use think\Request;

class Index 
{
    /**
     * @var \think\Request Request实例
     */
    protected $request;
    
    /**
     * 构造方法
     * @param Request $request Request对象
     * @access public
     */
    public function __construct(Request $request)
    {
		$this->request = $request;
    }
    
    public function index()
    {
		return $this->request->param('name');
    }    
}

如果你继承了系统的控制器基类think\Controller的话，系统已经自动完成了请求对象的构造方法注入了，你可以直接使用$this->request属性调用当前的请求对象。

<?php

namespace app\index\controller;

use think\Controller;

class Index extends Controller
{
    
    public function index()
    {
		return $this->request->param('name');
    }    
}

2.操作方法注入

在每个方法中使用依赖注入

<?php

namespace app\index\controller;

use think\Controller;
use think\Request;

class Index extends Controller
{
    
    public function index(Request $request)
    {
		return $request->param('name');
    }    
}

二、Facade调用

在没有使用依赖注入的场合，可以通过Facade机制来静态调用请求对象的方法（注意use引入的类库区别）。

<?php

namespace app\index\controller;

use think\Controller;
use think\facade\Request;

class Index extends Controller
{
    
    public function index()
    {
		return Request::param('name');
    }    
}

三、助手函数

<?php

namespace app\index\controller;

use think\Controller;

class Index extends Controller
{

    public function index()
    {
        return request()->param('name');
    }
}

请求信息

Request对象支持获取当前的请求信息，包括：

方法	含义
host	当前访问域名或者IP
scheme	当前访问协议
port	当前访问的端口
remotePort	当前请求的REMOTE_PORT
protocol	当前请求的SERVER_PROTOCOL
contentType	当前请求的CONTENT_TYPE
domain	当前包含协议的域名
subDomain	当前访问的子域名
panDomain	当前访问的泛域名
rootDomain	当前访问的根域名（V5.1.6+）
url	当前完整URL
baseUrl	当前URL（不含QUERY_STRING）
query	当前请求的QUERY_STRING参数
baseFile	当前执行的文件
root	URL访问根地址
rootUrl	URL访问根目录
pathinfo	当前请求URL的pathinfo信息（含URL后缀）
path	请求URL的pathinfo信息(不含URL后缀)
ext	当前URL的访问后缀
time	获取当前请求的时间
type	当前请求的资源类型
method	当前请求类型

对于上面的这些请求方法，一般调用无需任何参数，但某些方法可以传入true参数，表示获取带域名的完整地址，例如：

use think\facade\Request;
// 获取完整URL地址 不带域名
Request::url();
// 获取完整URL地址 包含域名
Request::url(true);
// 获取当前URL（不含QUERY_STRING） 不带域名
Request::baseFile();
// 获取当前URL（不含QUERY_STRING） 包含域名
Request::baseFile(true);
// 获取URL访问根地址 不带域名
Request::root();
// 获取URL访问根地址 包含域名
Request::root(true);

//例子：
echo Request::method();
echo request()->method();
echo $this->request->method();
//都返回POST

输入变量

可以通过Request对象完成全局输入变量的检测、获取和安全过滤，支持包括$_GET、$_POST、$_REQUEST、$_SERVER、$_SESSION、$_COOKIE、$_ENV等系统变量，以及文件上传信息。

一、检测变量是否设置

has方法

Request::has('id','get');
Request::has('name','post');

Request::has('user_id');
Request::has('user_id','post');
$this->request->has('user_id','post');
request()->has('user_id','post');
//bool(true)

变量检测可以支持所有支持的系统变量，包括get/post/put/request/cookie/server/session/env/file

二、变量获取

变量获取使用\think\Request类的如下方法及参数：

变量类型方法('变量名/变量修饰符','默认值','过滤方法')

变量类型方法包括：

方法	描述
param	获取当前请求的变量
get	获取 $_GET 变量
post	获取 $_POST 变量
put	获取 PUT 变量
delete	获取 DELETE 变量
session	获取 $_SESSION 变量
cookie	获取 $_COOKIE 变量
request	获取 $_REQUEST 变量
server	获取 $_SERVER 变量
env	获取 $_ENV 变量
route	获取 路由（包括PATHINFO） 变量
file	获取 $_FILES 变量

1.获取PARAM变量

// 获取当前请求的name变量
Request::param('name');
// 获取当前请求的所有变量（经过过滤）
Request::param();
// 获取当前请求的所有变量（原始数据）
Request::param(false);
// 获取当前请求的所有变量（包含上传文件）
Request::param(true);

如果你使用了依赖注入的方式，可以更简单的方式获取请求变量。

namespace app\index\controller;

use think\Request;

class Index 
{
	public function index(Request $request)
    {
    	// 获取name请求变量
    	return $request->name;
    }
}

param方法会把当前请求类型的参数和路由变量以及GET请求合并，并且路由变量是优先的。

你无法使用get方法获取路由变量，例如当访问地址是

//http://localhost/index.php/index/index/hello/name/thinkphp
echo Request::get('name'); // 输出为空
echo Request::param('name'); // 输出thinkphp
echo Request::route('name'); // 输出thinkphp

 

变量名区分大小写，除了server和env方法的变量名不区分大小写（会自动转为大写后获取）。

strtoupper($_SERVER['REQUEST_METHOD']) == 'POST'
strtoupper(Request::server('REQUEST_METHOD')) == 'POST'

2.默认值

当输入变量不含name的时候，返回null。

Request::get('name'); // 返回值为null
Request::get('name',''); // 返回值为空字符串
Request::get('name','default'); // 返回值为default

3.变量过滤

（1）框架默认没有设置任何全局过滤规则，你可以在应用配置文件中设置全局的过滤规则：

// 默认全局过滤方法 用逗号分隔多个
'default_filter'         => 'htmlspecialchars',

（2）使用Request对象进行全局变量的获取过滤，过滤方式包括函数、方法过滤，以及PHP内置的Types of filters：

Request::filter(['strip_tags','htmlspecialchars']),

Request::get('name','','htmlspecialchars'); 
// 获取get变量 并用htmlspecialchars函数过滤

Request::param('username','','strip_tags'); 
// 获取param变量 并用strip_tags函数过滤

Request::post('name','','org\Filter::safeHtml'); 
// 获取post变量 并用org\Filter类的safeHtml方法过滤

Request::param('username','','strip_tags,strtolower'); 
// 获取param变量 并依次调用strip_tags、strtolower函数过滤

Request::post('email','',FILTER_VALIDATE_EMAIL);
//PHP内置提供的Filter ID过滤

Request::post('email','','email');
//框架对FilterID做了转换支持，因此也可以使用字符串的方式

 

如果当前不需要进行任何过滤的话，可以使用

// 获取get变量 并且不进行任何过滤 即使设置了全局过滤
Request::get('name', '', null); 

对于body中提交的json对象，你无需使用php://input去获取，可以直接当做表单提交的数据使用，因为系统已经自动处理过了

4.获取部分变量

（1）如果你只需要获取当前请求的部分参数，可以使用：

// 只获取当前请求的id和name变量
Request::only('id,name');

// 只获取当前请求的id和name变量
Request::only(['id','name']);

V5.1.3+版本开始，only方法可以支持批量设置默认值，如下：

// 设置默认值
Request::only(['id'=>0,'name'=>'']);

默认获取的是当前请求参数（PARAM类型变量），如果需要获取其它类型的参数，可以在第二个参数传入，例如：

// 只获取GET请求的id和name变量
Request::only(['id','name'], 'get');
// 只获取POST请求的id和name变量
Request::only(['id','name'], 'post');

（2）支持排除某些变量后获取，例如

// 排除id和name变量
Request::except('id,name');

// 排除id和name变量
Request::except(['id','name']);

// 排除GET请求的id和name变量
Request::except(['id','name'], 'get');

// 排除POST请求的id和name变量
Request::except(['id','name'], 'post');

5.变量修饰符

Request::变量类型('变量名/修饰符');

修饰符	作用
s	强制转换为字符串类型
d	强制转换为整型类型
b	强制转换为布尔类型
a	强制转换为数组类型
f	强制转换为浮点类型

Request::get('id/d');
Request::post('name/s');
Request::post('ids/a');

6.修改变量

V5.1.12+版本开始，可以（通常是在中间件里面）设置请求变量的值。

<?php

namespace app\http\middleware;

class Check
{
    public function handle($request, \Closure $next)
    {
        if ('think' == $request->name) {
        	$request->name = 'ThinkPHP';
        }

        return $next($request);
    }
}

7.助手函数

为了简化使用，还可以使用系统提供的input助手函数完成上述大部分功能。

（1）判断变量是否定义

input('?get.id');
input('?post.name');

（2）获取PARAM参数

input('param.name'); // 获取单个参数
input('param.'); // 获取全部参数
// 下面是等效的
input('name'); 
input('');

（3）获取GET参数

// 获取单个变量
input('get.id');
// 使用过滤方法获取 默认为空字符串
input('get.name');
// 获取全部变量
input('get.');

（4）使用过滤方法

input('get.name','','htmlspecialchars'); 
// 获取get变量 并用htmlspecialchars函数过滤

input('username','','strip_tags'); 
// 获取param变量 并用strip_tags函数过滤

input('post.name','','org\Filter::safeHtml'); 
// 获取post变量 并用org\Filter类的safeHtml方法过滤

（5）使用变量修饰符

input('get.id/d');
input('post.name/s');
input('post.ids/a');

请求类型

一、获取请求类型

请求对象Request类提供了下列方法来获取或判断当前请求类型：

用途	方法
获取当前请求类型	method
判断是否GET请求	isGet
判断是否POST请求	isPost
判断是否PUT请求	isPut
判断是否DELETE请求	isDelete
判断是否AJAX请求	isAjax
判断是否PJAX请求	isPjax
判断是否为JSON请求	isJson（V5.1.38+）
判断是否手机访问	isMobile
判断是否HEAD请求	isHead
判断是否PATCH请求	isPatch
判断是否OPTIONS请求	isOptions
判断是否为CLI执行	isCli
判断是否为CGI模式	isCgi

method方法返回的请求类型始终是大写，这些方法都不需要传入任何参数。

没有必要在控制器中判断请求类型再来执行不同的逻辑，完全可以在路由中进行设置。

HTTP头信息

可以使用Request对象的header方法获取当前请求的HTTP请求头信息

$info = Request::header();
echo $info['accept'];
echo $info['accept-encoding'];
echo $info['user-agent'];

也可以直接获取某个请求头信息，例如：

$agent = Request::header('user-agent');

HTTP请求头信息的名称不区分大小写，并且_会自动转换为-，所以下面的写法都是等效的：

$agent = Request::header('user-agent');
$agent = Request::header('User-Agent');
$agent = Request::header('User_Agent');
$agent = Request::header('USER_AGENT');

 使用$_SERVER

<?php
foreach ($_SERVER as $key => $value) {
    if ('HTTP_' == substr($key, 0, 5)) {
        $headers[str_replace('_', '-', substr($key, 5))] = $value;
    }
}
//Array
//(
//[USER-AGENT] => ApiPOST Runtime +https://www.apipost.cn
//[TOKEN] => 002b2a746d542b0b40daa97c9b4f5cab
//[ORIGIN] => http://test.com
//[CONTENT-TYPE] => multipart/form-data; boundary=----WebKitFormBoundaryYFTohwOah2wRso36
//[CLIENT] => pc
//[ACCEPT-LANGUAGE] => zh-CN
//[ACCEPT-ENCODING] => gzip, deflate
//[ACCEPT] => application/json, text/javascript, */*; q=0.01
//    [CONTENT-LENGTH] => 251
//    [CONNECTION] => keep-alive
//    [HOST] => test.com
//)

Request::header();

//Array
//(
//[user-agent] => ApiPOST Runtime +https://www.apipost.cn
//[token] => 002b2a746d542b0b40daa97c9b4f5cab
//[origin] => http://test.com
//[content-type] => multipart/form-data; boundary=----WebKitFormBoundaryAKu54hzhQXPIth0o
//[client] => pc
//[accept-language] => zh-CN
//[accept-encoding] => gzip, deflate
//[accept] => application/json, text/javascript, */*; q=0.01
//    [content-length] => 251
//    [connection] => keep-alive
//    [host] => test.com
//)