详解PHP的Yii框架的运行机制及其路由功能_php技巧
每一次 Yii 应用开始处理 HTTP 请求时,它都会进行一个近似的流程。
- 用户提交指向 入口脚本 web/index.php 的请求。
- 入口脚本会加载 配置数组 并创建一个 应用 实例用于处理该请求。
- 应用会通过 request(请求) 应用组件解析被请求的 路由。
- 应用创建一个 controller(控制器) 实例具体处理请求。
- 控制器会创建一个 action(动作) 实例并为该动作执行相关的 Filters(访问过滤器)。
- 如果任何一个过滤器验证失败,该动作会被取消。
- 如果全部的过滤器都通过,该动作就会被执行。
- 动作会加载一个数据模型,一般是从数据库中加载。
- 动作会渲染一个 View(视图),并为其提供所需的数据模型。
- 渲染得到的结果会返回给 response(响应) 应用组件。
- 响应组件会把渲染结果发回给用户的浏览器。
下面的示意图展示了应用是如何处理一个请求的。
启动引导(Bootstrapping)
启动引导是指:在应用开始解析并处理新接受请求之前,一个预先准备环境的过程。启动引导会在两个地方具体进行:入口脚本(Entry Script) 和 应用主体(application)。
在入口脚本里,需注册各个类库的类文件自动加载器(Class Autoloader,简称自动加载器)。这主要包括通过其 autoload.php 文件加载的 Composer 自动加载器,以及通过 Yii 类加载的 Yii 自动加载器。之后,入口脚本会加载应用的 配置(configuration) 并创建一个 应用主体 的实例。
在应用主体的构造函数中,会执行以下引导工作:
- 调用 yii\base\Application::preInit()(预初始化)方法,配置一些高优先级的应用属性,比如 yii\base\Application::basePath 属性。
- 注册yii\base\Application::errorHandler。
- 通过给定的应用配置初始化应用的各属性。
- 通过调用 yii\base\Application::init()(初始化)方法,它会顺次调用 yii\base\Application::bootstrap() 从而运行引导组件。
- 加载扩展清单文件(extension manifest file) vendor/yiisoft/extensions.php。
- 创建并运行各个扩展声明的 引导组件(bootstrap components)。
- 创建并运行各个 应用组件 以及在应用的 Bootstrap 属性中声明的各个 模块(modules)组件(如果有)。
因为引导工作必须在处理每一次请求之前都进行一遍,因此让该过程尽可能轻量化就异常重要,请尽可能地优化这一步骤。
请尽量不要注册太多引导组件。只有他需要在 HTTP 请求处理的全部生命周期中都作用时才需要使用它。举一个用到它的范例:一个模块需要注册额外的 URL 解析规则,就应该把它列在应用的 bootstrap 属性之中,这样该 URL 解析规则才能在解析请求之前生效。(译注:换言之,为了性能需要,除了 URL 解析等少量操作之外,绝大多数组件都应该按需加载,而不是都放在引导过程中。)
在生产环境中,可以开启字节码缓存,比如 APC,来进一步最小化加载和解析 PHP 文件所需的时间。
一些大型应用都包含有非常复杂的应用配置,它们会被分割到许多更小的配置文件中。此时,可以考虑将整个配置数组缓存起来,并在入口脚本创建应用实例之前直接从缓存中加载。
yii的入口文件
这里使用了一个第三方的配置管理插件:marcovwout,来管理Yii的配置,细节我就不说了。剩下的就是就是一些基本的全局变量设置了。往Yii::createWebApplication里面传入配置的数组,然后调用run方法,一个web应用是不是就这么跑起来了,是的,抽象到最高层就是这样:我往一个容器里面传入对应的配置,然后这个应用可以基于该配置正常运行起来。
说YiiBase中的两个比较重要的方法 (import,autoload)
这里使用了一个第三方的配置管理插件:marcovwout,来管理Yii的配置,细节我就不说了。剩下的就是就是一些基本的全局变量设置了。往Yii::createWebApplication里面传入配置的数组,然后调用run方法,一个web应用是不是就这么跑起来了,是的,抽象到最高层就是这样:我往一个容器里面传入对应的配置,然后这个应用可以基于该配置正常运行起来。
路由
当入口脚本在调用 yii\web\Application::run() 方法时,它进行的第一个操作就是解析输入的请求,然后实例化对应的控制器操作处理这个请求。该过程就被称为引导路由(routing)。(译注:中文里既是动词也是名词)
解析路由
路由引导的第一步,是把传入请求解析为一个路由。如我们在 控制器(Controllers) 章节中所描述的那样,路由是一个用于定位控制器操作的地址。这个过程通过 request 应用组件的 yii\web\Request::resolve() 方法实现,该方法会调用 URL 管理器 进行实质上的请求解析工作。
默认情况下,传入请求会包含一个名为 r 的 GET 参数,它的值即被视为路由。但是如果启用 yii\web\UrlManager::enablePrettyUrl,那么在确定请求的路由时,就会进行更多处理。具体的细节请参考 URL 的解析与生成 章节。
假使某路由最终实在无法被确定,那么 request 组件会抛出 yii\web\NotFoundHttpException 异常(译注:大名鼎鼎的 404)。
缺省路由
如果传入请求并没有提供一个具体的路由,(一般这种情况多为于对首页的请求)此时就会启用由 yii\web\Application::defaultRoute 属性所指定的缺省路由。该属性的默认值为 site/index,它指向 site 控制器的 index 操作。你可以像这样在应用配置中调整该属性的值:
return [ // ... 'defaultRoute' => 'main/index', ];
catchAll 路由(全拦截路由)
有时候,你会想要将你的 Web 应用临时调整到维护模式,所有的请求下都会显示相同的信息页。当然,要实现这一点有很多种方法。这里面最简单快捷的方法就是在应用配置中设置下 yii\web\Application::catchAll 属性:
return [ // ... 'catchAll' => ['site/offline'], ];
catchAll 属性需要传入一个数组做参数,该数组的第一个元素为路由,剩下的元素会(以名值对的形式)指定绑定于该操作的各个参数。
当设置了 catchAll 属性时,它会替换掉所有从输入的请求中解析出来的路由。如果是上文的这种设置,用于处理所有传入请求的操作都会是相同的 site/offline。
创建操作
一旦请求路由被确定了,紧接着的步骤就是创建一个“操作(action)”对象,用以响应该路由。
路由可以用里面的斜杠分割成多个组成片段,举个栗子,site/index 可以分解为 site 和 index 两部分。每个片段都是指向某一模块(Module)、控制器(Controller)或操作(action)的 ID。
从路由的首个片段开始,应用会经过以下流程依次创建模块(如果有),控制器,以及操作:
- 设置应用主体为当前模块。
- 检查当前模块的 yii\base\Module::controllerMap 是否包含当前 ID。如果是,会根据该表中的配置创建一个控制器对象,然后跳到步骤五执行该路由的后续片段。
- 检查该 ID 是否指向当前模块中 yii\base\Module::modules 属性里的模块列表中的一个模块。如果是,会根据该模块表中的配置创建一个模块对象,然后会以新创建的模块为环境,跳回步骤二解析下一段路由。
- 将该 ID 视为控制器 ID,并创建控制器对象。用下个步骤解析路由里剩下的片段。
- 控制器会在他的 yii\base\Controller::actions()里搜索当前 ID。如果找得到,它会根据该映射表中的配置创建一个操作对象;反之,控制器则会尝试创建一个与该 ID 相对应,由某个 action 方法所定义的行内操作(inline action)。
在上面的步骤里,如果有任何错误发生,都会抛出 yii\web\NotFoundHttpException,指出路由引导的过程失败了。