Doctrine报Undefined variable: metadata错误，求原因及解决办法

我之前在用Doctrine ORM生成实体的时候也碰到过类似的问题，结合你的环境（Ubuntu 17.10、PHP 7.2、Doctrine ORM ^2.5），下面是几个最可能的原因和对应的解决办法：

1. 映射文件路径配置错误 #

Doctrine找不到你的映射文件，就会导致$metadata变量无法被正确初始化。

• 检查cli-config.php（或你的Doctrine核心配置文件）里的映射路径是否正确，确保路径指向实体映射文件所在的目录（不管是XML/YML映射文件目录，还是注解类的存放目录）。
• 举个配置示例，如果用注解驱动，代码应该类似这样：

  $config->setMetadataDriverImpl(
      $config->newDefaultAnnotationDriver(__DIR__.'/src/Entity')
  );
  

  如果是XML驱动，配置则是：

  $driver = new \Doctrine\ORM\Mapping\Driver\XmlDriver(__DIR__.'/config/mappings');
  $config->setMetadataDriverImpl($driver);
  

• 注意：Ubuntu是区分大小写的文件系统，路径的大小写一定要和实际目录/文件名完全匹配，尽量用绝对路径避免相对路径的歧义。

2. 映射文件本身存在语法/格式错误 #

如果你的XML/YML映射文件有语法问题，Doctrine解析失败后，也会无法生成$metadata变量。

• 仔细检查映射文件的格式：XML要确保标签闭合、命名空间正确；YML要注意冒号后必须加空格、缩进统一（不能混用空格和制表符）。
• 可以用Doctrine自带的命令快速验证映射文件的合法性：

  ./vendor/bin/doctrine orm:validate-schema
  

  这个命令会帮你排查映射文件的语法错误和映射逻辑问题。

3. 自定义生成脚本的变量遗漏 #

如果你不是用Doctrine自带的orm:generate-entities命令，而是自己写了生成实体的脚本，那大概率是脚本里没正确获取元数据就直接使用了$metadata变量。

• 确保脚本里先通过EntityManager获取元数据实例：

  $entityManager = EntityManager::create($dbParams, $config);
  $metadataFactory = $entityManager->getMetadataFactory();
  $metadata = $metadataFactory->getMetadataFor('Your\Entity\ClassName');
  

  只有正确获取到对应实体的元数据后，才能正常使用$metadata变量。

4. Doctrine缓存问题 #

旧的元数据缓存可能会干扰新映射文件的加载，尤其是你修改过映射内容之后。

• 执行命令清理Doctrine的元数据缓存：

  ./vendor/bin/doctrine orm:clear-cache:metadata
  

  如果Ubuntu下出现权限错误，可以尝试加sudo执行，或者确保PHP进程对缓存目录有读写权限。

5. PHP扩展或配置问题 #

PHP 7.2和Doctrine 2.5是兼容的，但某些必要扩展缺失或配置错误也可能引发这个问题。

• 确认安装了Doctrine依赖的PHP扩展：pdo、对应数据库的PDO驱动（比如pdo_mysql）、intl、mbstring。
• 检查php.ini里的memory_limit值是否足够，生成实体过程中内存不足也可能导致变量初始化失败。

内容的提问来源于stack exchange，提问作者Devin Matté