17370845950

在Angular项目中实现高效多字段模糊搜索与数据过滤

本教程详细指导如何在angular应用中为数据列表实现多字段模糊搜索功能。我们将从现有单字段过滤逻辑出发,逐步优化为支持姓名、邮箱、用户名等多个字段的灵活查询。教程将深入探讨如何利用javascript的数组和字符串方法进行高效过滤,并介绍如何有效管理原始数据与过滤结果,确保搜索体验流畅且高效。

1. 理解数据过滤与模糊匹配的核心概念

在Web应用中,数据列表的过滤是一个常见需求。用户通常希望通过输入关键词来快速查找相关信息。实现这一功能的核心在于以下几个JavaScript数组和字符串方法:

  • Array.prototype.filter(): 这是JavaScript数组的一个高阶函数,它创建一个新数组,其中包含通过所提供函数实现的测试的所有元素。它是实现数据过滤的基础。
  • String.prototype.toLocaleLowerCase(): 此方法将字符串转换为小写,通常用于实现大小写不敏感的比较,确保搜索结果的全面性。
  • String.prototype.includes(): 此方法用于判断一个字符串是否包含在另一个字符串中,返回 true 或 false。它是实现模糊匹配(即部分匹配)的关键。
  • 逻辑或运算符 (||): 当需要在一个搜索关键词匹配多个字段中的任意一个时,可以使用 || 运算符连接多个条件。

2. 现有实现与优化点分析

原始代码展示了一个基于mat-table的用户列表,并实现了一个简单的单字段(lastName)过滤功能。

原始HTML片段:



    
    
       Nome 
      {{ element.firstName }}
    
    
      Sobrenome
      {{ element.lastName }}
    
    
        Username
        {{ element.username }}
      
      
        E-mail
        {{ element.email }}
      
    

原始TypeScript片段:

export class GerenciamentoUsuariosListaComponent implements OnInit {
  @Input() usuarios: any[] = []; // 显示的数据源
  usuarios1: any; // 似乎用于临时存储,但未充分利用
  lastname :string; // 搜索关键词,仅用于姓氏

  readonly displayedColumns = ['firstName', 'lastName', 'username','email','actions'];

  constructor(private service: GerenciamentoUsuariosService) {
    this.lastname = '';
  }

  ngOnInit(): void {
    this.refreshListUser1()
  }

  refreshListUser1() {
    this.usuarios1 = this.service.list().subscribe(
      resp => {
        this.usuarios = resp.content // 直接赋值给显示数据源
       console.log(this.usuarios)
      });
  }

  Search(){
    if(this.lastname != ""){
      this.usuarios = this.usuarios.filter(res =>{
        return res.lastName.toLocaleLowerCase().match(this.lastname.toLocaleLowerCase());
      })
    }else if(this.lastname == ""){
      this.ngOnInit(); // 问题:清空搜索词时会重新加载数据
    }
  }
}

现有实现存在以下优化点:

  1. 单字段限制: Search() 方法目前只针对 lastName 字段进行过滤,无法满足多字段(firstName, username, email)的搜索需求。
  2. 数据源管理: 当搜索词为空时,Search() 方法会调用 ngOnInit() 重新获取数据。这会导致不必要的网络请求,并且在用户频繁清空搜索词时影响性能和用户体验。更优的做法是维护一份原始的完整数据列表,在需要重置过滤时直接使用这份数据。
  3. 变量命名: lastname 变量名不够通用,当实现多字段搜索时,应使用更具描述性的名称,如 searchTerm。
  4. 过滤逻辑: match() 方法通常用于正则表达式匹配,对于简单的字符串包含判断,includes() 方法更为直观和高效。

3. 实现多字段过滤的步骤

我们将对上述代码进行改进,以实现高效的多字段模糊搜索。

3.1 步骤一:更新HTML模板

首先,我们将搜索输入框的 [(ngModel)] 绑定到一个更通用的变量 searchTerm。




    
    
       姓名 
      {{ element.firstName }}
    
    
    
      姓氏
      {{ element.lastName }}
    
    
    
        用户名
        {{ element.username }}
      
      
      
        电子邮件
        {{ element.email }}
      
      

3.2 步骤二:调整组件逻辑 (TypeScript)

在组件中,我们将引入一个新数组 originalUsuarios 来存储从后端获取的完整用户列表。usuarios 数组将始终用于显示过滤后的结果。

import { Component, OnInit, Input } from '@angular/core';
import { GerenciamentoUsuariosService } from './gerenciamento-usuarios.service'; // 假设服务路径正确

@Component({
  selector: 'app-gerenciamento-usuarios-lista',
  templateUrl: './gerenciamento-usuarios-lista.component.html',
  styleUrls: ['./gerenciamento-usuarios-lista.component.scss']
})
export class GerenciamentoUsuariosListaComponent implements OnInit {
  @Input() usuarios: any[] = []; // 用于显示和过滤的数据列表
  originalUsuarios: any[] = []; // 存储原始的完整数据列表
  searchTerm: string = ''; // 通用的搜索关键词

  readonly displayedColumns = ['firstName', 'lastName', 'username', 'email', 'actions'];

  constructor(private service: GerenciamentoUsuariosService) { }

  ngOnInit(): void {
    this.refreshListUser1();
  }

