Doctrine 2中的代理是什么?

时间:2011-02-07 16:39:04

标签: design-patterns doctrine-orm proxy-classes

我刚刚阅读了所有Doctrine 2文档,我开始使用自己的沙箱,我理解了大部分原理,但仍有一个问题,我在文档中找不到任何完整的解释。

  1. 什么是Proxy课程?
  2. 我什么时候应该在实体上使用它们?
  3. 据我所知,代理类添加了一个层,让你可以为实体添加一些其他功能,但为什么要使用代理而不是在实体类中实现方法呢?

2 个答案:

答案 0 :(得分:159)

只要您的查询未返回创建实体所需的所有数据,就会使用代理对象。想象一下以下场景:

@Entity
class User {
     @Column protected $id;
     @Column protected $username;
     @Column protected $firstname;
     @Column protected $lastname;

     // bunch of setters/getters here
}

DQL query:

SELECT u.id, u.username FROM Entity\User u WHERE u.id = :id

如您所见,此查询不会返回firstnamelastname属性,因此您无法创建User对象。创建不完整的实体可能会导致意外错误。

这就是Doctrine将创建支持延迟加载的UserProxy对象的原因。当您尝试访问firstname属性(未加载)时,它将首先从数据库加载该值。


  

我的意思是为什么我应该使用代理?

您应该始终编写代码,就好像根本不使用代理对象一样。它们可以被视为Doctrine使用的内部对象。

  

为什么延迟加载无法在Entitiy中实现?

从技术上讲,它可能只是看看一些随机代理对象的类。它充满了脏代码,呃。在您的实体中拥有干净的代码真是太好了。

  

你能给我一个用例吗?

您正在显示最近25篇文章的列表,并且您希望显示第一篇文章的详细信息。它们中的每一个都包含大量文本,因此获取所有数据将浪费内存。这就是你没有获取不必要数据的原因。

SELECT a.title, a.createdAt
FROM Entity\Article a
ORDER BY a.createdAt DESC
LIMIT 25

$isFirst = true;
foreach ($articles as $article) {
    echo $article->getTitle();
    echo $article->getCreatedAt();

    if ($isFirst) {
        echo $article->getContent(); // Article::content is not loaded so it is transparently loaded 
                                     // for this single article.

        $isFirst = false;
    }
}

更新

在下面的评论部分中,有关代理对象和部分对象之间差异的错误信息。有关详细信息,请参阅@Kontrollfreak答案:https://stackoverflow.com/a/17787070/252591

答案 1 :(得分:76)

代理

Doctrine代理只是一个包装器,它扩展了一个实体类,为它提供了延迟加载。

默认情况下,当您向实体管理器询问与另一个实体关联的实体时,关联的实体将不会从数据库加载,而是包装到代理对象中。当您的应用程序然后请求属性或调用此代理实体的方法时,Doctrine将从数据库加载实体(除非您请求ID,代理始终知道该ID。)

由于代理扩展了您的实体类,因此对您的应用程序完全透明。

默认情况下,如果您在查询中没有JOIN它们,或者将获取模式设置为EAGER,则默认情况下会将协会水合作为延迟加载代理。


现在我必须添加这个,因为我没有足够的声誉在任何地方发表评论:

不幸的是,Crozin的答案包含错误的信息。

如果您执行像

这样的DQL查询
SELECT u.id, u.username FROM Entity\User u WHERE u.id = :id

你不会得到一个(代理的)实体对象,而是一个关联数组。因此,不可能延迟加载任何其他属性。

考虑到这一点,我们得出的结论是用例示例也不起作用。 必须将DQL更改为类似的内容才能以$article作为对象访问:

SELECT a FROM Entity\Article a ORDER BY a.createdAt DESC LIMIT 25

getContent()返回的属性必须是一个关联才能加载所有 25个实体的内容属性。


部分对象

如果要部分加载不是关联的实体属性,则必须明确告知该Doctrine:

SELECT partial u.{id, username} FROM Entity\User u WHERE u.id = :id

这为您提供了部分加载的实体对象。

但请注意,部分对象不是代理!延迟加载不适用于它们。因此,使用部分对象通常是危险的,应该避免。阅读更多:Partial Objects — Doctrine 2 ORM 2 documentation