用户
 找回密码
 入住 CI 中国社区
搜索
查看: 8572|回复: 11
收起左侧

CodeIgniter模型

[复制链接]
发表于 2013-12-6 22:21:12 | 显示全部楼层 |阅读模式
MVC中的业务逻辑放在控制器中或者模型里都是不合适的,所以这里对业务逻辑进行了分离,多出一层用来处理业务逻辑,模型就只当作数据访问层,这样子模型将会变得比较轻。CI中并未通过实体对象来传参,参数的传入和返回都由开发者控制,比较灵活。很多情况下都会以数组的方式传入或者返回。
模型的使用也比较简单,这里只提一下使用前想到的几个问题吧。
1、既然已经有了数据访问层了,那我们就应当避免在控制器或者某些类中直接通过SQL查询数据库,所有的数据库访问操作都应当经过模型获取,大多数情况下一个表名对应着一个模型类。
2、模型应当很方便的连接多个数据库,在database配置文件中有谈到多个库的配置问题,根据group_name的不同可以很方便的连接不同的库。如果有主从,还可以考虑到主从的切换使用问题。
3、模型是否还要按模块区分?在控制器中存在公用控制器分发的做法,在模型中这种思维可能不太好,但可以通过继承不同的公用模型类来实现,这些类再继承CI的MY_Model。在某些业务下根据模块来继承可能比较有用,大部分情况可以直接继承MY_Model,MY_Model主要实现数据库的初始化连接以及一些公用方法。
4、数据库提供的操作方式都是比较基础的,需要我们根据自身的需求去组装,但在我们日常操作中很多操作是类似的,如,根据主键获取信息,根据ID获取信息,根据属性获取信息等,可以对这些基础的操作在进行一次封装,更方便使用。因为如果要使用AR的方式来操作数据库,需要记住很多的方法,如我们根据用户名查询:
PHP复制代码
 
$query = $this->db->from('user')->where(array('username' => 'BobbyPeng'))->get();
return $query->row_array();
 
复制代码

如果封装后,则只需要记住一个方法即可,如:
PHP复制代码
 
public function findByAttributes($where = array())
{
    $query = $this->db->from($this->tableName())->where($where)->get();
    return $query->row_array();
}
 
 
复制代码

这样子在每个模型中添加一个tableName的方法返回表名后,再通过模型就可以很方便的使用该方法了。
5、上面的方法属于一个公用方法,我们会写在MY_Model中,但这种类似的方法会很多,我们可否将该类型的方法独立于一个文件中?因为这种方法大部分情况下是不会改的,而放在MY_Model中则表示对它的修改开放了,可能会影响到这些方法。如果说该类叫ActiveRecord类,那可以让MY_Model继承ActiveRecord类,而ActiveRecord类继承CI_Model,参考代码见后面。
很多时候类库提供给我们的方法都是比较细的,我们可以封装一下,减少使用难度。关于模型中公用方法的封装一直还在考虑中,下面给出的只是一个针对单表的简单的操作,复杂的操作就得在特定的模型中实现,还有一些公用操作或者说非AR的操作方式可以统一下,看以后是否有机会再来考虑下这个问题。
公用AR封装类,可进行常用的操作,需要赋予db属性为数据库连接对象,并在模型中设置几个方法,如主键、表名
PHP复制代码
 
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 
class ActiveRecord extends CI_Model
{
    /**
     * 保存数据
     *
     * @param array $data 需要插入的表数据
     * @return boolean 插入成功返回ID,插入失败返回false
     */

    public function save($data)
    {
        if($this->db->set($data)->insert($this->tableName())) {
            return $this->db->insert_id();
        }
        return FALSE;
    }
 
    /**
     * Replace数据
     * @param array $data
     */

    public function replace($data)
    {
        return $this->db->replace($this->tableName(), $data);
    }
 
    /**
     * 根据主键更新记录
     *
     * @param string $pk 主键值
     * @param array $attributes 更新字段
     * @param array $where 附加where条件
     * @return boolean true更新成功 false更新失败
     */

    public function updateByPk($pk, $attributes, $where = array())
    {
        $where[$this->primaryKey()] = $pk;
        return $this->updateAll($attributes, $where);
    }
 
    /**
     * 更新表记录
     *
     * @param array $attributes
     * @param array $where
     * @return bollean true更新成功 false更新失败
     */

    public function updateAll($attributes, $where = array())
    {
        return $this->db->where($where)->update($this->tableName(), $attributes);
    }
 
