首页
/ 在Psalm中优雅地处理对象属性与数组形状的映射

在Psalm中优雅地处理对象属性与数组形状的映射

2025-06-06 14:36:02作者:何举烈Damon

在实际开发中,我们经常遇到需要将对象属性转换为特定数组形状的需求。传统做法是通过手动维护@psalm-type注释来定义数组结构,这种方式不仅繁琐而且容易出错。Psalm提供了更优雅的解决方案。

传统方式的痛点

开发者通常需要为每个类单独定义类型别名,例如:

/**
 * @psalm-type FieldValueFileItemShape = array{
 *     filePath: string,
 *     fileName: string,
 *     mimeType: string,
 *     fileSize: int,
 *     originalFileName: string,
 *     checksum: string,
 *     isPostTmp?: bool,
 *     delete?: bool,
 *     isSymlink?: bool
 * }
 */
class FieldValueFileItem {
    // 类属性定义...
}

这种方式存在两个主要问题:

  1. 需要手动维护类型定义,当类属性变更时容易忘记更新
  2. 类型定义与类定义分离,增加了代码维护成本

Psalm的解决方案:properties-of

Psalm提供了properties-of泛型类型,可以自动将类属性映射为数组形状:

class C {
    private int $i = 1;
    private string $s = "aaa";
}

/** @param properties-of<C> $_a */
function f(array $_a): void {}

使用properties-of的优势:

  1. 自动同步:当类属性变更时,相关类型会自动更新
  2. 减少重复代码:无需手动维护类型定义
  3. 类型安全:Psalm会严格检查数组形状是否匹配类属性

实际应用场景

这种技术特别适用于:

  • DTO(数据传输对象)与数组的转换
  • API响应数据的类型定义
  • 数据库记录与领域对象的映射
  • 序列化/反序列化操作

注意事项

  1. properties-of会包含所有属性,包括私有属性
  2. 对于可选属性,需要使用?标记
  3. 继承关系中的属性也会被包含
  4. 静态属性不会被包含在结果中

通过使用properties-of,开发者可以大幅减少类型定义的工作量,同时提高代码的可维护性和类型安全性。这是Psalm类型系统中一个非常实用的特性,值得在项目中广泛应用。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
148
1.95 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
515