如何为graphql查询转义变量

Question

我使用 Angular 6 用 Apollo 编写我的网站，以便与 graphpl 服务器交互。在将它们添加到我的gql 查询之前，我希望能够对从客户端获取的参数进行转义。

这是我的服务文件：

import { Injectable } from '@angular/core';
import {Apollo} from 'apollo-angular';
import gql from 'graphql-tag';

@Injectable({
  providedIn: 'root'
})
export class ProductService {

  constructor(private apollo: Apollo) { }

  searchForProduct(productName: string) {
    return this.apollo.watchQuery<any>({
    query: gql`{products_by_p_name_search(lang_id:1,query:"${productName}")
    {category_id,price,category_name,id,name,desc,quantity,year_manufacture,image_file}}`
    });
  }

}

正如您在此处看到的，函数searchForProduct 正在接收我添加到gql 查询中的productName 参数。如何正确转义它，以便查询包含特殊字符时不会被破坏？

谢谢！

Answer 1

在 GraphQL 中，您的查询应该是静态的，这意味着查询字符串不应在运行时更改（我希望有更多的最佳实践分享，对此感到抱歉）。为了实现这一点，GraphQL 附带了对变量的支持。变量在查询字符串中定义，然后在不同的属性中发送到服务器。

查询示例：

query getProducts($productName: String!) {
  products_by_p_name_search(lang_id:1,query: $productName) {
    category_id
    price
    category_name
    id
    name
    desc
    quantity
    year_manufacture
    image_file
  }
}

然后将变量添加到您的客户端调用中：

return this.apollo.watchQuery<any>({
  query, //...
  variables: { productName }
});

这样就不需要转义 GraphQL (!)。

Answer 2

你也可以在 js es6 中使用模板字面量。

例如：

const singleProduct = product.id;

  const queryProduct = `{
    product(id:
      "${singleProduct}") {
          variants(first: 15) {
            edges {
              node {
                id,
                title
              }
            }
          }
    }
  }`;