美文网首页
JSON和序列化

JSON和序列化

作者: _白羊 | 来源:发表于2018-08-03 18:42 被阅读17次

    参考来源:https://flutterchina.club/json/#%E4%BD%BF%E7%94%A8json_serializable%E6%A8%A1%E5%9E%8B
    小项目手动序列化

    手动JSON序列化是指使使用dart:convert中内置的JSON解码器。它将原始JSON字符串传递给JSON.decode() 方法,然后在返回的Map<String, dynamic>中查找所需的值。 它没有外部依赖或其它的设置,对于小项目很方便。

    在大中型项目中使用代码生成

    代码生成功能的JSON序列化是指通过外部库为您自动生成序列化模板。它需要一些初始设置,并运行一个文件观察器,从您的model类生成代码。 例如,json_serializablebuilt_value就是这样的库。

    使用 dart:convert手动序列化JSON

    Flutter有一个内置dart:convert库,其中包含一个简单的JSON编码器和解码器。

    //  以下是一个简单的user model的示例JSON。
    {
      "name": "John Smith",
      "email": "john@example.com"
    }
    
    • 内连序列化JSON
      通过查看dart:转换JSON文档,我们发现可以通过调用JSON.decode方法来解码JSON ,使用JSON字符串作为参数。
    Map<String, dynamic> user = JSON.decode(json);
    
    print('Howdy, ${user['name']}!');
    print('We sent the verification link to ${user['email']}.');
    

    缺点:JSON.decode()仅返回一个Map<String, dynamic>,这意味着直到运行时才知道值的类型。 通过这种方法,我们失去了大部分静态类型语言特性:类型安全、自动补全和最重要的编译时异常。这样一来,我们的代码可能会变得非常容易出错。例如,当我们访问name或email字段时,我们输入的很快,导致字段名打错了。但由于这个JSON在map结构中,所以编译器不知道这个错误的字段名(所以编译时不会报错)。

    • 在模型类中序列化JSON
      可以通过引入一个简单的模型类(model class)来解决前面提到的问题,我们称之为User。在User类内部,我们有:
      • 一个User.fromJson 构造函数, 用于从一个map构造出一个 User实例 map structure
      • 一个toJson 方法, 将 User 实例转化为一个map.
    //  user.dart
    class User {
      final String name;
      final String email;
    
      User(this.name, this.email);
    
      User.fromJson(Map<String, dynamic> json)
          : name = json['name'],
            email = json['email'];
    
      Map<String, dynamic> toJson() =>
        {
          'name': name,
          'email': email,
        };
    }
    

    调用代码现在可以具有类型安全、自动补全字段(name和email)以及编译时异常。如果我们将拼写错误或字段视为int类型而不是String, 那么我们的应用程序就不会通过编译,而不是在运行时崩溃。现在,序列化逻辑移到了模型本身内部。采用这种新方法,我们可以非常容易地反序列化user。

    Map userMap = JSON.decode(json);
    var user = new User.fromJson(userMap);
    
    print('Howdy, ${user.name}!');
    print('We sent the verification link to ${user.email}.');
    

    要序列化一个user,我们只是将该User对象传递给该JSON.encode方法。我们不需要手动调用toJson这个方法,因为JSON.encode已经为我们做了。

    String json = JSON.encode(user);
    

    注意:调用代码就不用担心JSON序列化了。但是,model类还是必须的。在生产应用程序中,我们希望确保序列化正常工作。在实践中,User.fromJson和User.toJson方法都需要单元测试到位,以验证正确的行为。
    另外,实际场景中,JSON对象很少会这么简单,嵌套的JSON对象并不罕见。

    使用代码生成库序列化JSON

    使用json_serializable package包,它是一个自动化的源代码生成器,可以为我们生成JSON序列化模板。

    由于序列化代码不再由我们手写和维护,我们将运行时产生JSON序列化异常的风险降至最低。

    • 在项目中设置json_serializable
      要包含json_serializable到我们的项目中,我们需要一个常规和两个开发依赖项。
    //  pubspec.yaml
    dependencies:
      # Your other regular dependencies here
      json_annotation: ^0.2.2
    
    dev_dependencies:
      # Your other dev_dependencies here
      build_runner: ^0.7.6
      json_serializable: ^0.3.2
    

    在您的项目根文件夹中运行 flutter packages get (或者在编辑器中点击 “Packages Get”) 以在项目中使用这些新的依赖项.

    • 以json_serializable的方式创建model类

    相关文章

      网友评论

          本文标题:JSON和序列化

          本文链接:https://www.haomeiwen.com/subject/vuervftx.html