ESP8266闪存文件系统基本操作

不知道您有没有想过，当我们上传程序给ESP8266时，我们的程序具体存放在什么地方呢？ 每一个ESP8266都配有一个闪存，这个闪存很像是一个小硬盘，我们上传的文件就被存放在这个闪存里。这个闪存的全称是Serial Peripheral Interface Flash File System（SPIFFS）。 除了可以存放上传的程序以外，我们还可以将网页文件或者系统配置文件存放在ESP8266的闪存中。学习如何利用程序对闪存文件系统（SPIFFS）进行文件读取和修改。

一、 通过程序向闪存文件系统写入信息

/**
 函数说明：
 SPIFFS.open(file_name, "w");
 以上函数有两个参数：
 第一个参数是被操作的文件名称，本示例中该文件为/notes.txt
 第二个参数"w" 代表写入文件信息。（如需了解如何读取信息，请参阅示例程序esp8266-flash-read）
 **/

/*在使用SPIFFS存储文件以前，我们必须使用#include "FS.h"。*/
#include < FS.h >

String
file_name = "/taichi-maker/notes.txt"; //被读取的文件位置和名称

void setup()
{
    Serial.begin(9600);
    Serial.println("");

    Serial.println("SPIFFS format start");
    /**SPIFFS.format();是对闪存文件系统进行格式化。
     这很想是我们对u盘进行格式化的操作。您无需每次使用闪存文件系统都对它进行格式化操作。
     这里仅仅是为了演示如何使用SPIFFS.format();。
     */
    SPIFFS.format();    // 格式化SPIFFS
    Serial.println("SPIFFS format finish");

    /**
     SPIFFS.begin()用于启动闪存文件系统。
     在每次使用闪存文件系统以前都需要执行这一操作。
     如果闪存文件系统成功启动，该函数的返回值为布尔型，如果成功启动闪存文件形同，则返回真。否则将返回假。
     */
    if (SPIFFS.begin()) { // 启动SPIFFS
        Serial.println("SPIFFS Started.");
    } else {
        Serial.println("SPIFFS Failed to Start.");
    }

    /**
     File dataFile = SPIFFS.open(file_name, "w");这条语句中，open函数可用于对SPIFFS进行操作。
     该函数共有两个参数。第一个参数file_name是被操作的文件名称，本示例中该文件为/taichi-maker/notes.txt

     参数"w"代表此操作为向SPIFFS写入文件信息。
     请注意：如果文件系统没有/taichi-maker/notes.txt文件，此操作将会在文件系统中建立该文件。
     如果文件系统有该文件，则程序将会重新建立该文件，即原有文件信息将会被覆盖。
     */
    File
    dataFile = SPIFFS.open(file_name, "w");// 建立File对象用于向SPIFFS中的file对象（即/notes.txt）写入信息
    dataFile.println("Hello IOT World.");       // 向dataFile写入字符串信息
    dataFile.close();                           // 完成文件写入后关闭文件
    Serial.println("Finished Writing data to SPIFFS");
}

void loop()
{
}

二、 通过程序从闪存文件系统读取信息

/**
函数说明：
SPIFFS.open(file_name, "r"); 
以上SPIFFS函数有两个参数：
第一个参数是被操作的文件名称，本示例中该文件为/notes.txt
第二个参数"r" 代表读取文件信息。（如需了解如何写入信息，请参阅示例程序esp8266-flash-write）
***********************************************************************/
 
#include <FS.h>
 
String file_name = "/taichi-maker/notes.txt";              //被读取的文件位置和名称
 
