## 注解路由
ThinkPHP支持使用注解方式定义路由(也称为注解路由),如果需要使用注解路由需要安装额外的扩展:
```
composer require topthink/think-annotation
```
然后只需要直接在控制器类的方法注释中定义,例如:
~~~
<?php
namespace app\controller;
use think\annotation\Route;
class Index
{
/**
* @param string $name 数据名称
* @return mixed
* @Route("hello/:name")
*/
public function hello($name)
{
return 'hello,'.$name;
}
}
~~~
`@Route("hello/:name")` 就是注解路由的内容,请务必注意注释的规范,不能在注解路由里面使用单引号,否则可能导致注解路由解析失败,可以利用IDE生成规范的注释。如果你使用`PHPStorm`的话,建议安装`PHP Annotations`插件:https://plugins.jetbrains.com/plugin/7320-php-annotations ,可以支持注解的自动完成。
>[danger] 该方式定义的路由在调试模式下面实时生效,部署模式则在第一次访问的时候生成注解缓存。
然后就使用下面的URL地址访问:
~~~
http://tp5.com/hello/thinkphp
~~~
页面输出
~~~
hello,thinkphp
~~~
默认注册的路由规则是支持所有的请求,如果需要指定请求类型,可以在第二个参数中指定请求类型:
~~~
<?php
namespace app\controller;
use think\annotation\Route;
class Index
{
/**
* @param string $name 数据名称
* @return mixed
* @Route("hello/:name", method="GET")
*/
public function hello($name)
{
return 'hello,'.$name;
}
}
~~~
如果有路由参数需要定义,可以直接在后面添加方法,例如:
~~~
<?php
namespace app\controller;
use think\annotation\Route;
class Index
{
/**
* @param string $name 数据名称
* @Route("hello/:name", method="GET", https=1, ext="html")
* @return mixed
*/
public function hello($name)
{
return 'hello,'.$name;
}
}
~~~
支持在类的注释里面定义资源路由,例如:
~~~
<?php
namespace app\controller;
use think\annotation\route\Resource;
/**
* @Resource("blog")
*/
class Blog
{
public function index()
{
}
public function read($id)
{
}
public function edit($id)
{
}
}
~~~
如果需要定义路由分组,可以使用
~~~
<?php
namespace app\controller;
use think\annotation\route\Group;
use think\annotation\route\Route;
/**
* @Group("blog")
*/
class Blog
{
/**
* @param string $name 数据名称
* @return mixed
* @Route("hello/:name", method="GET")
*/
public function hello($name)
{
return 'hello,'.$name;
}
}
~~~
当前控制器中的注解路由会自动加入`blog`分组下面,最终,会注册一个`blog/hello/:name`的路由规则。你一样可以对该路由分组设置公共的参数,例如:
~~~
<?php
namespace app\controller;
use think\annotation\route\Middleware;
use think\annotation\route\Group;
use think\annotation\route\Route;
use think\middleware\SessionInit;
/**
* @Group("blog",ext="html")
* @Middleware({SessionInit::class})
*/
class Blog
{
/**
* @param string $name 数据名称
* @return mixed
* @Route("hello/:name",method="GET")
*/
public function hello($name)
{
return 'hello,'.$name;
}
}
~~~
- 序言
- 基础
- 安装
- 开发规范
- 目录结构
- 配置
- 架构
- 请求流程
- 架构总览
- 入口文件
- 多应用模式
- URL访问
- 容器和依赖注入
- 服务
- 门面
- 中间件
- 事件
- 路由
- 路由定义
- 变量规则
- 路由地址
- 路由参数
- 路由中间件
- 路由分组
- 资源路由
- 注解路由
- 路由绑定
- 域名路由
- MISS路由
- 跨域请求
- URL生成
- 控制器
- 控制器定义
- 基础控制器
- 空控制器
- 资源控制器
- 控制器中间件
- 请求
- 请求对象
- 请求信息
- 输入变量
- 请求类型
- HTTP头信息
- 伪静态
- 参数绑定
- 请求缓存
- 响应
- 响应输出
- 响应参数
- 重定向
- 文件下载
- 数据库
- 连接数据库
- 分布式数据库
- 查询构造器
- 查询数据
- 添加数据
- 更新数据
- 删除数据
- 查询表达式
- 链式操作
- where
- table
- alias
- field
- strict
- limit
- page
- order
- group
- having
- join
- union
- distinct
- lock
- cache
- cacheAlways
- comment
- fetchSql
- force
- partition
- failException
- sequence
- replace
- extra
- duplicate
- procedure
- 聚合查询
- 分页查询
- 时间查询
- 高级查询
- 视图查询
- JSON字段
- 子查询
- 原生查询
- 获取查询参数
- 查询事件
- 获取器
- 事务操作
- 存储过程
- 数据集
- 数据库驱动
- 模型
- 定义
- 模型字段
- 新增
- 更新
- 删除
- 查询
- 查询范围
- JSON字段
- 获取器
- 修改器
- 搜索器
- 数据集
- 自动时间戳
- 只读字段
- 软删除
- 类型转换
- 模型输出
- 模型事件
- 模型关联
- 一对一关联
- 一对多关联
- 远程一对多
- 远程一对一
- 多对多关联
- 多态关联
- 关联预载入
- 关联统计
- 关联输出
- 虚拟模型
- 视图
- 模板变量
- 视图过滤
- 模板渲染
- 模板引擎
- 视图驱动
- 错误和日志
- 异常处理
- 日志处理
- 调试
- 调试模式
- Trace调试
- SQL调试
- 变量调试
- 远程调试
- 验证
- 验证器
- 验证规则
- 错误信息
- 验证场景
- 路由验证
- 内置规则
- 表单令牌
- 注解验证
- 杂项
- 缓存
- Session
- Cookie
- 多语言
- 上传
- 命令行
- 启动内置服务器
- 查看版本
- 自动生成应用目录
- 创建类库文件
- 清除缓存文件
- 生成数据表字段缓存
- 生成路由映射缓存
- 输出路由定义
- 自定义指令
- Debug输出级别
- 扩展库
- 数据库迁移工具
- Workerman
- think助手工具库
- 验证码
- Swoole
- 附录
- 助手函数
- 升级指导
- 更新日志