添加 Request

master
yutent 2023-08-30 14:53:01 +08:00
parent aa3b7379af
commit f69a3dfb6e
1 changed files with 47 additions and 0 deletions

47
Request.md Normal file

@ -0,0 +1,47 @@
## `Request`请求体对象
> 这是一个对原生的http request请求体, 进一步封装的结果, 会自动对url的合法性进行校验, 并且以友好的方式返回错误信息。 同时封装一些常用的方法。
### 属性
+ `.origin<Object>` 原生的request和response对象,如果封装的这些方法不满足你的需求,可以直接对原生的request进行操作。
+ `.method<String>` http请求方法, 纯小写。
+ `.app<String>` 一级路由的名字。
+ `.path<Array>` 除一级路由以外的部分, 以数据形式储存。 注意: 路由中间件会抽走第2段。
+ `.url<String>` 经过修正后的path部分
### 方法
+ `.get(key<String>, xss<Boolean>)` 同php的$_GET[]。
- key`<String>` [可选], 不传返回所有的参数。
- xss`<Boolean>` [可选], 是否对取值进行基础的xss过滤。
+ `.post(key<String>, xss<Boolean>)` 同php的$_POST[]。
- key`<String>` [可选], 不传返回所有的参数。
- xss`<Boolean>` [可选], 是否对取值进行基础的xss过滤。
> 只要是在body中的, 都是用这个方法读取, 无论method是不是POST。
+ `.header(key<String>)` 读取头信息
- key`<String>` [可选], 字段名, 不分大小写。 不传返回所有的字段。
+ `.cookie(key<String>)` 读取cookie
- key`<String>` [可选], 字段名, 不传返回所有的cookie。
+ `.ip()` 读取客户端的IP地址(不一定能获取到)。
----
上一节: [⟪控制器⟫](https://github.com/bytedo/gmf.core/wiki/Controller)
下一节: [⟪Response⟫](https://github.com/bytedo/gmf.core/wiki/Response)