    /**
     * 根据主键删除数据
     *
     * @param string $pk 主键值
     * @param array $where 附加删除条件
     * @return boolean true删除成功 false删除失败
     */

    public function deleteByPk($pk, $where = array())
    {
        $where[$this->primaryKey()] = $pk;
        return $this->deleteAll($where);
    }
 
    /**
     * 删除记录
     *
     * @param array $where 删除条件
     * @param int $limit 删除行数
     * @return boolean true删除成功 false删除失败
     */

    public function deleteAll($where = array(), $limit = NULL)
    {
        return $this->db->delete($this->tableName(), $where, $limit);
    }
 
    /**
     * 根据主键检索
     *
     * @param string $pk
     * @param array $where 附加查询条件
     * @return array 返回一维数组,未找到记录则返回空数组
     */

    public function findByPk($pk, $where = array())
    {
        $where[$this->primaryKey()] = $pk;
        $query = $this->db->from($this->tableName())->where($where)->get();
        return $query->row_array();
    }
 
    /**
     * 根据属性获取一行记录
     * @param array $where
     * @return array 返回一维数组,未找到记录则返回空数组
     */

    public function findByAttributes($where = array())
    {
        $query = $this->db->from($this->tableName())->where($where)->limit(1)->get();
        return $query->row_array();
    }
 
    /**
     * 查询记录
     *
     * @param array $where 查询条件,可使用模糊查询,如array('name LIKE' => "pp%") array('stat >' => '1')
     * @param int $limit 返回记录条数
     * @param int $offset 偏移量
     * @param string|array $sort 排序, 当为数组的时候 如:array('id DESC', 'report_date ASC')可以通过第二个参数来控制是否escape
     * @return array 未找到记录返回空数组
     */

    public function findAll($where = array(), $limit = 0, $offset = 0, $sort = NULL)
    {
        $this->db->from($this->tableName())->where($where);
        if($sort !== NULL) {
            if(is_array($sort)){
                foreach($sort as $value){
                    $this->db->order_by($value, '', false);
                }
            } else {
                $this->db->order_by($sort);
            }
        }
        if($limit > 0) {
            $this->db->limit($limit, $offset);
        }
 
        $query = $this->db->get();
 
        return $query->result_array();
    }
 
    /**
     * 统计满足条件的总数
     *
     * @param array $where 统计条件
     * @return int 返回记录条数
     */

    public function count($where = array())
    {
        return $this->db->from($this->tableName())->where($where)->count_all_results();
    }
 
    /**
     * 根据SQL查询, 参数通过$param绑定
     * @param string $sql 查询语句,如SELECT * FROM some_table WHERE id = ? AND status = ? AND author = ?
     * @param array $param array(3, 'live', 'Rick')
     * @return array 未找到记录返回空数组,找到记录返回二维数组
     */

    public function query($sql, $param = array())
    {
        $query = $this->db->query($sql, $param);
        return $query->result_array();
    }
}
 
/* End of file ActiveRecord.php */
/* Location: ./application/core/database/ActiveRecord.php */
 
复制代码

MY_Model可以继承该类,这样子模型中可以直接调用上面的方法。
PHP复制代码
 
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 
require_once APPPATH.'core/database/ActiveRecord.php';
 
class MY_Model extends ActiveRecord
{
    public function __construct($group_name = '')
    {
        $this->initDb($group_name);
        parent::__construct();
    }
 
    protected function initDb($group_name = '')
    {
        $db_conn_name = $this->getDbName($group_name);
        $CI = & get_instance();
        if(isset($CI->{$db_conn_name}) && is_object($CI->{$db_conn_name})) {
            $this->db = $CI->{$db_conn_name};
        } else {
            $CI->{$db_conn_name} = $this->db = $this->load->database($group_name, TRUE);
        }
    }
}
 
/* End of file MY_Model.php */
/* Location: ./application/core/MY_Model.php */
 
复制代码

发表于 2014-7-23 10:50:37 | 显示全部楼层
zhengmz 发表于 2013-12-22 22:56
news_model使用新MY_Model的例子如下:

我擦,兄弟model里面的方法 $this->input->post()这样获取数据不太好吧?在控制器调用model方法的时候传一个数组进来不是更好?
发表于 2013-12-15 22:36:12 | 显示全部楼层
请问这里的getDbName()和tableName()是在哪里定义?
 楼主| 发表于 2013-12-15 23:31:19 | 显示全部楼层
zhengmz 发表于 2013-12-15 22:36
请问这里的getDbName()和tableName()是在哪里定义?

