Angular 2+ 和去抖动

IT技术 javascript angular
2021-01-29 01:37:14

在 AngularJS 中,我能够通过使用 ng-model 选项来消除模型的抖动。

ng-model-options="{ debounce: 1000 }"

如何在 Angular 中对模型进行去抖动?
我试图在文档中搜索去抖动,但找不到任何东西。

https://angular.io/search/#stq=debounce&stp=1

一个解决方案是编写我自己的 debounce 函数,例如:

import {Component, Template, bootstrap} from 'angular2/angular2';

// Annotation section
@Component({
  selector: 'my-app'
})
@Template({
  url: 'app.html'
})
// Component controller
class MyAppComponent {
  constructor() {
    this.firstName = 'Name';
  }
    
  changed($event, el){
    console.log("changes", this.name, el.value);
    this.name = el.value;
  }

  firstNameChanged($event, first){
    if (this.timeoutId) window.clearTimeout(this.timeoutID);
    this.timeoutID = window.setTimeout(() => {
        this.firstName = first.value;
    }, 250)
  }
    
}
bootstrap(MyAppComponent);

还有我的 html

<input type=text [value]="firstName" #first (keyup)="firstNameChanged($event, first)">

但我正在寻找一个内置函数,Angular 有吗?

6个回答

为 RC.5 更新

使用 Angular 2,我们可以debounceTime()在表单控件的valueChangesobservable使用 RxJS 操作符去抖动

import {Component}   from '@angular/core';
import {FormControl} from '@angular/forms';
import {Observable}  from 'rxjs/Observable';
import 'rxjs/add/operator/debounceTime';
import 'rxjs/add/operator/throttleTime';
import 'rxjs/add/observable/fromEvent';

@Component({
  selector: 'my-app',
  template: `<input type=text [value]="firstName" [formControl]="firstNameControl">
    <br>{{firstName}}`
})
export class AppComponent {
  firstName        = 'Name';
  firstNameControl = new FormControl();
  formCtrlSub: Subscription;
  resizeSub:   Subscription;
  ngOnInit() {
    // debounce keystroke events
    this.formCtrlSub = this.firstNameControl.valueChanges
      .debounceTime(1000)
      .subscribe(newValue => this.firstName = newValue);
    // throttle resize events
    this.resizeSub = Observable.fromEvent(window, 'resize')
      .throttleTime(200)
      .subscribe(e => {
        console.log('resize event', e);
        this.firstName += '*';  // change something to show it worked
      });
  }
  ngDoCheck() { console.log('change detection'); }
  ngOnDestroy() {
    this.formCtrlSub.unsubscribe();
    this.resizeSub  .unsubscribe();
  }
} 

Plunker

上面的代码还包括一个如何限制窗口大小调整事件的示例,正​​如@albanx 在下面的评论中所问的那样。


虽然上面的代码可能是 Angular 的做法,但效率不高。每个击键和每个调整大小事件,即使它们被去抖动和限制,也会导致更改检测运行。换句话说,去抖动和限制不会影响更改检测运行的频率(我发现Tobias BoschGitHub 评论证实了这一点。)您可以在运行 plunker 时看到这一点,并ngDoCheck()在您输入输入框或调整窗口大小时看到调用了多少次(使用蓝色的“x”按钮在单独的窗口中运行 plunker 以查看调整大小事件。)

一种更有效的技术是从 Angular 的“区域”之外的事件中自己创建 RxJS Observables。这样,每次触发事件时都不会调用更改检测。然后,在您的订阅回调方法中,手动触发更改检测——即,您控制何时调用更改检测:

import {Component, NgZone, ChangeDetectorRef, ApplicationRef, 
        ViewChild, ElementRef} from '@angular/core';
import {Observable} from 'rxjs/Observable';
import 'rxjs/add/operator/debounceTime';
import 'rxjs/add/operator/throttleTime';
import 'rxjs/add/observable/fromEvent';

