鸿蒙Flutter dart:convert - JSON编码解码基础

引言在现代移动应用开发中JSONJavaScript Object Notation已经成为数据交换的标准格式。无论是网络请求、本地存储还是API通信JSON都扮演着至关重要的角色。对于Flutter开发者来说掌握JSON的编码和解码是一项必备技能。本章节将深入探讨Dart标准库中dart:convert的使用方法结合天气查询应用的实际场景帮助读者全面理解JSON处理的核心技术。1. dart:convert 概述dart:convert是Dart标准库提供的编码解码工具包包含了JSON、UTF-8、Base64等多种编码解码功能。其中JSON处理是最常用的功能之一。1.1 核心组件dart:convert中与JSON相关的核心组件包括json全局函数对象提供decode和encode静态方法JsonCodecJSON编解码器类是json对象的底层实现JsonEncoderJSON编码器负责将对象转换为JSON字符串JsonDecoderJSON解码器负责将JSON字符串转换为对象1.2 基本导入使用dart:convert非常简单只需在文件顶部添加导入语句importdart:convert;这一行代码就可以让我们访问所有JSON处理相关的功能。2. JSON解码详解JSON解码是将JSON字符串转换为Dart对象的过程是网络请求后处理数据的关键步骤。2.1 基本解码操作json.decode()方法是最常用的解码方式voiddecodeJson(){StringjsonString{name:张三,age:25,city:北京};MapString,dynamicuserjson.decode(jsonString);print(姓名: ${user[name]});print(年龄: ${user[age]});print(城市: ${user[city]});}代码解析json.decode()接收一个JSON格式的字符串参数返回值类型为dynamic通常我们将其转换为MapString, dynamic或Listdynamic通过键值对方式访问解析后的数据2.2 解码JSON数组当JSON数据是数组格式时解码方式稍有不同voiddecodeJsonArray(){StringjsonArray[{id:1,name:苹果},{id:2,name:香蕉}];Listdynamicfruitsjson.decode(jsonArray);for(varfruitinfruits){print(${fruit[id]}: ${fruit[name]});}}代码解析数组类型的JSON字符串解码后返回Listdynamic需要遍历列表来访问每个元素每个元素仍然是dynamic类型需要根据实际数据结构进行类型转换2.3 解码嵌套JSON实际应用中JSON数据往往包含多层嵌套voidnestedJson(){Stringnested{ user: { name: 王五, address: { city: 上海, street: 南京路 } } };MapString,dynamicdatajson.decode(nested);Stringcitydata[user][address][city];print(城市:$city);}代码解析嵌套JSON解码后形成多层Map结构需要逐级访问每一级都是dynamic类型这种方式虽然直观但在深层嵌套时容易出错3. JSON编码详解JSON编码是将Dart对象转换为JSON字符串的过程常用于数据存储和网络请求。3.1 基本编码操作voidencodeJson(){MapString,dynamicuser{name:李四,age:30,isStudent:false,};StringjsonStringjson.encode(user);print(jsonString);// 输出: {name:李四,age:30,isStudent:false}}代码解析json.encode()接收一个Dart对象作为参数返回JSON格式的字符串支持的类型包括num、String、bool、null、List、Map3.2 编码JSON数组voidencodeJsonArray(){ListMapString,dynamicfruits[{id:1,name:苹果,price:5.99},{id:2,name:香蕉,price:3.99},];StringjsonStringjson.encode(fruits);print(jsonString);}代码解析List类型可以直接编码为JSON数组列表中的元素必须是可编码类型编码后的字符串以[开头]结尾3.3 格式化输出默认情况下json.encode()输出的是紧凑格式的JSON字符串。如果需要可读性更好的格式化输出可以使用JsonEncoder.withIndent()voidcustomCodec(){JsonCodeccodecJsonCodec();MapString,dynamicdatacodec.decode({key:value});StringprettyJsonJsonEncoder.withIndent( ).convert(data);print(prettyJson);}代码解析JsonEncoder.withIndent()可以指定缩进字符.convert()方法与json.encode()功能相同格式化后的JSON更易于阅读和调试4. 类型映射关系理解JSON类型与Dart类型的映射关系是正确处理JSON数据的基础。4.1 类型对应表JSON类型Dart类型说明stringString字符串numberint / double数字booleanbool布尔值nullnull空值arrayList数组objectMapString, dynamic对象4.2 数字类型处理JSON中的数字在Dart中默认解析为num类型需要根据实际情况转换为int或doublevoidhandleNumbers(){StringjsonStr{count: 10, price: 9.99};MapString,dynamicdatajson.decode(jsonStr);int countdata[count]asint;double pricedata[price]asdouble;int safeCount(data[count]asnum).toInt();double safePrice(data[price]asnum).toDouble();}代码解析使用as关键字进行类型转换使用toInt()和toDouble()方法进行安全转换当不确定数字类型时先转为num再转换为目标类型5. 实际应用天气数据处理结合天气查询应用场景展示dart:convert的实际应用。5.1 解析天气API响应voidparseWeatherResponse(){StringweatherJson{ city: 北京, current: { temp: 28.5, humidity: 65, condition: 晴 }, forecast: [ {date: 2024-01-01, high: 30, low: 20}, {date: 2024-01-02, high: 28, low: 18} ] };MapString,dynamicdatajson.decode(weatherJson);Stringcitydata[city]asString;MapString,dynamiccurrentdata[current]asMapString,dynamic;double temp(current[temp]asnum).toDouble();print($city当前温度:${temp}度);}5.2 构建天气请求数据voidbuildWeatherRequest(){MapString,dynamicrequestData{city:上海,type:forecast,days:7,options:{includeAqi:true,includeHourly:false}};StringjsonRequestjson.encode(requestData);print(jsonRequest);}6. 错误处理在处理JSON数据时错误处理是必不可少的环节。6.1 常见错误类型格式错误JSON字符串格式不正确类型错误数据类型与预期不符键缺失访问不存在的键嵌套错误嵌套结构与预期不符6.2 安全解析示例MapString,dynamic?safeDecode(StringjsonStr){try{returnjson.decode(jsonStr)asMapString,dynamic;}catch(e){print(JSON解析错误:$e);returnnull;}}T?safeGetT(MapString,dynamicdata,Stringkey){if(data.containsKey(key)data[key]isT){returndata[key]asT;}returnnull;}代码解析使用try-catch捕获解析异常检查键是否存在以及类型是否匹配返回可选类型调用方可以安全处理null值7. JsonCodec深入理解JsonCodec是json全局对象的底层实现提供了更灵活的配置选项。7.1 创建自定义CodecfinalJsonCodeccustomCodecJsonCodec(reviver:(key,value){if(key!nullvalueisString){returnvalue.trim();}returnvalue;});代码解析reviver参数允许在解码过程中对每个键值对进行处理可以用于数据清洗、类型转换等自定义操作7.2 性能优化预创建JsonCodec实例可以避免重复创建带来的性能开销finalJsonCodecjsonCodecJsonCodec();voidusePreCreatedCodec(StringjsonStr){MapString,dynamicdatajsonCodec.decode(jsonStr);}8. 最佳实践总结8.1 编码规范统一数据格式确保前后端使用一致的JSON格式字段命名使用驼峰命名法或下划线命名法保持一致性类型一致性同一字段在不同数据中保持相同类型版本兼容考虑API版本升级时的向后兼容性8.2 性能优化预创建Codec避免重复创建JsonCodec实例按需解析只解析需要的数据避免全量解析缓存结果对于重复使用的数据进行缓存使用Isolate对于大JSON数据考虑在后台线程解析8.3 代码组织数据模型分离将JSON解析逻辑封装到数据模型类中工具类封装创建统一的JSON处理工具类错误处理统一使用统一的错误处理机制日志记录记录解析错误便于排查问题9. 总结dart:convert是Dart处理JSON数据的核心工具掌握其使用方法对于Flutter开发者至关重要。本章详细介绍了JSON解码、编码、类型映射、错误处理等核心内容并结合天气查询应用场景展示了实际应用。在实际开发中建议结合代码生成工具如json_serializable来提高开发效率和代码质量。下一章将详细介绍json_serializable的使用方法。