yii源码分析3

转载请注明：TheViper http://www.cnblogs.com/TheViper/

上一篇说到CWebApplication中的￥route=$this->getUrlManager ()->parseUrl ($this->getRequest());,得到$route=controler/actionid。

这篇说他后面的$this->runController ( $route );

<?php
class CWebApplication extends CApplication {
    public $controllerNamespace;
    private $_controllerPath;
    private $_viewPath;
    private $_systemViewPath;
    private $_controller;
    public $controllerMap=array();
    public function processRequest() {//开始执行请求
        //获取urlManager组件，解析请求，得到controller/action这种格式的string,
        //并且将隐藏参数与请求的参数一一对应，匹配起来，写入$_REQUEST中
        $route = $this->getUrlManager ()->parseUrl ($this->getRequest());
        $this->runController ( $route );
    }
    public function getRequest() {//获取request组件
        return $this->getComponent ( 'request' );
    }
    protected function registerCoreComponents() {//注册核心组件
        parent::registerCoreComponents ();
    }
    //执行contronller
    public function runController($route) {
        if (($ca = $this->createController ( $route )) !== null) {
            list ( $controller, $actionID ) = $ca;
            $oldController = $this->_controller;
            $this->_controller = $controller;
            $controller->init ();//钩子,在执行action方法前调用，子类去实现
            $controller->run ( $actionID );//开始转入controller类中action方法的执行
            $this->_controller = $oldController;
        }
    }
    //创建controller类实例,从controller/action这种格式的string中解析出$controller, $actionID 
    public function createController($route, $owner = null) {
        if ($owner === null)
            $owner = $this;
        if (($route = trim ( $route, '/' )) === '')
            $route = $owner->defaultController;

        $route .= '/';
        while ( ($pos = strpos ( $route, '/' )) !== false ) {
            $id = substr ( $route, 0, $pos );
            if (! preg_match ( '/^w+$/', $id ))
                return null;
            $id = strtolower ( $id );
            $route = ( string ) substr ( $route, $pos + 1 );
            if (! isset ( $basePath ))             // first segment
            {
                $basePath = $owner->getControllerPath ();
                $controllerID = '';
            } else {
                $controllerID .= '/';
            }
            $className = ucfirst ( $id ) . 'Controller';
            $classFile = $basePath . DIRECTORY_SEPARATOR . $className . '.php';

            if (is_file ( $classFile )) {
                if (! class_exists ( $className, false ))
                    require ($classFile);
                if (class_exists ( $className, false ) && is_subclass_of ( $className, 'CController' )) {
                    $id [0] = strtolower ( $id [0] );
                    return array (
                            new $className ( $controllerID . $id, $owner === $this ? null : $owner ),
                            $this->parseActionParams ( $route )
                    );
                }
                return null;
            }
            $controllerID .= $id;
            $basePath .= DIRECTORY_SEPARATOR . $id;
        }
    }
    protected function parseActionParams($pathInfo) {
        if (($pos = strpos ( $pathInfo, '/' )) !== false) {
            $manager = $this->getUrlManager ();//再次获取urlManager,在上面第一次调用中已经导入。
            $manager->parsePathInfo ( ( string ) substr ( $pathInfo, $pos + 1 ) );
            $actionID = substr ( $pathInfo, 0, $pos );
            return $manager->caseSensitive ? $actionID : strtolower ( $actionID );
        } else
            return $pathInfo;
    }
    public function getControllerPath() {
        if ($this->_controllerPath !== null)
            return $this->_controllerPath;
        else
            return $this->_controllerPath = $this->getBasePath () . DIRECTORY_SEPARATOR . 'controllers';
    }
    //两个钩子,子类去实现
    public function beforeControllerAction($controller, $action) {
        return true;
    }
    public function afterControllerAction($controller, $action) {
    }
    protected function init() {
        parent::init ();
    }
}

$ca = $this->createController ( $route ))；createController的作用是将$route中的controller和action分离出来，并创建controller实例。

最后返回controller实例和actionid.

然后回到CWebApplication的runController($route),$controller->init ();在controller初始化时执行，这个需要在子类中重写，比如：

class VideoController extends CController {
    public function init() {
        $this->db = Yii::app ()->db;
    }
    public function actionBroadcast() {
        $b = $this->db->query ( "", array (1 ) );
        $this->render ( "u_broadcast", array (
        'b' => $b [0] ；
    ) );
    }
}    

这样在VideoController中便可以用$this->db调用db组件了。

$controller->run ( $actionID );转入Ccontroller.

