SAP Spartacus 中的 HTTP URL parameters

JerryWang_汪子熙 - 2022-10-26 09:32:24

使用带有参数请求选项的 HttpParams 类在 HttpRequest 中添加 URL 查询字符串。

下面的例子，searchHeroes() 方法查询名字中包含搜索词的英雄。

首先导入 HttpParams 类，如下图高亮代码所示：

如果有搜索词，代码会使用 HTML URL 编码的搜索参数构造一个选项对象。例如，如果术语是“cat”，则 GET 请求 URL 将是 api/heroes?name=cat。

HttpParams 对象是不可变的。如果您需要更新选项，请保存 .set() 方法的返回值。

下面是 Spartacus Customer Search 的一个例子：

上述代码设置了两个参数，baseSite 值为当前处于 active 状态的 base site 值，而 sort 参数硬编码为 byNameAsc.

使用用户名 asagent 登录 ASM module 之后，在 customer 字段输入客户名，比如 jerry，能看到 Chrome 开发者工具 network 面板的请求：

url：

https://xxx:9002/assistedservicewebservices/customers/search?baseSite=electronics-spa&sort=byNameAsc&query=jerry&pageSize=20

url 里的 query 和 pageSize 的参数，设置代码如下：

customerSearch(
    options: CustomerSearchOptions
  ): Observable<CustomerSearchPage> {
    const headers = InterceptorUtil.createHeader(
      USE_CUSTOMER_SUPPORT_AGENT_TOKEN,
      true,
      new HttpHeaders()
    );
    let params: HttpParams = new HttpParams()
      .set('baseSite', this.activeBaseSite)
      .set('sort', 'byNameAsc');

    if (typeof options['query'] !== 'undefined') {
      params = params.set('query', '' + options.query);
    }

    if (typeof options['pageSize'] !== 'undefined') {
      params = params.set('pageSize', '' + options.pageSize);
    }

    const url = this.occEndpointsService.buildUrl(
      'asmCustomerSearch',
      {},
      {
        baseSite: false,
        prefix: false,
      }
    );

    return this.http
      .get<CustomerSearchPage>(url, { headers, params })
      .pipe(this.converterService.pipeable(CUSTOMER_SEARCH_PAGE_NORMALIZER));
  }

按照 Spartacus 数据交换的惯例，这个 adapter 被 connector 调用：