TypeScript Map 用法：Map<K, V>、get、set、has 与遍历

TypeScript 的 Map 就是 JavaScript 内置的 Map，只是键和值带上了类型：Map<string, number> 把字符串映射到数字。用 new Map<K, V>() 创建，然后使用 set、get、has 和 delete。get 返回 V | undefined，因为键可能不存在。

const ages = new Map<string, number>();

ages.set("ada", 36);
ages.set("grace", 85).set("alan", 41); // set returns the map, so calls chain

console.log(ages.get("ada"));    // 36
console.log(ages.get("linus"));  // undefined
console.log(ages.has("grace"));  // true
console.log(ages.size);          // 3

ages.delete("alan");
console.log(ages); // Map(2) { 'ada' => 36, 'grace' => 85 }

// @ts-expect-error: Argument of type 'string' is not assignable to parameter of type 'number'.
ages.set("bob", "forty");

类型参数正是 Map 在 TypeScript 中有用的原因：每次 set 都会被检查，每次 get 都返回值的类型。最后一行是编译错误（TS2345）；@ts-expect-error 让这段代码仍然可以运行。

本页讲的是 Map 集合。如果你搜索的是 array.map()，请看最后一节。

创建 Map

类型可以来自类型参数、初始条目或类型标注。初始条目是一个由 [key, value] 元组组成的数组，或者任何能产出这种元组的东西。

// 1. Type arguments, empty map
const scores = new Map<string, number[]>();

// 2. Inferred from entries: Map<string, number>
const prices = new Map([
    ["tea", 2.5],
    ["coffee", 3.2],
]);

// 3. From an object: Map<string, boolean>
const flags = new Map(Object.entries({ darkMode: true, beta: false }));

// 4. Keys and values of any type
type User = { id: number; name: string };
const lastSeen = new Map<User, Date>();
lastSeen.set({ id: 1, name: "Ada" }, new Date("2024-03-15T10:30:00Z"));

console.log(scores.size, prices.get("tea"), flags.get("beta"), lastSeen.size);

两个推断陷阱：

• 不带类型参数也不带条目的 new Map() 是 Map<any, any>，放进去和取出来的东西都不会被检查。请始终写成 new Map<K, V>()。
• 值类型不同的条目不会被推断成联合类型。new Map([["a", 1], ["b", "x"]]) 会报错 TS2769（No overload matches this call）。请写出类型：new Map<string, number | string>([...])。

get 返回 V | undefined

Map 无法保证某个键一定存在，所以 get 的类型是 V | undefined。在 strict 模式下，把值当作 V 使用之前，你必须先处理 undefined：

// This does not compile: get may return undefined.
const stock = new Map<string, number>([["apples", 3]]);

const apples: number = stock.get("apples");
console.log(apples);

index.ts(4,7): error TS2322: Type 'number | undefined' is not assignable to type 'number'.
  Type 'undefined' is not assignable to type 'number'.

修复方法，按常用程度排列：

const stock = new Map<string, number>([["apples", 3]]);

// 1. A default value with ??
const pears = stock.get("pears") ?? 0;
console.log(pears); // 0

// 2. Store the result and check it
const apples = stock.get("apples");
if (apples !== undefined) {
    console.log(apples * 2); // 6: apples is number here
}

// 3. Update a counter in one line
stock.set("apples", (stock.get("apples") ?? 0) + 1);
console.log(stock.get("apples")); // 4

// has() does not narrow a later get():
if (stock.has("apples")) {
    const n = stock.get("apples"); // still number | undefined
    console.log(n);
}

之后调用 get 时，TypeScript 并不记得 has 返回过 true。直接检查 get 的结果既更简短又安全。非空断言 stock.get("apples")! 能让错误消失，但键不存在时它不提供任何保护。

Map 的方法及其类型

遍历 Map

Map 按插入顺序遍历。对 Map 使用 for...of 会产出 [key, value] 元组，类型为 [K, V]。

const prices = new Map<string, number>([
    ["tea", 2.5],
    ["coffee", 3.2],
    ["juice", 4],
]);

