有没有办法在Typescript中将字符串解析为JSON ? 示例:在JS中,我们可以使用JSON.parse()。Typescript中有类似的函数吗?

我有一个JSON对象字符串如下:

{"name": "Bob", "error": false}

当前回答

有一个很棒的ts-json-object库

在你的情况下,你需要运行以下代码:

import {JSONObject, required} from 'ts-json-object'

class Response extends JSONObject {
    @required
    name: string;

    @required
    error: boolean;
}

let resp = new Response({"name": "Bob", "error": false});

这个库将在解析之前验证json

其他回答

类型安全JSON.parse

您可以继续使用JSON。解析,因为TypeScript是JavaScript的超集:

这意味着你可以把任何可用的JavaScript代码放到TypeScript文件中,而不用担心它到底是如何编写的。

还有一个问题:JSON。Parse返回any,这会破坏类型安全(不要使用any)。

以下是针对较强类型的三种解决方案,按复杂度升序排列:

1. 用户定义类型保护

操场上

// For example, you expect to parse a given value with `MyType` shape
type MyType = { name: string; description: string; }

// Validate this value with a custom type guard (extend to your needs)
function isMyType(o: any): o is MyType {
  return "name" in o && "description" in o
}

const json = '{ "name": "Foo", "description": "Bar" }';
const parsed = JSON.parse(json);
if (isMyType(parsed)) {
  // do something with now correctly typed object
  parsed.description
} else { 
// error handling; invalid JSON format 
}

isMyType被称为类型保护。它的优点是,您可以在true if分支中获得一个完全类型的对象。

2. 通用的JSON。解析包装

操场上

围绕JSON创建一个通用包装器。Parse,它接受一个类型保护作为输入,并返回已解析、类型化的值或错误结果:

const safeJsonParse = <T>(guard: (o: any) => o is T) => 
  (text: string): ParseResult<T> => {
    const parsed = JSON.parse(text)
    return guard(parsed) ? { parsed, hasError: false } : { hasError: true }
  }

type ParseResult<T> =
  | { parsed: T; hasError: false; error?: undefined }
  | { parsed?: undefined; hasError: true; error?: unknown }

使用的例子:

const json = '{ "name": "Foo", "description": "Bar" }';
const result = safeJsonParse(isMyType)(json) // result: ParseResult<MyType>
if (result.hasError) {
  console.log("error :/")  // further error handling here
} else {
  console.log(result.parsed.description) // result.parsed now has type `MyType`
}

safeJsonParse可以扩展为快速失败或尝试/捕获JSON。解析错误。

3.外部库

如果需要验证许多不同的值,那么手动编写类型保护函数会变得很麻烦。有一些库可以帮助完成这个任务——示例(没有全面的列表):

Io-ts:具有fp-ts对等依赖,使用函数式编程风格 Zod:力求比io-ts更加面向过程/面向对象 typescript-is:编译器API的TS转换器,需要额外的包装器,如ttypescript typescript-json-schema/ajv:根据类型创建JSON模式,并用ajv进行验证


更多的信息

运行时类型检查#1573 使用Typescript检查接口类型 TypeScript:验证外部数据

JSON。parse在TypeScript中是可用的,所以你可以直接使用它:

JSON.parse('{"name": "Bob", "error": false}') // Returns a value of type 'any'

但是,您经常希望在解析JSON对象时确保它匹配某个类型,而不是处理any类型的值。在这种情况下,您可以定义如下函数:

function parse_json<TargetType extends Object>(
  json: string,
  type_definitions: { [Key in keyof TargetType]: (raw_value: any) => TargetType[Key] }
): TargetType {
  const raw = JSON.parse(json); 
  const result: any = {};
  for (const key in type_definitions) result[key] = type_definitions[key](raw[key]);
  return result;
}

这个函数接受一个JSON字符串和一个包含加载所创建对象的每个字段的单独函数的对象。你可以这样使用它:

const value = parse_json(
  '{"name": "Bob", "error": false}',
  { name: String, error: Boolean, }
);

有一个很棒的ts-json-object库

在你的情况下,你需要运行以下代码:

import {JSONObject, required} from 'ts-json-object'

class Response extends JSONObject {
    @required
    name: string;

    @required
    error: boolean;
}

let resp = new Response({"name": "Bob", "error": false});

这个库将在解析之前验证json

嘿,如果你对json对象进行typeof,结果是typescript类型的字符串。你可以在这里阅读更多:Typescript:字符串和字符串的区别

所以试试这个方法,它会起作用的

JSON.parse(String({"name": "Bob", "error": false}))

如果你想让你的JSON有一个经过验证的Typescript类型,你需要自己做这个验证工作。这并不是什么新鲜事。在纯Javascript中,也需要这样做。

验证

我喜欢将我的验证逻辑表示为一组“转换”。我将描述符定义为转换的映射:

type Descriptor<T> = {
  [P in keyof T]: (v: any) => T[P];
};

然后我可以创建一个函数,将这些变换应用于任意输入:

function pick<T>(v: any, d: Descriptor<T>): T {
  const ret: any = {};
  for (let key in d) {
    try {
      const val = d[key](v[key]);
      if (typeof val !== "undefined") {
        ret[key] = val;
      }
    } catch (err) {
      const msg = err instanceof Error ? err.message : String(err);
      throw new Error(`could not pick ${key}: ${msg}`);
    }
  }
  return ret;
}

现在,我不仅验证我的JSON输入,而且我正在构建一个Typescript类型。上述泛型类型确保结果从“转换”推断出类型。

如果转换抛出错误(这是实现验证的方式),我喜欢用另一个错误来包装它,显示是哪个键引起了错误。

使用

在你的例子中,我会这样使用:

const value = pick(JSON.parse('{"name": "Bob", "error": false}'), {
  name: String,
  error: Boolean,
});

现在value将被类型化,因为String和Boolean都是“转换器”,它们接受输入并返回类型化输出。

而且,该值实际上就是该类型。换句话说,如果name实际上是123,它将被转换为“123”,这样您就有了一个有效的字符串。这是因为我们在运行时使用了String,这是一个接受任意输入并返回字符串的内置函数。

你可以看到它在这里工作。试试下面的方法来说服自己:

将鼠标悬停在const值定义上,查看弹出窗口显示正确的类型。 尝试将“Bob”更改为123并重新运行示例。在控制台中,您将看到名称已正确地转换为字符串“123”。