TypeScript中的索引介绍及应用你有2个对象，描述2个软件开发人员的薪酬。 ts const salary1 =

你有2个对象，描述2个软件开发人员的薪酬:

const salary1 = {
  baseSalary: 100_000,
  yearlyBonus: 20_000
};
 
const salary2 = {
  contractSalary: 110_000
};

你想实现一个函数，根据工资对象返回总的报酬。

function totalSalary(salaryObject: ???) {
  let total = 0;
  for (const name in salaryObject) {
    total += salaryObject[name];
  }
  return total;
}
totalSalary(salary1); // => 120_000
totalSalary(salary2); // => 110_000

你将如何注释totalSalary() 函数的salaryObject 参数，以接受具有字符串键和数字值的对象？

答案是使用索引签名!

让我们来看看什么是TypeScript索引签名以及什么时候需要它们。

1.为什么是索引签名

索引签名的想法是，当你只知道键和值的类型时，可以对未知结构的对象进行类型化。

索引签名适合于工资参数的情况：函数应该接受不同结构的工资对象--只要求值是数字。

让我们用一个索引签名来注解salaryObject 参数。

function totalSalary(salaryObject: { [key: string]: number }) {
  let total = 0;
  for (const name in salaryObject) {
    total += salaryObject[name];
  }
  return total;
}
 
totalSalary(salary1); // => 120_000
totalSalary(salary2); // => 110_000

{ [key: string]: number } 是索引签名，它告诉TypeScript，必须是一个以类型为键、类型为值的对象。salaryObject string number

现在，totalSalary() 同时接受salary1 和salary2 对象作为参数，因为它们是具有数字值的对象。

然而，该函数不会接受一个以字符串为值的对象，比如说，字符串。

const salary3 = {
  baseSalary: '100 thousands'
};
 
totalSalary(salary3);
Argument of type '{ baseSalary: string; }' is not assignable to parameter of type '{ [key: string]: number; }'.
  Property 'baseSalary' is incompatible with index signature.
    Type 'string' is not assignable to type 'number'.

2.索引签名的语法

索引签名的语法相当简单，看起来与属性的语法相似，但有一点不同。你只需在方括号内写出键的类型，而不是属性名称：{ [key: KeyType]: ValueType } 。

下面是几个索引签名的例子。

string 类型是键和值:

interface StringByString {
  [key: string]: string;
}
 
const heroesInBooks: StringByString = {
  'Gunslinger': 'The Dark Tower',
  'Jack Torrance': 'The Shining'
};

string 类型是键，值可以是string,number, 或boolean 。

interface Options {
  [key: string]: string | number | boolean;
  timeout: number;
}
 
const options: Options = {
  timeout: 1000,
  timeoutMessage: 'The request timed out!',
  isFileUpload: false
};

Options 接口也有一个字段timeout ，在索引签名附近也可以使用。

索引签名的键只能是一个string,number, 或symbol 。其他类型是不允许的。

interface OopsDictionary {
  [key: boolean]: string;
An index signature parameter type must be 'string', 'number', 'symbol', or a template literal type.
}

3.索引签名的注意事项

TypeScript中的索引签名有一些你应该注意的注意事项。

3.1 不存在的属性

如果你试图访问一个索引签名为{ [key: string]: string } 的对象的不存在的属性，会发生什么？

正如预期的那样，TypeScript推断该值的类型为string 。但如果你检查运行时的值--它是undefined 。

interface StringByString {
  [key: string]: string;
}
 
const object: StringByString = {};
 
const value = object['nonExistingProp'];
value; // => undefined
 
const value: string

value 根据TypeScript，变量是一个类型，然而，它的运行时值是。string undefined

索引签名只是将一个键类型映射到一个值类型，仅此而已。如果你没有使这种映射正确，值类型可能会偏离实际运行时的数据类型。

为了使键入更准确，将索引值标记为string 或undefined 。这样做，TypeScript会意识到你访问的属性可能不存在。

interface StringByString {
  [key: string]: string | undefined;
}
 
const object: StringByString = {};
 
const value = object['nonExistingProp'];
value; // => undefined
 
const value: string | undefined

string | undefined 因为属性可能会丢失

3.2 字符串和数字键

假设你有一个数字名称的字典。

interface NumbersNames {
  [key: string]: string
}
 
const names: NumbersNames = {
  '1': 'one',
  '2': 'two',
  '3': 'three',
  // etc...
};

通过字符串键访问一个值，可以如期进行。

const value1 = names['1'];
        
const value1: string

如果你试图通过一个数字1 来访问一个值，会不会出现错误？

const value2 = names[1];
        
const value2: string

不会的，一切正常!

当在属性访问器中作为键使用时，JavaScript隐含地将数字强制为字符串（names[1] 与names['1'] 相同）。TypeScript也会执行这种强制操作。

你可以认为[key: string] 和[key: string | number] 是一样的。

4.索引签名与Record<Keys, Type>对比

TypeScript有一个实用类型 Record<Keys, Type> 来注释记录，类似于索引签名。

const object1: Record<string, string> = { prop: 'Value' }; // OK
const object2: { [key: string]: string } = { prop: 'Value' }; // OK

最大的问题是...什么时候使用Record<Keys, Type> ，什么时候使用索引签名？乍一看，它们看起来很相似

正如你前面所看到的，索引签名只接受string,number 或symbol 作为钥匙类型。如果你试图在索引签名中使用，例如，字符串字面类型的联盟作为键，那将是一个错误。

interface Salary {
  [key: 'yearlySalary' | 'yearlyBonus']: number
An index signature parameter type cannot be a literal type or generic type. Consider using a mapped object type instead.
}

这种行为表明，索引签名的目的是在键方面是通用的。

但是你可以使用字符串字面的联合来描述Record<Keys, Type> 中的键。

type SpecificSalary = Record<'yearlySalary'|'yearlyBonus', number>
 
const salary1: SpecificSalary = { 
  'yearlySalary': 120_000,
  'yearlyBonus': 10_000
}; // OK

具体一点：指出对象的键

Record<Keys, Type> 是为了具体说明键的情况。

我建议使用索引签名来注释通用对象，例如，键是string 类型。但是，当你事先知道键的时候，使用Record<Keys, Type> 来注释特定的对象，例如，一个字符串字面的联盟'prop1' | 'prop2' ，用于键。

5.结论

如果你不知道你要处理的对象结构，但你知道可能的键和值类型，那么索引签名就是你需要的。

索引签名由索引名称和它在方括号中的类型组成，后面是冒号和值的类型：{ [indexName: KeyType]: ValueType } 。KeyType 可以是string ，number ，或symbol ，而ValueType 可以是任何类型。

TypeScript中的索引介绍及应用

目录