RESTful API 中的数据筛选及查询实践-JavaScript中文网-JavaScript教程资源分享门户

RESTful API 是一种常见的 Web API 设计风格，它通过 HTTP 协议提供了一组定义良好的操作接口，使得客户端可以使用简单、统一的方式与服务端进行交互。在实际的开发中，RESTful API 的设计和实现经常涉及到数据的筛选和查询，本文将介绍 RESTful API 中的数据筛选和查询实践，包括筛选参数的传递、查询语法的选择、性能优化等方面的内容。

筛选参数的传递

RESTful API 的一个重要特点是使用 URL 来表示资源，因此我们需要考虑如何将筛选参数传递到 URL 中。一种常见的做法是使用查询字符串（query string）的方式，将筛选参数作为 URL 的一部分，例如：

GET /api/users?start=0&limit=10&sort=name&order=asc

上述 URL 中，start 表示起始记录的位置，limit 表示返回的记录条数，sort 表示排序的字段，order 表示排序的顺序。客户端可以根据需要传递不同的参数，服务端可以根据参数来筛选和排序数据。

另一种做法是使用 HTTP 请求头（HTTP header）来传递筛选参数，例如：

GET /api/users HTTP/1.1
Host: example.com
X-Start: 0
X-Limit: 10
X-Sort: name
X-Order: asc

上述请求中，X- 前缀表示自定义的请求头，客户端可以根据需要传递不同的请求头，服务端可以根据请求头来筛选和排序数据。这种做法的优点是可以避免 URL 过长，但需要注意的是，某些代理服务器可能会删除或修改请求头，因此不太可靠。

无论是使用查询字符串还是 HTTP 请求头，我们都需要考虑参数的安全性和合法性。一种常见的做法是使用白名单（whitelist）来限制可用的参数和取值，例如：

// www.javascriptcn.com code example
const allowedParams = ['start', 'limit', 'sort', 'order'];

function validateParams(params) {
  const validatedParams = {};
  for (const key in params) {
    if (allowedParams.includes(key)) {
      validatedParams[key] = params[key];
    }
  }
  return validatedParams;
}

app.get('/api/users', (req, res) => {
  const params = validateParams(req.query);
  // TODO: 根据 params 筛选和排序数据
});

上述代码中，allowedParams 是一个白名单数组，validateParams 函数用于验证参数的合法性和安全性，返回一个经过过滤的参数对象。客户端传递的参数会被过滤，只保留白名单中存在的参数，从而避免了恶意攻击和错误使用参数的可能性。

查询语法的选择

RESTful API 中的数据查询通常包括以下几种语法：

等于（equal）：field=value
不等于（not equal）：field!=value
大于（greater than）：field>value
小于（less than）：field<value
大于等于（greater than or equal to）：field>=value
小于等于（less than or equal to）：field<=value
包含（contains）：field=like:value
不包含（not contains）：field=not_like:value
在范围内（in）：field=in:value1,value2,value3
不在范围内（not in）：field=not_in:value1,value2,value3
区间（between）：field=between:value1,value2
为空（is null）：field=is_null
不为空（not null）：field=is_not_null

其中，等于、不等于、大于、小于、大于等于、小于等于等操作比较简单，可以直接使用 SQL 中的语法进行转换。例如，等于操作可以转换为 field=value，不等于操作可以转换为 field!=value，大于操作可以转换为 field>value，以此类推。

包含和不包含操作通常需要使用 LIKE 或 NOT LIKE 来实现，例如：

SELECT * FROM users WHERE name LIKE '%John%';
SELECT * FROM users WHERE name NOT LIKE '%John%';

在范围内和不在范围内操作通常需要使用 IN 或 NOT IN 来实现，例如：

SELECT * FROM users WHERE age IN (18, 19, 20);
SELECT * FROM users WHERE age NOT IN (18, 19, 20);

区间操作通常需要使用 BETWEEN 来实现，例如：

SELECT * FROM users WHERE salary BETWEEN 1000 AND 2000;

为空和不为空操作通常需要使用 IS NULL 或 IS NOT NULL 来实现，例如：

SELECT * FROM users WHERE email IS NULL;
SELECT * FROM users WHERE email IS NOT NULL;

在实际的开发中，我们需要根据具体的业务需求选择合适的查询语法，同时需要注意参数的合法性和安全性。

性能优化

RESTful API 中的数据查询通常涉及到大量的数据读取和处理，因此我们需要考虑如何优化查询性能。以下是一些常见的性能优化技巧：

使用索引：对于经常被查询的字段，可以创建索引来加速查询。例如，对于用户表的 ID 字段，可以创建唯一索引，对于用户表的名字字段，可以创建普通索引。
分页查询：对于大量的数据，可以使用分页查询来避免一次性读取过多的数据。例如，可以使用 start 和 limit 参数来指定起始位置和返回记录数，或者使用游标（cursor）来实现分页查询。
缓存数据：对于经常被查询的数据，可以使用缓存来加速查询。例如，可以使用 Redis 缓存用户数据，减少数据库的访问次数。
压缩数据：对于返回的数据，可以使用 Gzip 等压缩算法来减少网络传输的数据量，加快响应速度。
使用异步查询：对于复杂的查询，可以使用异步查询来避免阻塞主线程。例如，可以使用 Promise 或 Async/Await 来实现异步查询。

示例代码

以下是一个使用 Node.js 和 Express 实现的 RESTful API 示例代码，用于查询用户数据：

// www.javascriptcn.com code example
const express = require('express');
const mysql = require('mysql');
const util = require('util');

const app = express();
const port = process.env.PORT || 3000;

const pool = mysql.createPool({
  connectionLimit: 10,
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'test'
});

const query = util.promisify(pool.query).bind(pool);

const allowedParams = ['start', 'limit', 'sort', 'order'];

function validateParams(params) {
  const validatedParams = {};
  for (const key in params) {
    if (allowedParams.includes(key)) {
      validatedParams[key] = params[key];
    }
  }
  return validatedParams;
}

app.get('/api/users', async (req, res) => {
  try {
    const params = validateParams(req.query);
    const start = parseInt(params.start) || 0;
    const limit = parseInt(params.limit) || 10;
    const sort = params.sort || 'id';
    const order = params.order || 'asc';

    const sql = `
      SELECT * FROM users
      ORDER BY ${sort} ${order}
      LIMIT ${start}, ${limit}
    `;

    const users = await query(sql);
    res.json(users);
  } catch (error) {
    console.error(error);
    res.status(500).send('Internal Server Error');
  }
});

app.listen(port, () => {
  console.log(`Server is listening on port ${port}`);
});

上述代码中，我们使用了 mysql 模块来连接 MySQL 数据库，使用了 util.promisify 函数将回调函数转换为 Promise 函数，使用了 Express 框架来实现 RESTful API 的路由和中间件。在查询用户数据时，我们根据客户端传递的参数来筛选和排序数据，使用了分页查询和异步查询来优化查询性能。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67d252a9a941bf71344651e4

RESTful API 中的数据筛选及查询实践

筛选参数的传递

查询语法的选择

性能优化

示例代码

接着读