如何从已存在的数据库中生成实体

当开始使用一个新的项目，使用一个数据库时，自然会出现两个不同的情况。在大多数情况下，数据库模型的设计和建立从零开始。然而，有时，你可能会开始就使用一个已存在并且可能不会改变的数据库模式。幸运的是，Doctrine自带很多工具来帮助你从已存在的数据库中生成模型类。

正如Doctrine工具文档所说，逆向工程去开始一个项目是一次性过程。Doctrine基于字段，索引和外键约束可以转换约70-80%的必备映射信息。Doctrine不能发现逆关联、继承类型、用外键作为主键的实体，以及针对“关联”的语义化操作比如级联和lifecycle事件。当“已经生成的实体”满足了你的DOMain model（域模型）特定需求之后，对其展开一些额外的工作仍然是必需的。

本教程假设您使用的是一个简单的博客应用程序，有以下两个表: blog_post 和blog_comment。由于外键约束的原因，评论记录与文章记录相关联。

CREATE TABLE `blog_post` (
  `id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  `title` VARCHAR(100) COLLATE utf8_unicode_ci NOT NULL,
  `content` longtext COLLATE utf8_unicode_ci NOT NULL,
  `created_at` datetime NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=innodb AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
 
CREATE TABLE `blog_comment` (
  `id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  `post_id` BIGINT(20) NOT NULL,
  `author` VARCHAR(20) COLLATE utf8_unicode_ci NOT NULL,
  `content` longtext COLLATE utf8_unicode_ci NOT NULL,
  `created_at` datetime NOT NULL,
  PRIMARY KEY (`id`),
  KEY `blog_comment_post_id_idx` (`post_id`),
  CONSTRAINT `blog_post_id` FOREIGN KEY (`post_id`) REFERENCES `blog_post` (`id`) ON DELETE CASCADE
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

在深入本教程之前，确保你的数据库连接参数在 app/config/parameters.yml 文件（或者不管你的数据库配置保存在哪里）中已经设置好了，并确保你已经初始化了一个即将承载你未来实体类的Bundle。在这个教程中，假设有一个AcmeBlogBundle存在，并保存在src/Acme/BlogBundle文件夹中。

从已存在的数据库中创建实体类的第一步：是让 Doctrine 自检数据库并生成相应的元数据文件。元数据文件描述了基于表的字段来生成的实体类。

$ php bin/console doctrine:mapping:import --force AcmeBlogBundle xml

这个命令行工具要求Doctrine去自检这个数据库并生成XML元数据文件到你bundle的src/Acme/BlogBundle/Resources/config/doctrine文件夹下。命名使它生成了两个文件：BlogPost.orm.xml 和 BlogComment.orm.xml。

你也可以通过修改最后的参数为yml，来生成 YAML 格式的元数据文件。

生成的BlogPost.orm.xml元数据文件如下:

<?xml version="1.0" encoding="utf-8"?>
<doctrine-mapping xmlns="Http://doctrine-project.org/schemas/orm/doctrine-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
  <entity name="Acme\BlogBundle\Entity\BlogPost" table="blog_post">
    <id name="id" type="bigint" column="id">
      <generator strategy="IDENTITY"/>
    </id>
    <field name="title" type="string" column="title" length="100" nullable="false"/>
    <field name="content" type="text" column="content" nullable="false"/>
    <field name="createdAt" type="datetime" column="created_at" nullable="false"/>
  </entity>
</doctrine-mapping>

一旦元数据文件被生成，你可以执行下面的两个命令，要求Doctrine去构建相关的实体类。

$ php bin/console doctrine:mapping:convert annotation ./src
$ php bin/console doctrine:generate:entities AcmeBlogBundle

第一个命令生成注释映射的实体类。但如果你想要使用YAML和XML映射来替代注释，你应该只执行第二个命令。

如果你想使用注释，在运行了这两个命令后，一定要删除 XML（或 YAML）文件。这是必须的，因为这些映射配置的格式不能相容。

例如,新创建的BlogComment实体类看起来如下所示:

// src/Acme/BlogBundle/Entity/BlogComment.php
namespace Acme\BlogBundle\Entity;
 
use Doctrine\ORM\Mapping as ORM;
 
/**
 * Acme\BlogBundle\Entity\BlogComment
 *
 * @ORM\Table(name="blog_comment")
 * @ORM\Entity
 */
class BlogComment
{
    /**
     * @var integer $id
     *
     * @ORM\Column(name="id", type="bigint")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     */
    private $id;
 
    /**
     * @var string $author
     *
     * @ORM\Column(name="author", type="string", length=100, nullable=false)
     */
    private $author;
 
    /**
     * @var text $content
     *
     * @ORM\Column(name="content", type="text", nullable=false)
     */
    private $content;
 
    /**
     * @var datetime $createdAt
     *
     * @ORM\Column(name="created_at", type="datetime", nullable=false)
     */
    private $createdAt;
 
    /**
     * @var BlogPost
     *
     * @ORM\ManyToOne(targetEntity="BlogPost")
     * @ORM\JoinColumn(name="post_id", referencedColumnName="id")
     */
    private $post;
}

正如你所看到的，Doctrine把所有表的字段转化为纯私有的类属性并添加了注释。最令人印象深刻的是，基于外键约束的关系它发现了BlogPost实体类。因此，你可以在BlogComment实体类中找到一个私有的$post属性，它映射一个BlogPost实体。

如果你想有一个one-to-many（一对多）的映射关系，您将需要手动将其添加到实体或生成的XML或YAML文件中。要在指定的实体中加一小段，对于one-to-many来说就需要定义inversedBy 和 mappedBy 。

现在可以使用生成的实体啦。祝你玩的开心！

Symfony中文手册

如何从已存在的数据库中生成实体