for (const [item, price] of prices) {   // item: string, price: number
    console.log(`${item}: ${price.toFixed(2)}`);
}

prices.forEach((price, item) => {       // value first, then key
    console.log(item.toUpperCase(), price);
});

const items = [...prices.keys()];       // string[]
const total = [...prices.values()].reduce((a, b) => a + b, 0);
console.log(items, total);              // [ 'tea', 'coffee', 'juice' ] 9.7

// Sorted by value: sort the entries, build a new Map
const byPrice = new Map([...prices].sort((a, b) => b[1] - a[1]));
console.log([...byPrice.keys()]);       // [ 'juice', 'coffee', 'tea' ]

给已有的键赋值会更新它的值，但保留它原来在顺序中的位置。

以对象为键与计数

任何值都可以作键，包括对象和数组。键的比较方式和 === 一样：内容相同的两个对象是不同的键。Map 也是计数或分组的标准做法。

const a = { id: 1 };
const b = { id: 1 };
const visits = new Map<object, number>([[a, 5]]);
console.log(visits.get(a), visits.get(b)); // 5 undefined: b is another object

// Counting words
const words = "the cat and the hat and the bat".split(" ");
const counts = new Map<string, number>();
for (const w of words) {
    counts.set(w, (counts.get(w) ?? 0) + 1);
}
console.log(counts); // Map(5) { 'the' => 3, 'cat' => 1, 'and' => 2, 'hat' => 1, 'bat' => 1 }

// Grouping into arrays
const byLength = new Map<number, string[]>();
for (const w of new Set(words)) {
    const group = byLength.get(w.length) ?? [];
    group.push(w);
    byLength.set(w.length, group);
}
console.log(byLength); // Map(1) { 3 => [ 'the', 'cat', 'and', 'hat', 'bat' ] }

如果要按对象的内容作键，就改用从中派生的字符串或数字键，比如 user.id 或 `${x},${y}`。

Map、对象与 Record 的对比

经验法则：键本身是数据（用户 id、单词、缓存条目）并且会在运行时变化的集合，用 Map；键是固定已知的一组，或者数据要和 JSON 互相转换时，用对象类型或 Record。字典页面对比了用于字符串键查找的索引签名、Record 和 Map。

Map 与对象和 JSON 的互相转换

Map 的条目不是属性，所以 JSON.stringify 看不到它们。请借助 Object.fromEntries 和 Object.entries 转换：

const settings = new Map<string, string | number>([
    ["theme", "dark"],
    ["fontSize", 14],
]);

console.log(JSON.stringify(settings)); // {}

const obj = Object.fromEntries(settings); // { [k: string]: string | number }
const json = JSON.stringify(obj);
console.log(json); // {"theme":"dark","fontSize":14}

// And back again
const restored = new Map(Object.entries(JSON.parse(json) as Record<string, string | number>));
console.log(restored.get("theme")); // dark

JSON.parse 返回 any，所以用 as Record<...> 说明数据应当是什么样子。它不是运行时检查；在信任这个类型之前，请先校验不可信的 JSON。

array.map() 的类型

很多人搜索“typescript map”时指的是数组方法，它会转换每个元素并返回一个新数组。它的类型由回调推断，所以很少需要标注：

type User = { id: number; first: string; last: string };
const users: User[] = [
    { id: 1, first: "Ada", last: "Lovelace" },
    { id: 2, first: "Alan", last: "Turing" },
];

const names = users.map((u) => `${u.first} ${u.last}`); // string[]
const ids = users.map((u) => u.id);                     // number[]

// An explicit result type, checked against what the callback returns
type Option = { value: number; label: string };
const options = users.map((u): Option => ({ value: u.id, label: u.first }));

// With the index
const numbered = users.map((u, i) => `${i + 1}. ${u.first}`);

console.log(names, ids);
console.log(options);
console.log(numbered);

标注回调的返回类型（(u): Option => ...）是说明结果类型最清晰的方式：这样返回的对象中缺少属性或者属性名拼错，都会在回调处产生编译错误。