sql.js sqlite_嵌入式浏览器SQLite：SQL.Js

sql.js sqlite

介绍 (Introduction)

Sometimes your application will provide so little data, that it may be overkill to provide an API to access it. In such case you might want to embedded the database within your application. Actually, this technique is used for a while in mobile applications. It can be useful to speed up low bandwidth devices, boost application launch and more. Thing is, I’m a web developer and I wanted to be able to do the same in one of my web application.

有时，您的应用程序提供的数据太少，以至于提供访问它的API可能会过大。 在这种情况下，您可能希望将数据库嵌入到应用程序中。 实际上，此技术在移动应用程序中使用了一段时间。 加快低带宽设备的速度，促进应用程序的启动等等可能很有用。 是的，我是一名Web开发人员，我希望能够在我的一个Web应用程序中执行相同的操作。

标准 (Standard)

The recommended and compatible way to store data in Browser is by using the IndexedDB. Thing is, it uses a different approach than pure SQL, as explained in documentation. The API is also tedious to use, that is why MDN recommend to use more programmer-friendly library for simple usages. And to finish, IndexedDB format being younger it is not as supported as SQLite.

推荐的兼容方法是使用IndexedDB在Browser中存储数据。 事实是，它使用的方法不同于纯SQL，如文档中所述。 该API的使用也很繁琐，因此MDN建议使用对程序员更友好的库来简化用法。 最后， IndexedDB格式还不如SQLite受到支持。

Based on that, I wanted to try to load a SQLite database into my browser and request it. The database contains some 13 thousand entries about file extension information. The application provides the company and software associated to a file extension searched by users.

基于此，我想尝试将一个SQLite数据库加载到我的浏览器中并请求它。 该数据库包含约1.3万个有关文件扩展名信息的条目。 该应用程序提供与用户搜索的文件扩展名相关的公司和软件。

网络组装 (Web Assembly)

MDN describes Web Assembly as a way to run code written in multiple languages on the web at near native speed, allowing us to run a whole new class of programs. It is a low-level assembly-like language with a compact binary format that runs with near-native performance and provides languages such as C/C++ and Rust with a compilation target so that they can run on the web. It works by compiling code to LLVM byte-code and loading it using Emscripten.

MDN将Web Assembly描述为一种以接近本机的速度运行以多种语言编写的代码的方法，从而使我们能够运行全新的程序类。 它是一种类似于汇编语言的低级语言，具有紧凑的二进制格式，具有接近本机的性能，并为C / C ++和Rust等语言提供了编译目标，以便它们可以在Web上运行。 它通过将代码编译为LLVM字节代码并使用Emscripten加载来工作。

Web Assembly

网络组装

Usages can be : * Porting a C/C++ application with Emscripten. * Writing or generating Web Assembly directly at the assembly level. * Writing a Rust application and targeting Web Assembly as its output. * Using AssemblyScript which looks similar to Type Script and compiles to Web Assembly binary.

用法可以是：*用Emscripten移植C / C ++应用程序。 *直接在程序集级别编写或生成Web程序集。 *编写Rust应用程序，并以Web Assembly作为输出。 *使用外观类似于Type Script的AssemblyScript并编译为Web Assembly二进制文件。

SQL.js (SQL.js)

A while ago I’ve heard about a project to load and parse PDF files directly in the browser and learned that it uses a port of PDFium. So I begun to search for a port of SQLite client and by chance, found the SQL.js awesome project done by Alon Zakai. It provides a port to Web Assembly and a JavaScript loader.

不久前，我听说过一个直接在浏览器中加载和解析PDF文件的项目，并了解到该项目使用PDFium端口。 因此，我开始搜索SQLite客户端的端口，偶然发现了Alon Zakai完成的SQL.js出色项目。 它提供了Web程序集和JavaScript加载程序的端口。

To install, it was a breeze as there is a first release and an npmjs package. You can check the documentation for different usages.

要安装，很容易，因为有第一个版本和npmjs软件包。 您可以查看文档中的不同用法。

npm install --save sql.js

Webpack (Webpack)

So I decided to start working on this project, because I didn’t find any API listing file extensions. I made a SQLite database and created a React application to showcase it.

因此，我决定开始从事这个项目，因为我没有找到任何API 列表文件扩展名 。 我创建了一个SQLite数据库并创建了一个React应用程序来展示它。

While in the process of implementing the solution I found some blockers that I wanted to share for those having the same issues.

