[后端]定制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,编辑如下
 <?php
if(!function_exists('_exception_handler')){
   function _exception_handler($exception){
       $_error =& load_class('Exceptions', 'core');
       $_error->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\目录下

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,137评论 6 511
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,824评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,465评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,131评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,140评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,895评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,535评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,435评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,952评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,081评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,210评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,896评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,552评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,089评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,198评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,531评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,209评论 2 357

推荐阅读更多精彩内容