dart-json-codable
JSON 解析、验证和模式生成。
- 星标
- 0
- 复刻
- 0
- 最近推送(UTC)
- 2026年9月15日
- 项目状态
- 未归档
原始 README
以下为英文项目原文快照,最新内容请访问 GitHub。
json_codable
JSON parsing, validation, and schema generation.
Usage
Parsing & Validation (JsonObject)
JsonObject supports two parsing modes: Accumulated Validation (json.parse) and Fail-Fast (direct constructor).
import 'dart:convert';
import 'package:json_codable/json_codable.dart';
class CreateUserDto {
CreateUserDto.fromJson(JsonObject json)
: name = json.string('name', rules: [.length(min: 2)]),
email = json.string('email', rules: [.email()]),
age = json.integerOrNull('age', rules: [.range(min: 18)]);
final String name;
final String email;
final int? age;
}
final jsonString = '{"name": "A", "email": "invalid"}';
final jsonMap = jsonDecode(jsonString) as Map<String, Object?>;
final json = JsonObject(jsonMap);
// Accumulated Validation: collects ALL field errors before throwing
try {
final user = json.parse(CreateUserDto.fromJson);
} on ValidationErrors catch (error) {
print(error.toJson()); // Contains errors for both 'name' and 'email'
}
// Fail-Fast: throws immediately on the first encountered error
try {
final user = CreateUserDto.fromJson(json);
} on ValidationErrors catch (error) {
print(error.toJson()); // Contains only the first error ('name')
}
Serialization (ToJson)
Implement ToJson for DTOs and models that export to JSON maps:
class UserDto implements ToJson {
UserDto({required this.id, required this.name});
final String id;
final String name;
@override
Map<String, Object?> toJson() => {
'id': id,
'name': name,
};
}
Schema Generation
Generate JSON Schema documents directly from fromJson mappers or builder callbacks:
class CreateUserDto {
// ...
static final Schema schema = JsonObject.schema(
CreateUserDto.fromJson,
title: 'CreateUserDto',
);
}
语言Dart
分类
使用的依赖
如何选择适合项目的代码仓?
先按使用场景筛选,再比较项目活跃情况,最后到原始仓库核对使用要求。
- 通过仓库名、作者或描述搜索,再按技术分类缩小范围。
- 结合星标、复刻与最近推送比较项目;星标反映社区关注,不代表质量保证。
- 使用前在 GitHub 核对 README、许可证与 Issues。
来源与维护
“A repository is the most basic element of GitHub.”
GitHub Docs — About repositories ↗