添加搜索功能

ABAP RESTful 应用程序编程模型 › 开发 › 开发应用程序 › 开发只读列表报表应用 › 改善用户体验 › 添加搜索功能

包括搜索输入字段以对多个元素执行文本和模糊搜索。

上下文

在上一章中,您为基于机场代码字段的选择字段实施了值帮助。这意味着您可以轻松搜索来自和到达特定机场的连接。但是,无法按特定航空公司或在特定日期运营的航班过滤转机。可能用户甚至想要搜索不同元素的值,假设有人想要找出哪些连接在 2019 年 2 月 18 日可用于法兰克福或从法兰克福可用。这就是需要搜索功能的地方。

使用注释为特定 CDS 视图启用搜索功能,还可以定义要包含在搜索范围中的 CDS 中的元素。还可以为搜索定义模糊性阈值,以便在搜索字段中输入拼写不正确的值时也能找到条目。这使得搜索更加轻松有效。

以下部分介绍了用于实施搜索功能的流程:

  • 由一个或多个特定航空公司运营的联运

  • 在一个或多个特定日期连接

  • 与一个或多个飞机类型的连接

  • 或者其中任何一个的组合。

尽管前两个搜索仅在 CDS 视图 /DMO/C_Connection_R 上运行(因为搜索目标元素 Airline、Departure Airport Code 和 Destination Airport Code 是此视图的一部分),但搜索天和平面类型需要在相关视图上进行搜索,因为元素 Flight Date 和 Plane Type 是 /DMO/C_Flight_R 的一部分。此外,我们还希望能够搜索完整的航空公司名称。因此,还必须启用文本提供者视图 /DMO/I_Carrier。

过程

  1. 在 /DMO/C_Connection_R 中启用搜索的相关元素

    1. 打开 CDS 视图 /DMO/C_Connection_R。

    2. 在实体级别使用注释 @Search.searchable: true 启用用于搜索的 CDS 视图并在 UI 上公开标准搜索字段。

      备注

      如果在 CDS 视图中使用此注释,则必须至少分配一个缺省搜索元素。

      ...
      @UI.headerInfo: { typeName: 'Connection',
                        typeNamePlural: 'Connections' }
      @Search.searchable: true       //*** exposes a standard search field on the UI
      
      define view entity /DMO/C_Connection_R
        as select from /DMO/I_Connection_R
      ...
      
    3. 选择要搜索的元素并使用 @Search.defaultSearchElement: true 进行注释。

    4. 使用 @Search.fuzzinessThreshold: <fuzziness_value> 为可搜索元素定义模糊性阈值。

      备注

      您可以将模糊性阈值设置为 0–1。SAP 建议您使用 0.7 开始。这意味着将找到 70% 匹配且更大的每个项目。然后,您可以定制阈值。

      连接视图中的搜索元素为 Airline 、 Departure Airport Code 和 Destination Airport Code 。由于第一个仅由两个字母代码组成,因此无需为此元素定义模糊性阈值。

      {
      …
             @Search.defaultSearchElement: true
             ...
        key  Connection.carrier_id       as AirlineID,
      …
            @Search.defaultSearchElement: true
            @Search.fuzzinessThreshold: 0.7
            Connection.airport_from_id  as DepartureAirport,
      …
            @Search.defaultSearchElement: true
            @Search.fuzzinessThreshold: 0.7
            Connection.airport_to_id    as DestinationAirport,
      … }
      
    5. 对 _Flight 和 @Search.defaultSearchElement: true 的关联进行注释,以启用对关联视图中元素的搜索。

      {…
            @Search.defaultSearchElement: true
            _Flight,
      … }
      
    6. 激活 CDS 视图。

    现在,用户可以按特定航空公司或从特定机场搜索连接。下图说明了 SQ(新加坡航空公司)运营的连接。

  2. 对于用例,我们不仅希望在应用的主视图中搜索元素,还希望在关联视图的字段中搜索元素。在 /DMO/C_Flight_R 中启用搜索的相关元素。如之前所述,打开 CDS 视图 /DMO/C_Flight_R,将其定义为启用搜索,然后选择具有适当模糊性阈值的元素进行搜索。

    ...
    @Search.searchable: true
    define view entity /DMO/C_Flight_R
      as select from /DMO/I_Flight_R
    {…
          @Search.defaultSearchElement: true
          @Search.fuzzinessThreshold: 0.7
          ...
      key Flight.flight_date    as FlightDate,
    
          @Search.defaultSearchElement: true
          @Search.fuzzinessThreshold: 0.7
          Flight.plane_type_id  as PlaneType,
    … }
    

    关联现在已启用搜索。这意味着,可以同时搜索与特定航空公司和特定机场的连接。

  3. 在 /DMO/I_Carrier 中启用搜索的相关元素,以便能够搜索完整的航空公司名称,而不仅仅是搜索两个字母的代码。打开 CDS 视图 /DMO/I_Carrier,将其标记为启用搜索,然后选择具有适当模糊性阈值的元素进行搜索。

    ...
    @Search.searchable: true
    define view entity /DMO/I_Carrier_R
      as select from /dmo/carrier as Airline
    {…
          @Search.defaultSearchElement: true
          @Search.fuzzinessThreshold: 0.7
          ...
          Airline.name          as Name,
    … }
    

    现在,文本关联允许用户搜索航空公司的全名。

结果

现在已为航空公司和机场启用搜索。

搜索日和机场