<?php
class CController {
    protected $db;
    public $defaultAction = 'index';
    private $_id;
    private $_action;
    public function __construct($id, $module = null) {
        $this->_id = $id;
    }
    public function init() {
    }
    //过滤方法,子类重写
    public function filters() {
        return array ();
    }
    public function run($actionID) {
        //创建action实例
        if (($action = $this->createAction ( $actionID )) !== null) {
            $parent = Yii::app ();
            if ($parent->beforeControllerAction ( $this, $action )) {
                $this->runActionWithFilters ( $action, $this->filters () );
                $parent->afterControllerAction ( $this, $action );
            }
        }
    }
    public function refresh($terminate = true, $anchor = '') {
        $this->redirect ( Yii::app ()->getRequest ()->getUrl () . $anchor, $terminate );
    }
    public function redirect($url, $terminate = true, $statusCode = 302) {
        Yii::app ()->getRequest ()->redirect ( $url, $terminate, $statusCode );
    }
    //如果controller里面有filter
    public function runActionWithFilters($action, $filters) {
        if (empty ( $filters ))
            $this->runAction ( $action );
        else {
            $priorAction = $this->_action;
            $this->_action = $action;
            CFilterChain::create ( $this, $action, $filters )->run ();
            $this->_action = $priorAction;
        }
    }
    public function runAction($action) {
        $priorAction = $this->_action;
        $this->_action = $action;
        if ($this->beforeAction ( $action )) {
            if ($action->runWithParams ( $this->getActionParams () ) === false)
                $this->invalidActionParams ( $action );
            else
                $this->afterAction ( $action );
        }
        $this->_action = $priorAction;
    }
    //渲染视图
    public function render($view, $data = array()) {
        if (isset ( $data ))
            extract ( $data );
        include VIEWS_DIR . "/" . $this->_id . "/" . $view . ".php";
    }
    public function renderFile($file, $data = array()) {
        if (isset ( $data ))
            extract ( $data );
        include VIEWS_DIR . "/" . $file;
    }
    //跳转到另一个controller/action,不过浏览器的地址没有变
    public function forward($route) {
        if (strpos ( $route, '/' ) === false)
            $this->run ( $route );
        else {
            //不在同一个controller里面，重新创建
            Yii::app ()->runController ( $route );
        }
    }
    public function getActionParams() {
        return $_GET;
    }
    public function createAction($actionID) {
        if ($actionID === '')
            $actionID = $this->defaultAction;
        if (method_exists ( $this, 'action' . $actionID ) && strcasecmp ( $actionID, 's' ))
            return new CInlineAction ( $this, $actionID );
    }
    public function getAction() {
        return $this->_action;
    }
    public function setAction($value) {
        $this->_action = $value;
    }
    public function getId() {
        return $this->_id;
    }
    //两个钩子
    protected function beforeAction($action) {
        return true;
    }
    protected function afterAction($action) {
    }
}

$this->createAction ( $actionID );创建action实例.

然后是runActionWithFilters($action, $filters)；如果没有filter(),直接runAction($action)。

$action->runWithParams ( $this->getActionParams () ).$action是CInlineAction实例。

<?php
class CInlineAction extends CAction
{
    //执行该动作
    public function run()
    {
        $method='action'.$this->getId();
        $this->getController()->$method();
    }
    //执行带提供的请求的参数的动作
    public function runWithParams($params)
    {
        $methodName='action'.$this->getId();//拼接action方法
        $controller=$this->getController();
        $method=new ReflectionMethod($controller, $methodName);//反射
        if($method->getNumberOfParameters()>0)//方法参数个数>0
            return $this->runWithParamsInternal($controller, $method, $params);
        else
            return $controller->$methodName();
    }
}

CAction

<?php
abstract class CAction extends CComponent
{
    private $_id;
    private $_controller;
    public function __construct($controller,$id)
    {
        $this->_controller=$controller;
        $this->_id=$id;
    }
    public function getController()
    {
        return $this->_controller;
    }
    public function getId()
    {
        return $this->_id;
    }
    //运行带有请求参数的对象。 这个方法通过CController::runAction()内部调用
    public function runWithParams($params)
    {
        $method=new ReflectionMethod($this, 'run');
        if($method->getNumberOfParameters()>0)
            return $this->runWithParamsInternal($this, $method, $params);
        else
            return $this->run();
    }
    //执行一个带有命名参数的对象的方法
    protected function runWithParamsInternal($object, $method, $params)
    {
        $ps=array();
        foreach($method->getParameters() as $i=>$param)
        {
            $name=$param->getName();
            if(isset($params[$name]))
            {
                if($param->isArray())
                    $ps[]=is_array($params[$name]) ? $params[$name] : array($params[$name]);
                elseif(!is_array($params[$name]))
                $ps[]=$params[$name];
                else
                    return false;
            }
            elseif($param->isDefaultValueAvailable())
            $ps[]=$param->getDefaultValue();
            else
                return false;
        }
        $method->invokeArgs($object,$ps);//反射，执行
        return true;
    }
}

这两个类都很简单，就是执行controller类中的action方法。

回到上面的runActionWithFilters($action, $filters)；如果有filter(),CFilterChain::create ( $this, $action, $filters )->run ();

显然，如果有filter的话必须在执行action方法前，就设置好filter过滤器列表。

CFilterChain就是将类似于'application.filters.LoginFilter+upload_video' 这种配置解析成过滤器链。

