schema-dsl 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/CHANGELOG.md +130 -113
  2. package/LICENSE +21 -21
  3. package/README.md +628 -628
  4. package/dist/{DslBuilder-DkLaOo9Q.d.ts → DslBuilder-BIgQOAXp.d.ts} +2 -0
  5. package/dist/{DslBuilder-DQDN0ZxZ.d.cts → DslBuilder-CjHTucNQ.d.cts} +2 -0
  6. package/dist/{Validator-hFWKGxir.d.ts → Validator-CllRdrY0.d.ts} +1 -1
  7. package/dist/{Validator-C7GsVQOH.d.cts → Validator-D6okG9tr.d.cts} +1 -1
  8. package/dist/index.cjs +75 -29
  9. package/dist/index.d.cts +10 -4
  10. package/dist/index.d.ts +10 -4
  11. package/dist/index.js +75 -29
  12. package/dist/plugins/custom-format.cjs +33 -17
  13. package/dist/plugins/custom-format.d.cts +1 -1
  14. package/dist/plugins/custom-format.d.ts +1 -1
  15. package/dist/plugins/custom-format.js +33 -17
  16. package/dist/plugins/custom-type-example.cjs +33 -17
  17. package/dist/plugins/custom-type-example.d.cts +1 -1
  18. package/dist/plugins/custom-type-example.d.ts +1 -1
  19. package/dist/plugins/custom-type-example.js +33 -17
  20. package/dist/plugins/custom-validator.cjs +0 -2
  21. package/dist/plugins/custom-validator.d.cts +1 -1
  22. package/dist/plugins/custom-validator.d.ts +1 -1
  23. package/dist/plugins/custom-validator.js +0 -2
  24. package/docs/FEATURE-INDEX.md +553 -553
  25. package/docs/add-custom-locale.md +496 -496
  26. package/docs/add-keyword.md +24 -24
  27. package/docs/api-reference.md +1047 -1047
  28. package/docs/api.md +13 -13
  29. package/docs/best-practices-project-structure.md +417 -417
  30. package/docs/best-practices.md +712 -712
  31. package/docs/cache-manager.md +344 -344
  32. package/docs/compile.md +45 -45
  33. package/docs/conditional-api.md +1307 -1307
  34. package/docs/custom-extensions-guide.md +339 -339
  35. package/docs/design-philosophy.md +606 -606
  36. package/docs/doc-index.md +324 -324
  37. package/docs/dsl-syntax.md +714 -714
  38. package/docs/dynamic-locale.md +608 -608
  39. package/docs/enum.md +482 -482
  40. package/docs/error-handling.md +1975 -1975
  41. package/docs/export-guide.md +501 -501
  42. package/docs/export-limitations.md +567 -567
  43. package/docs/faq.md +596 -596
  44. package/docs/frontend-i18n-guide.md +307 -307
  45. package/docs/i18n-user-guide.md +487 -487
  46. package/docs/i18n.md +476 -476
  47. package/docs/index.md +48 -48
  48. package/docs/json-schema-basics.md +40 -40
  49. package/docs/label-vs-description.md +271 -271
  50. package/docs/markdown-exporter.md +406 -406
  51. package/docs/mongodb-exporter.md +302 -302
  52. package/docs/multi-language.md +26 -26
  53. package/docs/multi-type-support.md +322 -322
  54. package/docs/mysql-exporter.md +280 -280
  55. package/docs/number-operators.md +449 -449
  56. package/docs/optional-marker-guide.md +326 -326
  57. package/docs/performance-guide.md +49 -49
  58. package/docs/plugin-system.md +381 -381
  59. package/docs/plugin-type-registration.md +34 -34
  60. package/docs/postgresql-exporter.md +311 -311
  61. package/docs/public/favicon.svg +4 -4
  62. package/docs/quick-start.md +435 -435
  63. package/docs/runtime-locale-support.md +532 -532
  64. package/docs/schema-helper.md +345 -345
  65. package/docs/schema-utils-advanced-issues.md +23 -23
  66. package/docs/schema-utils-best-practices.md +20 -20
  67. package/docs/schema-utils-chaining.md +150 -150
  68. package/docs/schema-utils.md +524 -524
  69. package/docs/security-checklist.md +20 -20
  70. package/docs/string-extensions.md +488 -488
  71. package/docs/troubleshooting.md +486 -486
  72. package/docs/type-converter.md +310 -310
  73. package/docs/type-reference.md +242 -242
  74. package/docs/typescript-guide.md +584 -584
  75. package/docs/union-type-guide.md +157 -157
  76. package/docs/union-types.md +284 -284
  77. package/docs/validate-async.md +491 -491
  78. package/docs/validate-batch.md +49 -49
  79. package/docs/validate-dsl-object-support.md +578 -578
  80. package/docs/validate.md +506 -506
  81. package/docs/validation-guide.md +502 -502
  82. package/docs/validator.md +39 -39
  83. package/package.json +131 -131
  84. package/plugins/custom-format.cjs +8 -8
  85. package/plugins/custom-type-example.cjs +8 -8
  86. package/plugins/custom-validator.cjs +8 -8
  87. package/src/adapters/DslAdapter.ts +111 -111
  88. package/src/adapters/index.ts +1 -1
  89. package/src/config/constants.ts +83 -83
  90. package/src/config/index.ts +2 -2
  91. package/src/config/patterns.ts +77 -77
  92. package/src/core/CacheManager.ts +169 -159
  93. package/src/core/ConditionalBuilder.ts +382 -382
  94. package/src/core/ConditionalRuntime.ts +27 -27
  95. package/src/core/ConditionalValidator.ts +254 -254
  96. package/src/core/DslBuilder.ts +687 -677
  97. package/src/core/ErrorCodes.ts +38 -38
  98. package/src/core/ErrorFormatter.ts +271 -271
  99. package/src/core/JSONSchemaCore.ts +65 -65
  100. package/src/core/Locale.ts +187 -187
  101. package/src/core/MessageTemplate.ts +42 -42
  102. package/src/core/ObjectDslBuilder.ts +64 -64
  103. package/src/core/PluginManager.ts +326 -326
  104. package/src/core/StringExtensions.ts +140 -140
  105. package/src/core/TemplateEngine.ts +44 -44
  106. package/src/core/Validator.ts +448 -448
  107. package/src/errors/I18nError.ts +159 -159
  108. package/src/errors/ValidationError.ts +105 -105
  109. package/src/exporters/BaseExporter.ts +60 -60
  110. package/src/exporters/MarkdownExporter.ts +305 -305
  111. package/src/exporters/MongoDBExporter.ts +126 -126
  112. package/src/exporters/MySQLExporter.ts +156 -155
  113. package/src/exporters/PostgreSQLExporter.ts +222 -222
  114. package/src/exporters/index.ts +18 -18
  115. package/src/index.ts +651 -633
  116. package/src/locales/en-US.ts +160 -160
  117. package/src/locales/es-ES.ts +160 -160
  118. package/src/locales/fr-FR.ts +160 -160
  119. package/src/locales/index.ts +103 -103
  120. package/src/locales/ja-JP.ts +160 -160
  121. package/src/locales/types.ts +156 -156
  122. package/src/locales/zh-CN.ts +160 -160
  123. package/src/parser/ConstraintParser.ts +101 -101
  124. package/src/parser/DslParser.ts +470 -470
  125. package/src/parser/SchemaCompiler.ts +66 -66
  126. package/src/parser/TypeRegistry.ts +250 -250
  127. package/src/parser/index.ts +6 -6
  128. package/src/plugins/custom-format.ts +124 -126
  129. package/src/plugins/custom-type-example.ts +106 -108
  130. package/src/plugins/custom-validator.ts +138 -140
  131. package/src/types/conditional.ts +28 -28
  132. package/src/types/config.ts +59 -59
  133. package/src/types/dsl.ts +131 -131
  134. package/src/types/error.ts +60 -60
  135. package/src/types/index.ts +17 -17
  136. package/src/types/infer.ts +127 -127
  137. package/src/types/plugin.ts +58 -58
  138. package/src/types/safe-regex.d.ts +9 -9
  139. package/src/types/schema.ts +66 -66
  140. package/src/types/validate.ts +71 -71
  141. package/src/utils/SchemaHelper.ts +196 -196
  142. package/src/utils/SchemaUtils.ts +365 -346
  143. package/src/utils/TypeConverter.ts +215 -215
  144. package/src/utils/index.ts +10 -10
  145. package/src/validators/CustomKeywords.ts +477 -477
