パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細v4.12.0

json_annotation

`json_serializable` パッケージを介して JSON コード生成をサポートするクラスとヘルパー関数。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
1530万
いいね数
1320
Pub ポイント
150

パッケージをインストール

flutter pub add json_annotation

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

json_annotation パッケージは、json_serializable コードジェネレーターを使用して JSON のシリアライズおよびデシリアライズを可能にするための Dart クラス用のメタデータアノテーションを提供します。開発者がクラスが JSON にどのようにマップされるかを定義できるようにし、カスタムフィールド名、必須フィールド、型変換をサポートします。Flutter アプリで JSON データを扱う際には、特に json_serializable と併用することでボイラープレートコードを自動生成できるため、このパッケージは不可欠です。複雑なデータモデルの処理を簡素化し、コードの保守性を向上させます。

用途

  • Dart オブジェクトを JSON にシリアライズおよびデシリアライズする
  • JSON変換用のボイラープレートコードを生成する
  • ネストされたまたは複雑なデータ構造の処理
  • JSON を返す API との統合
  • Flutterアプリでの型安全なデータモデルのサポート

主な機能

  • @JsonSerializable および @JsonKey などの注釈
  • build_runner を通じた自動コード生成
  • カスタムフィールド名のマッピングをサポート
  • 柔軟なnull安全性の取り扱い
  • 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.

カテゴリー

依存関係

依存関係一覧 1 件

ソースリポジトリ

このパッケージを使用しているプロジェクト