JSON parsing (jsonDecode) in Flutter

Introduction

We use JSON parsing to turn text data into objects our app can understand and use.

When you get data from the internet in JSON format.

When you read a JSON file stored on the device.

When you want to convert a JSON string into Dart objects to show in the app.

Syntax

Flutter

import 'dart:convert';

var data = jsonDecode(jsonString);

jsonDecode converts a JSON string into Dart objects like Map or List.

Make sure to import 'dart:convert' to use jsonDecode.

Examples

This converts a JSON string representing a user into a Map object.

Flutter

import 'dart:convert';

var jsonString = '{"name":"Alice","age":30}';
var user = jsonDecode(jsonString);

This converts a JSON array string into a Dart List.

Flutter

import 'dart:convert';

var jsonString = '[1, 2, 3]';
var numbers = jsonDecode(jsonString);

Sample App

This app parses a JSON string and shows the title in the app bar and the count in the center.

Flutter

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

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

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

  @override
  Widget build(BuildContext context) {
    const jsonString = '{"title":"Hello Flutter","count":5}';
    final Map<String, dynamic> data = jsonDecode(jsonString);

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text(data['title'])),
        body: Center(
          child: Text('Count is: ${data['count']}'),
        ),
      ),
    );
  }
}

Important Notes

jsonDecode throws an error if the JSON string is invalid, so handle exceptions if needed.

The result of jsonDecode is usually a Map for JSON objects or a List for JSON arrays.

Summary

jsonDecode converts JSON text into Dart objects.

Use it to read data from APIs or files in JSON format.

Remember to import 'dart:convert' before using jsonDecode.

Practice

1. What does the jsonDecode function do in Flutter?

easy

A. It converts a JSON string into Dart objects like Map or List.

B. It converts Dart objects into a JSON string.

C. It formats JSON strings for better readability.

D. It sends JSON data to a web server.

Solution

1. Step 1: Understand jsonDecode purpose

   The jsonDecode function takes a JSON formatted string and parses it into Dart objects such as Map or List.

2. Step 2: Differentiate from encoding

   Converting Dart objects back to JSON string is done by jsonEncode, not jsonDecode.

3. Final Answer:

   It converts a JSON string into Dart objects like Map or List. -> Option A

4. Quick Check:

   jsonDecode = JSON string to Dart objects [OK]

Hint: jsonDecode parses JSON text into Dart objects [OK]

Common Mistakes:

• Confusing jsonDecode with jsonEncode
• Thinking jsonDecode formats JSON for display
• Assuming jsonDecode sends data over network

2. Which import is required before using jsonDecode in Flutter?

easy

A. import 'dart:io';

B. import 'dart:convert';

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

D. import 'dart:async';

Solution

1. Step 1: Identify the library for JSON functions

   The jsonDecode function is part of the dart:convert library.

2. Step 2: Confirm correct import statement

   To use jsonDecode, you must import dart:convert with import 'dart:convert';.

3. Final Answer:

   import 'dart:convert'; -> Option B

4. Quick Check:

   dart:convert import needed for jsonDecode [OK]

Hint: Always import dart:convert for jsonDecode [OK]

Common Mistakes:

• Forgetting to import dart:convert
• Importing dart:io instead
• Assuming Flutter imports include jsonDecode

3. What is the output of this Flutter code?

import 'dart:convert';
void main() {
  String jsonString = '{"name":"Anna","age":25}';
  var user = jsonDecode(jsonString);
  print(user['age']);
}

medium

A. Anna

B. SyntaxError

C. 25

D. null

Solution

1. Step 1: Decode JSON string to Map

   The jsonDecode converts the JSON string into a Map with keys 'name' and 'age'.

2. Step 2: Access the 'age' key value

   Accessing user['age'] returns the integer 25.

3. Final Answer:

   25 -> Option C

4. Quick Check:

   jsonDecode output is Map, user['age'] = 25 [OK]

Hint: jsonDecode returns Map; access keys like a dictionary [OK]

Common Mistakes:

• Trying to access JSON string directly without decoding
• Expecting a string instead of integer for 'age'
• Using wrong key name in the Map

4. What is wrong with this Flutter code snippet?

import 'dart:convert';
void main() {
  String jsonString = '{name:"John", age:30}';
  var data = jsonDecode(jsonString);
  print(data['name']);
}

medium

A. print statement syntax is incorrect

B. Missing import for jsonDecode

C. jsonDecode cannot parse strings with numbers

D. JSON string keys must be in double quotes

Solution

1. Step 1: Check JSON string format

   JSON keys and string values must be enclosed in double quotes. Here, keys name and age are not quoted properly.

2. Step 2: Identify parsing error cause

   Because keys lack double quotes, jsonDecode will throw a FormatException.

3. Final Answer:

   JSON string keys must be in double quotes -> Option D

4. Quick Check:

   JSON keys need double quotes for valid parsing [OK]

Hint: JSON keys must be double-quoted strings [OK]

Common Mistakes:

• Using single quotes for JSON keys
• Forgetting quotes around string values
• Assuming jsonDecode accepts invalid JSON

5. Given this JSON string representing a list of users:

String jsonString = '[{"id":1,"name":"Alice"},{"id":2,"name":"Bob"}]';

How do you parse it to get the name of the second user in Flutter?

hard

A. var users = jsonDecode(jsonString); print(users[1]['name']);

B. var users = jsonDecode(jsonString); print(users['1']['name']);

C. var users = jsonDecode(jsonString); print(users[2]['name']);

D. var users = jsonDecode(jsonString); print(users[1].name);

Solution

1. Step 1: Decode JSON string to List of Maps

   The JSON string represents a list with two user objects. jsonDecode converts it to a List of Maps.

2. Step 2: Access second user and their name

   List indices start at 0, so the second user is at index 1. Accessing users[1]['name'] gives 'Bob'.

3. Final Answer:

   var users = jsonDecode(jsonString); print(users[1]['name']); -> Option A

4. Quick Check:

   List index 1, then key 'name' = 'Bob' [OK]

Hint: List index starts at 0; use users[1]['name'] for second item [OK]

Common Mistakes:

• Using string '1' as index instead of integer 1
• Accessing index 2 which is out of range
• Trying to access Map keys with dot notation