@@ -1,491 +1,491 @@
1
- # validateAsync - 异步验证
2
-
3
- > 验证失败自动抛出错误
4
-
5
- ---
6
-
7
- ## 快速开始
8
-
9
- ```javascript
10
- const { dsl, validateAsync } = require('schema-dsl');
11
-
12
- const userSchema = dsl({
13
- name: 'string!',
14
- email: 'email!',
15
- age: 'integer:18-120'
16
- });
17
-
18
- try {
19
- const data = await validateAsync(userSchema, {
20
- name: 'John',
21
- email: 'john@example.com',
22
- age: 30
23
- });
24
-
25
- console.log('验证成功:', data);
26
- } catch (error) {
27
- console.error('验证失败:', error.message);
28
- }
29
- ```
30
-
31
- ---
32
-
33
- ## 基础用法
34
-
35
- ```javascript
36
- try {
37
- await validateAsync(userSchema, {
38
- name: '',
39
- email: 'invalid'
40
- });
41
- } catch (error) {
42
- console.log(error instanceof ValidationError); // true
43
- console.log(error.getFieldErrors());
44
- // { email: '邮箱格式错误' }
45
- // `string!` 只表示字段必填;若要限制空字符串,需要叠加长度约束。
46
- }
47
- ```
48
-
49
- ---
50
-
51
- ## ValidationError
52
-
53
- ### 属性
54
-
55
- ```javascript
56
- class ValidationError extends Error {
57
- name: 'ValidationError' // 错误名称
58
- message: string // 友好的错误消息
59
- errors: Array<Object> // 格式化后的错误项列表(path/message/keyword/...)
60
- data: any // 原始输入数据
61
- statusCode: 400 // HTTP 状态码
62
- }
63
- ```
64
-
65
- ### 方法
66
-
67
- #### 1. `toJSON()` - 转换为 JSON(用于 API 响应)
68
-
69
- ```javascript
70
- try {
71
- await validateAsync(schema, data);
72
- } catch (error) {
73
- const json = error.toJSON();
74
- // {
75
- // error: 'ValidationError',
76
- // message: 'Validation failed: name: 字段必填',
77
- // statusCode: 400,
78
- // details: [
79
- // { field: 'name', message: '字段必填', keyword: 'required', params: {...} }
80
- // ]
81
- // }
82
- }
83
- ```
84
-
85
- #### 2. `getFieldError(field)` - 获取指定字段的错误
86
-
87
- ```javascript
88
- try {
89
- await validateAsync(schema, data);
90
- } catch (error) {
91
- const nameError = error.getFieldError('name');
92
- console.log(nameError.message); // '字段必填'
93
- }
94
- ```
95
-
96
- #### 3. `getFieldErrors()` - 获取所有字段的错误映射
97
-
98
- ```javascript
99
- try {
100
- await validateAsync(schema, data);
101
- } catch (error) {
102
- const fieldErrors = error.getFieldErrors();
103
- // { name: '字段必填', email: '邮箱格式错误' }
104
- }
105
- ```
106
-
107
- #### 4. `hasFieldError(field)` - 检查字段是否有错误
108
-
109
- ```javascript
110
- try {
111
- await validateAsync(schema, data);
112
- } catch (error) {
113
- if (error.hasFieldError('email')) {
114
- console.log('邮箱格式错误');
115
- }
116
- }
117
- ```
118
-
119
- #### 5. `getErrorCount()` - 获取错误数量
120
-
121
- ```javascript
122
- try {
123
- await validateAsync(schema, data);
124
- } catch (error) {
125
- console.log(`发现 ${error.getErrorCount()} 个错误`);
126
- }
127
- ```
128
-
129
- ---
130
-
131
- ## Express 集成
132
-
133
- ### 基础集成
134
-
135
- ```javascript
136
- const express = require('express');
137
- const { dsl, validateAsync, ValidationError } = require('schema-dsl');
138
-
139
- const app = express();
140
- app.use(express.json());
141
-
142
- // 定义 Schema
143
- const userSchema = dsl({
144
- name: 'string:1-50!',
145
- email: 'email!',
146
- age: 'integer:18-120'
147
- });
148
-
149
- // 路由处理
150
- app.post('/users', async (req, res, next) => {
151
- try {
152
- // 验证请求体
153
- const validData = await validateAsync(userSchema, req.body);
154
-
155
- // 保存到数据库
156
- const user = await db.users.insert(validData);
157
-
158
- res.status(201).json({ success: true, user });
159
- } catch (error) {
160
- next(error); // 传递给错误处理中间件
161
- }
162
- });
163
-
164
- // 全局错误处理中间件
165
- app.use((error, req, res, next) => {
166
- if (error instanceof ValidationError) {
167
- return res.status(error.statusCode).json(error.toJSON());
168
- }
169
-
170
- // 其他错误
171
- res.status(500).json({ error: 'Internal Server Error' });
172
- });
173
-
174
- app.listen(3000);
175
- ```
176
-
177
- ### 完整 CRUD 示例
178
-
179
- ```javascript
180
- const { SchemaUtils } = require('schema-dsl');
181
-
182
- // 定义完整 Schema
183
- const fullUserSchema = dsl({
184
- id: 'objectId!',
185
- name: 'string:1-50!',
186
- email: 'email!',
187
- password: 'string:8-32!',
188
- age: 'integer:18-120',
189
- createdAt: 'date',
190
- updatedAt: 'date'
191
- });
192
-
193
- // POST /users - 创建用户(排除系统字段)
194
- const createSchema = SchemaUtils
195
- .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
196
-
197
- app.post('/users', async (req, res, next) => {
198
- try {
199
- const data = await validateAsync(createSchema, req.body);
200
- const user = await db.users.insert({
201
- ...data,
202
- createdAt: new Date(),
203
- updatedAt: new Date()
204
- });
205
- res.status(201).json(user);
206
- } catch (error) {
207
- next(error);
208
- }
209
- });
210
-
211
- // GET /users/:id - 查询用户(业务层显式移除敏感字段)
212
- const publicSchema = SchemaUtils
213
- .pick(fullUserSchema, ['id', 'name', 'email', 'age', 'createdAt', 'updatedAt']);
214
-
215
- app.get('/users/:id', async (req, res, next) => {
216
- try {
217
- const user = await db.users.findById(req.params.id);
218
- const { password, ...publicUser } = user;
219
- const { validate } = require('schema-dsl');
220
- const result = validate(publicSchema, publicUser);
221
- res.json(result.data);
222
- } catch (error) {
223
- next(error);
224
- }
225
- });
226
-
227
- // PATCH /users/:id - 更新用户(部分验证)
228
- const updateSchema = SchemaUtils
229
- .pick(fullUserSchema, ['name', 'age'])
230
- .partial();
231
-
232
- app.patch('/users/:id', async (req, res, next) => {
233
- try {
234
- const data = await validateAsync(updateSchema, req.body);
235
- const user = await db.users.updateById(req.params.id, {
236
- ...data,
237
- updatedAt: new Date()
238
- });
239
- res.json(user);
240
- } catch (error) {
241
- next(error);
242
- }
243
- });
244
-
245
- // PUT /users/:id - 替换用户(排除系统字段)
246
- const replaceSchema = SchemaUtils
247
- .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
248
-
249
- app.put('/users/:id', async (req, res, next) => {
250
- try {
251
- const data = await validateAsync(replaceSchema, req.body);
252
- const user = await db.users.replaceById(req.params.id, {
253
- ...data,
254
- updatedAt: new Date()
255
- });
256
- res.json(user);
257
- } catch (error) {
258
- next(error);
259
- }
260
- });
261
- ```
262
-
263
- > ⚠️ `SchemaUtils` 当前只负责生成派生 Schema(如 `pick()` / `omit()` / `partial()` / `extend()`),不会自动删除运行时对象上的额外字段。返回公开响应时,请先在业务层显式投影数据,再用 `validate()` 校验投影结果。
264
-
265
- ---
266
-
267
- ## 错误处理
268
-
269
- ### 自定义错误格式
270
-
271
- ```javascript
272
- app.use((error, req, res, next) => {
273
- if (error instanceof ValidationError) {
274
- // 自定义错误响应格式
275
- return res.status(422).json({
276
- code: 'VALIDATION_FAILED',
277
- message: '数据验证失败',
278
- timestamp: new Date().toISOString(),
279
- fields: error.getFieldErrors()
280
- });
281
- }
282
-
283
- next(error);
284
- });
285
- ```
286
-
287
- ### 分类错误处理
288
-
289
- ```javascript
290
- app.use((error, req, res, next) => {
291
- if (error instanceof ValidationError) {
292
- const fieldErrors = error.getFieldErrors();
293
-
294
- // 邮箱格式错误
295
- if (error.hasFieldError('email')) {
296
- return res.status(400).json({
297
- code: 'INVALID_EMAIL',
298
- message: '邮箱格式错误',
299
- field: 'email'
300
- });
301
- }
302
-
303
- // 其他验证错误
304
- return res.status(400).json(error.toJSON());
305
- }
306
-
307
- next(error);
308
- });
309
- ```
310
-
311
- ### 日志记录
312
-
313
- ```javascript
314
- app.use((error, req, res, next) => {
315
- if (error instanceof ValidationError) {
316
- // 记录验证错误日志
317
- logger.warn('Validation failed', {
318
- url: req.url,
319
- method: req.method,
320
- errors: error.errors,
321
- data: error.data
322
- });
323
-
324
- return res.status(error.statusCode).json(error.toJSON());
325
- }
326
-
327
- next(error);
328
- });
329
- ```
330
-
331
- ---
332
-
333
- ## 完整示例
334
-
335
- ### 用户注册 API
336
-
337
- ```javascript
338
- const express = require('express');
339
- const bcrypt = require('bcrypt');
340
- const { dsl, validateAsync, ValidationError, SchemaUtils } = require('schema-dsl');
341
-
342
- const app = express();
343
- app.use(express.json());
344
-
345
- // 基础用户 Schema
346
- const baseUserSchema = dsl({
347
- id: 'objectId!',
348
- username: 'string:3-32!',
349
- email: 'email!',
350
- password: 'string:8-32!',
351
- age: 'integer:18-120',
352
- createdAt: 'date',
353
- updatedAt: 'date'
354
- });
355
-
356
- // 注册 Schema(排除系统字段)
357
- const registerSchema = SchemaUtils
358
- .omit(baseUserSchema, ['id', 'createdAt', 'updatedAt']);
359
-
360
- // 注册接口
361
- app.post('/register', async (req, res, next) => {
362
- try {
363
- // 1. 验证请求数据
364
- const data = await validateAsync(registerSchema, req.body);
365
-
366
- // 2. 检查用户是否存在
367
- const existingUser = await db.users.findOne({ email: data.email });
368
- if (existingUser) {
369
- return res.status(409).json({
370
- code: 'USER_EXISTS',
371
- message: '邮箱已被注册'
372
- });
373
- }
374
-
375
- // 3. 加密密码
376
- const hashedPassword = await bcrypt.hash(data.password, 10);
377
-
378
- // 4. 保存用户
379
- const user = await db.users.insert({
380
- ...data,
381
- password: hashedPassword,
382
- createdAt: new Date(),
383
- updatedAt: new Date()
384
- });
385
-
386
- // 5. 返回公开信息(先显式投影,再按公开 Schema 校验)
387
- const publicSchema = SchemaUtils
388
- .pick(baseUserSchema, ['id', 'username', 'email', 'age', 'createdAt', 'updatedAt']);
389
-
390
- const { password, ...publicUser } = user;
391
-
392
- const { validate } = require('schema-dsl');
393
- const result = validate(publicSchema, publicUser);
394
-
395
- res.status(201).json({
396
- success: true,
397
- user: result.data
398
- });
399
-
400
- } catch (error) {
401
- next(error);
402
- }
403
- });
404
-
405
- // 全局错误处理
406
- app.use((error, req, res, next) => {
407
- if (error instanceof ValidationError) {
408
- return res.status(error.statusCode).json(error.toJSON());
409
- }
410
-
411
- console.error('Server error:', error);
412
- res.status(500).json({ error: 'Internal Server Error' });
413
- });
414
-
415
- app.listen(3000, () => {
416
- console.log('Server running on http://localhost:3000');
417
- });
418
- ```
419
-
420
- ---
421
-
422
- ## API 参考
423
-
424
- ### validateAsync(schema, data, options?)
425
-
426
- **参数**:
427
- - `schema` - JSON Schema 或 DslBuilder 实例
428
- - `data` - 待验证的数据
429
- - `options` - 验证选项(可选)
430
- - `locale` - 语言设置(如 'zh-CN', 'en-US')
431
- - `format` - 是否格式化错误(默认 true)
432
-
433
- **返回值**:
434
- - 验证通过:返回处理后的数据
435
- - 验证失败:抛出 `ValidationError`
436
-
437
- **示例**:
438
- ```javascript
439
- // 基础用法
440
- const data = await validateAsync(schema, inputData);
441
-
442
- // 指定语言
443
- const data = await validateAsync(schema, inputData, { locale: 'zh-CN' });
444
-
445
- // 不格式化错误
446
- const data = await validateAsync(schema, inputData, { format: false });
447
- ```
448
-
449
- ### ValidationError 类
450
-
451
- **构造函数**:
452
- ```javascript
453
- new ValidationError(errors, data)
454
- ```
455
-
456
- **属性**:
457
- - `name: 'ValidationError'`
458
- - `message: string` - 友好的错误消息
459
- - `errors: Array<Object>` - 格式化后的错误项列表(如 `path`、`message`、`keyword`、`params`)
460
- - `data: any` - 原始输入数据
461
- - `statusCode: 400` - HTTP 状态码
462
-
463
- **方法**:
464
- - `toJSON()` - 转换为 JSON 格式
465
- - `getFieldError(field)` - 获取指定字段的错误
466
- - `getFieldErrors()` - 获取所有字段的错误映射
467
- - `hasFieldError(field)` - 检查字段是否有错误
468
- - `getErrorCount()` - 获取错误数量
469
-
470
- ---
471
-
472
- ## 相关文档
473
-
474
- - [SchemaUtils 链式调用](schema-utils-chaining.md) - Schema 复用简化方法
475
- - [validate.md](validate.md) - 传统同步验证方法
476
- - [error-handling.md](error-handling.md) - 错误处理指南
477
- - [validate-async 完整示例](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validate-async.ts) - 顶层 `validateAsync()`、`ValidationError` 与业务层异步检查示例
478
-
479
- ---
480
-
481
- ## 对应示例文件
482
-
483
- **示例入口**: [validate-async.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validate-async.ts)
484
- **说明**: 覆盖 `validateAsync()` 的成功路径、`ValidationError` 捕获,以及“结构校验通过后再做业务层异步检查”的推荐方式。
485
-
486
- ---
487
-
488
- **版本**: v1.0.4
489
- **更新日期**: 2025-12-29
490
- **作者**: schema-dsl Team
491
-
1
+ # validateAsync - 异步验证
2
+
3
+ > 验证失败自动抛出错误
4
+
5
+ ---
6
+
7
+ ## 快速开始
8
+
9
+ ```javascript
10
+ const { dsl, validateAsync } = require('schema-dsl');
11
+
12
+ const userSchema = dsl({
13
+ name: 'string!',
14
+ email: 'email!',
15
+ age: 'integer:18-120'
16
+ });
17
+
18
+ try {
19
+ const data = await validateAsync(userSchema, {
20
+ name: 'John',
21
+ email: 'john@example.com',
22
+ age: 30
23
+ });
24
+
25
+ console.log('验证成功:', data);
26
+ } catch (error) {
27
+ console.error('验证失败:', error.message);
28
+ }
29
+ ```
30
+
31
+ ---
32
+
33
+ ## 基础用法
34
+
35
+ ```javascript
36
+ try {
37
+ await validateAsync(userSchema, {
38
+ name: '',
39
+ email: 'invalid'
40
+ });
41
+ } catch (error) {
42
+ console.log(error instanceof ValidationError); // true
43
+ console.log(error.getFieldErrors());
44
+ // { email: '邮箱格式错误' }
45
+ // `string!` 只表示字段必填;若要限制空字符串,需要叠加长度约束。
46
+ }
47
+ ```
48
+
49
+ ---
50
+
51
+ ## ValidationError
52
+
53
+ ### 属性
54
+
55
+ ```javascript
56
+ class ValidationError extends Error {
57
+ name: 'ValidationError' // 错误名称
58
+ message: string // 友好的错误消息
59
+ errors: Array<Object> // 格式化后的错误项列表(path/message/keyword/...)
60
+ data: any // 原始输入数据
61
+ statusCode: 400 // HTTP 状态码
62
+ }
63
+ ```
64
+
65
+ ### 方法
66
+
67
+ #### 1. `toJSON()` - 转换为 JSON(用于 API 响应)
68
+
69
+ ```javascript
70
+ try {
71
+ await validateAsync(schema, data);
72
+ } catch (error) {
73
+ const json = error.toJSON();
74
+ // {
75
+ // error: 'ValidationError',
76
+ // message: 'Validation failed: name: 字段必填',
77
+ // statusCode: 400,
78
+ // details: [
79
+ // { field: 'name', message: '字段必填', keyword: 'required', params: {...} }
80
+ // ]
81
+ // }
82
+ }
83
+ ```
84
+
85
+ #### 2. `getFieldError(field)` - 获取指定字段的错误
86
+
87
+ ```javascript
88
+ try {
89
+ await validateAsync(schema, data);
90
+ } catch (error) {
91
+ const nameError = error.getFieldError('name');
92
+ console.log(nameError.message); // '字段必填'
93
+ }
94
+ ```
95
+
96
+ #### 3. `getFieldErrors()` - 获取所有字段的错误映射
97
+
98
+ ```javascript
99
+ try {
100
+ await validateAsync(schema, data);
101
+ } catch (error) {
102
+ const fieldErrors = error.getFieldErrors();
103
+ // { name: '字段必填', email: '邮箱格式错误' }
104
+ }
105
+ ```
106
+
107
+ #### 4. `hasFieldError(field)` - 检查字段是否有错误
108
+
109
+ ```javascript
110
+ try {
111
+ await validateAsync(schema, data);
112
+ } catch (error) {
113
+ if (error.hasFieldError('email')) {
114
+ console.log('邮箱格式错误');
115
+ }
116
+ }
117
+ ```
118
+
119
+ #### 5. `getErrorCount()` - 获取错误数量
120
+
121
+ ```javascript
122
+ try {
123
+ await validateAsync(schema, data);
124
+ } catch (error) {
125
+ console.log(`发现 ${error.getErrorCount()} 个错误`);
126
+ }
127
+ ```
128
+
129
+ ---
130
+
131
+ ## Express 集成
132
+
133
+ ### 基础集成
134
+
135
+ ```javascript
136
+ const express = require('express');
137
+ const { dsl, validateAsync, ValidationError } = require('schema-dsl');
138
+
139
+ const app = express();
140
+ app.use(express.json());
141
+
142
+ // 定义 Schema
143
+ const userSchema = dsl({
144
+ name: 'string:1-50!',
145
+ email: 'email!',
146
+ age: 'integer:18-120'
147
+ });
148
+
149
+ // 路由处理
150
+ app.post('/users', async (req, res, next) => {
151
+ try {
152
+ // 验证请求体
153
+ const validData = await validateAsync(userSchema, req.body);
154
+
155
+ // 保存到数据库
156
+ const user = await db.users.insert(validData);
157
+
158
+ res.status(201).json({ success: true, user });
159
+ } catch (error) {
160
+ next(error); // 传递给错误处理中间件
161
+ }
162
+ });
163
+
164
+ // 全局错误处理中间件
165
+ app.use((error, req, res, next) => {
166
+ if (error instanceof ValidationError) {
167
+ return res.status(error.statusCode).json(error.toJSON());
168
+ }
169
+
170
+ // 其他错误
171
+ res.status(500).json({ error: 'Internal Server Error' });
172
+ });
173
+
174
+ app.listen(3000);
175
+ ```
176
+
177
+ ### 完整 CRUD 示例
178
+
179
+ ```javascript
180
+ const { SchemaUtils } = require('schema-dsl');
181
+
182
+ // 定义完整 Schema
183
+ const fullUserSchema = dsl({
184
+ id: 'objectId!',
185
+ name: 'string:1-50!',
186
+ email: 'email!',
187
+ password: 'string:8-32!',
188
+ age: 'integer:18-120',
189
+ createdAt: 'date',
190
+ updatedAt: 'date'
191
+ });
192
+
193
+ // POST /users - 创建用户(排除系统字段)
194
+ const createSchema = SchemaUtils
195
+ .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
196
+
197
+ app.post('/users', async (req, res, next) => {
198
+ try {
199
+ const data = await validateAsync(createSchema, req.body);
200
+ const user = await db.users.insert({
201
+ ...data,
202
+ createdAt: new Date(),
203
+ updatedAt: new Date()
204
+ });
205
+ res.status(201).json(user);
206
+ } catch (error) {
207
+ next(error);
208
+ }
209
+ });
210
+
211
+ // GET /users/:id - 查询用户(业务层显式移除敏感字段)
212
+ const publicSchema = SchemaUtils
213
+ .pick(fullUserSchema, ['id', 'name', 'email', 'age', 'createdAt', 'updatedAt']);
214
+
215
+ app.get('/users/:id', async (req, res, next) => {
216
+ try {
217
+ const user = await db.users.findById(req.params.id);
218
+ const { password, ...publicUser } = user;
219
+ const { validate } = require('schema-dsl');
220
+ const result = validate(publicSchema, publicUser);
221
+ res.json(result.data);
222
+ } catch (error) {
223
+ next(error);
224
+ }
225
+ });
226
+
227
+ // PATCH /users/:id - 更新用户(部分验证)
228
+ const updateSchema = SchemaUtils
229
+ .pick(fullUserSchema, ['name', 'age'])
230
+ .partial();
231
+
232
+ app.patch('/users/:id', async (req, res, next) => {
233
+ try {
234
+ const data = await validateAsync(updateSchema, req.body);
235
+ const user = await db.users.updateById(req.params.id, {
236
+ ...data,
237
+ updatedAt: new Date()
238
+ });
239
+ res.json(user);
240
+ } catch (error) {
241
+ next(error);
242
+ }
243
+ });
244
+
245
+ // PUT /users/:id - 替换用户(排除系统字段)
246
+ const replaceSchema = SchemaUtils
247
+ .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
248
+
249
+ app.put('/users/:id', async (req, res, next) => {
250
+ try {
251
+ const data = await validateAsync(replaceSchema, req.body);
252
+ const user = await db.users.replaceById(req.params.id, {
253
+ ...data,
254
+ updatedAt: new Date()
255
+ });
256
+ res.json(user);
257
+ } catch (error) {
258
+ next(error);
259
+ }
260
+ });
261
+ ```
262
+
263
+ > ⚠️ `SchemaUtils` 当前只负责生成派生 Schema(如 `pick()` / `omit()` / `partial()` / `extend()`),不会自动删除运行时对象上的额外字段。返回公开响应时,请先在业务层显式投影数据,再用 `validate()` 校验投影结果。
264
+
265
+ ---
266
+
267
+ ## 错误处理
268
+
269
+ ### 自定义错误格式
270
+
271
+ ```javascript
272
+ app.use((error, req, res, next) => {
273
+ if (error instanceof ValidationError) {
274
+ // 自定义错误响应格式
275
+ return res.status(422).json({
276
+ code: 'VALIDATION_FAILED',
277
+ message: '数据验证失败',
278
+ timestamp: new Date().toISOString(),
279
+ fields: error.getFieldErrors()
280
+ });
281
+ }
282
+
283
+ next(error);
284
+ });
285
+ ```
286
+
287
+ ### 分类错误处理
288
+
289
+ ```javascript
290
+ app.use((error, req, res, next) => {
291
+ if (error instanceof ValidationError) {
292
+ const fieldErrors = error.getFieldErrors();
293
+
294
+ // 邮箱格式错误
295
+ if (error.hasFieldError('email')) {
296
+ return res.status(400).json({
297
+ code: 'INVALID_EMAIL',
298
+ message: '邮箱格式错误',
299
+ field: 'email'
300
+ });
301
+ }
302
+
303
+ // 其他验证错误
304
+ return res.status(400).json(error.toJSON());
305
+ }
306
+
307
+ next(error);
308
+ });
309
+ ```
310
+
311
+ ### 日志记录
312
+
313
+ ```javascript
314
+ app.use((error, req, res, next) => {
315
+ if (error instanceof ValidationError) {
316
+ // 记录验证错误日志
317
+ logger.warn('Validation failed', {
318
+ url: req.url,
319
+ method: req.method,
320
+ errors: error.errors,
321
+ data: error.data
322
+ });
323
+
324
+ return res.status(error.statusCode).json(error.toJSON());
325
+ }
326
+
327
+ next(error);
328
+ });
329
+ ```
330
+
331
+ ---
332
+
333
+ ## 完整示例
334
+
335
+ ### 用户注册 API
336
+
337
+ ```javascript
338
+ const express = require('express');
339
+ const bcrypt = require('bcrypt');
340
+ const { dsl, validateAsync, ValidationError, SchemaUtils } = require('schema-dsl');
341
+
342
+ const app = express();
343
+ app.use(express.json());
344
+
345
+ // 基础用户 Schema
346
+ const baseUserSchema = dsl({
347
+ id: 'objectId!',
348
+ username: 'string:3-32!',
349
+ email: 'email!',
350
+ password: 'string:8-32!',
351
+ age: 'integer:18-120',
352
+ createdAt: 'date',
353
+ updatedAt: 'date'
354
+ });
355
+
356
+ // 注册 Schema(排除系统字段)
357
+ const registerSchema = SchemaUtils
358
+ .omit(baseUserSchema, ['id', 'createdAt', 'updatedAt']);
359
+
360
+ // 注册接口
361
+ app.post('/register', async (req, res, next) => {
362
+ try {
363
+ // 1. 验证请求数据
364
+ const data = await validateAsync(registerSchema, req.body);
365
+
366
+ // 2. 检查用户是否存在
367
+ const existingUser = await db.users.findOne({ email: data.email });
368
+ if (existingUser) {
369
+ return res.status(409).json({
370
+ code: 'USER_EXISTS',
371
+ message: '邮箱已被注册'
372
+ });
373
+ }
374
+
375
+ // 3. 加密密码
376
+ const hashedPassword = await bcrypt.hash(data.password, 10);
377
+
378
+ // 4. 保存用户
379
+ const user = await db.users.insert({
380
+ ...data,
381
+ password: hashedPassword,
382
+ createdAt: new Date(),
383
+ updatedAt: new Date()
384
+ });
385
+
386
+ // 5. 返回公开信息(先显式投影,再按公开 Schema 校验)
387
+ const publicSchema = SchemaUtils
388
+ .pick(baseUserSchema, ['id', 'username', 'email', 'age', 'createdAt', 'updatedAt']);
389
+
390
+ const { password, ...publicUser } = user;
391
+
392
+ const { validate } = require('schema-dsl');
393
+ const result = validate(publicSchema, publicUser);
394
+
395
+ res.status(201).json({
396
+ success: true,
397
+ user: result.data
398
+ });
399
+
400
+ } catch (error) {
401
+ next(error);
402
+ }
403
+ });
404
+
405
+ // 全局错误处理
406
+ app.use((error, req, res, next) => {
407
+ if (error instanceof ValidationError) {
408
+ return res.status(error.statusCode).json(error.toJSON());
409
+ }
410
+
411
+ console.error('Server error:', error);
412
+ res.status(500).json({ error: 'Internal Server Error' });
413
+ });
414
+
415
+ app.listen(3000, () => {
416
+ console.log('Server running on http://localhost:3000');
417
+ });
418
+ ```
419
+
420
+ ---
421
+
422
+ ## API 参考
423
+
424
+ ### validateAsync(schema, data, options?)
425
+
426
+ **参数**:
427
+ - `schema` - JSON Schema 或 DslBuilder 实例
428
+ - `data` - 待验证的数据
429
+ - `options` - 验证选项(可选)
430
+ - `locale` - 语言设置(如 'zh-CN', 'en-US')
431
+ - `format` - 是否格式化错误(默认 true)
432
+
433
+ **返回值**:
434
+ - 验证通过:返回处理后的数据
435
+ - 验证失败:抛出 `ValidationError`
436
+
437
+ **示例**:
438
+ ```javascript
439
+ // 基础用法
440
+ const data = await validateAsync(schema, inputData);
441
+
442
+ // 指定语言
443
+ const data = await validateAsync(schema, inputData, { locale: 'zh-CN' });
444
+
445
+ // 不格式化错误
446
+ const data = await validateAsync(schema, inputData, { format: false });
447
+ ```
448
+
449
+ ### ValidationError 类
450
+
451
+ **构造函数**:
452
+ ```javascript
453
+ new ValidationError(errors, data)
454
+ ```
455
+
456
+ **属性**:
457
+ - `name: 'ValidationError'`
458
+ - `message: string` - 友好的错误消息
459
+ - `errors: Array<Object>` - 格式化后的错误项列表(如 `path`、`message`、`keyword`、`params`)
460
+ - `data: any` - 原始输入数据
461
+ - `statusCode: 400` - HTTP 状态码
462
+
463
+ **方法**:
464
+ - `toJSON()` - 转换为 JSON 格式
465
+ - `getFieldError(field)` - 获取指定字段的错误
466
+ - `getFieldErrors()` - 获取所有字段的错误映射
467
+ - `hasFieldError(field)` - 检查字段是否有错误
468
+ - `getErrorCount()` - 获取错误数量
469
+
470
+ ---
471
+
472
+ ## 相关文档
473
+
474
+ - [SchemaUtils 链式调用](schema-utils-chaining.md) - Schema 复用简化方法
475
+ - [validate.md](validate.md) - 传统同步验证方法
476
+ - [error-handling.md](error-handling.md) - 错误处理指南
477
+ - [validate-async 完整示例](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validate-async.ts) - 顶层 `validateAsync()`、`ValidationError` 与业务层异步检查示例
478
+
479
+ ---
480
+
481
+ ## 对应示例文件
482
+
483
+ **示例入口**: [validate-async.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validate-async.ts)
484
+ **说明**: 覆盖 `validateAsync()` 的成功路径、`ValidationError` 捕获,以及“结构校验通过后再做业务层异步检查”的推荐方式。
485
+
486
+ ---
487
+
488
+ **版本**: v1.0.4
489
+ **更新日期**: 2025-12-29
490
+ **作者**: schema-dsl Team
491
+