yii CDbCriteria类的compare方法的使用

Yii的Active Recorder包装了很多。

特别是把SQL中把where,order,limit,IN/not IN,like等常用短句都包含进CDbCriteria这个类中去，这样整个代码会比较规范，一目了然。

 $criteria =newCDbCriteria; 
   $criteria->addCondition("id=1"); //查询条件，即where id =1  
   $criteria->addInCondition('id', array(1,2,3,4,5));//代表where id IN (1,23,,4,5,);  
   $criteria->addNotInCondition('id',array(1,2,3,4,5));//与上面正好相法，是NOT IN  
   $criteria->addCondition('id=1','OR');//这是OR条件，多个条件的时候，该条件是OR而非AND 
   $criteria->addSearchCondition('name','分类');//搜索条件，其实代表了。。where name like '%分类%'  
   $criteria->addBetweenCondition('id', 1, 4);//between1 and 4   
     
   $criteria->compare('id',1);   //这个方法比较特殊，他会根据你的参数自动处理成addCondition或者addInCondition， 
                                   //即如果第二个参数是数组就会调用addInCondition  
    
   $criteria->addCondition("id = :id"); 
   $criteria->params[':id']=1;  
    
   $criteria->select = 'id,parentid,name';//代表了要查询的字段，默认select='*';  
   $criteria->join = 'xxx'; //连接表 
   $criteria->with = 'xxx';//调用relations   
   $criteria->limit =10;   //取1条数据，如果小于0，则不作处理  
   $criteria->offset =1;   //两条合并起来，则表示 limit 10 offset1,或者代表了。limit 1,10  
   $criteria->order = 'xxx DESC,XXX ASC' ;//排序条件 
   $criteria->group = 'group 条件'; 
   $criteria->having = 'having 条件 '; 
   $criteria->distinct = FALSE;//是否唯一查询

一.注意慎用yii CDbCriteria类的compare方法，这里面可能会有坑。

二.场景：线上的一个报表查询，发现当选择其中的一个筛选时，查询出来的范围不对，后跟代码后发现这里有个坑。

三.由来：一般看compare方法的解释是: “这个方法比较特殊，他会根据你的参数自动处理成addCondition或者addInCondition”, 所以想着使用 $criteria->compare(‘id’,$id);的这种写法是比较好的，即能匹配整型或字符串类型的参数，也能匹配数组类型的参数，可谓一举两得，但是当$id为空数组时，该查询条件直接返回，不会作为连接的查询。

四.举例如下:

$criteria =newCDbCriteria;

$criteria->compare('name',$name);

$criteria->compare('id',$id);

$criteria->compare('date',$date);

正常情况下的，转化为对应的sql会如下: select ... from ... where name = '$name' and id = '$id' and date = '$date'...-- 或 select ... from ... where name = '$name' and id in (id1,id2...) and date = '$date'...

-- 但是当$id = array()时，打印query_log时，却会发现输出的sql是select ... from ... where name = '$name' and date = '$date'... 少了一个id的筛选查询，所以数据范围就不对了

那么，why?

五.看源码: 我们进入到CDbCriteria类，找到compare()方法

public function compare($column, $value, $partialMatch=false, $operator='AND', $escape=true){

      if(is_array($value)){

            if($value===array())return $this;

return $this->addInCondition($column,$value,$operator);

}else{

$value="$value";

if(preg_match('/^(?:/s*(<>|<=|>=|<|>|=))?(.*)$/',$value,$matches)){

$value=$matches[2];

$op=$matches[1];

}else{

$op='';

if($value==='')return $this;

if($partialMatch){

if($op==='')return $this->addSearchCondition($column,$value,$escape,$operator);

if($op==='<>')return $this->addSearchCondition($column,$value,$escape,$operator,'NOT LIKE');

}elseif($op===''){

$op='=';

$this->addCondition($column.$op.self::PARAM_PREFIX.self::$paramCount,$operator);

$this->params[self::PARAM_PREFIX.self::$paramCount++]=$value;

return $this;

}

看compare方法的3,4,5行代码，当是数组，且是空数组时，直接return了。。。真相大白..

六.总结：

知道原因后，以后在使用compare()方法作为筛选条件时，一定要注意参数的类型，如果是空数组的时候，就要加上另外的逻辑判断；

或者当参数为空数组时直接用addInCondition()来替代.

yii CDbCriteria类的compare方法的使用

猜你喜欢