getDbName应该是拷贝的时候拷错了文件, 它的作用就是把group name转换为CI对象的属性名, 通常情况下是一致的。但当传入空白的时候处理下返回db, 这样子就默认的就可以通过$this->db来连接数据库。

公用方法参考YII做了几个基本的方法,觉得他们的命名参数都处理的挺好的。tableName是模型中的方法,给个这边生成的模型:

PHP复制代码
 
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 
/**
 * 用户管理;
 *
 */

class Admin_user_model Extends MY_Model
{
    /**
     * 主键
     */

    public function primaryKey()
    {
        return 'user_id';
    }
 
    /**
     * 表名称
     */

    public function tableName()
    {
        return 'admin_user';
    }
 
    /**
     * 字段
     */

    public function attributes()
    {
        return array(
            'user_id' => '用户ID',
            'username' => '用户名',
            'password' => '密码',
            'salt' => '密钥',
            'nickname' => '昵称',
            'email' => '邮箱',
            'mobile' => '手机',
            'stat' => '状态',
            'created_ts' => '创建时间',
            'last_logined_ts' => '上次登录时间',
        );
    }
}
 
/* End of file admin_user_model.php */
/* Location: ./application/models/admin_user_model.php */
 
复制代码

发表于 2013-12-16 14:26:48 | 显示全部楼层
Bobby 发表于 2013-12-15 23:31
getDbName应该是拷贝的时候拷错了文件, 它的作用就是把group name转换为CI对象的属性名, 通常情况下是 ...

好的,多谢了。
确实,CI感觉轻量级就是它没有封装更多的类或方法,而是留给开发者自己应用,所以,感觉要写的代码会多一些。
发表于 2013-12-22 22:53:54 | 显示全部楼层
根据你的代码,我直接将ActiveRecord实现在MY_Model中,如例子:

PHP复制代码
 
<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
class MY_Model extends CI_Model {
 
        /**
         * 构造函数,连接数据库
         *
         * @param string 在文件config/database.php中配置的数据库连接名
         */

        public function __construct($group_name = '')
        {
                parent::__construct();
                $this->load->database($group_name);
 
                log_message('debug', "MY_Model Class Initialized");
        }
 
        /**
         * 表名
         */

        public function table_name()
        {
                show_error('You must rewrite function table_name() at models.');
        }
 
        /**
         * 主键
         */

        public function primary_key()
        {
                show_error('You must rewrite function primary_key() at models.');
        }
 
        /**
         * 保存数据
         *
         * @param array $data 需要插入的表数据
         * @return boolean 插入成功返回ID,插入失败返回FALSE
         */

        public function save($data)
        {
                if($this->db->set($data)->insert($this->table_name())) {
                        return $this->db->insert_id();
                }
                return FALSE;
        }
 
        /**
         * Replace数据
         * @param array $data
         */

        public function replace($data)
        {
                return $this->db->replace($this->table_name(), $data);
        }
 
        /**
         * 根据主键更新记录
         *
         * @param string $pk 主键值
         * @param array $attributes 更新字段
         * @param array $where 附加where条件
         * @return boolean TRUE更新成功 FALSE更新失败
         */

        public function update_by_pk($pk, $attributes, $where = array())
        {
                $where[$this->primary_key()] = $pk;
                return $this->update_all($attributes, $where);
        }
 
        /**
         * 更新表记录
         *
         * @param array $attributes
         * @param array $where
         * @return bollean true更新成功 false更新失败
         */

        public function update_all($attributes, $where = array())
        {
                return $this->db->where($where)->update($this->table_name(), $attributes);
        }
 
        /**
         * 根据主键删除数据
         *
         * @param string $pk 主键值
         * @param array $where 附加删除条件
         * @return boolean true删除成功 false删除失败
         */

        public function delete_by_pk($pk, $where = array())
        {
                $where[$this->primary_key()] = $pk;
                return $this->delete_all($where);
        }
 
        /**
         * 删除记录
         *
         * @param array $where 删除条件
         * @param int $limit 删除行数
         * @return boolean TRUE删除成功 FALSE删除失败
         */

        public function delete_all($where = array(), $limit = NULL)
        {
                return $this->db->delete($this->table_name(), $where, $limit);
        }
 
        /**
         * 根据主键检索
         *
         * @param string $pk
         * @param array $where 附加查询条件
         * @return array 返回一维数组,未找到记录则返回空数组
         */

        public function find_by_pk($pk, $where = array())
        {
                $where[$this->primary_key()] = $pk;
                $query = $this->db->from($this->table_name())->where($where)->get();
                return $query->row_array();
        }
 
