如何在 EntityCollectionService 上使用 setFilter

Question

我想知道@ngrx/data 中的 EntityCollectionService 的 setFilter 方法是如何工作的。 documentation 暗示了它的使用方式，但没有示例显示实际使用的 setFilter(pattern: any) 函数。由于参数可以是任何类型，我无法真正推断出应该在这里做什么。

基本上，我使用@ngrx/data 模块在数据存储中有一个对象列表。我想定义一个过滤器，以便我可以订阅 EntityCollectionService 的 filteredEntities$ observable。我可以成功订阅 entities$ observable 并接收完整的未过滤列表。以前，我在 EntityCollectionService 之外进行过滤，但我想利用内置的过滤机制。


export class MyComponent implements OnInit {
  filteredProjects$: Observable<Project[]>;
  typeFilterOptions: FilterOption[];
  stageFilterOptions: FilterOption[];

  constructor(private projectService: ProjectEntityService, ptivate metadataService: MetadataService) {}

  ngOnInit() {
    this.typeFilterOptions = this.metadataService.getProjectTypes();
    this.stageFilterOptions = this.metadataService.getProjectStages();

    this.filteredProjects$ = this.projectService.filteredEntities$;
  }

  onFilterChange() {
    typeFilter = typeFilterOptions.filter(option => option.isChecked).map(option.name);
    stageFilter = stageFilterOptions.filter(option => option.isChecked).map(option.name);

    this.projectService.setFilter(project => {
      return (typeFilter.indexOf(project.type) >= 0) &&
             (stageFilter.indexOf(project.stage) >= 0); 
    }
  }
}

以上代码是我尝试正确设置过滤器的最佳方法。显然，这并没有像我预期的那样工作。将过滤器设置为过滤器功能时，即使我可以看到 set filter 操作按预期触发，也没有任何变化。此时实体仍未被过滤。被标记为 pattern: any 的参数让我认为它应该是函数以外的东西，但我还是无法从文档中推断出它期望的是什么。

Answer 1

好的，所以深入研究 source code 我能够弄清楚如何在 ngrx/data 实体服务上使用过滤器。

我遗漏的部分是在实体服务元数据配置中定义过滤器函数 (see docs here)：

app.module.ts


const entityMetadata: EntityMetadataMap = {
  Project: {
    //pattern can be any object you want it to be.  This is the same argument used in setFilter(pattern: any)
    filterFn: (entities: Project[], pattern: {types: string[], stages: string[]}) => {
      return entitites.filter(entity => {
       return (pattern.types.indexOf(entity.type) >= 0) &&
              (pattern.stages.indexOf(entity.stage) >= 0)
      });
    }
  }
};

@NgModule({
    ...
})
export class AppModule {

    constructor(private eds: EntityDefinitionService) {

    eds.registerMetadataMap(entityMetadata);
  }
}

然后在组件中，您需要做的就是创建过滤器对象并将其用作实体服务上 setFilter 的参数：

my.component.ts

export class MyComponent implements OnInit {
  filteredProjects$: Observable<Project[]>;
  typeFilterOptions: FilterOption[];
  stageFilterOptions: FilterOption[];

  constructor(private projectService: ProjectEntityService, private metadataService: MetadataService) {}

  ngOnInit() {
    this.typeFilterOptions = this.metadataService.getProjectTypes();
    this.stageFilterOptions = this.metadataService.getProjectStages();

    this.filteredProjects$ = this.projectService.filteredEntities$;
  }

  onFilterChange() {
    typeFilter = typeFilterOptions.filter(option => option.isChecked).map(option.name);
    stageFilter = stageFilterOptions.filter(option => option.isChecked).map(option.name);

    this.projectService.setFilter({
      types: typeFilter,
      stages: stageFilter
    });
  }
}

此时，在调用 setFilter 时，订阅 filteredProjects$ observable 的模板中的任何内容都将获得更新的过滤实体。例如：

my.component.html

...
<app-project-list [projects]="filteredProjects$ | async"></app-project-list>
...

Answer 2

一个简单的方法就是使用您实体的模型，例如 User

export const entityMetadata: EntityMetadataMap = {
  User: {
    filterFn: (entities: User[], { email, name }: Partial<User>) =>
      entities
        .filter((user) => (email? -1 < user.email.indexOf(email) : true))
        .filter((user) => (name ? -1 < user.name.indexOf(name) : true))
  }
};

然后在你的组件中

constructor(private collectionService: UserCollectionService) {
  ...
}

filter() {
  this.collectionService.setFilter({ name: 'jan' });
  // or this.collectionService.setFilter({ name: 'jan', email: '@github.com' });
}

如何在 EntityCollectionService 上使用 setFilter

How to use setFilter on the EntityCollectionService

ngrx

angular-ngrx-data