在实施解决方案的过程中，我发现了一些我想与遇到同样问题的人分享的障碍。

To run SQL.js the module need to load the WASM file in order to parse the SQLite database. Thing is, because I used Webpack 4, I always got the following error when trying to load it from the bundle :

要运行SQL.js，该模块需要加载WASM文件才能解析SQLite数据库。 事情是，因为我使用了Webpack 4 ，所以在尝试从包中加载它时总是遇到以下错误：

`Web Assembly module is included in initial chunk. This is not allowed, because Web Assembly download and compilation must happen asynchronous.`

Web程序集模块包含在初始块中。 不允许这样做，因为Web程序集的下载和编译必须异步进行。

Making some researches learned me that Webpack is not fully compatible with Web Assembly for the moment, so I couldn’t include it with my bundle. So I hacked my way by loading directly the wasm file from SQL.js repository (not a big fan of that but it worked) :

进行一些研究后，我了解到Webpack目前尚不能与Web Assembly 完全兼容 ，因此我无法将其包含在捆绑软件中。 因此，我通过直接从SQL.js存储库中加载wasm文件来破解自己的方式(虽然不大喜欢它，但它确实有效)：

let config = {
    locateFile: filename => `https://cdn.rawgit.com/kripken/sql.js/v1.0.1/dist/${filename}`}

This way you can pass the `config` object to SQL.js initialization function and it will load the wasm from the specified location.

这样，您可以将config对象传递给SQL.js初始化函数，它将从指定位置加载wasm。

打包数据库 (Pack the database)

I also needed to embedded the database with my application, this was more straightforward as Webpack provides a file-loader to include any binary file to your project. To use it you just have to add this to your Webpack configuration file.

我还需要将数据库嵌入到我的应用程序中，这更加简单，因为Webpack提供了一个文件加载器来将任何二进制文件包含到您的项目中。 要使用它，只需将其添加到Webpack配置文件中。

{
    test: /\.(sqlite)$/i,
    use: [
      {
        loader: 'file-loader',
        options: {
          name: '[name].[ext]'
        }
      }
    ]},

After that, you just import your database to get the URL on your server. I did it this way :

之后，只需导入数据库即可在服务器上获取URL。 我这样做是这样的：

import database from '../assets/database.sqlite';

加载数据库 (Load the database)

Now that we have our SQL.js initialized and our database packed with our application we need to load it as SQL.js do not provide database loading by URL. The documentation shows you how to do it, I used the same code and specified the database path.

现在我们已经初始化了SQL.js ，并且数据库与应用程序一起打包 ，我们需要加载它，因为SQL.js不提供按URL加载数据库的功能。 该文档显示了如何执行此操作，我使用了相同的代码并指定了数据库路径。

var xhr = new XMLHttpRequest();
xhr.open('GET', database, true);
xhr.responseType = 'arraybuffer';
xhr.onload = () => {
    var uInt8Array = new Uint8Array(xhr.response);
    var db = new SQL.Database(uInt8Array);};
xhr.send();

请求数据库 (Request the database)

To finish, I added a simple query in the application to allow users to search by file extension using the`db.exec` function provided by SQL.js.

最后，我在应用程序中添加了一个简单查询，以允许用户使用SQL.js提供的db.exec 函数按文件扩展名进行搜索。

You can check the relevant code in the `Search.js` React component in the project. It will search based on requested extension and update the Redux store afterwards.

您可以在项目的 Search.js React组件中检查相关代码。 它将根据请求的扩展名进行搜索，然后更新Redux存储。

观看演示 (See the demo)

You can check the project source code and demo at https://github.com/Acrecio/file-extension-api.

您可以在https://github.com/Acrecio/file-extension-api上查看项目源代码和演示。

Hoping that it will be useful for those who wants to embedded little databases within their web browser applications. Moreover I was thinking that by not accessing an API to request the database on a server, this removes server security breach through SQL injection.

希望对那些希望在其Web浏览器应用程序中嵌入少量数据库的人有用。 此外，我还认为，通过不访问API来请求服务器上的数据库，这可以消除SQL注入导致的服务器安全漏洞。

I also wanted to thanks Cory House for his coryhouse/react-slingshot starter kit with React + React-redux which I used to make this application.

我还想感谢Cory House提供的带有我的React + React-redux的coryhouse / react-slingshot入门套件，我曾用它来制作此应用程序。

翻译自: https://medium.com/swlh/embedded-browser-sqlite-sql-js-6c72a250bf36

sql.js sqlite