0

0

如何优雅地处理PHP数据结构:使用phpexperts/simple-dto提升代码质量与效率

心靈之曲

心靈之曲

发布时间:2025-09-24 10:36:03

|

990人浏览过

|

来源于php中文网

原创

可以通过一下地址学习composer学习地址

在日常的php开发中,我们常常会遇到这样的场景:从外部接口接收到一大串json数据,或者从数据库中查询出一条记录,它们通常都被解析成php数组。为了方便,我们可能直接在代码中通过 array['key'] 的方式来访问数据。起初这似乎没什么问题,但随着项目规模的扩大和业务逻辑的复杂化,这种方式的弊端就逐渐显现出来了:

  1. 可读性差:一个数组可能包含几十个键值对,如果不看文档,很难一眼看出这个数组到底代表了什么,有哪些必填字段,哪些是可选的。
  2. 缺乏类型安全:PHP数组本身不强制类型,你可能期望某个键是字符串,结果却收到了一个整数,这很容易导致运行时错误。
  3. 难以维护:如果数据结构发生变化,你需要手动修改所有用到这个数组的地方,稍有遗漏就可能引发线上问题。
  4. 数据易被篡改:数组是可变的,在代码的不同地方,数据可能会被无意中修改,导致难以追踪的bug。

为了解决这些痛点,我们通常会引入“数据传输对象”(Data Transfer Object,简称DTO)的概念。DTO是一种设计模式,它将数据封装成一个对象,提供清晰的结构和类型定义。然而,手动为每个数据结构编写DTO类,包括构造函数、属性、getter方法等,又会带来大量的样板代码。

这时,phpexperts/simple-dto 这个Composer包就如同救星一般出现了。它是一个轻量级且功能强大的DTO实现,旨在简化DTO的创建和使用,同时提供类型安全和不可变性。

phpexperts/simple-dto:让数据结构清晰可见

phpexperts/simple-dto 的核心理念是:将数组数据映射到带有明确类型定义的类属性上,并确保对象一旦创建就不可更改(Immutable)。这意味着你的数据将变得可预测,且在应用程序的不同层级传递时保持一致性。

安装与基本使用

首先,通过Composer轻松安装:

立即学习PHP免费学习笔记(深入)”;

Content at Scale
Content at Scale

SEO长内容自动化创作平台

下载
composer require phpexperts/simple-dto

接下来,我们来看看如何定义一个简单的DTO。假设我们需要处理用户的生日信息,包含姓名和生日日期:

use Carbon\Carbon;
use PHPExperts\SimpleDTO\SimpleDTO;

/**
 * @property-read string $name
 * @property-read Carbon $date
 */
class BirthdayDTO extends SimpleDTO
{
    /** @var string */
    protected $name;

    /** @var Carbon */
    protected $date;
}

// 实例化DTO
$birthdayDTO = new BirthdayDTO([
    'name' => 'John Doe',
    'date' => '1990-01-15',
]);

// 访问数据,如同访问普通对象属性
echo $birthdayDTO->name; // 输出: John Doe

// 惊艳之处:自动将日期字符串转换为 Carbon 对象
echo $birthdayDTO->date->format('Y年m月d日'); // 输出: 1990年01月15日

// 轻松转换为数组或JSON
$dataArray = $birthdayDTO->toArray();
echo json_encode($birthdayDTO, JSON_PRETTY_PRINT);

从上面的例子可以看出,phpexperts/simple-dto 带来了以下显著优势:

  1. 清晰的结构定义:通过 @property-read DocBlock 和 protected 类型属性,你可以一目了然地知道DTO包含哪些字段及其类型。
  2. 自动类型转换:对于 CarbonCarbon\Carbon 类型的属性,它会自动将日期字符串转换为 Carbon 对象,省去了手动转换的麻烦。
  3. 不可变性:一旦 BirthdayDTO 对象创建,其内部属性就不能被修改。如果需要修改数据,你必须创建一个新的DTO实例,这极大地提高了数据的可预测性和代码的健壮性。
  4. 便捷的序列化:内置 toArray()json_encode() 支持,方便将DTO转换为数组或JSON字符串。

更多高级特性

phpexperts/simple-dto 还提供了一些高级功能,以适应更复杂的场景:

  • WriteOnce Trait:有时,你可能需要在DTO创建后,在某个特定时机设置一次属性(例如,在多步骤表单中)。WriteOnce Trait 允许你将某些属性初始化为 null,然后只设置一次。
  • #[IgnoreAsDTO] Attribute (PHP 8+):如果你有一些 protected 属性不希望被DTO机制管理,可以使用此属性将其排除。
  • NestedDTOs:当你的数据结构包含其他复杂对象时,NestedDTOs 允许你轻松地嵌套DTO,构建出多层级的数据模型。例如,一个订单DTO可以包含一个客户DTO和多个商品DTO。
use PHPExperts\SimpleDTO\NestedDTO;
use PHPExperts\SimpleDTO\SimpleDTO;

/**
 * @property-read string $productName
 * @property-read int $quantity
 */
class ProductDTO extends SimpleDTO
{
    protected string $productName;
    protected int $quantity;
}

/**
 * @property-read string $orderId
 * @property-read ProductDTO[] $products
 */
class OrderDTO extends NestedDTO
{
    protected string $orderId;
    protected array $products; // 数组中的每个元素都会被自动转换为 ProductDTO
}

$order = new OrderDTO([
    'orderId' => 'ORD-2023001',
    'products' => [
        ['productName' => 'Laptop', 'quantity' => 1],
        ['productName' => 'Mouse', 'quantity' => 2],
    ]
]);

echo $order->products[0]->productName; // 输出: Laptop

总结其优势与实际应用效果

使用 phpexperts/simple-dto,你的PHP代码将变得:

  • 更易读:通过DTO的类定义,数据结构一目了然。
  • 更健壮:类型安全和不可变性减少了运行时错误和意外数据修改的风险。
  • 更易维护:数据结构变更时,只需修改DTO定义,IDE也能提供更好的重构支持。
  • 更高效:减少了手动验证和转换数据的样板代码。
  • 架构更清晰:促进了不同层级之间的数据传输规范化,提升了代码质量。

无论你是在构建API、处理表单提交,还是在应用程序的不同模块之间传递数据,phpexperts/simple-dto 都能帮助你将混乱的数组数据转化为清晰、安全、可维护的对象,让你的PHP项目开发体验更上一层楼。告别那些令人头疼的 array['undefined_key'] 错误吧,拥抱结构化和类型安全的数据传输!

相关专题

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

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

2687

2023.09.01

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

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

1662

2023.10.11

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

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

1523

2023.10.11

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

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

953

2023.10.23

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

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

1420

2023.10.23

html怎么上传
html怎么上传

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

1235

2023.11.03

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

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

1488

2023.11.09

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

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

1306

2023.11.13

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

0

2026.01.20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.4万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 6.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号