0

0

TypeScript中实现类型属性只读化的通用映射类型

DDD

DDD

发布时间:2025-08-24 17:24:01

|

411人浏览过

|

来源于php中文网

原创

TypeScript中实现类型属性只读化的通用映射类型

本文介绍如何在TypeScript中创建一个通用的映射类型Modify<T>,用于将任何给定类型T的所有属性转换为只读(readonly)。通过利用TypeScript的映射类型机制,我们可以轻松地为现有类型强制执行不变性约束,从而提高代码的健壮性和可维护性。

理解只读属性的需求

typescript开发中,确保数据在初始化后不被意外修改是提高代码可靠性的重要实践。readonly修饰符是实现这一目标的核心工具。当我们将readonly应用于对象属性时,typescript编译器会阻止对该属性的任何后续赋值操作。

例如,当我们使用as const断言来声明一个对象字面量时,TypeScript会自动推断出该对象的所有属性都是只读的,并且其值类型会被推断为最窄的字面量类型:

const config = {
  port: 8080,
  host: 'localhost'
} as const;

// typeof config 的结果是:
// { readonly port: 8080; readonly host: 'localhost'; }

// 尝试修改只读属性会导致编译错误:
// config.port = 3000; // Error: Cannot assign to 'port' because it is a read-only property.

然而,在许多情况下,我们可能需要对一个已经存在的类型(例如,通过接口、类型别名或Record定义的类型)应用这种只读特性,而不是仅仅针对字面量。我们希望能够编写一个通用的类型,将任何给定类型的所有属性都标记为只读。

构建通用的只读映射类型

TypeScript的映射类型(Mapped Types)提供了一种强大的能力,允许我们基于现有类型来创建新类型,并对新类型的每个属性进行转换。我们可以利用这一特性来创建一个泛型类型,为输入类型T的所有属性添加readonly修饰符。

以下是实现这一功能的Modify类型定义:

type Modify<T> = {
  readonly [K in keyof T]: T[K];
};

让我们详细解析这个类型定义:

Imagine By Magic Studio
Imagine By Magic Studio

AI图片生成器,用文字制作图片

下载
  • [K in keyof T]: 这是映射类型的核心语法。
    • keyof T:这个操作符用于获取类型T的所有公共属性名(键)的联合类型。例如,如果T是{ name: string; age: number; },那么keyof T的结果就是联合类型'name' | 'age'。
    • K in ...:表示我们将迭代keyof T中获取到的每一个键K,并为新类型创建相应的属性。
  • readonly: 这是TypeScript提供的属性修饰符。它确保在新类型中,由K表示的每个属性都将是只读的,一旦初始化赋值后便不能再被修改。
  • T[K]: 这部分指定了新类型中属性K的值类型。它将与原始类型T中属性K的值类型保持一致。这意味着Modify类型只会添加readonly修饰符,而不会改变属性的原始数据类型。

示例应用

现在,我们通过一个具体的例子来演示如何使用这个Modify类型。假设我们有一个基础类型MyType,它是一个Record<string, string>,表示一个键值对都是字符串的对象:

type MyType = Record<string, string>;
// MyType 可以表示类似 { userId: '123', userName: 'Alice' } 这样的对象。

我们可以使用Modify类型来创建一个新的类型ModifiedMyType,它将MyType的所有属性都变为只读:

type ModifiedMyType = Modify<MyType>;

// 现在,我们可以声明一个符合 ModifiedMyType 类型约束的对象
const userProfile: ModifiedMyType = {
  userId: '12345',
  userName: 'John Doe'
};

// 尝试修改 userProfile 的属性将导致编译错误:
// userProfile.userId = '67890'; // Error: Cannot assign to 'userId' because it is a read-only property.

需要强调的是,虽然ModifiedMyType成功地将userId和userName属性标记为只读,但它们的类型仍然是string,而不是字面量类型(如'12345')。这是因为Modify<T>的设计目标是添加readonly修饰符,同时保留原始的属性类型T[K]。如果需要推断字面量类型,通常需要结合as const或更复杂的类型推断机制。然而,对于仅需添加readonly修饰符的场景,Modify<T>提供了一个简洁而有效的解决方案。

注意事项与扩展

  1. 与 as const 的区别
    • as const 是一个运行时断言,主要用于对象字面量,它会递归地将对象的所有属性及其嵌套属性变为只读,并将所有值类型推断为最窄的字面量类型。
    • Modify<T> 是一种编译时类型转换,它只在当前层级为属性添加 readonly 修饰符,并且保留原始的属性值类型。它不会自动递归处理嵌套对象(除非嵌套类型本身也被Modify处理)。
  2. 应用场景
    • 配置对象:当应用程序的配置在加载后不应被修改时,可以使用Modify<ConfigType>来强制其不可变性。
    • 状态管理:在某些状态管理模式(如Redux、Vuex)中,为了确保状态的不可变性,可以对状态类型应用Modify。
    • API响应数据:如果从API获取的数据在客户端不应被修改,可以将其类型包装在Modify中,以防止意外的数据篡改。
  3. 其他映射类型修饰符:映射类型的功能远不止添加readonly。你还可以:
    • 移除只读属性:使用-readonly。例如,type Writable<T> = { -readonly [K in keyof T]: T[K]; };
    • 添加/移除可选属性:使用?或-?。例如,type Partial<T> = { [K in keyof T]?: T[K]; };(TypeScript内置的Partial就是这样实现的)。
    • 重映射键名:通过模板字面量类型(Template Literal Types)和as子句来改变属性名。

总结

通过本文,我们深入学习了如何利用TypeScript的映射类型机制,创建一个通用的Modify<T>类型。这个类型能够高效地为任何给定类型的所有属性添加readonly修饰符,从而在编译时强制实现对象的不可变性。理解Modify<T>与as const之间的关键区别,能帮助开发者更准确地选择适合特定场景的类型策略,从而编写出更加健壮、可维护的TypeScript代码。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

194

2026.02.25

数据类型有哪几种
数据类型有哪几种

数据类型有整型、浮点型、字符型、字符串型、布尔型、数组、结构体和枚举等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

338

2023.10.31

php数据类型
php数据类型

本专题整合了php数据类型相关内容,阅读专题下面的文章了解更多详细内容。

225

2025.10.31

c语言 数据类型
c语言 数据类型

本专题整合了c语言数据类型相关内容,阅读专题下面的文章了解更多详细内容。

138

2026.02.12

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1030

2023.08.02

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

562

2023.09.20

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 9.5万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.6万人学习

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

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