Magento模块开发之数据库SQL操作方法说明

今天主要来看Magento中的Mysql4/Resource(资源) 如何对数据库进行操作， 来执行更为复杂的 sql 语句。 在Magento中Model 通常都会继承 Mage_Core_Model_Abstract， 而这个 Abstract 又继承了Varien_Object， 在 Abstract 类中包含许多常用的方法，例如: getId(), load(), save(), delete() 等等…而 Mysql4/Resource Model 则继承 Mage_Core_Model_Mysql4_Abstract， 而这个 Abstract 又继承了 Mage_Core_Model_Resource_Abstract

SQL 和 Mysql4 Resource 文件

Mysql4/Resource(资源) 文件， 用来和数据库中的表打交道，执行各类的数据库查询，在下面我会展示如何在 Resource(资源) 文件中进行 SQL 语句操作。

SELECT 操作

在这里，我就用 Test 模块中的 Mysql4/Resource 文件来举例。

PATH:  Excellence/Test/Model/Mysql4/Test.php
 
class Excellence_Test_Model_Mysql4_Test 
        extends Mage_Core_Model_Mysql4_Abstract
{
    public function _construct()
    {   
        $this->_init('test/test', 'test_id');
    }
     
    public function loadByField($field, $value)
    {
        $table  = $this->getMainTable();
        $where  = $this->_getReadAdapter()->quoteInto("$field = ?", $value);
        $select = $this->_getReadAdapter()
                       ->select()
                       ->from($table, array('test_id'))
                       ->where($where);
        $item   = $this->_getReadAdapter()->fetchOne($sql);
        return $item;
    }
}

这是我们的 Model 文件， Excellence/Test/Model/Test.php

class Excellence_Test_Model_Test 
            extends Mage_Core_Model_Abstract
{
    public function _construct()
    {
        parent::_construct();
        $this->_init('test/test');
    }
     
    public function loadByField($field, $value)
    {
        $id = $this->getResource()
                   ->loadByField($field, $value);
        $this->load($id);
    }
}

我们一个一个的来了解，首先，我们用到了这个方法

$id = $this->getResource()
           ->loadByField($field, $value);

这个方法 $this->getResource() 会返回出一个资源(Resource)模型类, 这样我们就可以很方便的在资源模型类里调用 loadyByField($field, $value)

getTable() 方法

在我们的 Mysql4 文件里，方法 loadByField() 调用了 $table = $this->getMainTable(); 这个方法会返回出当前 Model 所对应的表名。 这个方法定义在其父类中， 如果你想进行连表查询或想获得另外一个表， 你可以这样操作:

$table = $this->getTable(‘newsletter/subscribe’);

 _getReadAdapter() 方法

现在我们来看下这句: $where = $this->_getReadAdapter()->quoteInto(“$field = ?”, $value); 第一个方法是 $this->_getReadAdapter()， 该方法返回出一个对象，其包含许多方法可以用来执行数据库操作 在 Read 适配器(Adapter)里， 我们可以用到以下方法:

#1、 fetchAll()  
//单次 select 查询 - 以多维数组形式返回出数据表中的所有数据
//例: 'select * from `table_name`'， 用该方法来获取所有数据
 
#2、 fetchRow()
//单次 select 查询 - 返回数据表中的一行数据
//例: "select * from `table` where `id` = ’1′"， 用该方法来获取单条数据
 
#3、 fetchCol()
//单次 select 查询 - 返回数据表中的一列数据
//例: "select `name` from `table`"， 用该方法来获取单条数据
 
#4、 fetchOne()
//单次 select 查询 - 返回数据表中单一的值
//例: "select count(*) from `table`"， 我们就会用到该方法来获取单条数据
  $result = $this->_getReadAdapter()->fetchOne(
                'SELECT `user` FROM `table` WHERE `user` = :greatman',
                array('greatman' => 'shawn')
  );
  echo "$result";

