Flutter类型化JSON数据获取插件typed_json_getters的使用

特性

• 类型安全访问：通过显式类型检索值。
• 默认值：当键缺失时提供默认值。
• 错误处理：在类型转换失败时抛出 FormatException。
• 嵌套键支持：使用点符号（.）访问嵌套的JSON属性。

安装

在你的 pubspec.yaml 文件中添加 typed_json_getters：

dependencies:
  typed_json_getters: ^1.0.0

示例代码

main.dart

import 'package:typed_json_getters/typed_json_getters.dart';

void main() {
  // 示例JSON数据
  Map<String, dynamic> jsonData = {
    'user': {
      'id': 'u123',
      'name': 'Alice',
      'isActive': 'true',
      // 可以转换为布尔值的字符串
      'details': {
        'age': '30', // 可以转换为整数的字符串
        'height': 5.6, // 双精度值
        'weight': 'not available', // 无效的双精度值
      },
      'preferences': {
        'notifications': 'false', // 可以转换为布尔值的字符串
        'theme': 'dark',
      },
      'scores': ['100', '95', '80'],
      // 可以转换为整数的字符串列表
      'invalidScores': ['100', 'ninety-five', 80],
      // 混合列表，包含无效整数
      'address': null,
      // 空值
    },
    'meta': {
      'lastLogin': '2023-10-01T12:34:56Z',
      'signupCount': 'invalid', // 无效的整数
    },
  };

  // 使用 get<T> 获取带有默认值的数据
  String userId = jsonData.get<String>('user.id', defaultValue: '');
  String userName = jsonData.get<String>('user.name', defaultValue: 'Unknown');
  bool isActive = jsonData.get<bool>('user.isActive', defaultValue: false);
  int age = jsonData.get<int>('user.details.age', defaultValue: 0);
  double height = jsonData.get<double>('user.details.height', defaultValue: 0.0);
  double weight = jsonData.get<double>('user.details.weight', defaultValue: 0.0); // 转换失败
  bool notifications = jsonData.get<bool>('user.preferences.notifications', defaultValue: true);
  String theme = jsonData.get<String>('user.preferences.theme', defaultValue: 'light');
  List<int> scores = jsonData.getList<int>('user.scores', defaultValue: []);
  List<int> invalidScores = jsonData.getList<int>('user.invalidScores', defaultValue: []);
  Map<String, String> address = jsonData.getMap<String, String>('user.address', defaultValue: {}); // 空值
  int signupCount = jsonData.get<int>('meta.signupCount', defaultValue: 0); // 转换失败

  // 使用 getNullable<T> 获取可能为空的数据
  String? nickname = jsonData.getNullable<String>('user.nickname'); // 键不存在
  int? nullableAge = jsonData.getNullable<int>('user.details.age');
  double? nullableWeight = jsonData.getNullable<double>('user.details.weight'); // 转换失败
  bool? nullableNotifications = jsonData.getNullable<bool>('user.preferences.notifications');
  String? nullableTheme = jsonData.getNullable<String>('user.preferences.theme');
  List<int>? nullableScores = jsonData.getNullableList<int>('user.scores');
  List<int>? nullableInvalidScores = jsonData.getNullableList<int>('user.invalidScores'); // 转换失败
  Map<String, String>? nullableAddress = jsonData.getNullableMap<String, String>('user.address'); // 空值
  int? nullableSignupCount = jsonData.getNullable<int>('meta.signupCount'); // 转换失败

  // 使用点符号访问嵌套键
  String lastLogin = jsonData.get<String>('meta.lastLogin', defaultValue: 'Never');
  String innerValue1 = jsonData.get<String>('user.details.innerKey', defaultValue: 'No Value'); // 无效路径

  // 打印结果
  print('--- 使用 get<T> ---');
  print('User ID: $userId'); // 输出: User ID: u123
  print('User Name: $userName'); // 输出: User Name: Alice
  print('Is Active: $isActive'); // 输出: Is Active: true
  print('Age: $age'); // 输出: Age: 30
  print('Height: $height'); // 输出: Height: 5.6
  print('Weight: $weight'); // 输出: Weight: 0.0 (默认值由于转换失败)
  print('Notifications Enabled: $notifications'); // 输出: Notifications Enabled: false
  print('Theme: $theme'); // 输出: Theme: dark
  print('Scores: $scores'); // 输出: Scores: [100, 95, 80]
  print('Invalid Scores: $invalidScores'); // 输出: Invalid Scores: []
  print('Address: $address'); // 输出: Address: {}
  print('Signup Count: $signupCount'); // 输出: Signup Count: 0 (默认值由于转换失败)

  print('\n--- 使用 getNullable<T> ---');
  print('Nickname: $nickname'); // 输出: Nickname: null
  print('Nullable Age: $nullableAge'); // 输出: Nullable Age: 30
  print('Nullable Weight: $nullableWeight'); // 输出: Nullable Weight: null
  print('Nullable Notifications Enabled: $nullableNotifications'); // 输出: Nullable Notifications Enabled: false
  print('Nullable Theme: $nullableTheme'); // 输出: Nullable Theme: dark
  print('Nullable Scores: $nullableScores'); // 输出: Nullable Scores: [100, 95, 80]
  print('Nullable Invalid Scores: $nullableInvalidScores'); // 输出: Nullable Invalid Scores: null
  print('Nullable Address: $nullableAddress'); // 输出: Nullable Address: null
  print('Nullable Signup Count: $nullableSignupCount'); // 输出: Nullable Signup Count: null

  print('\n--- 嵌套键 ---');
  print('Last Login: $lastLogin'); // 输出: Last Login: 2023-10-01T12:34:56Z
  print('Inner Value1: $innerValue1'); // 输出: Inner Value1: No Value
}