Model classes from JSON in Flutter

Introduction

Model classes help you organize data from JSON into easy-to-use objects in your app.

When you get data from a web service in JSON format.

When you want to convert JSON data into Dart objects to use in your app.

When you want to send data from your app as JSON to a server.

When you want to keep your code clean and easy to understand by using classes.

When you want to avoid working with raw JSON maps everywhere in your code.

Syntax

Flutter

class ModelName {
  final Type propertyName;

  ModelName({required this.propertyName});

  factory ModelName.fromJson(Map<String, dynamic> json) {
    return ModelName(
      propertyName: json['propertyName'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'propertyName': propertyName,
    };
  }
}

The fromJson factory converts JSON map to a Dart object.

The toJson method converts the Dart object back to JSON map.

Examples

This model class represents a user with a name and age.

Flutter

class User {
  final String name;
  final int age;

  User({required this.name, required this.age});

  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      name: json['name'],
      age: json['age'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'name': name,
      'age': age,
    };
  }
}

This model class shows how to handle numbers that might be int or double in JSON.

Flutter

class Product {
  final String id;
  final double price;

  Product({required this.id, required this.price});

  factory Product.fromJson(Map<String, dynamic> json) {
    return Product(
      id: json['id'],
      price: (json['price'] as num).toDouble(),
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'price': price,
    };
  }
}

Sample App

This Flutter app shows how to convert a JSON string into a User object and display its data on screen.

Flutter

import 'dart:convert';
import 'package:flutter/material.dart';

class User {
  final String name;
  final int age;

  User({required this.name, required this.age});

  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      name: json['name'],
      age: json['age'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'name': name,
      'age': age,
    };
  }
}

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    const jsonString = '{"name": "Alice", "age": 30}';
    final Map<String, dynamic> userMap = json.decode(jsonString);
    final user = User.fromJson(userMap);

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('User Info')),
        body: Center(
          child: Text('Name: ${user.name}, Age: ${user.age}'),
        ),
      ),
    );
  }
}

Important Notes

Always check JSON keys exist before using them to avoid errors.

Use toDouble() when JSON numbers can be int or double.

Model classes make your code easier to maintain and test.

Summary

Model classes convert JSON data into Dart objects and back.

Use fromJson factory and toJson method.

This helps keep your app code clean and organized.

Practice

1. What is the main purpose of a model class when working with JSON in Flutter?

easy

A. To handle user input events

B. To display UI elements on the screen

C. To convert JSON data into Dart objects and back

D. To manage app navigation between screens

Solution

1. Step 1: Understand the role of model classes

   Model classes are designed to represent data structures in Dart that match JSON data.

2. Step 2: Identify the purpose related to JSON

   They convert JSON strings into Dart objects and convert Dart objects back to JSON for easy data handling.

3. Final Answer:

   To convert JSON data into Dart objects and back -> Option C

4. Quick Check:

   Model class = JSON conversion [OK]

Hint: Model classes handle JSON to Dart object conversion [OK]

Common Mistakes:

• Confusing model classes with UI widgets
• Thinking model classes manage navigation
• Assuming model classes handle user input

2. Which of the following is the correct syntax for a factory constructor named fromJson in a Dart model class?

easy

A. factory Model.fromJson(Map json) { return Model(json['id']); }

B. Model.fromJson(Map json) { return Model(json['id']); }

C. factory Model.fromJson(Map json) { Model(json['id']); }

D. Model.fromJson(Map json) => Model(json['id']);

Solution

1. Step 1: Recall factory constructor syntax

   In Dart, a factory constructor uses the keyword 'factory' and returns an instance, often with a return statement.

2. Step 2: Check each option for correct syntax

   factory Model.fromJson(Map json) { return Model(json['id']); } correctly uses 'factory', has the parameter, and returns a new Model instance inside braces.

3. Final Answer:

   factory Model.fromJson(Map json) { return Model(json['id']); } -> Option A

4. Quick Check:

   Factory constructor syntax = factory Model.fromJson(Map json) { return Model(json['id']); } [OK]

Hint: Factory constructors need 'factory' keyword and return statement [OK]

Common Mistakes:

• Omitting the 'factory' keyword
• Not returning an instance
• Using arrow syntax without 'factory'

3. Given this Dart model class snippet, what will print(user.name); output?

class User {
  final String name;
  User(this.name);

  factory User.fromJson(Map json) {
    return User(json['name']);
  }
}

void main() {
  final json = {'name': 'Alice'};
  final user = User.fromJson(json);
  print(user.name);
}

medium

A. null

B. Alice

C. User Instance

D. Error: No such method

Solution

1. Step 1: Understand fromJson factory usage

   The factory constructor takes the JSON map and extracts the 'name' value, passing it to the User constructor.

2. Step 2: Trace the print statement

   The user object has name set to 'Alice', so printing user.name outputs 'Alice'.

3. Final Answer:

   Alice -> Option B

4. Quick Check:

   JSON 'name' value = printed name [OK]

Hint: fromJson sets fields from JSON keys [OK]

Common Mistakes:

• Expecting print to show object instead of field
• Confusing factory constructor with normal constructor
• Assuming null if key missing

4. Identify the error in this Dart model class code for JSON parsing:

class Product {
  final int id;
  final String name;

  Product(this.id, this.name);

  factory Product.fromJson(Map json) {
    return Product(json['id'], json['title']);
  }
}

medium

A. The JSON key 'title' does not match the field 'name'

B. The constructor parameters are in wrong order

C. Missing semicolon after constructor

D. Factory constructor should not return Product instance

Solution

1. Step 1: Compare JSON keys with class fields

   The class has a field 'name' but the factory uses 'json['title']' which does not match.

2. Step 2: Understand impact of key mismatch

   This causes the 'name' field to get null or wrong value, leading to incorrect data mapping.

3. Final Answer:

   The JSON key 'title' does not match the field 'name' -> Option A

4. Quick Check:

   JSON keys must match field names [OK]

Hint: JSON keys must match model field names exactly [OK]

Common Mistakes:

• Using wrong JSON keys
• Ignoring field and parameter order
• Thinking factory can't return instance

5. You have a JSON list of users: [{'id':1,'name':'Bob'},{'id':2,'name':'Eve'}]. How do you convert this list into a Dart list of User objects using a model class with fromJson factory?

hard

A. User.fromJson(jsonList[0])

B. User.fromJson(jsonList)

C. jsonList.forEach((json) => User.fromJson(json))

D. jsonList.map((json) => User.fromJson(json)).toList()

Solution

1. Step 1: Understand JSON list to Dart list conversion

   Each JSON map in the list must be converted to a User object using fromJson.

2. Step 2: Use map and toList for conversion

   Using map applies fromJson to each item, and toList collects results into a Dart list.

3. Final Answer:

   jsonList.map((json) => User.fromJson(json)).toList() -> Option D

4. Quick Check:

   Map each JSON to User, then toList [OK]

Hint: Use map + fromJson + toList to convert JSON list [OK]

Common Mistakes:

• Passing whole list to fromJson expecting batch conversion
• Using forEach without collecting results
• Converting only first item