在 Read 适配器中还有很多其他方法，可以仔细去了解下

quoteInto($text, $value) 方法

另一个常用的就是 quoteInto()， 这个方法就是用来创建我们的 WHERE 语句， 在执行该方法时，真正的值会把问号替换掉，语法书写格式如下:

//"user_id = 3″
$this->_getReadAdapter()
     ->quoteInto("user_id = ?", 3);
 
//"field in (1,2,3)"
$this->_getReadAdapter()
     ->quoteInto("$field IN(?)", array(1,2,3));
      
//如果含有多个 WHERE 的时候
$this->_getReadAdapter()->quoteInto("$field = ? AND ", $value)
     .
     $this->_getReadAdapter()->quoteInto("$field1 = ? OR ", $value1)
     .
     $this->_getReadAdapter()->quoteInto("$field2 = ?", $value2);

我们继续来说 loadByField() 方法， 接下来着重要说的就是:

$select = $this->_getReadAdapter()
               ->select()
               ->from($table, array('test_id'))
               ->where($where);

我们通过调用 select() 方法来获得到 select 对象，同时创建 select 查询， 然后它继续调用了 from() 方法

from($name, $cols = ‘*’, $schema = null) 方法

from() 这个方法带有多个参数，如果你只想执行 “select * from ” 语句， 你可以只填写第一个参数 from($table) 如果你想选择一列 test_id, 那么第二个参数就有用了， 同样的，如果想选择多列， 方法如下:

//单列 "select `test_id` from $table"
from($table, array('test_id'));
 
//多列 "select `test_id`, `col1`, `col2` from $table"
from($table, array('test_id', 'col1', 'col2'));
 
//多列带AS "select `test_id` as id, `col1` as column1 from $table"
from($table,array('id'=>'test_id', 'column1'=>'col1'));

还有，如果你想要输出自己刚写的 sql 语句，可以直接输出句柄

echo $select;

 select 对象

select() 方法返回出一个 select 对象，该对象为我们提供了很多方法来执行 sql 语句， 其父类便是 Varien_Db_Select， 你可以在其类中找到更多的方法来更深一步的操作， 现在我们来看一个简单的php代码

public function getAll()
{
    $table  = $this->getMainTable();
    $where  = $this->_getReadAdapter()
                   ->quoteInto("id = ?", 123);
                    
    $select = $this->_getReadAdapter()
                   ->select()
                   ->from($table)
                   ->columns(array('test_id'))
                   ->where($where)
                   ->limit(10,5)
                   ->order('created_time')
                   ->group('list_id')
                   ->having('list_id > ?', 10);    
    echo $select;
}

从上你可以看出，这些方法都是来自于 select 对象， 并且都返回出自己所在的对象，这样的操作可以便于我们把多个方法串在一起。 现在让我们来逐个温习：

#1、 select()
//用来初始化 sql 语句操作， 返回出一个 select 对象， 基于这个对象，我们可以做更多的操作
 
#2、 from($name, $cols = '*', $schema = null)
//用来选择数据表的名字， 此时 select 已经初始化完成
 
#3、 columns($cols = '*', $correlationName = null)
//通过这个方法你可以指定列名
 
#4、 where($cond, $value = null, $type = null)
//用来声明 where 语句
 
#5、 limit($count = null, $offset = null)
//第一个参数代表想要返回多少条数据， 第二个参数代表 offset 偏移量
//在上面代码中就是: LIMIT 10 OFFSET 5, 而不是 LIMIT 10,5
 
#6、 order($spec)
//用来排序你所得的结果， 默认是: ascending
//如果想要是 descending， 可以写成 order(array('created_time' => Zend_Db_Select::SQL_DESC))
 
#7、 group($spec)
//相当于 group by 语句
 
#8、 having($cond, $value = null, $type = null)
//用来对 group by 语句的一个补充

 Joins 方法

