Angular 2FormGroupからすべての検証エラーを取得します

92

このコードを考えると：

this.form = this.formBuilder.group({
      email: ['', [Validators.required, EmailValidator.isValid]],
      hasAcceptedTerms: [false, Validators.pattern('true')]
    });

からすべての検証エラーを取得するにはどうすればよいthis.formですか？

単体テストを作成していて、実際の検証エラーをアサートメッセージに含めたいと思います。

angular  typescript  validation 
— EagleBeak
ソース
Validators.pattern（ 'true'）の代わりに、Validators.requiredTrueを使用して、チェックボックスをオンにすることができます。
— ボイド

回答:

146

私は同じ問題に遭遇し、すべての検証エラーを見つけて表示するために、次のメソッドを作成しました。

getFormValidationErrors() {
  Object.keys(this.productForm.controls).forEach(key => {

  const controlErrors: ValidationErrors = this.productForm.get(key).errors;
  if (controlErrors != null) {
        Object.keys(controlErrors).forEach(keyError => {
          console.log('Key control: ' + key + ', keyError: ' + keyError + ', err value: ', controlErrors[keyError]);
        });
      }
    });
  }

フォーム名productFormはあなたのものに変更する必要があります。

これは次のように機能し{[p: string]: AbstractControl}ます。フォームからすべてのコントロールをフォーマットで取得し、エラーの詳細を取得するために各エラーキーで繰り返します。nullエラー値をスキップします。

テンプレートビューに検証エラーを表示するように変更することもできますconsole.log(..)。必要なものに置き換えるだけです。

— アレックスエフィモフ
ソース
2
同じパターンでFormArrayの上記のメソッドを拡張するにはどうすればよいですか？
— Mohammad Sharaf Ali
の' + controlErrors[keyErrors];代わりに意味しました', controlErrors[keyErrors];か？
— ryanm
@ryanmいいえ、オブジェクトや文字列値のような印刷には違いがあります。
— Alex Efimov 2018
どこからAngular2にインポートできValidationErrorsますか？
— sainu
import { ValidationErrors } from '@angular/forms';
— クレイグウェイン
31

これはFormGroup内部サポートを備えたソリューションです（ここのように）

テスト済み：Angular 4.3.6

get-form-validation-errors.ts

import { AbstractControl, FormGroup, ValidationErrors } from '@angular/forms';

export interface AllValidationErrors {
  control_name: string;
  error_name: string;
  error_value: any;
}

export interface FormGroupControls {
  [key: string]: AbstractControl;
}

export function getFormValidationErrors(controls: FormGroupControls): AllValidationErrors[] {
  let errors: AllValidationErrors[] = [];
  Object.keys(controls).forEach(key => {
    const control = controls[ key ];
    if (control instanceof FormGroup) {
      errors = errors.concat(getFormValidationErrors(control.controls));
    }
    const controlErrors: ValidationErrors = controls[ key ].errors;
    if (controlErrors !== null) {
      Object.keys(controlErrors).forEach(keyError => {
        errors.push({
          control_name: key,
          error_name: keyError,
          error_value: controlErrors[ keyError ]
        });
      });
    }
  });
  return errors;
}

例を使用して：

