ArduinoJson库解析LittleFS文件时EmptyInput错误解决方案

在使用ArduinoJson库解析存储在LittleFS文件系统中的JSON文件时，开发者可能会遇到EmptyInput或InvalidInput错误。本文将深入分析这些问题的原因，并提供多种解决方案。

问题现象

当尝试使用ArduinoJson库的deserializeJson()函数解析LittleFS中的JSON文件时，函数返回EmptyInput错误。具体表现为：

1. 文件能够成功打开
2. 文件内容能够被读取并打印
3. 但解析函数返回错误

根本原因分析

EmptyInput错误

EmptyInput错误通常发生在以下情况：

1. 文件指针已经到达文件末尾
2. 传入的输入源为空
3. 文件内容已经被完全读取

在示例代码中，开发者先使用readString()读取了整个文件内容，导致文件指针移动到了文件末尾，此时再调用deserializeJson()就会遇到EmptyInput错误。

InvalidInput错误

InvalidInput错误可能由以下原因引起：

1. 文件包含BOM(字节顺序标记)
2. 文件编码问题
3. 文件内容格式不正确

解决方案

方案1：直接传递文件对象

最推荐的方式是直接将文件对象传递给deserializeJson()函数，无需预先读取内容：

File deviceConfigFile = LittleFS.open("/dante.json", "r");
DeserializationError error = deserializeJson(configsDoc, deviceConfigFile);

方案2：使用字符串传递

如果确实需要先读取内容，可以将内容存储在字符串中再解析：

String jsonContent = deviceConfigFile.readString();
DeserializationError error = deserializeJson(configsDoc, jsonContent);

方案3：重置文件指针

如果已经读取了文件内容，可以重置文件指针后再解析：

deviceConfigFile.seek(0, SeekSet);  // 将文件指针重置到开头
DeserializationError error = deserializeJson(configsDoc, deviceConfigFile);

处理BOM问题

对于可能包含BOM的文件，可以跳过前几个字节：

// 跳过可能的BOM标记
deviceConfigFile.read();
deviceConfigFile.read();
DeserializationError error = deserializeJson(configsDoc, deviceConfigFile);

最佳实践建议

1. 文件大小检查：在解析前检查文件大小是否超过分配的缓冲区
2. 错误处理：始终检查deserializeJson()的返回值
3. 资源释放：确保在完成后关闭文件
4. 内存管理：合理设置StaticJsonDocument的大小

完整示例代码

#include <ArduinoJson.h>
#include "LittleFS.h"

StaticJsonDocument<1024> configsDoc;

bool loadConfigFile() {
  File deviceConfigFile = LittleFS.open("/dante.json", "r");
  
  if (!deviceConfigFile) {
    Serial.println("Failed to open config file");
    return false;
  }

  // 方案1：直接解析文件
  DeserializationError error = deserializeJson(configsDoc, deviceConfigFile);
  
  if (error) {
    Serial.print("JSON解析错误: ");
    Serial.println(error.c_str());
    deviceConfigFile.close();
    return false;
  }

  deviceConfigFile.close();
  return true;
}

void setup() {
  Serial.begin(115200);
  
  if(!LittleFS.begin()) {
    Serial.println("LittleFS初始化失败");
    return;
  }

  if(loadConfigFile()) {
    Serial.println("配置加载成功");
    // 访问配置值示例
    const char* serialKey = configsDoc["SERIAL_KEY_PROD"];
    int buttonPin = configsDoc["BUTTON_PIN"];
  }
}

通过以上方法和最佳实践，开发者可以有效地解决ArduinoJson在解析LittleFS文件时遇到的各种问题。