[后端]定制CodeIgniter-自定义控制器与错误处理

前言

使用现有的codeigniter还不能很好地满足我们业务的需求，比如在做一个API服务器的时候，一些权限验证，格式输出的事情都比较难完成，如果都单独写在各个controller里的话就显得冗余不可维护。所以我们要对Codeigniter进行一些特殊的定制。

自定义控制器

原本的CI_controller是所有controller的父类，其功能是简单的。我们还希望对于controller以及每个调用的函数都做一些统一的工作，比如权限验证、输入验证、输出格式等等。所以我们有必要自己再封装一层controller的基类。具体描述如下：

• override _remap($method, $params)
  这个函数在每个controller成员函数被调用前都会被调用，参数$method表示当前被调用的函数，$params表示传递的参数。我们可以对这个在这个函数里面做一些目标函数被调用时候的预处理，接着调用call_user_func_array来执行真正的函数，并得到结果。

• override __destruct()
  这个解构函数中，我们可以做一些做一些输出格式化的工作。CI中的$this->output类是框架带有的输出类，我们controller控制过程中的load->view其实都是被这个类给缓存下来了，只有当调用$this->output->_display()后才会真正传输到浏览器中（默认的，_display()会自动在output析构的时候调用）。我们可以在__destruct中对输出进行一些定制，比如对call_user_func_array的输出封装一些格式化的东西。

• 步骤

• step1 在application/config/config.php中，配置修改$config['subclass_prefix']一行代码，开启对API_自定义类的自动加载。

$config['subclass_prefix'] = 'API_';

• step2 新建application/core/API_Controller并编辑成如下内容。函数内部的内容是自定义的，这里只是举个返回json的例子。

class API_Controller extends CI_Controller {
     function __construct()
     {
         parent::__construct();
         $this->result = array();
     }

     function _remap($method, $params = array()){
         $methodResult = call_user_func_array(array($this, $method), array());
         $this->result['result'] = $methodResult;
         return $methodResult;
     }

     function __destruct(){
         $this->result['msg'] = 'success';
         $this->output->set_content_type('json'); 
         $this->output->set_output(json_encode($this->result));
         $this->output->_display();
     }
}

• step3 修改自己的业务controller继承这个API_Controller即可。

自定义错误处理

服务端经常发生程序在业务上遇到逻辑错误的情况，比如余额不足无法购买，没有登录这样的错误处理信息。处理错误返回在原来也是一个比较麻烦的事情，要写一大堆判断和返回错误码来告诉客户端相对应错误。为了解决这个错误处理的问题，我们用异常来解决这件事情。我们向框架统一注册一个底层的异常处理程序，这样在业务处理错误的时候，任何地方都可以threw一个异常。底层异常处理程序捕获异常之后，根据异常取出相关的信息，统一处理或者封装之后返回给客户端，就解决了这个令人头疼的错误处理。

• _exception_handler
  原来框架有定义了错误处理，在system\core\CodeIgniter.php中有如下的描述。

   set_error_handler('_error_handler');
   set_exception_handler('_exception_handler');
   register_shutdown_function('_shutdown_handler');

分别表示发送运行错误的时候用_error_handler函数来处理，发生未捕获的异常的时候用_exception_handler来处理，showdown的时候用_shutdown_handler处理。这三个函数都在system\core\Common.php被定义。

理论上我们修改Common.php中这三个函数的内容就行了。但是原则上我们不应该去修改system目录下的文件。所以我们换一种方式，只要抢先声明_exception_handler就可以override这个异常处理了，其他几个函数要定制的话也是同理。

我们发现applicaiton下有个constants.php的文件是在Common.php的文件前被引入的，所以自然地我们在constants.php中做一些手脚。

• 步骤
  step1 新建文件application\core\exception\exception_handler.php，编辑如下

 log_exception('error', 'Exception: '.$exception->getMessage(), $exception->getFile(), $exception->getLine());

       // Should we display the error?
       if(true){
           $statusCode = method_exists($exception, 'getStatusCode')?$exception->getStatusCode():500;
           set_status_header($statusCode);
           !class_exists('CI_Controller') OR $ci = get_instance();
           $ci->result['err'] = $statusCode;
       }

       exit(1); // EXIT_ERROR
   }
}

step2 在application\config\constants.php文件末尾添加上

 require_once (APPPATH.'core/exception/exception_handler.php');

这样就完成了复写_exception_handler的工作。一些基础的自定义Exception类也可以放在application\core\exception\目录下