TypeScript Academy · 课时

经过模式验证的配置

使用模式在启动时验证配置。

第 2 / 4 课13 个步骤

经过模式验证的配置 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 2 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 4 节课。

在启动时验证配置

手动解析辅助函数确实可用,但模式可以在一个地方声明完整的结构和规则,并在启动时对其全部进行验证,在应用开始处理流量前快速失败。

快速失败的含义

快速失败意味着配置错误时进程会立即退出,并显示清晰的消息,而不是在请求期间于晦涩的代码路径中稍后崩溃。

使用 Zod 的 Schema

诸如 zod 这样的库可以让您以声明式方式描述配置。每个字段都会声明其类型和约束;验证会生成一个完整类型化的对象。

import { z } from "zod";
const EnvSchema = z.object({
  PORT: z.coerce.number().int().positive(),
  NODE_ENV: z.enum(["development", "production"]),
  DATABASE_URL: z.string().url(),
});

内置强制转换

模式可以将字符串强制转换为正确的类型。z.coerce.number() 会将 "8081" 转换为 8081,因此原始环境字符串能够安全地变成真正的数字。

// "8081" -> 8081 via z.coerce.number()

解析并快速失败

调用 parse 会验证所有内容。如果存在任何无效值,zod 就会抛出详细错误,您可以记录该错误并退出,从而立即停止启动。

function loadConfig() {
  const result = EnvSchema.safeParse(process.env);
  if (!result.success) {
    console.error(result.error.format());
    process.exit(1);
  }
  return result.data;
}

推断类型

一个很大的优点是:可以使用 z.infer 从模式中派生验证后的类型。模式同时成为运行时检查和编译时类型的唯一事实来源。

type Env = z.infer<typeof EnvSchema>;
// { PORT: number; NODE_ENV: "development" | "production"; DATABASE_URL: string }

描述性错误

模式验证器会准确报告哪个字段失败以及失败原因,例如“PORT:应为正数”。清晰的消息让配置错误变得非常容易诊断。

// e.g. { PORT: { _errors: ["Expected number, received nan"] } }

可选字段和默认字段

模式可以直接表达可选性和默认值,从而省去手写的回退逻辑,并将所有规则集中在一个声明中。

const Schema = z.object({
  LOG_LEVEL: z.enum(["info", "debug"]).default("info"),
  TIMEOUT_MS: z.coerce.number().optional(),
});

验证一次,处处使用

在启动时只执行一次验证,然后导出生成的类型化对象。下游代码可以信任配置存在且格式正确。

export const config = loadConfig();

超越 Env:文件和参数

同一个模式不仅可以验证 process.env,还可以验证来自 JSON 文件或合并来源的配置。验证步骤与值的来源无关。

模式为何优于临时检查

模式统一了验证和类型,能够生成一致且详细的错误,支持强制转换和默认值,并且可以快速失败,用一个声明替代分散的手动 if 检查。

快速检查

快速检查本课内容。

回顾

config 模式(例如 zod)在一个地方声明类型、约束、强制转换和默认值,并在启动时进行验证,以便通过描述性错误快速失败;同时,您还可以使用 z.infer 从这个唯一事实来源推断出类型化配置。

免费开始

用 AI 导师学习 TypeScript — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
101
课程
352

常见问题解答

「经过模式验证的配置」课时是免费的吗?

是的 — 「经过模式验证的配置」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 TypeScript Academy 课程的其余内容,请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 4 节课。

「经过模式验证的配置」这节课中我会学到什么?

使用模式在启动时验证配置。 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 TypeScript Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 2 节课,共 4 节。

「经过模式验证的配置」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 TypeScript Academy 课中编写并运行代码吗?

能。每节 TypeScript Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 环境变量的类型标注
  2. 经过模式验证的配置
  3. 配置分层与默认值
  4. 机密信息与类型安全
← 返回 TypeScript Academy