CodeIgniter 是个很传统的 PHP 框架,小巧玲珑,尽管与 Laravel 等新兴框架相比,缺乏优雅,但它简单、容易上手、易掌控
下面记录一下,我在用 CodeIgniter(以下简称 CI)过程中,摸索或查阅到的一些技巧
先做一些约定:
-
dirApp
表示 application 目录
一、改造 Controller 方法名,加上 Http Method 前缀
该方法为本人原创,受 YII、Laravel 等框架启发
CI 支持自定义一些类,重定义其本身的行为,创建 dirApp/core/MY_Router.php
,重写 set_method
方法,如下:
method = $verb . ucfirst($method);
}
}
改造之后,对于 Http 请求:
-
get /vendor/list
,将会执行controllers/Vendor::getList
方法 -
post /vendor/list
,将会执行controllers/Vendor::postList
方法 -
put /vendor/list
,将会执行controllers/Vendor::putList
方法 - 以此类推
而改造之前,这些方法就没有区分,都会执行 controllers/Vendor::list
方法。很不幸,list
是 php 的关键字,你还不能用 list
作为方法名
二、修复 CI Route 不能带 Url 参数的行为
该方法思路来自网络,后经本人优化,原文链接太久忘了,就不放了
假设我定义一个这样的 route
:
$route['error/(:num)'] = 'site/error/index?code=$1';
CI 竟然不支持带 Url 参数,会把整个 index?code=$1
识别为方法名,从而找不到正确的方法
为了纠正这一行为,仍然重写 dirApp/core/MY_Router.php
的 set_method
的方法,代码如下:
method = $parts[0];
}
}
代码原理很简单,就是通过 explode
将 Url 参数从 $method
分离出来,将前面的部分赋值给 $this->method
,并用 parse_str
将 Url 参数,赋值到 $_GET
一、二都是重写 set_method
,若要具备两者的功能,代码则应改为:
method = $verb . $parts[0];
}
}
三、设置应用代码目录名称
CI 默认的应用代码目录名为 application
,这个名字老长了,不喜,改为 web
,打开入口文件 index.php
,搜索 application_folder =
,并改写如下:
$application_folder = 'web';
后文用
web
目录,指代application
目录
四、给 CI 插上 Composer 的翅膀
Composer 是现代化 PHP 框架的标配,而 CI 很传统,默认没有带 Composer,也没有命名空间,这很不方便,其实加上 Composer 与命名空间也很简单
1、首先需要安装 Composer,这步不赘述,考虑到 GFW 的影响,最好按照 https://pkg.phpcomposer.com/
上的说明,设置中国镜像
2、在根目录,创建 composer.json
,写入:
{
"autoload": {
"psr-4": {
"web\\": "web/"
}
}
}
应根据需要修改
psr-4
中的内容,我这里用的是web
作为 application 的名称
3、然后在根目录执行 composer dump
4、在 index.php
末尾部分,最后一句 require_once BASEPATH.'core/CodeIgniter.php';
之前添加:
require_once 'vendor/autoload.php';
5、除了 Controller 与 core/MY_*,应用程序目录 web
里的其他文件,开头应带上 namespace
声明,例如文件 web\models\User.php
,开头这样声明:
引用该 Model 也很简单,请用 PHP 的机制,不要再用 CI 的 $this->load->model
,如下:
同样,应该废弃 CI 的 helpers
,在 web
目录下,创建 util
子目录,并用标准的 PHP 命名空间/面向对象机制规划工具类
实际上,引入 Composer 后,几乎可以废弃所有的
$this->load->xxx
加载方法,改用标准的 PHP 类加载机制
6、每次上线前,应执行一次 composer dump -o
,以便优化 Composer 的执行速度
五、为 Model 定义基类
为了继承 CI 的遗产,可以为 Model 定义一个基类,放在 web\core\BaseModel.php
里:
web\util\CI
是一个很有用的 trait,用来在 model 里方便地获取 CI 实例,这样定义的:
web\util\Db
用来方便地操纵数据库,定义如下:
load->database($name, true);
}
return self::$_ciDbCache[$name];
}
private static $_ciDbCache = [];
protected static function executeSql($sql, $data = null)
{
return self::db()->query($sql, $data);
}
}
web\util\Instance
用来提供单例模式,定义如下:
六、为 Controller 定义基类
Controller 也需要有一个共同的基类,以便定义一些公用的行为,大致代码如下(省略了一些本司商业逻辑,以免泄密 ,只讨论技术):
location = '$url'")
: header("Location:$url");
}
/**
* 跳转到错误页 xxx
*/
protected function goError($code) {
$this->redirect('/error' . $code, true);
}
/**
* 跳转到 404 页
*/
protected function go404()
{
$this->goError(404);
}
/**
* 跳转首页
*/
protected function goHome()
{
$this->redirect('xxx', true);
}
/**
* 跳转到登录页
*/
protected function goLogin()
{
$loginUrl = 'xxx';
$this->redirect($loginUrl, true);
}
/**
* 是否为 ajax 请求
*/
protected function isAjax()
{
return 'XMLHttpRequest' == @$_SERVER['HTTP_X_REQUESTED_WITH'];
}
/**
* 是否为 post 请求
*/
protected function isPost()
{
return 'POST' == @$_SERVER['REQUEST_METHOD'];
}
/**
* 当前登录的用户 ID
*/
protected $uid = 0;
/**
* 当前登录的用户实例
*/
protected $user = null;
/**
* 需要登录
*/
protected function requireLogin()
{
...
}
}
再定义一个 web\core\RequireLoginController
类,所有需要登录的页面,应继承自该类:
requireLogin();
}
}
本来,
requireLogin
方法,是放在RequireLoginController
类的,但后来,考虑到一些继承自BaseController
的某个页面,也可能需要登录
七、引入优秀 ORM 库 Eloquent
该方法是一名喜欢 Laravel 的前同事总结的
Eloquent
是非常优秀的 ORM 库,将它引入 CI 也非常简单,github 也有现成的库,但这里手写代码,也不复杂
以下示例,使用 mysql 数据库,其他请根据实际情况进行修改
1、根目录执行 composer require illuminate/database
2、创建 web/libraries/Eloquent.php
,写入代码:
'host',
'username' => 'username',
'password' => 'password',
'database' => 'database',
'dbdriver' => 'driver',
'dbprefix' => 'prefix',
'char_set' => 'charset',
'dbcollat' => 'collation',
'stricton' => 'strict',
];
foreach ($db as $k => $v) {
$t = [];
if (!isset($v['char_set']) or $v['char_set'] != 'utf8') {
$v['char_set'] = 'utf8';
}
foreach ($v as $mm => $nn) {
if (isset($ciToEloquentKeyMap[$mm])) {
$t[$ciToEloquentKeyMap[$mm]] = $nn;
} else {
$t[$mm] = $nn;
}
}
$t['driver'] = 'mysql';
$capsule->addConnection($t, $k);
}
$capsule->bootEloquent();
3、打开 index.php
,在 require_once 'vendor/autoload.php';
与 require_once BASEPATH.'core/CodeIgniter.php';
之间,插入:
require_once 'web/libraries/Eloquent.php';
4、定义一个基类 web\core\EloquentModel
:
更多用法,请参考 Eloquent
官方文档
整篇完。欢迎转载,转载请注明出处:
作者:lip2up
微信公众号:前端大牛