Question

我对TypeScript还是很陌生，所以我正在升级旧项目以使用它。

但是，当对某些数据调用Object.entries时，我不确定如何保留正确的Type。

例如：

Level.tsx：

  const UnpassableTileComponents = useMemo(() => 
    Object.entries(levelData[`level_${gameLevel}`].tiles.unpassable_tiles).map(([tileType, tiles]) => (
      tiles.map(([leftPos, topPos], index) => (
        <UnpassableTile
          key={`${tileType}_${index}`}
          leftPos={leftPos * 40}
          topPos={topPos * 40}
          tileType={tileType}
        />
      ))
    )
  ).flat(), [gameLevel])

levelData.tsx：

import levelJSON from "./levelJSON.json";

interface ILevelJSON {
  [key: string]: Level;
}

interface Level {
  tiles: Tiles;
}

interface Tiles {
  unpassable_tiles: UnpassableTiles;
}

interface UnpassableTiles {
  rock: Array<number[]>;
  tree: Array<number[]>;
}

export default levelJSON as ILevelJSON;

levelJSON.json：

{
  "level_1": {
    "tiles": {
      "unpassable_tiles": {
        "rock": [[0, 0]],
        "tree": [[2, 0]]
      }
    }
  },
  "level_2": {
    "tiles": {
      "unpassable_tiles": {
        "rock": [[]],
        "tree": [[]]
      }
    }
  }
}

