Symfony Doctrine自定义类型Type的开发方法

千敏吖_3843

千敏吖_3843

2026-05-19

654人浏览

原创

自定义Doctrine Type必须实现getSQLType()和convertToPHPValue(),否则schema更新时报“Unknown column type”;需通过Column注解传参而非实例状态,加密Type须在convertToPHPValue()中抛出ConversionException。

symfony doctrine自定义类型type的开发方法

Doctrine自定义Type必须实现getSQLType()和convertToPHPValue()

Doctrine不接受只重写convertToDatabaseValue()的类——它会在schema更新或数据库内省时直接报错Unknown column type。核心原因是Type注册后,Doctrine需要知道该类型映射到哪一种底层SQL类型(如varchar、text、json),才能生成正确的DDL语句。

常见错误现象:执行php bin/console doctrine:schema:update --dump-sql时抛出Unknown column type "encrypted_string",即使你已在config/packages/doctrine.yaml里声明了type映射。

  • getSQLType()必须返回一个Doctrine内置SQL类型字符串,例如'string'、'text'、'json'(Symfony 5.3+原生支持)
  • convertToPHPValue()和convertToDatabaseValue()负责双向转换逻辑,但不能缺失任一方向
  • 若需支持数据库函数(如JSON_EXTRACT),还需实现convertToDatabaseValueSQL()和convertToPHPValueSQL()

注册自定义Type时,doctrine.dbal.types配置仅在首次加载生效

你在config/packages/doctrine.yaml中写的types映射,只在容器编译期被读取一次。如果之后想动态修改Type实例状态(比如设置密钥、IV),不能靠$type->setKey()——因为每次数据库操作都可能拿到全新实例。

典型踩坑场景:在Kernel::boot()里调用Type::getType('my_type')->setKey(...),第二次请求就失效,甚至引发并发问题。

  • 正确做法是把运行时参数通过Column注解传入:@ORM\Column(type="encrypted_string", options={"cipher": "AES-256-CBC", "key": "env:APP_ENCRYPTION_KEY"})
  • 然后在Type类的__construct()或getMappedDatabaseTypes()中解析$platform->getDatabasePlatform()->getDoctrineTypeMapping('my_type')获取options
  • 避免在Type实例上保存状态;所有配置应从$column->getCustomSchemaOptions()或环境变量中按需提取

使用convertToDatabaseValueSQL()拼接SQL函数时,字段名不可硬编码

当你想让Doctrine在INSERT/UPDATE时自动调用数据库函数(如MD5(CONCAT(email, username))),不能在convertToDatabaseValueSQL()里写死列名。因为这个方法接收的是SQL表达式字符串(如?或t0_.email),不是PHP实体属性值。

Symfony Linux版
Symfony Linux版

Symfony Linux版整理 Symfony CLI 5.17.1 官方下载入口和 Symfony 框架安装配置说明。

下载

错误示例:return 'MD5(CONCAT(' . $sqlExpr . ', username))';——这里的username是未知列,且无法跨表引用。

  • 正确方式是依赖Doctrine的AbstractPlatform提供上下文:$platform->getConcatExpression($sqlExpr, 'username')
  • 若需关联另一列,应在DQL或Repository层处理,而不是在Type里尝试跨字段计算
  • 对MSSQL等平台,注意函数语法差异:[dbo].[myfunc]($sqlExpr, 'username')需确保username是合法标识符或参数占位符

加密类Type务必区分convertToPHPValue()与convertToDatabaseValue()的异常边界

加密型Type(如EncryptedStringType)最容易在解密失败时静默返回null或原始密文,导致业务逻辑误判。Doctrine不会拦截这些异常,也不会回滚事务——它只关心“是否成功转成PHP值”。

真实项目中,解密失败往往意味着密钥变更、数据损坏或迁移遗漏,必须显式暴露。

  • 在convertToPHPValue()中,捕获OpenSSLException等并抛出ConversionException(来自Doctrine\DBAL\Types\ConversionException)
  • 不要用try/catch吞掉异常后返回''或$value——这会让坏数据持续写入,排查成本陡增
  • 测试时用无效密文触发解密失败,确认异常能穿透到控制器层,而非被表单或API响应忽略

最常被忽略的一点:自定义Type的requiresSQLCommentHint()返回true时,Doctrine会在生成的SQL中添加注释,但这在MySQL 8.0.19+和PostgreSQL 12+可能触发语法错误。除非你明确控制所有目标平台版本,否则默认返回false更稳妥。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

symfony

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11724

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6741

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2175

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4288

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4994

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3931

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5657

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4442

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12342

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 15.9万人学习