玩转 ESP32 + Arduino (二十一) SPIFFS文件系统 (已弃用)

SPIFFS已被抛弃, 😎, 原因参考: https://www.bilibili.com/video/BV1kR4y1o7H7
现在我们使用LittleFS代替它, 请参考后续文章

一. 文件系统 SPIFFS

ESP32 自带SPIFFS.h库用来管理文件系统
注意: 此文件系统是没用文件层次的 比如你建立一个 /doc/test.txt 那这个txt的名字就是 doc/test, 而不是在doc目录下有个 test.txt

#include "SPIFFS.h"

二. SPIFFS相关函数

1. SPIFFS.begin(); //开启SPIFFS

参数:
- formatOnFail : 打开失败就格式化 (bool)
- *basePath :  根目录 
- maxOpenFiles  : 最大可打开文件数量

返回值: 打开成功或者失败

bool fs::SPIFFSFS::begin(bool formatOnFail = false, const char *basePath = "/spiffs", uint8_t maxOpenFiles = (uint8_t)'\n')
SPIFFS.begin();

2. SPIFFS.open //创建或打开文件

参数:
- path : 文件路径
- mode : 打开方式, 可选:
                       FILE_READ (读文件) 
                       FILE_WRITE (写文件) 
                       FILE_APPEND (添加内容)
返回值: 一个File类型的对象, 其实就是打开的文件对象

File FS::open(const char* path, const char* mode){}

我们可以看到 SPIFFS.open其实是继承自 FS类的

File file = SPIFFS.open("/test.txt", FILE_WRITE);
注意:

File重载了 Boolean运算符, 如果文件打开了 file就为true

if(!file){
     Serial.println("There was an error opening the file for writing");
     return;
}

关于File类型的函数放在下一节

3. SPIFFS.format() //文件系统格式化

SPIFFS.format();

4. SPIFFS.exists("/test.txt") //判断有没有某个文件

SPIFFS.exists("/test.txt");

5. SPIFFS.remove("/test.txt"); //删除某个文件

SPIFFS.exists("/test.txt")

6. SPIFFS.rename("原文件名","新文件名"); //文件重命名

7. SPIFFS.end(); //结束文件系统挂载

三. File类相关函数

1. file.name(); //读取文件的名字

返回文件的名字, char *字符串

2. file.print(""); //往文件中写入内容

参数: 要写入的字符串
返回值: 写入的char的个
size_t Print::print(const char *)

我们可以看到 File的print 是继承并扩展了 Print类

f(file.print("TEST")) {
    Serial.println("File was written");
}else {
    Serial.println("File write failed");
}

3. file.println(""); //往文件中写入一行内容

这个方法有好多个重载, 输入内容的方式比较丰富,可用看一下源码了解一下

file.println("xiongba,haha");

4. file.printf(); //写入内容

file.printf("tizhong:%dKG",90);

5. file.find('!'); //在文件中寻找某个char或字符串

返回布尔值!

  Serial.print("寻找!位置");
  Serial.println(file.find('!'));

4. file.findUntil("haha","!"); //在文件中寻找某个char或字符串(遇到某字符串就停止)

返回布尔值!

file.findUntil("haha","!");

5. file.close(); //关闭文件

6. file.size(); //文件大小

读模式下能返回文件大小,写模式下返回 -负值文件大小

7. file.readString(); //读取字符串, 返回读取字符串

8. file.readStringUntil(); //读取字符串, 遇到终止符终止, 返回读取字符串

9. file.readBytes(); //读取数据到buf中,

  char *buf;
  file.readBytes(buf,15);

10. file.readBytesUntil('1',buf,15); //读取数据到buf中, 遇到终止符终止

  uint8_t *buf;
  file.readBytesUntil(0x18,buf,15);

  char *buf;
  file.readBytesUntil('!',buf,15);

三. 简单测试

#include <Arduino.h>
#include <SPIFFS.h>
void setup()
{
  Serial.begin(115200);
  delay(3000);
  Serial.println("opening SPIFFS");
  while (!SPIFFS.begin())
  {
    Serial.print("...");
  }
  Serial.println("SPIFFS OK!");


  File file = SPIFFS.open("/test.txt", FILE_WRITE);
  if (!file)
  {
    Serial.println("open file failed");
  }
  Serial.println(file.print("hello,xiongba!"));
  file.println("xiongba,haha");
  Serial.println(file.print("hello,xiongba!"));
  file.printf("tizhong:%dKG",90);
  file.close();

  
  file = SPIFFS.open("/test.txt", FILE_READ);
  Serial.print("可用file.available():");
  Serial.println(file.available());
  Serial.print("test.txt的大小:");
  Serial.println(file.size());
  Serial.print("读取文件");
  String data = file.readString();
  Serial.println(data);
  Serial.print("寻找字符串");
  Serial.println(file.find('!'));
  file.findUntil("haha","!");
  Serial.println(file.name());
  file.close();

  Serial.printf("SPIFFS的总体积: %d 字节\r\n", SPIFFS.totalBytes());
  Serial.printf("SPIFFS的已用体积: %d 字节\r\n", SPIFFS.usedBytes());

  Serial.print("现在存在/test.txt吗:");
  Serial.println(SPIFFS.exists("/test.txt"));
  Serial.println("现在把/test.txt改名为/test2.txt");
  SPIFFS.rename("/test.txt", "/test2.txt");
  Serial.print("现在存在/test.txt吗:");
  Serial.println(SPIFFS.exists("/test.txt"));
  Serial.print("现在存在/test2.txt吗:");
  Serial.println(SPIFFS.exists("/test2.txt"));
  Serial.println("删除/test2.txt");
  SPIFFS.remove("/test2.txt");
  Serial.print("现在还存在/test2.txt吗:");
  Serial.println(SPIFFS.exists("/test2.txt"));
  SPIFFS.end();
}

void loop()
{
}

四. 测试FILE_WRITE和FILE_APPEND的区别(答案显而易见)

先说结论: FILE_WRITE是把文件重写, FILE_APPEND是从源文件的基础上增量

1.FILE_WRITE

#include <Arduino.h>
#include <SPIFFS.h>
void setup()
{
  Serial.begin(115200);
  delay(3000);
  Serial.println("opening SPIFFS");
  while (!SPIFFS.begin())
  {
    Serial.print("...");
  }
  Serial.println("SPIFFS OK!");


  File file = SPIFFS.open("/test.txt", FILE_WRITE);
  if (!file)
  {
    Serial.println("open file failed");
  }
  Serial.println(file.print("hello,xiongba!"));
  file.println("xiongba,haha");
  Serial.println(file.print("hello,xiongba!"));
  file.printf("tizhong:%dKG",90);
  file.close();


  file = SPIFFS.open("/test.txt", FILE_READ);
  Serial.print("可用file.available():");
  Serial.println(file.available());
  Serial.print("test.txt的大小:");
  Serial.println(file.size());
  Serial.print("读取文件");
  String data = file.readString();
  Serial.println(data);
  Serial.print("寻找字符串");
  Serial.println(file.find('!'));
  file.findUntil("haha","!");
  Serial.println(file.name());
  file.close();

  Serial.printf("SPIFFS的总体积: %d 字节\r\n", SPIFFS.totalBytes());
  Serial.printf("SPIFFS的已用体积: %d 字节\r\n", SPIFFS.usedBytes());

  SPIFFS.end();
}

void loop()
{
}

2. FILE_APPEND模式

File file = SPIFFS.open("/test.txt", FILE_APPEND);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342