@Component({
  selector: 'my-app',
  template: `<input #input type=text [value]="firstName">
    <br>{{firstName}}`
})
export class AppComponent {
  firstName = 'Name';
  keyupSub:  Subscription;
  resizeSub: Subscription;
  @ViewChild('input') inputElRef: ElementRef;
  constructor(private ngzone: NgZone, private cdref: ChangeDetectorRef,
    private appref: ApplicationRef) {}
  ngAfterViewInit() {
    this.ngzone.runOutsideAngular( () => {
      this.keyupSub = Observable.fromEvent(this.inputElRef.nativeElement, 'keyup')
        .debounceTime(1000)
        .subscribe(keyboardEvent => {
          this.firstName = keyboardEvent.target.value;
          this.cdref.detectChanges();
        });
      this.resizeSub = Observable.fromEvent(window, 'resize')
        .throttleTime(200)
        .subscribe(e => {
          console.log('resize event', e);
          this.firstName += '*';  // change something to show it worked
          this.cdref.detectChanges();
        });
    });
  }
  ngDoCheck() { console.log('cd'); }
  ngOnDestroy() {
    this.keyupSub .unsubscribe();
    this.resizeSub.unsubscribe();
  }
} 

Plunker

我使用ngAfterViewInit()代替ngOnInit()来确保inputElRef已定义。

detectChanges()将对该组件及其子组件运行更改检测。如果您更愿意从根组件运行更改检测(即,运行完整的更改检测检查),请ApplicationRef.tick()改用。(我ApplicationRef.tick()在 plunker 的评论中调用了 。)请注意,调用tick()将导致ngDoCheck()被调用。

@Mark Rajcok 我认为您应该使用 [ngModel] 而不是 [value] ,因为 [value] 不会更新输入值。
2021-03-12 01:37:14
我们什么时候需要取消订阅以防止内存泄漏?
2021-03-20 01:37:14
@MarkRajcok 我相信您在回答中描述的 CD 问题已由github.com/angular/zone.js/pull/843解决
2021-03-26 01:37:14
@slanden 是的,根据netbasal.com/when-to-unsubscribe-in-angular-d61c6b21bad3,我们应该取消.fromEvent()订阅
2021-04-06 01:37:14
是否有任何通用的去抖动方法(例如应用于窗口调整大小事件)?
2021-04-09 01:37:14

如果您不想处理@angular/forms,您可以使用Subject带有更改绑定的 RxJS

视图.component.html

<input [ngModel]='model' (ngModelChange)='changed($event)' />

视图.component.ts

import { Subject } from 'rxjs/Subject';
import { Component }   from '@angular/core';
import 'rxjs/add/operator/debounceTime';

export class ViewComponent {
    model: string;
    modelChanged: Subject<string> = new Subject<string>();

    constructor() {
        this.modelChanged
            .debounceTime(300) // wait 300ms after the last event before emitting last event
            .distinctUntilChanged() // only emit if value is different from previous value
            .subscribe(model => this.model = model);
    }

    changed(text: string) {
        this.modelChanged.next(text);
    }
}

这确实会触发更改检测。对于不触发更改检测的方法,请查看 Mark 的答案。


更新

.pipe(debounceTime(300), distinctUntilChanged()) 需要 rxjs 6。

例子:

   constructor() {
        this.modelChanged.pipe(
            debounceTime(300), 
            distinctUntilChanged())
            .subscribe(model => this.model = model);
    }
你认为我们需要在 OnDestroy 上取消订阅或做其他事情吗?
2021-03-29 01:37:14
.pipe(debounceTime(300), distinctUntilChanged()) 需要 rxjs 6
2021-04-02 01:37:14
工作完美,简单明了,不涉及任何形式。我在 Angular 4.1.3,rxjs 5.1.1
2021-04-04 01:37:14
我认为这是一个很好的解决方案,因为它可以在需要时选择使用表单,但消除了这种依赖性,使实现变得更加简单。谢谢。
2021-04-04 01:37:14
我更喜欢这个解决方案!使用 angular 2.0.0, rxjs 5.0.0-beta 12
2021-04-05 01:37:14

由于该主题很旧,因此大多数答案不适用于Angular 6/7/8/9/10和/或使用其他库。
所以这是一个简短而简单的 Angular 6+ 和 RxJS 解决方案。

首先导入必要的东西:

import { Component, OnInit, OnDestroy } from '@angular/core';
import { Subject, Subscription } from 'rxjs';
import { debounceTime, distinctUntilChanged } from 'rxjs/operators';

实施ngOnInitngOnDestroy

export class MyComponent implements OnInit, OnDestroy {
  public notesText: string;
  public notesModelChanged: Subject<string> = new Subject<string>();
  private notesModelChangeSubscription: Subscription

  constructor() { }

  ngOnInit() {
    this.notesModelChangeSubscription = this.notesModelChanged
      .pipe(
        debounceTime(2000),
        distinctUntilChanged()
      )
      .subscribe(newText => {
        this.notesText = newText;
        console.log(newText);
      });
  }

