Flutter Converting object to an encodable object failed: Instance of 'DateTime'

문제상황

Firestore에 데이터를 업데이트할 때 List<Map>타입의 데이터를 Json문자열로 변환하여 업데이트하는 상황에 발생한 문제이다.

---

문제원인

List<Map> 타입의 데이터를 JSON 문자열로 변환하여 Firestore에 업데이트하려면 json 패키지를 사용하여 데이터를 직렬화하고 jsonEncode 함수를 사용하여 JSON 문자열로 변환해야한다.

업데이트 하려는 데이터에 "DateTime" 타입이 존재한게 원인이며, DateTime 객체가 직렬화될 수 없는 형태이기 때문이다. JSON은 일반적으로 문자열, 숫자, 불리언, 배열, 맵과 같은 기본적인 데이터 타입을 지원한다. 따라서 DateTime 객체는 JSON 직렬화를 위해 추가 처리가 필요하다.

---

해결방법

DateTime 객체를 JSON으로 직렬화하려면 toIso8601String() 메서드를 사용하여 DateTime을 ISO 8601 형식의 문자열로 변환해야 한다. 그리고 JSON 디코딩 시에는 해당 문자열을 다시 DateTime 객체로 변환하면 된다.

 

DateTime을 ISO 8601 형식의 문자열로 변환

date.toIso8601String()

 

// jsonString 변환
Map<String, dynamic> updateMap = {
	'date': date.toIso8601String(),
};

jsonEncode(updateMap);

// JSON 문자열을 변환
 Map<String, dynamic> json = jsonDecode(jsonString);
DateTime.parse(json['date']);