搜索插件、代码仓与 APP 分类

ducafecatFlutter 生态导航
插件详情v4.12.0

json_annotation

支持通过 `json_serializable` 包进行 JSON 代码生成的类和辅助函数。

AndroidiOSWebmacOSWindowsLinux
pub.dev API 文档 源代码
近 30 天下载
1530万
喜欢数
1320
Pub 分数
150

安装插件

flutter pub add json_annotation

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

json_annotation 包为 Dart 类提供元数据注解，以启用使用 json_serializable 代码生成器进行 JSON 序列化和反序列化。它允许开发人员定义类如何映射到 JSON，支持自定义字段名称、必填字段和类型转换。在 Flutter 应用中处理 JSON 数据时，此包至关重要，尤其是与 json_serializable 配合使用时，可自动生成功能代码。它简化了复杂数据模型的处理，并提高了代码可维护性。

适合场景

  • 将 Dart 对象序列化和反序列化为/从 JSON
  • 为JSON转换生成样板代码
  • 处理嵌套或复杂的数据结构
  • 与返回 JSON 的 API 集成
  • 在Flutter应用中支持类型安全的数据模型

主要特点

  • 注解如 @JsonSerializable 和 @JsonKey
  • 通过 build_runner 自动生成代码
  • 支持自定义字段名称映射
  • 灵活的空安全处理
  • 与 json_serializable 的集成

适合对象

  • 使用 JSON API 的 Flutter 开发人员
  • 需要类型安全数据模型的项目
  • 致力于减少手动序列化代码的团队
  • 频繁API交互的应用
  • 使用代码生成工作流的开发人员

使用建议

  • 需要 build_runner 和 json_serializable 才能正常运行
  • 模型更改后需要重新生成
  • 可能会略微增加构建时间
  • 不适用于无需生成代码的运行时 JSON 解析
  • 仅限编译时代码生成

原始 README

以下为关联源码仓库的 README 原文快照，最新内容请访问源码仓库。

Dart CI

Provides Dart Build System builders for handling JSON.

json_serializable Pub Package

The core package providing Generators for JSON-specific tasks.

Import it into your pubspec dev_dependencies: section.

json_annotation Pub Package

The annotation package which has no dependencies.

Import it into your pubspec dependencies: section.

checked_yaml Pub Package

Generate more helpful exceptions when decoding YAML documents using package:json_serializable and package:yaml.

Import it into your pubspec dependencies: section.

example

An example showing how to set up and use json_serializable and json_annotation.

所属分类

代码生成器与序列化（JSON）

依赖

依赖清单 1 项

源码仓库

使用此插件的项目