# 输入变量
可以通过`Request`对象完成全局输入变量的检测、获取和安全过滤,
为了方便说明,本篇内容的所有示例代码均使用`Facade`方式,因此需要首先引入
~~~
use think\facade\Request;
~~~
如果你使用的是依赖注入,请自行调整代码为动态调用即可。
### 获取变量
长连接中没有http方式下的GET,POST等方式,获取变量使用统一的param方法
~~~
// 获取当前请求的name变量
Request::param('name');
// 获取当前请求的所有变量
Request::param();
~~~
## 默认值
获取输入变量的时候,可以支持默认值,例如当data中不包含`name`的时候,使用下面的方式输出的结果比较。
~~~
Request::param('name'); // 返回值为null
Request::param('name',''); // 返回值为空字符串
Request::param('name','default'); // 返回值为default
~~~
前面提到的方法都支持在第二个参数中传入默认值的方式。
## 变量过滤
> 框架默认没有设置任何全局过滤规则,你可以在应用配置文件中设置全局的过滤规则:
~~~
// 默认全局过滤方法 用逗号分隔多个
'default_filter' => 'htmlspecialchars',
~~~
也支持使用`Request`对象进行全局变量的获取过滤,过滤方式包括函数、方法过滤,以及PHP内置的Types of filters,我们可以设置全局变量过滤方法,支持设置多个过滤方法,例如:
~~~
Request::filter(['strip_tags','htmlspecialchars']),
~~~
也可以在获取变量的时候添加过滤方法,例如:
~~~
Request::param('name','','htmlspecialchars'); // 获取get变量 并用htmlspecialchars函数过滤
Request::param('username','','strip_tags'); // 获取param变量 并用strip_tags函数过滤
Request::param('name','','org\Filter::safeHtml'); // 获取post变量 并用org\Filter类的safeHtml方法过滤
~~~
可以支持传入多个过滤规则,例如:
~~~
Request::param('username','','strip_tags,strtolower'); // 获取param变量 并依次调用strip_tags、strtolower函数过滤
~~~
Request对象还支持PHP内置提供的Filter ID过滤,例如:
~~~
Request::param('email','',FILTER_VALIDATE_EMAIL);
~~~
框架对FilterID做了转换支持,因此也可以使用字符串的方式,例如:
~~~
Request::param('email','','email');
~~~
采用字符串方式定义`FilterID`的时候,系统会自动进行一次`filter_id`调用转换成`Filter`常量。
具体的字符串根据`filter_list`函数的返回值来定义。
> 需要注意的是,采用Filter ID 进行过滤的话,如果不符合过滤要求的话 会返回false,因此你需要配合默认值来确保最终的值符合你的规范。
例如,
~~~
Request::param('email','',FILTER_VALIDATE_EMAIL);
~~~
就表示,如果不是规范的`email`地址的话 返回空字符串。
如果当前不需要进行任何过滤的话,可以使用
~~~
// 获取get变量 并且不进行任何过滤 即使设置了全局过滤
Request::param('name', '', null);
~~~
## 获取部分变量
如果你只需要获取当前请求的部分参数,可以使用:
~~~
// 只获取当前请求的id和name变量
Request::only('id,name');
~~~
或者使用数组方式
~~~
// 只获取当前请求的id和name变量
Request::only(['id','name']);
~~~
> 采用`only`方法能够安全的获取你需要的变量,避免额外变量影响数据处理和写入。
`V5.1.3+`版本开始,only方法可以支持批量设置默认值,如下:
~~~
// 设置默认值
Request::only(['id'=>0,'name'=>'']);
~~~
表示`id`的默认值为0,`name`的默认值为空字符串。
也支持排除某些变量后获取,例如
~~~
// 排除id和name变量
Request::except('id,name');
~~~
或者使用数组方式
~~~
// 排除id和name变量
Request::except(['id','name']);
~~~
## 变量修饰符
支持对变量使用修饰符功能,可以一定程度上简单过滤变量,更为严格的过滤请使用前面提过的变量过滤功能。
用法如下:
> ### Request::变量类型('变量名/修饰符');
| 修饰符 | 作用 |
| --- | --- |
| s | 强制转换为字符串类型 |
| d | 强制转换为整型类型 |
| b | 强制转换为布尔类型 |
| a | 强制转换为数组类型 |
| f | 强制转换为浮点类型 |
下面是一些例子:
~~~
Request::param('id/d');
Request::param('name/s');
Request::param('ids/a');
~~~
> 如果你要获取的数据为数组,请一定注意要加上`/a`修饰符才能正确获取到。