void setup() {
  Serial.begin(9600);
  Serial.println("");
  
  if(SPIFFS.begin()){ // 启动闪存文件系统
    Serial.println("SPIFFS Started.");
  } else {
    Serial.println("SPIFFS Failed to Start.");
  }
 
  //确认闪存中是否有file_name文件
  if (SPIFFS.exists(file_name)){
    Serial.print(file_name);
    Serial.println(" FOUND.");
  } else {
    Serial.print(file_name);
    Serial.print(" NOT FOUND.");
  }
 
  //建立File对象用于从SPIFFS中读取文件
  // File dataFile = SPIFFS.open(file_name, "r");这条语句中，open函数可用于对SPIFFS进行操作。该函数共有两个参数。第一个参数file_name是被操作的文件名称，本示例中该文件为/taichi-maker/notes.txt
  File dataFile = SPIFFS.open(file_name, "r"); 
 
  // 循环条件使用了函数dataFile.size()。该函数将会返回dataFile的大小。循环语句体中，dataFile.read()将会读取dataFile文件内容。每调用一次该含税都会返回dataFile文件中一个字符。再次调用，将会返回下一个字符。以此类推，直到dataFile结尾。通过for循环语句，程序将会依次读取dataFile文件内容，并且将文件内容逐字符输出于串口监视器中。
  //读取文件内容并且通过串口监视器输出文件信息
  for(int i=0; i<dataFile.size(); i++){
    Serial.print((char)dataFile.read());       
  }
 
  //完成文件读取后关闭文件
  dataFile.close();                           
}
 
void loop() {
}

三、通过程序向闪存文件系统文件添加信息

/**
 函数说明：
 SPIFFS.open(file_name, "a");
 以上SPIFFS函数有两个参数：
 第一个参数是被操作的文件名称，本示例中该文件为/notes.txt
 第二个参数"a" 代表添加文件信息。（如需了解如何读取信息，请参阅示例程序esp8266-flash-read）
 此示例程序所演示的是向SPIFFS中的文件里添加信息。这一操作写入信息有所区别。
 添加信息是不会删除文件内原有信息，而是在原有信息后面添加新的信息。
 但写入操作（示例 esp8266-flash-write.ino）是将文件内容完全清除，重新写入新信息。
 ***********************************************************************/

#include < FS.h >

String
file_name = "/taichi-maker/notes.txt";              //被读取的文件位置和名称

void setup()
{
    Serial.begin(9600);
    Serial.println("");

    if (SPIFFS.begin()) { // 启动闪存文件系统
        Serial.println("SPIFFS Started.");
    } else {
        Serial.println("SPIFFS Failed to Start.");
    }

    //确认闪存中是否有file_name文件
    if (SPIFFS.exists(file_name)) {
        Serial.print(file_name);
        Serial.println(" FOUND.");

        // File dataFile = SPIFFS.open(file_name, "a");这条语句中，open函数可用于对SPIFFS进行操作。该函数共有两个参数。第一个参数file_name是被操作的文件名称,第二个参数"a"代表向该文件添加信息。请留意，此处的添加信息是不会删除文件内原有信息，而是在原有信息后面添加新的信息。这与但写入操作是有所区别的。写入操作是将文件内容完全清除，重新写入新信息。
        File dataFile = SPIFFS.open(file_name, "a");// 建立File对象用于向SPIFFS中的file对象（即/notes.txt）写入信息
        // dataFile.println("This is Appended Info.")，此语句作用将会向dataFile文件尾部添加双引号中的信息内容，也就是在文件尾部添加“This is Appended Info.”。
        dataFile.println("This is Appended Info."); // 向dataFile添加字符串信息
        dataFile.close();                           // 完成文件操作后关闭文件   
        Serial.println("Finished Appending data to SPIFFS");

    } else {
        Serial.print(file_name);
        Serial.print(" NOT FOUND.");
    }

}

void loop()
{
}

四、通过程序读取目录内容

/**
 函数说明：
 SPIFFS.openDir(folder_name);
 以上函数打开指定目录并返回一个目录对象实例。
 ***********************************************************************/
 
 
#include <FS.h>
String file_name = "/taichi-maker/myFile.txt"; //被读取的文件位置和名称
String folder_name = "/taichi-maker";         //被读取的文件夹