        /**
         * 根据属性获取一行记录
         * @param array $where
         * @return array 返回一维数组,未找到记录则返回空数组
         */

        public function find_by_attributes($where = array())
        {
                $query = $this->db->from($this->table_name())->where($where)->limit(1)->get();
                return $query->row_array();
        }
 
        /**
         * 查询记录
         *
         * @param array $where 查询条件,可使用模糊查询,如array('name LIKE' => "pp%") array('stat >' => '1')
         * @param int $limit 返回记录条数
         * @param int $offset 偏移量
         * @param string|array $sort 排序, 当为数组的时候 如:array('id DESC', 'report_date ASC')可以通过第二个参数来控制是否escape
         * @return array 未找到记录返回空数组
         */

        public function find_all($where = array(), $limit = 0, $offset = 0, $sort = NULL)
        {
                log_message('debug', "enter find_all function");
                $this->db->from($this->table_name())->where($where);
                log_message('debug', "set from and where");
                if($sort !== NULL) {
                        if(is_array($sort)){
                                foreach($sort as $value){
                                        $this->db->order_by($value, '', false);
                                }
                        } else {
                                $this->db->order_by($sort);
                        }
                }
                if($limit > 0) {
                        $this->db->limit($limit, $offset);
                }
 
                $query = $this->db->get();
 
                return $query->result_array();
        }
 
        /**
         * 统计满足条件的总数
         *
         * @param array $where 统计条件
         * @return int 返回记录条数
         */

        public function count($where = array())
        {
                return $this->db->from($this->table_name())->where($where)->count_all_results();
        }
 
        /**
         * 根据SQL查询, 参数通过$param绑定
         * @param string $sql 查询语句,如SELECT * FROM some_table WHERE id = ? AND status = ? AND author = ?
         * @param array $param array(3, 'live', 'Rick')
         * @return array 未找到记录返回空数组,找到记录返回二维数组
         */

        public function query($sql, $param = array())
        {
                $query = $this->db->query($sql, $param);
                return $query->result_array();
        }
}
 
/* End of file MY_Model.php */
/* Location: ./application/core/MY_Model.php */
 
复制代码





发表于 2013-12-22 22:56:19 | 显示全部楼层
news_model使用新MY_Model的例子如下:

PHP复制代码
 
<?php
 
 
class News_model extends MY_Model {
 
        public function __construct($group_name = '')
        {
                parent::__construct();
 
                log_message('debug', "News_model Class Initialized");
        }
        /**
         * 表名
         */

        public function table_name()
        {
                return "news";
        }
 
        /**
         * 主键
         */

        public function primary_key()
        {
                return "slug";
        }
 
        public function get_news($slug = FALSE)
        {
                log_message('debug', "enter get_news function");
                $where = array();
                if ($slug !== FALSE)
                {
                        $where['slug'] = $slug;
                }
               
                log_message('debug', "prepare calling find_all function");
                return find_all($where);
        }
 
        public function set_news()
        {
                $this->load->helper('url');
               
                $slug = url_title($this->input->post('title'), '_', TRUE);
 
                $data = array(
                        'title' => $this->input->post('title'),
                        'slug' => $slug,
                        'text' => $this->input->post('text')
                );
 
                return save($data);
        }
}
 
/* End of file news_model.php */
/* Location: ./application/models/news_model.php */
 
复制代码


运行get_news时,却无法调用find_all,为什么呢,能帮我看一下吗,谢谢。
 楼主| 发表于 2013-12-22 23:06:56 | 显示全部楼层
zhengmz 发表于 2013-12-22 22:56
news_model使用新MY_Model的例子如下:

你写的不是函数,是类里面的方法,需要使用this
发表于 2013-12-22 23:10:03 | 显示全部楼层
Bobby 发表于 2013-12-22 23:06
你写的不是函数,是类里面的方法,需要使用this

呵,谢谢,我也刚发现。
你觉得我直接实现MY_Model方式可行吗?
 楼主| 发表于 2013-12-22 23:14:00 | 显示全部楼层
zhengmz 发表于 2013-12-22 22:56
news_model使用新MY_Model的例子如下:

有没有想过set news 参数不是通过post获取,该怎么获取?怎么保存?
 楼主| 发表于 2013-12-22 23:18:30 | 显示全部楼层
zhengmz 发表于 2013-12-22 23:10
呵,谢谢,我也刚发现。
你觉得我直接实现MY_Model方式可行吗?

可行的 命名 格式都挺统一挺好的,独立出来就是为了方便my model再些一些公用方法,以及ar的修改不影响my model

本版积分规则