if (!this.formValid()) {
  const error: AllValidationErrors = getFormValidationErrors(this.regForm.controls).shift();
  if (error) {
    let text;
    switch (error.error_name) {
      case 'required': text = `${error.control_name} is required!`; break;
      case 'pattern': text = `${error.control_name} has wrong pattern!`; break;
      case 'email': text = `${error.control_name} has wrong email format!`; break;
      case 'minlength': text = `${error.control_name} has wrong length! Required length: ${error.error_value.requiredLength}`; break;
      case 'areEqual': text = `${error.control_name} must be equal!`; break;
      default: text = `${error.control_name}: ${error.error_name}: ${error.error_value}`;
    }
    this.error = text;
  }
  return;
}
— MixerOID
ソース
1
Angular5の変更-constcontrolErrors：ValidationErrors = form.controls [key] .errors;
— Kris Kilton 2018
提案は上truthyをチェックするためcontrolErrors 、すなわちif (controlErrors) {だけをチェックするとnullエラーがされた場合にエラーが発生しますundefined
— mtholen
8

これは、エラーを再帰的に収集し、lodash（ES6のみ）のような外部ライブラリに依存しない別のバリアントです。

function isFormGroup(control: AbstractControl): control is FormGroup {
  return !!(<FormGroup>control).controls;
}

function collectErrors(control: AbstractControl): any | null {
  if (isFormGroup(control)) {
    return Object.entries(control.controls)
      .reduce(
        (acc, [key, childControl]) => {
          const childErrors = collectErrors(childControl);
          if (childErrors) {
            acc = {...acc, [key]: childErrors};
          }
          return acc;
        },
        null
      );
  } else {
    return control.errors;
  }
}
— AndreasKlöber
ソース
6

Angularフォームからすべてのエラーを取得する再帰的な方法。任意の種類の処方集構造を作成した後、フォームからすべてのエラーを取得する方法はありません。これは、デバッグの目的だけでなく、それらのエラーのプロットにも非常に役立ちます。

Angular9のテスト済み

getFormErrors(form: AbstractControl) {
    if (form instanceof FormControl) {
        // Return FormControl errors or null
        return form.errors ?? null;
    }
    if (form instanceof FormGroup) {
        const groupErrors = form.errors;
        // Form group can contain errors itself, in that case add'em
        const formErrors = groupErrors ? {groupErrors} : {};
        Object.keys(form.controls).forEach(key => {
            // Recursive call of the FormGroup fields
            const error = this.getFormErrors(form.get(key));
            if (error !== null) {
                // Only add error if not null
                formErrors[key] = error;
            }
        });
        // Return FormGroup errors or null
        return Object.keys(formErrors).length > 0 ? formErrors : null;
    }
}
— ArnauTG
ソース
私はAngular7を使用しform.errors ?? nullていて、コードに2つの変更を加えました。??を削除する必要がありました。コンパイルするために。さらに重要なことに、FormGroupチェック条件で|| formParameter instanceof FormArray、アプリケーションを実際に開いたものを追加しました。ありがとう！
— タイラーフォーサイス
6

または、このライブラリを使用して、深く動的なフォームからでもすべてのエラーを取得できます。 

npm i @naologic/forms

独自のフォームで静的関数を使用する場合

import {NaoFormStatic} from '@naologic/forms';
...
const errorsFlat = NaoFormStatic.getAllErrorsFlat(fg); 
console.log(errorsFlat);

使用したいNaoFromGroup場合はインポートして使用できます

import {NaoFormGroup, NaoFormControl, NaoValidators} from '@naologic/forms';
...
    this.naoFormGroup = new NaoFormGroup({
      firstName: new NaoFormControl('John'),
      lastName: new NaoFormControl('Doe'),
      ssn: new NaoFormControl('000 00 0000', NaoValidators.isSSN()),
    });

   const getFormErrors = this.naoFormGroup.getAllErrors();
   console.log(getFormErrors);
   // --> {first: {ok: false, isSSN: false, actualValue: "000 00 0000"}}

完全なドキュメントを読む

— Pian0_M4n
ソース
2

@MixerOIDの応答に基づいて、コンポーネントとしての最終的なソリューションを次に示します（ライブラリを作成する可能性があります）。FormArrayもサポートしています。

import {Component, ElementRef, Input, OnInit} from '@angular/core';
import {FormArray, FormGroup, ValidationErrors} from '@angular/forms';
import {TranslateService} from '@ngx-translate/core';

interface AllValidationErrors {
  controlName: string;
  errorName: string;
  errorValue: any;
}

@Component({
  selector: 'app-form-errors',
  templateUrl: './form-errors.component.html',
  styleUrls: ['./form-errors.component.scss']
})
export class FormErrorsComponent implements OnInit {

  @Input() form: FormGroup;
  @Input() formRef: ElementRef;
  @Input() messages: Array<any>;

  private errors: AllValidationErrors[];

  constructor(
    private translateService: TranslateService
  ) {
    this.errors = [];
    this.messages = [];
  }

  ngOnInit() {
    this.form.valueChanges.subscribe(() => {
      this.errors = [];
      this.calculateErrors(this.form);
    });

    this.calculateErrors(this.form);
  }

  calculateErrors(form: FormGroup | FormArray) {
    Object.keys(form.controls).forEach(field => {
      const control = form.get(field);
      if (control instanceof FormGroup || control instanceof FormArray) {
        this.errors = this.errors.concat(this.calculateErrors(control));
        return;
      }

      const controlErrors: ValidationErrors = control.errors;
      if (controlErrors !== null) {
        Object.keys(controlErrors).forEach(keyError => {
          this.errors.push({
            controlName: field,
            errorName: keyError,
            errorValue: controlErrors[keyError]
          });
        });
      }
    });

    // This removes duplicates
    this.errors = this.errors.filter((error, index, self) => self.findIndex(t => {
      return t.controlName === error.controlName && t.errorName === error.errorName;
    }) === index);
    return this.errors;
  }

  getErrorMessage(error) {
    switch (error.errorName) {
      case 'required':
        return this.translateService.instant('mustFill') + ' ' + this.messages[error.controlName];
      default:
        return 'unknown error ' + error.errorName;
    }
  }
}

そしてHTML：

<div *ngIf="formRef.submitted">
  <div *ngFor="let error of errors" class="text-danger">
    {{getErrorMessage(error)}}
  </div>
</div>

使用法：

<app-form-errors [form]="languageForm"
                 [formRef]="formRef"
                 [messages]="{language: 'Language'}">
</app-form-errors>
— ismaestro
ソース
2

これを試してください、それはフォームのすべてのコントロールの検証を呼び出します：

validateAllFormControl(formGroup: FormGroup) {         
  Object.keys(formGroup.controls).forEach(field => {  
    const control = formGroup.get(field);             
    if (control instanceof FormControl) {             
      control.markAsTouched({ onlySelf: true });
    } else if (control instanceof FormGroup) {        
      this.validateAllFormControl(control);            
    }
  });
}
— マユールドンレ
ソース
1 
export class GenericValidator {
    constructor(private validationMessages: { [key: string]: { [key: string]: string } }) {
    }

processMessages(container: FormGroup): { [key: string]: string } {
    const messages = {};
    for (const controlKey in container.controls) {
        if (container.controls.hasOwnProperty(controlKey)) {
            const c = container.controls[controlKey];
            if (c instanceof FormGroup) {
                const childMessages = this.processMessages(c);
                // handling formGroup errors messages
                const formGroupErrors = {};
                if (this.validationMessages[controlKey]) {
                    formGroupErrors[controlKey] = '';
                    if (c.errors) {
                        Object.keys(c.errors).map((messageKey) => {
                            if (this.validationMessages[controlKey][messageKey]) {
                                formGroupErrors[controlKey] += this.validationMessages[controlKey][messageKey] + ' ';
                            }
                        })
                    }
                }
                Object.assign(messages, childMessages, formGroupErrors);
            } else {
                // handling control fields errors messages
                if (this.validationMessages[controlKey]) {
                    messages[controlKey] = '';
                    if ((c.dirty || c.touched) && c.errors) {
                        Object.keys(c.errors).map((messageKey) => {
                            if (this.validationMessages[controlKey][messageKey]) {
                                messages[controlKey] += this.validationMessages[controlKey][messageKey] + ' ';
                            }
                        })
                    }
                }
            }
        }
    }
    return messages;
}
}

私はそれをデボラクから取り、少し修正しました。

— バンガッシュ
ソース
1 
// IF not populated correctly - you could get aggregated FormGroup errors object
let getErrors = (formGroup: FormGroup, errors: any = {}) {
  Object.keys(formGroup.controls).forEach(field => {
    const control = formGroup.get(field);
    if (control instanceof FormControl) {
      errors[field] = control.errors;
    } else if (control instanceof FormGroup) {
      errors[field] = this.getErrors(control);
    }
  });
  return errors;
}

// Calling it:
let formErrors = getErrors(this.form);
— ウロスレート
ソース
0

this.form.errorsプロパティを反復処理できます。

— unsafePtr
ソース
14
私は推測するthis.form.errorsリターンの検証のエラーだけthis.formではないために、this.form.controls。FormGroupsとその子（FormGroups、FormControls、FormArraysの任意の数）を個別に検証できます。すべてのエラーをフェッチするには、再帰的に質問する必要があると思います。
— のRistoVälimäki
0

大きなFormGroupツリーの場合、lodashを使用してツリーをクリーンアップし、エラーのあるコントロールのみのツリーを取得できます。これは、子コントロールを繰り返し実行し（たとえば、を使用してallErrors(formGroup)）、完全に有効なコントロールのサブグループを削除することによって行われます。

private isFormGroup(control: AbstractControl): control is FormGroup {
  return !!(<FormGroup>control).controls;
}

// Returns a tree of any errors in control and children of control
allErrors(control: AbstractControl): any {
  if (this.isFormGroup(control)) {
    const childErrors = _.mapValues(control.controls, (childControl) => {
      return this.allErrors(childControl);
    });

    const pruned = _.omitBy(childErrors, _.isEmpty);
    return _.isEmpty(pruned) ? null : pruned;
  } else {
    return control.errors;
  }
}
— オレックス・ポノマレンコ
ソース
-2

私はAngular5を使用していますが、FormGroupを使用してフォームのステータスプロパティを簡単に確認できます。

this.form = new FormGroup({
      firstName: new FormControl('', [Validators.required, validateName]),
      lastName: new FormControl('', [Validators.required, validateName]),
      email: new FormControl('', [Validators.required, validateEmail]),
      dob: new FormControl('', [Validators.required, validateDate])
    });

this.form.statusは、すべてのフィールドがすべての検証ルールに合格しない限り、「INVALID」になります。

最良の部分は、リアルタイムで変更を検出することです。

— ガガン
ソース
1
はい私たちは全体formgroupのエラーを取得する必要があるだけでなく、知っているのではない有効な場合
— Motassem MK
OPには検証メッセージが必要ですが、これは単なるブール値であるため、statusプロパティには含まれていません。
— ステファン
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.