在上述情况下，图块表示一个数组数组，每个数组都有两个数字。因此，[leftPos，topPos]都应键入数字。但是，在Level.tsx中，它们具有任何属性。我可以通过以下方法得到想要的结果：

  const UnpassableTileComponents = useMemo(() => 
    Object.entries(levelData[`level_${gameLevel}`].tiles.unpassable_tiles).map(([tileType, tiles]) => (
      tiles.map(([leftPos, topPos] : number[], index: number) => (
        <UnpassableTile
          key={`${tileType}_${index}`}
          leftPos={leftPos * 40}
          topPos={topPos * 40}
          tileType={tileType}
        />
      ))

但是无论如何都不应该推断数字[]？

任何建议将不胜感激。

Answer 1

这与Why doesn't Object.keys() return a keyof type in TypeScript?之类的问题有关。两种方法的答案都是TypeScript中的对象类型不是exact。对象类型的值允许具有编译器不知道的额外属性。这允许接口和类继承，这非常有用。但这会导致混乱。

例如，如果我有一个类型为nameHaver的值{name: string}，我知道它具有一个name属性，但我不知道它只是具有name属性。所以我不能说Object.entries(nameHaver)将是Array<["name", string]>：

interface NameHaver { name: string }
declare const nameHaver: NameHaver;
const entries: Array<["name", string]> = Object.entries(nameHaver); // error here: why?
entries.map(([k, v]) => v.toUpperCase());

如果nameHaver不仅具有name属性，该怎么办，例如：

interface NameHaver { name: string }
class Person implements NameHaver { constructor(public name: string, public age: number) { } }
const nameHaver: NameHaver = new Person("Alice", 35);
const entries: Array<["name", string]> = Object.entries(nameHaver); // error here: ohhh
entries.map(([k, v]) => v.toUpperCase());  // explodes at runtime!

糟糕。我们假设nameHaver的值始终是string，但其中一个是number，对toUpperCase()不会满意。假设Object.entries()产生的唯一安全的东西是Array<[string, unknown]>（尽管标准库使用Array<[string, any]>代替）。

那我们该怎么办？好吧，如果您碰巧知道并且绝对确定一个值只有编译器知道的键，那么您可以为Object.entries()编写自己的类型并使用它...而您需要非常小心点。这是一种可能的输入方式：

type Entries<T> = { [K in keyof T]: [K, T[K]] }[keyof T];
function ObjectEntries<T extends object>(t: T): Entries<T>[] {
  return Object.entries(t) as any;
}

as any是type assertion，可以抑制对Object.entries()的正常抱怨。类型Entries<T>是mapped type，我们立即look up产生已知条目的并集：

const entries = ObjectEntries(nameHaver);
// const entries: ["name", string][]

这与我之前为entries手动编写的类型相同。如果您在代码中使用ObjectEntries而不是Object.entries，它将“修复”您的问题。但是请记住，您所依赖的事实是您要迭代其条目的对象没有未知的额外属性。如果确实有人在number[]上添加了非unpassable_tiles类型的额外属性，则在运行时可能会出现问题。

好的，希望能有所帮助；祝你好运！

Playground link to code

Answer 2

@jcalz的出色答案说明了为什么您尝试做的事情如此棘手。如果您要保持基础架构和JSON相同，则他的方法可能会起作用。但我要指出的是，您可以通过不同地构造数据来回避整个问题。我认为这将使您的开发人员体验以及您的数据是什么的阐明变得更好。

您遇到的一个基本问题是，您试图将key: value对的映射视作某种无法通行的磁贴列表。但是，仅使用Object.entries来处理您无法逾越的图块类型，这是固有的笨拙和混乱。

为什么不将ImpassableTile定义为类型，而将不可逾越的图块列表定义为该类型的数组？从概念上讲，这更好地匹配了数据实际代表的内容。它还完全避开了Object.entries及其困难，并使对数据的迭代更加简单明了。

// levelData.ts
import levelJSON from "./levelJSON.json";

interface ILevelJSON {
  [key: string]: Level;
}

interface Level {
  tiles: Tiles;
}

export type UnpassableType = "rock" | "tree";

type UnpassableTile = {
  type: UnpassableType;
  position: number[];
};

interface Tiles {
  unpassable_tiles: UnpassableTile[];
}

export default levelJSON as ILevelJSON;

要正确匹配新接口，您还需要修改levelJSON.json。但是请注意，它更加干净，并且您不需要在level_2中为岩石或树木定义空数组，这些数组根本不存在：

{
  "level_1": {
    "tiles": {
      "unpassable_tiles": [
        { "type": "rock", "position": [0, 0] },
        { "type": "rock", "position": [2, 0] },
        { "type": "tree", "position": [2, 2] }
      ]
    }
  },
  "level_2": {
    "tiles": {
      "unpassable_tiles": []
    }
  }
}

现在，您可以非常轻松地在不可逾越的图块，它们的类型以及相关的位置数据上进行映射，同时保留完整的类型推断和安全性。而且它看起来更清晰易懂。

// App.tsx
const UnpassableTileComponents = React.useMemo(() => {
  return levelData[`level_1`].tiles.unpassable_tiles.map(
    ({ type, position: [leftPos, topPos] }) => (
      <UnpassableTile
        key={`level_1_${type}_${leftPos}_${topPos}`}
        leftPos={leftPos}
        topPos={topPos}
        tileType={type}
      />
    )
  );
}, []);

https://codesandbox.io/s/goofy-snyder-u9x60?file=/src/App.tsx

您可以将此哲学进一步扩展到如何构造关卡及其界面。为什么不让levelJSON是Level对象的数组，每个对象都有一个名称和一组图块？

interface Tiles {
  unpassable_tiles: UnpassableTile[];
}

interface Level {
  name: string;
  tiles: Tiles;
}

export type UnpassableType = "rock" | "tree";

type UnpassableTile = {
  type: UnpassableType;
  position: number[];
};

您的相应数据看起来会更干净：

[
  {
    "name": "level_1",
    "tiles": {
      "unpassable_tiles": [
        { "type": "rock", "position": [0, 0] },
        { "type": "rock", "position": [2, 0] },
        { "type": "tree", "position": [2, 2] }
      ]
    }
  },
  {
    "name": "level_2",
    "tiles": {
      "unpassable_tiles": []
    }
  }
]

对其进行迭代将变得更加清晰：

const level = levelData[0];

const UnpassableTileComponents = React.useMemo(() => {
  return level.tiles.unpassable_tiles.map(
    ({ type, position: [leftPos, topPos] }) => (
      <UnpassableTile
        key={`${level.name}_${type}_${leftPos}_${topPos}`}
        leftPos={leftPos}
        topPos={topPos}
        tileType={type}
      />
    )
  );
}, [level]);

https://codesandbox.io/s/hopeful-grass-dnohi?file=/src/App.tsx

使用Object.entries时保留类型

2 个答案: