IndexedDB基本使用-操作流程

时间:2024-10-29 15:09:33

打开数据库

使用 IndexedDB 的第一步是打开数据库,使用indexedDB.open()方法。

var db;

// databaseName数据库的名字 version版本
const request = window.indexedDB.open(databaseName, version);

// 打开数据库失败
request.onerror = function (event) {
  console.log('数据库打开报错');
};

// 成功打开数据库,通过request对象的result属性拿到数据库对象
request.onsuccess = function (event) {
  db = request.result;
  console.log('数据库打开成功');
};

// 如果指定的版本号,大于数据库的实际版本号,就会发生数据库升级事件。这时通过事件对象的target.result属性,拿到数据库实例。
request.onupgradeneeded = function (event) {
  db = event.target.result;
}

注意: 如果指定的数据库不存在,就会新建数据库。如果省略版本,打开已有数据库时,默认为当前版本;新建数据库时,默认为1

建立新数据库

新建数据库与打开数据库是同一个操作。如果指定的数据库不存在,就会新建。

不同之处在于,后续的操作主要在upgradeneeded事件的监听函数里面完成,因为这时版本从无到有,所以会触发这个事件。

新建对象仓库(建表)
request.onupgradeneeded = function(event) {
  db = event.target.result;
    
  var objectStore;
  // 判断person是否存在
  if (!db.objectStoreNames.contains('person')) {
    // 新增一张叫做person的表格,主键是id
    // 1.指定id
    objectStore = db.createObjectStore('person', { keyPath: 'id' });
    
    // 2.自动生成id
    objectStore = db.createObjectStore('person',{ autoIncrement: true });
  }
}
新建索引

新建对象仓库以后,下一步可以新建索引。

request.onupgradeneeded = function(event) {
  db = event.target.result;
  var objectStore = db.createObjectStore('person', { keyPath: 'id' });
  // name索引的名称 name索引的属性 指定了索引是否唯一
  objectStore.createIndex('name', 'name', { unique: false });
  objectStore.createIndex('email', 'email', { unique: true });
}
新增数据

新增数据指的是向对象仓库写入数据记录。这需要通过事务完成。

function add() {
  // 创建一个事务 person存储空间名称 readwrite将进行读写操作(事务模式)
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .add({ id: 1, name: '张三', age: 24, email: 'zhangsan@example.com' });

  request.onsuccess = function (event) {
    console.log('数据写入成功');
  };

  request.onerror = function (event) {
    console.log('数据写入失败');
  }
}

add();
读取数据

读取数据也是通过事务完成。

function read() {
   var transaction = db.transaction(['person']);
   var objectStore = transaction.objectStore('person');
   var request = objectStore.get(1);

   request.onerror = function(event) {
     console.log('事务失败');
   };

   request.onsuccess = function( event) {
      if (request.result) {
        console.log('Name: ' + request.result.name);
        console.log('Age: ' + request.result.age);
        console.log('Email: ' + request.result.email);
      } else {
        console.log('未获得数据记录');
      }
   };
}

read();
更新数据

更新数据要使用IDBObject.put()方法。

function update() {
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .put({ id: 1, name: '李四', age: 35, email: 'lisi@example.com' });

  request.onsuccess = function (event) {
    console.log('数据更新成功');
  };

  request.onerror = function (event) {
    console.log('数据更新失败');
  }
}

update();
删除数据

IDBObjectStore.delete()方法用于删除记录。

function remove() {
  var request = db.transaction(['person'], 'readwrite')
    .objectStore('person')
    .delete(1);

  request.onsuccess = function (event) {
    console.log('数据删除成功');
  };
}

remove();
遍历数据

遍历数据表格的所有记录,要使用指针对象 IDBCursor。

function readAll() {
  var objectStore = db.transaction('person').objectStore('person');

   objectStore.openCursor().onsuccess = function (event) {
     var cursor = event.target.result;

     if (cursor) {
       console.log('Id: ' + cursor.key);
       console.log('Name: ' + cursor.value.name);
       console.log('Age: ' + cursor.value.age);
       console.log('Email: ' + cursor.value.email);
       cursor.continue();
    } else {
      console.log('没有更多数据了!');
    }
  };
}

readAll();
使用索引

索引的意义在于,可以让你搜索任意字段,也就是说从任意字段拿到数据记录。如果不建立索引,默认只能搜索主键(即从主键取值)。

假定新建表格的时候,对name字段建立了索引。

objectStore.createIndex('name', 'name', { unique: false });

现在,就可以从name找到对应的数据记录了。

var transaction = db.transaction(['person'], 'readonly');
var store = transaction.objectStore('person');
var index = store.index('name');
var request = index.get('李四');

request.onsuccess = function (e) {
  var result = e.target.result;
  if (result) {
    // ...
  } else {
    // ...
  }
}
操作文件
存储文件

使用FileReader将文件读取为BlobArrayBuffer,然后将其存储到IndexedDB中。

function storeFile(file) {
    const db = request.result;
    const transaction = db.transaction(['files'], 'readwrite');
    const store = transaction.objectStore('files');

    const reader = new FileReader();
    reader.onload = function(event) {
        const fileData = {
            name: file.name,
            type: file.type,
            data: new Blob([event.target.result], { type: file.type })
        };

        const request = store.add(fileData);

        request.onsuccess = function() {
            console.log('文件存储成功');
        };

        request.onerror = function(event) {
            console.error('文件存储失败', event);
        };
    };

    reader.readAsArrayBuffer(file);
}

// 假设你有一个文件输入框
document.getElementById('fileInput').addEventListener('change', function(event) {
    const file = event.target.files[0];
    storeFile(file);
});
读取文件

从IndexedDB中读取文件并将其显示在页面上。

function readFile(fileId) {
    const db = request.result;
    const transaction = db.transaction(['files'], 'readonly');
    const store = transaction.objectStore('files');

    const request = store.get(fileId);

    request.onsuccess = function(event) {
        const fileData = event.target.result;
        if (fileData) {
            const url = URL.createObjectURL(fileData.data);
            const img = document.createElement('img');
            img.src = url;
            document.body.appendChild(img);
        } else {
            console.log('文件未找到');
        }
    };

    request.onerror = function(event) {
        console.error('文件读取失败', event);
    };
}

// 假设你有一个按钮来读取文件
document.getElementById('readFileButton').addEventListener('click', function() {
    const fileId = 1; // 假设你要读取ID为1的文件
    readFile(fileId);
});