5

多年来,我一直在一遍又一遍地(随着进化)重新实现相同的代码,却没有找到某种干净、有效的方法,将其抽象出来。

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

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

  1. 减少由不同的重新实现引入的错误的可能性
  2. 向 IDE 公开有效/无效参数选项以进行自动完成
  3. 遵循 DRY 原则

我最近的实现通常类似于以下示例。该方法采用一组条件和一组选项,并从中创建并执行一个 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 ... */
}

这个基函数的好处是:

  1. 它使我能够随着架构的发展快速支持新的条件和选项
  2. 它允许我在查询中快速实现全局条件(例如,添加一个默认为 true 的 'excludeDisabled' 选项,并过滤所有 disabled = 0 模型,除非调用者明确表示不同)。
  3. 它允许我快速创建新的、更易于使用的方法,这些方法代理回调 findPosts 方法。例如:
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 ... */
}

这种方法的主要缺点是:

  • 在每个模型访问服务中都创建了相同的整体“find[Model]s”方法,大部分情况下只有条件切换构造和基表名称发生变化。
  • 没有简单的方法来执行 AND/OR 条件操作。所有条件都明确地与。
  • 引入了许多拼写错误的机会
  • 在基于约定的 API 中引入了许多中断的机会(例如,以后的服务可能需要实现不同的语法约定来指定 orderBy 选项,这对于向后移植到所有以前的服务变得乏味)。
  • 违反 DRY 原则。
  • 有效条件和选项对 IDE 自动完成解析器隐藏,选项和条件参数需要冗长的文档块解释来跟踪允许的选项。

在过去的几天里,我试图为这个问题开发一个更面向对象的解决方案,但我觉得我正在开发一个过于复杂的解决方案,这个解决方案将过于僵化和限制使用。

我正在努力的想法类似于以下内容(当前项目将是 Doctrine2 仅供参考,所以略有改变)......

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 父类。这个父类处理初始化允许的变量和默认值,访问设置的选项,限制访问仅定义的选项,并为 DqlOptionsMapper 提供一个迭代器接口来循环选项。

不幸的是,在研究了几天之后,我对这个系统的复杂性感到沮丧。照原样,这仍然不支持条件组和 OR 条件,并且指定备用条件比较运算符的能力已经完全陷入了创建 Foo\Options\FindConditions\Comparison 类在指定 FindConditions 时环绕一个值的泥潭值 ( $conditions->setCondition('Foo', new Comparison('NOT LIKE', 'bar'));)。

如果存在的话,我宁愿使用其他人的解决方案,但我还没有遇到任何可以满足我要求的东西。

我想超越这个过程,回到实际构建我正在从事的项目,但我什至看不到结束的迹象。

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

4

1 回答 1

4

我认为你把事情复杂化了。

我已经使用 Doctrine 2 进行了一个项目,该项目有很多实体,它们的不同用途,各种服务,自定义存储库等,我发现这样的东西效果很好(无论如何对我来说)..

1. 查询存储库

首先,我通常不会在服务中进行查询。Doctrine 2 提供了 EntityRepository 和为每个实体子类化它的选项。

  • 只要有可能,我就会使用标准的 findOneBy... 和 findBy... 风格的魔法方法。这使我不必自己编写 DQL,并且开箱即用地工作得很好。
  • 如果我需要更复杂的查询逻辑,我通常会在存储库中创建特定于用例的查找器。这些是类似的UserRepository.findByNameStartsWith事情。
  • 我一般不会创造一个超级花哨的“我可以接受你给我的任何参数!” 类型的魔法探测器。如果我需要一个特定的查询,我会添加一个特定的方法。虽然这似乎需要您编写更多代码,但我认为这是一种更简单、更容易理解的做事方式。(我尝试浏览您的查找器代码,但在某些地方查找相当复杂)

所以换句话说...

  • 尝试使用学说已经给你的东西(神奇的发现者方法)
  • 如果您需要自定义查询逻辑,请使用自定义存储库类
  • 为每个查询类型创建一个方法

2.结合非实体逻辑的服务

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

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

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

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

3.实体特定逻辑的实体

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

这种情况的一个简单示例可能是,在上述场景中发送的电子邮件可能使用了某种问候语……“Hello Mr. Anderson”或“Hello Ms. Anderson”。

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

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

这种方法的好处

我发现我在这里详述的方法效果很好。它是可维护的,因为它通常对所做的事情非常“明显”,它不依赖于复杂的查询行为,并且因为事情被清楚地划分为不同的“区域”(存储库、服务、实体),所以单元测试非常简单,因为出色地。

于 2011-07-08T20:06:23.187 回答