void setup(){
        Serial.begin(9600);
        Serial.println("");

        if(SPIFFS.begin()){ // 启动闪存文件系统
            Serial.println("SPIFFS Started.");
        }else{
            Serial.println("SPIFFS Failed to Start.");
        }

        File dataFile=SPIFFS.open(file_name,"w");// 建立File对象用于向SPIFFS中的file对象（即myFile.txt）写入信息
        dataFile.println("Hello Taichi-Maker.");    // 向dataFile写入字符串信息
        dataFile.close();                           // 完成文件写入后关闭文件
        Serial.println(F("Finished Writing data to SPIFFS"));

        // SPIFFS.openDir(folder_name)中的openDir函数函将返回一个“目录”对象并且赋值给dir。此”目录”对象正是folder_name所存储的/taichi-maker/目录。后续程序对dir的所有操作都是针对/taichi-maker/所执行的
        Dir dir=SPIFFS.openDir(folder_name);  // 建立“目录”对象
        // while循环语句的循环条件是dir.next()的返回值。dir.next()函数用于检查dir文件夹内的文件。我们可以想象dir文件夹里有一个指针，每一次调用next函数都会让指针向下挪动一格。每一次挪动一格，如果下一个位置有文件，则返回真。否则将会返回假。因此，while (dir.next())循环语句中的内容会依次显示dir文件夹中的每一个文件的文件名。
        while(dir.next()){  // dir.next()用于检查目录中是否还有“下一个文件”
            Serial.println(dir.fileName()); // 输出文件名
        }
}

void loop() {
}

五、从闪存文件系统中删除文件

#include <FS.h>
 
String file_name = "/taichi-maker/notes.txt";              //被读取的文件位置和名称
 
void setup() {
  Serial.begin(9600);
  Serial.println("");
  
  if(SPIFFS.begin()){ // 启动闪存文件系统
    Serial.println("SPIFFS Started.");
  } else {
    Serial.println("SPIFFS Failed to Start.");
  }
  
  //从闪存中删除file_name文件
  if (SPIFFS.remove(file_name)){
    
    Serial.print(file_name);
    Serial.println(" remove sucess");
    
  } else {
    Serial.print(file_name);
    Serial.println(" remove fail");
  }                       
}
 
void loop() {
}

六、显示闪存文件系统信息

// FSInfo fs_info;建立了FSInfo 对象，用于存储闪存状态信息。
#include <FS.h>
 
FSInfo fs_info;
 
void setup() {
  Serial.begin(9600);
 
  SPIFFS.begin();       //启动SPIFFS
  Serial.println("");
  Serial.println("SPIFFS Started.");
 
  // 闪存文件系统信息 SPIFFS.info(fs_info);。通过info函数将闪存状态信息赋给fs_info。后续的程序中，通过一系列语句将闪存状态信息通过串口监视器输出。具体信息内容可参考程序注释部分
  SPIFFS.info(fs_info);
 
  // 可用空间总和（单位：字节）
  Serial.print("totalBytes: ");     
  Serial.print(fs_info.totalBytes); 
  Serial.println(" Bytes"); 
 
  // 已用空间（单位：字节）
  Serial.print("usedBytes: "); 
  Serial.print(fs_info.usedBytes);
  Serial.println(" Bytes"); 
 
  // 最大文件名字符限制（含路径和'\0'）
  Serial.print("maxPathLength: "); 
  Serial.println(fs_info.maxPathLength);
 
  // 最多允许打开文件数量
  Serial.print("maxOpenFiles: "); 
  Serial.println(fs_info.maxOpenFiles);
 
  // 存储块大小
  Serial.print("blockSize: "); 
  Serial.println(fs_info.blockSize);
 
  // 存储页大小
  Serial.print("pageSize: ");
  Serial.println(fs_info.pageSize);
}
 
void loop() {
}

以上是关于ESP8266闪存文件系统的常用功能介绍。关于ESP8266闪存文件系统的更多操作介绍，请参考Arduino ESP8266官方页面中的介绍部分。该页面可点击以下链接前往。 参考 https://arduino-esp8266.readthedocs.io/en/latest/filesystem.html 转载 http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/iot-c/spiffs/spiffs-operation/