使用DRY原则帮助在服务类中创建灵活的基础“查找”方法

时间:2011-07-08 19:26:44

标签: php zend-framework doctrine-orm service-layer query-builder

多年以来,我一直在重复实现相同的代码(使用进化)而没有找到一些干净,有效,抽象出来的方法。

模式是我的服务层中的基本'find [Type] s'方法,它将选择查询创建抽象到服务中的单个点,但支持快速创建更易于使用的代理方法的能力(请参阅示例PostServivce :: getPostById()方法如下)。

不幸的是,到目前为止,我一直无法实现这些目标:

  1. 减少由不同重新实施引入的错误的可能性
  2. 将有效/无效参数选项公开给IDE以进行自动完成
  3. 遵循DRY原则
  4. 我最近的实现通常类似于以下示例。该方法采用一系列条件和一组选项,并从中创建并执行Doctrine_Query(我今天在这里大部分重写了这一点,因此可能存在一些拼写错误/语法错误,它不是直接剪切和粘贴)。

    class PostService
    {
        /* ... */
    
        /**
         * Return a set of Posts
         *
         * @param Array $conditions Optional. An array of conditions in the format
         *                          array('condition1' => 'value', ...)
         * @param Array $options    Optional. An array of options 
         * @return Array An array of post objects or false if no matches for conditions
         */
        public function getPosts($conditions = array(), $options = array()) {
            $defaultOptions =  = array(
                'orderBy' => array('date_created' => 'DESC'),
                'paginate' => true,
                'hydrate' => 'array',
                'includeAuthor' => false,
                'includeCategories' => false,
            );
    
            $q = Doctrine_Query::create()
                            ->select('p.*')
                            ->from('Posts p');
    
            foreach($conditions as $condition => $value) {
                $not = false;
                $in = is_array($value);
                $null = is_null($value);                
    
                $operator = '=';
                // This part is particularly nasty :(
                // allow for conditions operator specification like
                //   'slug LIKE' => 'foo%',
                //   'comment_count >=' => 1,
                //   'approved NOT' => null,
                //   'id NOT IN' => array(...),
                if(false !== ($spacePos = strpos($conditions, ' '))) {
                    $operator = substr($condition, $spacePost+1);
                    $conditionStr = substr($condition, 0, $spacePos);
    
                    /* ... snip validate matched condition, throw exception ... */
                    if(substr($operatorStr, 0, 4) == 'NOT ') {
                      $not = true;
                      $operatorStr = substr($operatorStr, 4);
                    }
                    if($operatorStr == 'IN') {
                        $in = true;
                    } elseif($operatorStr == 'NOT') {
                        $not = true;
                    } else {
                        /* ... snip validate matched condition, throw exception ... */
                        $operator = $operatorStr;
                    }
    
                }
    
                switch($condition) {
                    // Joined table conditions
                    case 'Author.role':
                    case 'Author.id':
                        // hard set the inclusion of the author table
                        $options['includeAuthor'] = true;
    
                        // break; intentionally omitted
                    /* ... snip other similar cases with omitted breaks ... */
                        // allow the condition to fall through to logic below
    
                    // Model specific condition fields
                    case 'id': 
                    case 'title':
                    case 'body':
                    /* ... snip various valid conditions ... */
                        if($in) {
                            if($not) {
                                $q->andWhereNotIn("p.{$condition}", $value);
                            } else {
                                $q->andWhereIn("p.{$condition}", $value);
                            }
                        } elseif ($null) {
                            $q->andWhere("p.{$condition} IS " 
                                         . ($not ? 'NOT ' : '') 
                                         . " NULL");
                        } else {
                            $q->andWhere(
                                "p.{condition} {$operator} ?" 
                                    . ($operator == 'BETWEEN' ? ' AND ?' : ''),
                                $value
                            );
                        }
                        break;
                    default:
                        throw new Exception("Unknown condition '$condition'");
                }
            }
    
            // Process options
    
            // init some later processing flags
            $includeAuthor = $includeCategories = $paginate = false;
            foreach(array_merge_recursivce($detaultOptions, $options) as $option => $value) {
                switch($option) {
                    case 'includeAuthor':
                    case 'includeCategories':
                    case 'paginate':
                    /* ... snip ... */
                        $$option = (bool)$value;
                        break;
                    case 'limit':
                    case 'offset':
                    case 'orderBy':
                        $q->$option($value);
                        break;
                    case 'hydrate':
                        /* ... set a doctrine hydration mode into $hydration */ 
                        break;
                    default:
                        throw new Exception("Invalid option '$option'");
                }
            }
    
            // Manage some flags...
            if($includeAuthor) {
                $q->leftJoin('p.Authors a')
                  ->addSelect('a.*');
            } 
    
            if($paginate) {
                /* ... wrap query in some custom Doctrine Zend_Paginator class ... */
                return $paginator;
            }
    
            return $q->execute(array(), $hydration);
        }
    
        /* ... snip ... */
    }
    

    Phewf

    这个基本功能的好处是:

    1. 它允许我在模式发展时快速支持新的条件和选项
    2. 它允许我快速实现查询的全局条件(例如,添加'excludeDisabled'选项,默认值为true,并过滤所有disabled = 0模型,除非调用者明确说明不同)。
    3. 它允许我快速创建新的,更简单的方法,将代理调用代理回到findPosts方法。例如:
    4. class PostService
      {
          /* ... snip ... */
      
          // A proxy to getPosts that limits results to 1 and returns just that element
          public function getPost($conditions = array(), $options()) {
              $conditions['id'] = $id;
              $options['limit'] = 1;
              $options['paginate'] = false;
              $results = $this->getPosts($conditions, $options);
              if(!empty($results) AND is_array($results)) {
                  return array_shift($results);
              }
              return false;
          }
      
          /* ... docblock ...*/       
          public function getPostById(int $id, $conditions = array(), $options()) {
              $conditions['id'] = $id;
              return $this->getPost($conditions, $options);
          }
      
          /* ... docblock ...*/
          public function getPostsByAuthorId(int $id, $conditions = array(), $options()) {
              $conditions['Author.id'] = $id;
              return $this->getPosts($conditions, $options);
          }
      
          /* ... snip ... */
      }
      

      此方法的 MAJOR 缺点是:

      • 在每个模型访问服务中都创建了相同的单一“find [Model] s”方法,主要只有条件切换构造和基表名称更改。
      • 没有简单的方法来执行AND / OR条件操作。所有条件都明确与之相关。
      • 介绍很多拼写错误的机会
      • 介绍了基于约定的API中断的许多机会(例如,以后的服务可能需要实现不同的语法约定来指定orderBy选项,这对于所有以前的服务都是后退的。)
      • 违反DRY原则。
      • IDE自动完成解析器隐藏有效条件和选项,选项和条件参数需要冗长的文档块说明才能跟踪允许的选项。

      在过去的几天里,我试图为这个问题开发一个更多的OO解决方案,但感觉我正在开发太复杂的解决方案,这个解决方案过于严格和限制使用。

      我正在努力的想法是下面的内容(当前的项目将是Doctrine2 fyi,因此稍有变化)......

      namespace Foo\Service;
      
      use Foo\Service\PostService\FindConditions; // extends a common \Foo\FindConditions abstract
      use Foo\FindConditions\Mapper\Dql as DqlConditionsMapper;
      
      use Foo\Service\PostService\FindOptions; // extends a common \Foo\FindOptions abstract
      use Foo\FindOptions\Mapper\Dql as DqlOptionsMapper;
      
      use \Doctrine\ORM\QueryBuilder;
      
      class PostService
      {
          /* ... snip ... */
          public function findUsers(FindConditions $conditions = null, FindOptions $options = null) {
      
              /* ... snip instantiate $q as a Doctrine\ORM\QueryBuilder ... */
      
              // Verbose
              $mapper = new DqlConditionsMapper();
              $q = $mapper
                      ->setQuery($q)
                      ->setConditions($conditions)
                      ->map();
      
              // Concise
              $optionsMapper = new DqlOptionsMapper($q);        
              $q = $optionsMapper->map($options);
      
      
              if($conditionsMapper->hasUnmappedConditions()) {
                  /* .. very specific condition handling ... */
              }
              if($optionsMapper->hasUnmappedConditions()) {
                  /* .. very specific condition handling ... */
              }
      
              if($conditions->paginate) {
                  return new Some_Doctrine2_Zend_Paginator_Adapter($q);
              } else {
                  return $q->execute();
              }
          }
      
          /* ... snip ... */
      }
      

      最后,Foo \ Service \ PostService \ FindConditions类的示例:

      namespace Foo\Service\PostService;
      
      use Foo\Options\FindConditions as FindConditionsAbstract;
      
      class FindConditions extends FindConditionsAbstract {
      
          protected $_allowedOptions = array(
              'user_id',
              'status',
              'Credentials.credential',
          );
      
          /* ... snip explicit get/sets for allowed options to provide ide autocompletion help */
      }
      

      Foo \ Options \ FindConditions和Foo \ Options \ FindOptions非常相似,所以,至少现在它们都扩展了一个常见的Foo \ Options父类。此父类处理初始化允许的变量和默认值,访问set选项,限制只访问已定义的选项,以及为DqlOptionsMapper提供迭代器接口以循环选项。

      不幸的是,经过几天的黑客攻击后,我对这个系统的复杂性感到沮丧。对于条件组和OR条件,仍然没有这方面的支持,并且指定备用条件比较运算符的能力一直是在指定FindConditions时创建Foo \ Options \ FindConditions \ Comparison类环绕值的完全困境值($conditions->setCondition('Foo', new Comparison('NOT LIKE', 'bar'));)。

      如果它存在的话,我宁愿使用其他人的解决方案,但我还没有遇到任何我正在寻找的东西。

      我想超越这个过程,回到实际构建我正在进行的项目,但我甚至看不到目标。

      所以,Stack Overflowers: - 有没有更好的方法可以提供我已经确定的好处而不包括缺点?

