使用Prisma时多页面资源API端点优化及参数传递方案问询

问题背景 #

使用Prisma与数据库交互（含嵌套关联特性），同一资源被多个页面请求，但每个页面需要不同的数据集合，导致前端会发送不同查询参数。现有查询逻辑随着页面增多变得越来越复杂：需要不断新增筛选条件和select语句，若不使用select则会返回不必要的数据。

现有简化示例代码：

prisma.product.findMany({
  where: {
    ...(collectionName ? { collection: {
      is: {
        collectionName,
      },
    } } : {}),
    ...(productName ? { productName } : {}),
  },
  ...(select ? { // 省略了数组检查和映射逻辑
    select: {
      [select]: true, // 无法选择关联表的字段
  } } : {}),
});

优化方案 #

1. 拆分专用端点 #

为每个页面的需求创建独立API端点，每个端点的Prisma查询写死对应的select/include和筛选条件。这种方式逻辑清晰，每个端点只处理单一需求，维护成本低，前端也无需拼接复杂参数。

示例：

• 基础数据端点（返回name、price）：

// /api/products/basic
const products = await prisma.product.findMany({
  where: {
    ...(req.query.productName ? { productName: req.query.productName } : {}),
  },
  select: {
    name: true,
    price: true,
  },
});

• 带关联集合数据的端点（返回name、price及collection信息）：

// /api/products/with-collection
const products = await prisma.product.findMany({
  where: {
    ...(req.query.collectionName ? { collection: { is: { collectionName: req.query.collectionName } } } : {}),
    ...(req.query.productName ? { productName: req.query.productName } : {}),
  },
  select: {
    name: true,
    price: true,
    collection: { select: { collectionName: true } },
  },
});

2. 允许前端传递Prisma风格参数（类GraphQL方式） #

完全可行，但必须做好安全校验，不能直接将前端参数原封不动传入Prisma，否则会存在数据泄露、恶意查询（如全表读取）等风险。

实现思路：

• 前端发送包含where、select、include、take、skip等字段的JSON参数；
• 后端创建白名单，限制允许查询的字段、关联关系、筛选条件；
• 对前端传入的参数进行清洗，只保留白名单内的内容。

示例代码：

// 定义允许的字段和关联白名单
const allowedSelectFields = ['id', 'name', 'price'];
const allowedIncludeRelations = ['collection'];
const allowedWhereFilters = ['productName', 'collectionName'];

// 清洗前端传入的select参数
const sanitizedSelect = {};
if (req.body.select) {
  Object.keys(req.body.select).forEach(key => {
    if (allowedSelectFields.includes(key)) {
      sanitizedSelect[key] = req.body.select[key];
    }
  });
  // 处理关联表的筛选
  if (req.body.select.collection) {
    sanitizedSelect.collection = { select: { collectionName: true } };
  }
}

// 清洗前端传入的where参数
const sanitizedWhere = {};
if (req.body.where) {
  if (req.body.where.productName && allowedWhereFilters.includes('productName')) {
    sanitizedWhere.productName = req.body.where.productName;
  }
  if (req.body.where?.collection?.is?.collectionName && allowedWhereFilters.includes('collectionName')) {
    sanitizedWhere.collection = { is: { collectionName: req.body.where.collection.is.collectionName } };
  }
}

// 执行查询，限制默认分页大小防止全表查询
const products = await prisma.product.findMany({
  where: sanitizedWhere,
  select: sanitizedSelect,
  take: req.body.take || 10,
  skip: req.body.skip || 0,
});

这种方式灵活性极高，新增页面无需修改后端，只要前端按规则传参即可，但安全校验是核心，必须严格限制可操作的范围。

3. 封装可复用的查询构建器函数 #

把通用的查询逻辑封装成函数，根据不同场景传入配置生成Prisma查询参数，避免重复编写相似代码，提升复用性。

示例代码：

/**
 * 构建Product查询参数
 * @param {Object} options - 查询配置
 * @param {Object} options.filters - 筛选条件（productName、collectionName）
 * @param {Array} options.fields - 需要返回的字段
 * @param {Array} options.includeRelations - 需要包含的关联（如['collection']）
 * @param {number} options.take - 分页大小
 * @param {number} options.skip - 跳过条数
 */
function buildProductQuery(options = {}) {
  const { filters, fields, includeRelations, take = 10, skip = 0 } = options;
  
  // 构建where条件
  const where = {};
  if (filters?.productName) where.productName = filters.productName;
  if (filters?.collectionName) where.collection = { is: { collectionName: filters.collectionName } };

  // 构建select字段
  const select = {};
  (fields || ['id', 'name']).forEach(field => {
    select[field] = true;
  });
  if (includeRelations?.includes('collection')) {
    select.collection = { select: { collectionName: true } };
  }

  return { where, select, take, skip };
}

// 使用示例：获取基础产品数据
const basicQuery = buildProductQuery({
  filters: { productName: '无线耳机' },
  fields: ['name', 'price'],
});
const basicProducts = await prisma.product.findMany(basicQuery);

// 使用示例：获取带集合信息的产品数据
const collectionQuery = buildProductQuery({
  filters: { collectionName: '数码配件' },
  fields: ['name', 'price'],
  includeRelations: ['collection'],
});
const collectionProducts = await prisma.product.findMany(collectionQuery);

新增场景时，只需调用函数传入对应配置即可，无需重复编写Prisma查询细节，维护更高效。

内容的提问来源于stack exchange，提问作者PYTHON DEVELOPER999