  refreshListUser1(): void {
    this.service.list().subscribe(
      resp => {
        this.originalUsuarios = resp.content; // 将完整数据存储到 originalUsuarios
        this.usuarios = [...this.originalUsuarios]; // 初始化显示列表为完整数据
        console.log(this.usuarios);
      },
      error => {
        console.error('获取用户列表失败:', error);
        // 处理错误,例如显示错误消息给用户
      }
    );
  }

  Search(): void {
    const keyword = this.searchTerm.toLocaleLowerCase().trim(); // 获取并转换为小写,去除首尾空格

    if (keyword) {
      // 如果有搜索关键词,则从原始数据中过滤
      this.usuarios = this.originalUsuarios.filter(res => {
        return res.firstName.toLocaleLowerCase().includes(keyword) ||
               res.lastName.toLocaleLowerCase().includes(keyword) ||
               res.username.toLocaleLowerCase().includes(keyword) ||
               res.email.toLocaleLowerCase().includes(keyword);
      });
    } else {
      // 如果搜索关键词为空,则重置显示列表为原始完整数据
      this.usuarios = [...this.originalUsuarios];
    }
  }
}

代码解释:

  1. originalUsuarios: any[] = [];: 新增一个数组用于存储从后端获取的未过滤的完整用户列表。
  2. searchTerm: string = '';: 将 lastname 变量重命名为 searchTerm,使其更通用。
  3. refreshListUser1() 方法修改:
    • 在订阅数据后,首先将 resp.content 赋值给 this.originalUsuarios,确保我们始终有一份完整的数据副本。
    • 然后,使用 this.usuarios = [...this.originalUsuarios]; 将显示列表初始化为完整数据。使用扩展运算符 ... 创建一个副本,以避免直接引用导致意外修改 originalUsuarios。
  4. Search() 方法修改:
    • const keyword = this.searchTerm.toLocaleLowerCase().trim();: 获取搜索词,转换为小写,并使用 trim() 移除可能存在的空白字符,提高搜索准确性。
    • if (keyword): 判断搜索词是否非空。
      • 如果非空: this.usuarios = this.originalUsuarios.filter(...)。这里是关键:我们总是从 originalUsuarios (完整数据)开始过滤,而不是从当前 usuarios (可能已经过滤过的数据)过滤。这确保了每次搜索都是基于完整数据集。过滤条件使用 || 连接多个字段的 includes() 方法,实现了多字段的模糊匹配。
      • 如果为空: this.usuarios = [...this.originalUsuarios];。将显示列表重置为原始的完整用户列表,避免了重新请求数据。

4. 注意事项与进阶考量

  • 性能优化 (去抖/Debounce): 对于包含大量数据或用户输入非常频繁的场景,input 事件可能触发 Search() 方法过于频繁。可以考虑使用 RxJS 的 debounceTime 操作符来延迟 Search() 方法的执行,例如:

    import { Subject } from 'rxjs';
    import { debounceTime } from 'rxjs/operators';
    
    export class GerenciamentoUsuariosListaComponent implements OnInit, OnDestroy {
      // ... 其他变量 ...
      private searchTerms = new Subject();
      private destroy$ = new Subject(); // 用于管理订阅的生命周期
    
      constructor(private service: GerenciamentoUsuariosService) { }
    
      ngOnInit(): void {
        this.refreshListUser1();
    
        this.searchTerms.pipe(
          debounceTime(300), // 300毫秒内没有新输入则执行
          takeUntil(this.destroy$) // 组件销毁时取消订阅
        ).subscribe(() => {
          this.Search();
        });
      }
    
      // 在HTML中调用这个方法
      onSearchInput(): void {
        this.searchTerms.next(this.searchTerm);
      }
    
      ngOnDestroy(): void {
        this.destroy$.next();
        this.destroy$.complete();
      }
    
      // ... Search() 方法保持不变 ...
    }

    HTML中将 (input)="Search()" 改为 (input)="onSearchInput()"。

  • 可扩展性: 如果需要过滤的字段非常多,或者过滤条件需要动态配置,可以考虑将过滤逻辑抽象成一个独立的函数或服务,甚至使用第三方库(如 lodash 的 filter 或自定义管道 Pipe)。

  • 后端过滤: 对于非常大的数据集(例如数万条甚至更多),前端进行过滤可能会导致性能瓶颈。在这种情况下,更推荐将过滤逻辑推送到后端API实现,前端只负责发送搜索关键词并接收过滤后的数据。

  • 用户体验: 考虑在数据加载或过滤时显示加载指示器(如 mat-spinner),并在没有搜索结果时显示友好的提示信息。

  • 完全匹配 vs. 模糊匹配: 当前实现是模糊匹配 (includes())。如果需要完全匹配,可以将 includes(keyword) 替换为 === keyword。

5. 总结

通过本教程,我们学习了如何在Angular项目中实现一个健壮且高效的多字段模糊搜索功能。关键在于:

  1. 维护原始数据副本: 确保在组件中始终有一份完整的、未过滤的数据源,以便进行重置和新的过滤操作。
  2. 利用JavaScript数组和字符串方法: 熟练运用 filter(), toLocaleLowerCase(), includes() 以及逻辑或运算符 || 来构建灵活的过滤条件。
  3. 优化搜索逻辑: 避免不必要的网络请求,并考虑性能优化(如去抖)来提升用户体验。

掌握这些技巧,您将能够为您的Angular应用构建出更加强大和用户友好的数据列表过滤功能。