  ngOnDestroy() {
    this.notesModelChangeSubscription.unsubscribe();
  }
}

使用这种方式:

<input [ngModel]='notesText' (ngModelChange)='notesModelChanged.next($event)' />

PS 对于更复杂和有效的解决方案,您可能仍想查看其他答案。

@JustShadow 谢谢!这真的很有帮助。
2021-03-27 01:37:14
真奇怪。在我这边它仍然可以正常工作。您能否分享更多信息,或者为此提出一个新问题?
2021-04-04 01:37:14
这在第一次尝试时很完美。但是当我以某种方式删除搜索到的文本时,下一个请求需要很长时间才能响应。
2021-04-10 01:37:14

它可以作为指令实施

import { Directive, Input, Output, EventEmitter, OnInit, OnDestroy } from '@angular/core';
import { NgControl } from '@angular/forms';
import 'rxjs/add/operator/debounceTime';
import 'rxjs/add/operator/distinctUntilChanged';
import { Subscription } from 'rxjs';

@Directive({
  selector: '[ngModel][onDebounce]',
})
export class DebounceDirective implements OnInit, OnDestroy {
  @Output()
  public onDebounce = new EventEmitter<any>();

  @Input('debounce')
  public debounceTime: number = 300;

  private isFirstChange: boolean = true;
  private subscription: Subscription;

  constructor(public model: NgControl) {
  }

  ngOnInit() {
    this.subscription =
      this.model.valueChanges
        .debounceTime(this.debounceTime)
        .distinctUntilChanged()
        .subscribe(modelValue => {
          if (this.isFirstChange) {
            this.isFirstChange = false;
          } else {
            this.onDebounce.emit(modelValue);
          }
        });
  }

  ngOnDestroy() {
    this.subscription.unsubscribe();
  }

}

像使用它一样

<input [(ngModel)]="value" (onDebounce)="doSomethingWhenModelIsChanged($event)">

组件样本

import { Component } from "@angular/core";

@Component({
  selector: 'app-sample',
  template: `
<input[(ngModel)]="value" (onDebounce)="doSomethingWhenModelIsChanged($event)">
<input[(ngModel)]="value" (onDebounce)="asyncDoSomethingWhenModelIsChanged($event)">
`
})
export class SampleComponent {
  value: string;

  doSomethingWhenModelIsChanged(value: string): void {
    console.log({ value });
  }

  async asyncDoSomethingWhenModelIsChanged(value: string): Promise<void> {
    return new Promise<void>(resolve => {
      setTimeout(() => {
        console.log('async', { value });
        resolve();
      }, 1000);
    });
  }
} 
更多的进口,这对我有用: import "rxjs/add/operator/debounceTime"; 导入“rxjs/add/operator/distinctUntilChanged”;
2021-03-18 01:37:14
在 Angular 8 和 rxjs 6.5.2 中工作,但有以下变化。如果要使用管道语法,请更改以下内容:import 'rxjs/add/operator/debounceTime'; import 'rxjs/add/operator/distinctUntilChanged';toimport { debounceTime, distinctUntilChanged } from 'rxjs/operators';this.model.valueChanges .debounceTime(this.debounceTime) .distinctUntilChanged()tothis.model.valueChanges .pipe( debounceTime(this.debounceTime), distinctUntilChanged() )
2021-03-23 01:37:14
到目前为止,这使得在应用程序范围内实现它是最简单的
2021-03-27 01:37:14
在 Angular 9 和 rxjs 6.5.4 中工作,@kumaheiyama 在他的评论中进行了更改。只是不要忘记在您创建它的module中导出指令。并且不要忘记将您在其中创建该指令的module包含在您使用它的module中。
2021-03-27 01:37:14
isFirstChange 用于在初始化时不发出
2021-04-11 01:37:14

不能像 angular1 那样直接访问,但你可以轻松地使用 NgFormControl 和 RxJS observables:

<input type="text" [ngFormControl]="term"/>

this.items = this.term.valueChanges
  .debounceTime(400)
  .distinctUntilChanged()
  .switchMap(term => this.wikipediaService.search(term));

这篇博文解释清楚:http : //blog.thoughtram.io/angular/2016/01/06/taking-advantage-of-observables-in-angular2.html

这是一个自动完成,但它适用于所有场景。

但是服务出现错误,这不会再次运行
2021-03-13 01:37:14
我不明白这个例子。[...] 是单向目标绑定。为什么可以通知容器valueChanges不应该是…… 喜欢(ngFormControl)="..."
2021-03-28 01:37:14