1 个答案:

答案 0 :(得分:4)

我认为你过于复杂了。

我使用Doctrine 2开发了一个项目,它有很多实体,它们有不同的用途,各种服务,自定义存储库等等。我发现这样的东西运行得相当好(无论如何对我来说)。

1。查询存储库

首先,我通常不会在服务中进行查询。为了这个目的,Doctrine 2提供了EntityRepository以及为每个实体创建子类的选项。

  • 尽可能使用标准的findOneBy ...和findBy ...样式魔术方法。这使我免于必须自己编写DQL并且开箱即用。
  • 如果我需要更复杂的查询逻辑,我通常会在存储库中创建用例特定的查找程序。这些是像UserRepository.findByNameStartsWith之类的东西。
  • 我一般不会创造一个超级幻想“我可以接受你给我的任何args!”魔术探测器的类型。如果我需要特定的查询,我添加一个特定的方法。虽然这似乎需要您编写更多代码,但我认为这是一种更简单易懂的操作方式。 (我尝试通过你的查找器代码,看起来相当复杂)

换句话说......

  • 尝试使用已经给你的学说(魔术探测器方法)
  • 如果需要自定义查询逻辑,请使用自定义存储库类
  • 为每种查询类型创建方法

2。用于组合非实体逻辑的服务

