利用路由功能,可以让你的URL地址更加简洁和优雅。ThinkPHP支持对模块的URL地址进行路由操作。路由功能是针对PATHINFO模式或者兼容URL而设计的,暂时不支持普通URL模式。
路由解析的最终结果通常是把URL地址解析到当前模块的某个控制器下的操作方法(不能跨模块路由),在特殊的情况下,也可以跳转到外部地址或者执行闭包函数。
注意:3.2版本的路由定义是针对模块定义的,所以路由是在模块配置文件中定义的,并且模块本身不能被路由(模块名的路由使用模块映射或者采用域名部署即可)。
路由定义
启用路由
要使用路由功能,前提是你的URL支持PATH_INFO(或者兼容URL模式也可以,采用普通URL模式的情况下不支持路由功能),并且在应用(或者模块)配置文件中开启路由:
// 开启路由 ‘URL_ROUTER_ON‘ => true,
3.2的路由功能是针对模块设置的,所以URL中的模块名不能被路由,路由定义也通常是放在模块配置文件中。 3.2.3版本开始增加全局路由定义支持,可以在项目的公共配置文件中定义路由。
然后就是配置路由规则了,在模块的配置文件中使用URL_ROUTE_RULES参数进行配置,配置格式是一个数组,每个元素都代表一个路由规则,例如:
‘URL_ROUTE_RULES‘=>array( ‘news/:year/:month/:day‘ => array(‘News/archive‘, ‘status=1‘), ‘news/:id‘ => ‘News/read‘, ‘news/read/:id‘ => ‘/news/:1‘, ),
系统会按定义的顺序依次匹配路由规则,一旦匹配到的话,就会定位到路由定义中的控制器和操作方法去执行(可以传入其他的参数),并且后面的规则不会继续匹配。
路由定义
路由规则的定义格式为: ‘路由表达式‘=>‘路由地址和传入参数‘
或者:array(‘路由表达式‘,‘路由地址‘,‘传入参数‘)
路由表达式包括规则路由和正则路由的定义表达式,只能使用字符串。
表达式 | 示例 |
正则表达式 | /^blog\/(\d+)$/ |
规则表达式 | blog/:id |
路由地址(可以支持传入额外参数)表示前面的路由表达式需要路由到的地址(包括内部地址和外部地址),并且允许隐式传入URL里面没有的一些参数,这里允许使用字符串或者数组方式定义,特殊情况下还可以采用闭包函数定义路由功能,支持下面6种方式定义:
定义方式 | 定义格式 |
方式1:路由到内部地址(字符串) | ‘[控制器/操作]?额外参数1=值1&额外参数2=值2...‘ |
方式2:路由到内部地址(数组)参数采用字符串方式 | array(‘[控制器/操作]‘,‘额外参数1=值1&额外参数2=值2...‘) |
方式3:路由到内部地址(数组)参数采用数组方式 | array(‘[控制器/操作]‘,array(‘额外参数1‘=>‘值1‘,‘额外参数2‘=>‘值2‘...)[,路由参数]) |
方式4:路由到外部地址(字符串)301重定向 | ‘外部地址‘ |
方式5:路由到外部地址(数组)可以指定重定向代码 | array(‘外部地址‘,‘重定向代码‘[,路由参数]) |
方式6:闭包函数 | function($name){ echo ‘Hello,‘.$name;} |
3.2.3版本开始支持全局路由定义,如果你定义的是全局路由,那么路由地址的定义格式中需要增加模块名,例如:
‘blog/:id‘=>‘Home/blog/read‘ // 表示路由到Home模块的blog控制器的read操作方法
如果路由地址以“/”或者“http”开头则会认为是一个重定向地址或者外部地址,例如:
‘blog/:id‘=>‘/blog/read/id/:1‘ ‘blog/:id‘=>‘blog/read‘
虽然都是路由到同一个地址,但是前者采用的是301重定向的方式路由跳转,这种方式的好处是URL可以比较随意(包括可以在URL里面传入更多的非标准格式的参数),而后者只是支持模块和操作地址。
举个例子,如果我们希望 avatar/123 重定向到 /member/avatar/id/123_small 的话,只能使用:
‘avatar/:id‘=>‘/member/avatar/id/:1_small‘
路由地址采用重定向地址的话,如果要引用动态变量,也是采用 :1、:2 的方式。
采用重定向到外部地址通常对网站改版后的URL迁移过程非常有用,例如:
‘blog/:id‘=>‘http://blog.thinkphp.cn/read/:1‘
表示当前网站(可能是http://thinkphp.cn)的 blog/123 地址会直接重定向到 http://blog.thinkphp.cn/read/123。
默认情况下,外部地址的重定向采用301重定向,如果希望采用其它的,可以使用:
‘blog/:id‘=>array(‘http://blog.thinkphp.cn/read/:1‘,302);
在路由跳转的时候支持额外传入参数对(额外参数指的是不在URL里面的参数,隐式传入需要的操作中,有时候能够起到一定的安全防护作用,后面我们会提到),支持 额外参数1=值1&额外参数2=值2 或者 array(‘额外参数1‘=>‘值1‘,‘额外参数2‘=>‘值2‘...) 这样的写法,可以参考不同的定义方式选择。例如:
‘blog/:id‘=>‘blog/read?status=1&app_id=5‘, ‘blog/:id‘=>array(‘blog/read?status=1&app_id=5‘), ‘blog/:id‘=>array(‘blog/read‘,‘status=1&app_id=5‘), ‘blog/:id‘=>array(‘blog/read‘,array(‘status‘=>1,‘app_id‘=>5)),
上面的路由规则定义中额外参数的传值方式都是等效的。status和app_id参数都是URL里面不存在的,属于隐式传值,当然并不一定需要用到,只是在需要的时候可以使用。
路由参数
当路由地址采用数组方式定义的时候,还可以传入额外的路由参数。这些参数的作用是限制前面定义的路由规则的生效条件。
限制URL后缀
‘blog/:id‘=>array(‘blog/read‘,‘status=1&app_id=5‘,array(‘ext‘=>‘html‘)),
限制请求类型
‘blog/:id‘=>array(‘blog/read‘,‘status=1&app_id=5‘,array(‘method‘=>‘get‘)),
自定义检测
‘blog/:id‘=>array(‘blog/read‘,‘status=1&app_id=5‘,array(‘callback‘=>‘checkFun‘)),
自定义checkFun函数来检测是否生效,如果函数返回false则表示不生效。
规则路由
规则路由是一种比较容易理解的路由定义方式,采用ThinkPHP设计的规则表达式来定义。
规则表达式
规则表达式通常包含静态地址和动态地址,或者两种地址的结合,例如下面都属于有效的规则表达式:
‘my‘ => ‘Member/myinfo‘, // 静态地址路由 ‘blog/:id‘ => ‘Blog/read‘, // 静态地址和动态地址结合 ‘new/:year/:month/:day‘=>‘News/read‘, // 静态地址和动态地址结合 ‘:user/:blog_id‘ =>‘Blog/read‘,// 全动态地址
规则表达式的定义始终以“/”为参数分割符,不受URL_PATHINFO_DEPR设置的影响
每个参数中以“:”开头的参数都表示动态参数,并且会自动对应一个GET参数,例如:id表示该处匹配到的参数可以使用$_GET[‘id‘]方式获取,:year、 :month 、:day 则分别对应$_GET[‘year‘]、 $_GET[‘month‘] 和 $_GET[‘day‘]。
数字约束
支持对变量的类型检测,但仅仅支持数字类型的约束定义,例如
‘blog/:id\d‘=>‘Blog/read‘,
表示只会匹配数字参数,如果你需要更加多的变量类型检测,请使用正则表达式定义来解决。
函数支持
可以支持对路由变量的函数过滤,例如:
‘blog/:id\d|md5‘=>‘Blog/read‘,
表示对匹配到的id变量进行md5处理,也就是说,实际传入read操作方法的$_GET[‘id‘] 其实是 md5($_GET[‘id‘])。
注意:不支持对变量使用多次函数处理和函数额外参数传入。
可选定义
支持对路由参数的可选定义,例如:
‘blog/:year\d/[:month\d]‘=>‘Blog/archive‘,
[:month\d]变量用[ ]包含起来后就表示该变量是路由匹配的可选变量。
以上定义路由规则后,下面的URL访问地址都可以被正确的路由匹配:
http://serverName/index.php/Home/blog/2013 http://serverName/index.php/Home/blog/2013/12
采用可选变量定义后,之前需要定义两个或者多个路由规则才能处理的情况可以合并为一个路由规则。
可选参数只能放到路由规则的最后,如果在中间使用了可选参数的话,后面的变量都会变成可选参数。
规则排除
非数字变量支持简单的排除功能,主要是起到避免解析混淆的作用,例如:
‘news/:cate^add|edit|delete‘=>‘News/category‘
3.2.2版本开始,为了避免和函数规则冲突,规则路由排除分隔符改为“-”,所以上面的路由定义需要改为: ‘news/:cate^add-edit-delete‘=>‘News/category‘
因为规则定义的局限性,恰巧我们的路由规则里面的news和实际的news模块是相同的命名,而:cate并不能自动区分当前URL里面的动态参数是实际的操作名还是路由变量,所以为了避免混淆,我们需要对路由变量cate进行一些排除以帮助我们进行更精确的路由匹配,格式^add|edit|delete 表示,匹配除了add edit 和delete之外的所有字符串,我们建议更好的方式还是改进你的路由规则,避免路由规则和模块同名的情况存在,例如
‘new/:cate‘=>‘News/category‘
完全匹配
规则匹配检测的时候只是对URL从头开始匹配,只要URL地址包含了定义的路由规则就会匹配成功,如果希望完全匹配,可以使用$符号,例如:
‘new/:cate$‘=> ‘News/category‘
http://serverName/index.php/Home/new/info 会匹配成功,而 http://serverName/index.php/Home/new/info/2 则不会匹配成功。
如果是采用以下方式定义的话,则两种方式的URL访问都可以匹配成功。
‘new/:cate‘=> ‘News/category‘
完全匹配的路由规则中如果使用可选参数的话将会无效。
正则路由
正则路由也就是采用正则表达式定义路由的一种方式,依靠强大的正则表达式,能够定义更灵活的路由规则。
路由表达式支持的正则定义必须以“/”开头,否则就视为规则表达式。也就是说如果采用以下方式定义的正则表达式不会被支持,而会被认为是规则表达式进行解析,从而无法正确匹配。
‘#^blog\/(\d+)$#‘ => ‘Blog/read/id/:1‘
下面是一种正确的正则路由定义:
‘/^new\/(\d{4})\/(\d{2})$/‘ => ‘News/achive?year=:1&month=:2‘,
对于正则表达式中的每个变量(即正则规则中的子模式)部分,如果需要在后面的路由地址中引用,可以采用:1、:2这样的方式,序号就是子模式的序号。
正则定义也支持函数过滤处理,例如:
‘/^new\/(\d{4})\/(\d{2})$/‘ => ‘News/achive?year=:1|format_year&month=:2‘,
其中 year=:1|format_year 就表示对匹配到的变量进行format_year函数处理(假设format_year是一个用户自定义函数)。
静态路由