过滤器链的每一项是一个CInlineFilter或CFilter实例。

<?php
//过滤器列表
class CFilterChain extends CList {
    public $controller;
    public $action;
    public $filterIndex = 0;
    public function __construct($controller, $action) {
        $this->controller = $controller;
        $this->action = $action;
    }
    //创建过滤器列表
    public static function create($controller, $action, $filters) {
        $chain = new CFilterChain ( $controller, $action );
        $actionID = $action->getId ();
        foreach ( $filters as $filter ) {
            if (is_string ( $filter ))             // filterName [+|- action1 action2]
            {
                if (($pos = strpos ( $filter, '+' )) !== false || ($pos = strpos ( $filter, '-' )) !== false) {
                    $matched = preg_match ( "/{$actionID}/i", substr ( $filter, $pos + 1 ) ) > 0;
                    if (($filter [$pos] === '+') === $matched)
                        $filter = CInlineFilter::create ( $controller, trim ( substr ( $filter, 0, $pos ) ) );
                } else
                    $filter = CInlineFilter::create ( $controller, $filter );
            } elseif (is_array ( $filter ))             // array('path.to.class [+|- action1, action2]','param1'=>'value1',...)
            {
                $filterClass = $filter [0];
                unset ( $filter [0] );
                //开始解析过滤器配置
                if (($pos = strpos ( $filterClass, '+' )) !== false || ($pos = strpos ( $filterClass, '-' )) !== false) {
                    preg_match ( "/{$actionID}/i", substr ( $filterClass, $pos + 1 ), $a );
                    $matched = preg_match ( "/{$actionID}/i", substr ( $filterClass, $pos + 1 ) ) > 0;
                    //如果是filterName+action，创建一个过滤器,否则忽略
                    if (($filterClass [$pos] === '+') === $matched) {
                        //解析出过滤器的类名
                        $filterClass = trim ( substr ( $filterClass, 0, $pos ) );
                    } else
                        continue;
                }
                $filter ['class'] = $filterClass;
                $filter = Yii::createComponent ( $filter );
            }
            
            if (is_object ( $filter )) {
                $filter->init ();
                $chain->add ( $filter );//list添加过滤器
            }
        }
        return $chain;
    }
    public function run() {
        if ($this->offsetExists ( $this->filterIndex )) {//过滤器列表个数不为0
            //取出过滤器实例
            $filter = $this->itemAt ( $this->filterIndex ++ );
            $filter->filter ( $this );
        } else
            $this->controller->runAction ( $this->action );
    }
}

'application.filters.LoginFilter+upload_video' 这种配置会创建CFilter实例。

<?php
class CFilter extends CComponent {
    public function filter($filterChain) {
        //前置，后置方法
        if ($this->preFilter ( $filterChain )) {
            $filterChain->run ();
            $this->postFilter ( $filterChain );
        }
    }
    //钩子
    public function init() {
    }
    protected function preFilter($filterChain) {
        return true;
    }
    protected function postFilter($filterChain) {
    }
}

然后是上面的CFilterChain::create ( $this, $action, $filters )->run ();中的run(),如果请求被解析成的action是upload_video,yii就会取出LoginFilter实例。

比如我的LoginFilter

<?php
class LoginFilter extends CFilter {
    protected function preFilter($filterChain) {
        if (! isset ( $_SESSION )) {
            session_start ();
        }
        if (isset ( $_SESSION ['user'] ))
            return true;
        else {
            setcookie ( "return", Yii::app ()->getRequest ()->getUrl (), time () + 360, '/' );
            Yii::app ()->getRequest ()->redirect ( 'http://localhost/youtube/login', true, 302 );
            return false;
        }
    }
    protected function postFilter($filterChain) {
    }
}
?>

里面就一个前置和后置，表示对于需要启用过滤器的action方法，分别在执行action方法之前和之后执行自己定义的preFilter,postFilter方法。

然后是$filterChain->run ();这里很容易出错。

其实是再次用CFilterChain里面的run(),注意到里面的$this->filterIndex++,这有点像递归.

如果过滤器要过滤对个action,就像这样去CFilter,然后$filterChain->run ();返回CFilterChain，同时$this->filterIndex++,然后继续$filterChain->run ();。。。。。。

对于我的'application.filters.LoginFilter+upload_video'，只过滤upload_video这一个action,所以当返回CFilterChain时，$this->filterIndex已经变成1了，而过滤器列表只有一个过滤器实例，所以这次就会走$this->controller->runAction ( $this->action );了，这就和没设置过滤器时走的$this->runAction ( $action );一样了。

过滤器分析完后，就是什么数据操作之类的，最后是渲染视图render()。这就太简单了，extract($data),然后在include下视图文件就可以了。

还有forward()方法，就是跳转到另一个controller/action,实质就是返回CWebApplication的runController再来一遍上面分析的过程。

最后附上，裁剪的yii http://files.cnblogs.com/TheViper/framework.zip