使用服务将“事务”组合在一个简单的界面后面,您可以在控制器中使用它,或者使用单元测试轻松测试。

例如,假设您的用户可以添加好友。每当用户与其他人交朋友时,都会向另一个人发送电子邮件通知。这是您在服务中可以拥有的。

您的服务将(例如)包含一个方法addNewFriend,该方法需要两个用户。然后,它可以使用存储库来查询某些数据,更新用户的朋友数组,并调用其他类然后发送电子邮件。

您可以在服务中使用entitymanager来获取存储库类或持久化实体。

3。特定于实体的逻辑的实体

最后,您应该尝试将特定于实体的业务逻辑直接放入实体类中。

这个案例的一个简单示例可能是上述场景中发送的电子邮件可能会使用某种问候语。“你好安德森先生”,或“你好安德森女士”。

因此,例如,您需要一些逻辑来确定适当的问候语。这是你可以在实体类中拥有的东西 - 例如,getGreeting或其他东西,然后可以考虑用户的性别和国籍,并根据它返回一些东西。 (假设性别和国籍将存储在数据库中,而不是问候本身 - 问候语将由函数的逻辑计算)

我还应该指出,实体通常知道实体管理器或存储库。如果逻辑需要其中任何一个,它可能不属于实体类本身。

这种方法的好处

我发现我在这里详述的方法效果很好。它是可维护的,因为它通常对事物的作用非常“明显”,它不依赖于复杂的查询行为,并且因为事物被清楚地分成不同的“区域”(repos,services,entity),因此单元测试非常简单。好。