本文深入探讨了如何在typescript中创建高度类型安全的函数，该函数接收一个对象和一个键，但仅允许选择那些对应值为特定类型（例如字符串）的键。通过引入自定义工具类型`keysoftype`，文章详细解释了如何利用映射类型和条件类型来精确约束键的类型，从而在编译时捕获错误，并提升ide的代码补全体验，最终实现更健壮、更易用的api设计。
在TypeScript开发中，我们经常需要编写通用函数来处理对象及其属性。然而，有时我们希望函数只接受特定类型的属性键，例如，只允许访问值为字符串的属性，或只允许访问值为布尔值的属性。直接使用 keyof T 这样的泛型约束，虽然可以确保传入的键是对象 T 的有效属性，但它无法进一步约束这些键所对应的值的类型。这可能导致运行时错误，并且在开发过程中无法提供精确的类型提示。
考虑以下场景，我们希望创建一个 extractStringValue 函数，它从一个对象中提取一个字符串类型的值。一个直观的尝试可能如下：
function extractStringValue<T extends object, K extends keyof T>(obj: T, key: K): string {
// 错误：类型 'T[K]' 不能赋值给类型 'string'
// 因为 K 可能是任何 keyof T，所以 T[K] 可能是任何类型，不一定是 string
return obj[key];
}
const myObj = { stringKey: "hi", boolKey: false };
// 期望的用法：
const stringVal = extractStringValue(myObj, "stringKey"); // 期望通过
// const stringVal2 = extractStringValue(myObj, "boolKey"); // 期望报错在这个例子中，extractStringValue 函数的定义会立即产生一个类型错误。原因是 T[K] 的类型是 T 中所有属性值类型的联合，它可能包含 string、boolean 或其他类型。TypeScript 编译器无法保证 obj[key] 总是 string 类型，因此拒绝了赋值。更重要的是，即使我们强制转换了类型，extractStringValue(myObj, "boolKey") 在编译时也不会报错，这与我们期望的行为不符。
为了解决这个问题，我们需要一种机制来动态地生成一个类型，该类型只包含那些对应值为 string 的键。
TypeScript 的映射类型（Mapped Types）和条件类型（Conditional Types）提供了强大的能力来转换和筛选类型。我们可以定义一个通用的工具类型 KeysOfType<T, O>，它能从对象 T 中提取所有值为类型 O 的键。
首先，我们定义一个更通用的 KeysOfType 工具类型：
type KeysOfType<T, O> = Exclude<{
[P in keyof T]: T[P] extends O ? P : never
}[keyof T], undefined>;让我们分解这个复杂的类型定义：
有了 KeysOfType，我们可以轻松地定义 StringKeys<T> 类型，并将其应用于 extractStringValue 函数：
// 定义 StringKeys<T>，用于获取所有值为 string 类型的键
type StringKeys<T> = KeysOfType<T, string>;
function extractStringValue<T extends Record<K, string>, K extends StringKeys<T>>(
obj: T,
key: K,
): string {
// 现在 T[K] 明确是 string 类型，因为 K 已经被约束为 StringKeys<T>
// 并且 T 被约束为 Record<K, string>，确保了 obj[key] 必然是 string
return obj[key];
}在这个改进后的 extractStringValue 函数中：
现在，我们再次尝试之前的例子：
const myObj = { stringKey: "hi", boolKey: false, numKey: 123 };
// 正确用法：编译通过
const stringVal = extractStringValue(myObj, "stringKey");
console.log(stringVal); // 输出: hi
// 错误用法：编译时报错
// Argument of type '"boolKey"' is not assignable to parameter of type '"stringKey"'.
// Argument of type '"numKey"' is not assignable to parameter of type '"stringKey"'.
// const stringVal2 = extractStringValue(myObj, "boolKey");
// const stringVal3 = extractStringValue(myObj, "numKey"); 通过这种方式，TypeScript 编译器能够精确地识别出 boolKey 和 numKey 不是 myObj 中值为 string 的键，从而在编译阶段就报告错误。
这种方法不仅提供了强大的类型检查，还极大地提升了开发体验。当你在调用 extractStringValue 函数并输入 key 参数时，IDE（如 VS Code）的代码补全功能将只会显示那些符合 StringKeys<T> 约束的键，即 myObj 中值为 string 的键。这大大减少了开发者的心智负担，避免了因输入错误键名或选择错误类型键而导致的潜在问题。
KeysOfType 的通用性意味着你可以轻松地为其他类型创建类似的键约束。例如，如果你想提取布尔类型的值：
type BooleanKeys<T> = KeysOfType<T, boolean>;
function extractBooleanValue<T extends Record<K, boolean>, K extends BooleanKeys<T>>(
obj: T,
key: K,
): boolean {
return obj[key];
}
const myOtherObj = { isActive: true, name: "Alice", age: 30 };
const activeStatus = extractBooleanValue(myOtherObj, "isActive"); // 编译通过
console.log(activeStatus); // 输出: true
// 编译时报错：Argument of type '"name"' is not assignable to parameter of type '"isActive"'.
// const invalidBoolean = extractBooleanValue(myOtherObj, "name"); 通过巧妙地结合 TypeScript 的映射类型和条件类型，我们创建了一个强大的 KeysOfType 工具类型，它允许我们精确地约束泛型函数中键的类型，使其只接受那些对应值为特定类型的键。这种方法不仅显著增强了代码的类型安全性，在编译时捕获潜在错误，而且通过提供智能的代码补全，极大地优化了开发者的体验。掌握这些高级类型技巧，能够帮助我们构建更加健壮、可维护且易于使用的 TypeScript 应用。
以上就是TypeScript中按值类型约束对象键的技巧与实践的详细内容，更多请关注php中文网其它相关文章！
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移，垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是，许多工具可以让 Windows 保持平稳运行。
广告
收藏
收藏
收藏
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号
699