public function joinUs()
{
    $table  = $this->getMainTable();
    $table2 = $this->getTable('customer/entity');
    $cond   = $this->_getReadAdapter()
                   ->quoteInto('t1.id = t2.customer_id','');
    $where  = $this->_getReadAdapter()
                   ->quoteInto('t1.list_id = ?', '123');
                    
    $select = $this->_getReadAdapter()
                   ->select()
                   ->from(array('t1'=>$table))
                   ->join(array('t2'=>$table2), $cond)
                   ->where($where);
    echo $select . "<br>";
     
    $select = $this->_getReadAdapter()
                   ->select()
                   ->from(array('t1'=>$table))
                   ->joinLeft(array('t2'=>$table2), $cond)
                   ->where($where);
    echo $select . "<br>";
     
    $select = $this->_getReadAdapter()
                   ->select()
                   ->from(array('t1'=>$table))
                   ->joinRight(array('t2'=>$table2), $cond)
                   ->where($where);
    echo $select . "<br>";
}

这是我输出所得的结果：

SELECT `t1`.*, `t2`.* FROM `szh` AS `t1` 
INNER JOIN `customer_entity` AS `t2` 
ON t1.id = t2.customer_id 
WHERE (t1.list_id = '123')
 
SELECT `t1`.*, `t2`.* FROM `szh` AS `t1` 
LEFT JOIN `customer_entity` AS `t2` 
ON t1.id = t2.customer_id 
WHERE (t1.list_id = '123')
 
SELECT `t1`.*, `t2`.* FROM `szh` AS `t1` 
RIGHT JOIN `customer_entity` AS `t2` 
ON t1.id = t2.customer_id 
WHERE (t1.list_id = '123')

相信如何使用 Joins 已经十分清晰了， 如果你想使用 joinCross, joinFull, joinNatural 等， 你可以自己动手仔细的看下 Varien_Db_Select 类。

COUNT,MAX 方法

继续来看一个简单的方法

public function countUs()
{
    $table  = $this->getMainTable();
    $where  = $this->_getReadAdapter()
                   ->quoteInto("id = ?", 123);
                    
    $select = $this->_getReadAdapter()
                   ->select()
                   ->from($table)
                   ->reset('columns')
                   ->columns(new Zend_Db_Expr('count(*)'));
    echo $select . '<br>';
     
    $select = $this->_getReadAdapter()
                   ->select()
                   ->from($table)
                   ->reset('columns')
                   ->columns(new Zend_Db_Expr('max(list_id)'));
    echo $select . '<br>';
}

所得的结果:

SELECT count(*) FROM `szh`
SELECT max("list_id") FROM `szh`

这里可以看出， 包括平均值等， 我们都可以采用 Zend_Db_Expr 类。

query() 方法

如果你有一个十分复杂的 sql 语句， 你也可以直接使用 query() 方法来执行

$sql = '...复杂的 sql 语句...';
$this->_getReadAdapter()->query($sql);

 UPDATE 和 DELETE 方法

public function updateUs()
{
    $table = $this->getMainTable();
    $where = $this->_getWriteAdapter()
                  ->quoteInto('id = ?', 1);
                   
    $query = $this->_getWriteAdapter()
                  ->update($table, 
                           array('product_id' => 2, 'file_id' => 3),
                           $where
                    );
}

这里你可以看出如何来执行 Update(更新) 语句：

UPDATE `szh` SET `product_id` = 2, `file_id` = 3 WHERE (id = 1)

至于 Delete(删除) 语句， 如下:

$this->_getWriteAdapter()
     ->delete($table, $where)
     ->limit(1);

P.S 你可以在其他文件，如: model, phtml等获得到 Read Adapter(适配器)， 但为了更好的体现出你代码的规整性及效率， 建议在 Resource 文件里执行这些 sql 语句

原文: http://blog.wangjunfeng.com/archives/569

本文:  Magento模块开发之数据库SQL操作方法说明