通知

例：ウィンドウのエラーチェック（C＃）

図1には、保険金請求を判断するために送信する単純なフォームがあります。送信するデータは3つあります。保険証券番号（文字列）、請求の種類（ピックリストからのテキスト）、および事故の日付（DateTime）です。

データが単純であれば、有効性チェックを待ってください。

• 3つのデータが欠落していないこと（文字列の場合はnullまたは空白）を確認します。
• 保険証券番号がデータストアに存在することを確認します。
• 事故の日付が保険証券の開始日以降であることを確認します。

できるだけ多くの情報をユーザーに返したいので、合理的に複数のエラーを検出できる場合は、そうする必要があります。

ドメイン層から説明を始めます。ドメインロジックへの基本的なインターフェースは、サービ スレイヤーにあります。

クラス ClaimService...

  public void RegisterClaim (RegisterClaimDTO claim) {
    RegisterClaim cmd = new RegisterClaim(claim);
    cmd.Run();
  }

このメソッドは、コマンドオブジェクトを作成して実行し、実際の作業を行います。メソッドコールサービ スレイヤーの背後にコマンドオブジェクトをラップすると、サーバーAPIを簡素化し、リモートファサードを構築しやすくなります。

データを転送するために、データ転送オブジェクトを使用します。RegisterClaimDTOには、メインデータが含まれています。

RegisterClaimDTO：DataTransferObject

  private string _policyID;
  private string _Type;
  private DateTime _incidentDate = BLANK_DATE;

  public string PolicyId {
    get { return _policyID; }
    set { _policyID = value; }
  }
  public string Type {
    get { return _Type; }
    set { _Type = value; }
  }
  public DateTime IncidentDate {
    get { return _incidentDate; }
    set { _incidentDate = value; }
  }

DataTransferObjectは、すべてのDTOのレイヤースーパータイプです。これには、インタラクションに付随する通知を作成してアクセスするための一般的なコードが含まれています。

クラス DataTransferObject...

  private Notification _notification = new Notification();
  public Notification Notification {
    get { return _notification; }
    set { _notification = value; }
  }

通知クラスは、ドメイン層でエラーをキャプチャするために使用するものです。本質的には、エラーのコレクションであり、それぞれが文字列の単純なラッパーです。

クラス Notification...

  private IList _errors = new ArrayList();

  public IList Errors {
    get { return _errors; }
    set { _errors = value; }
  }
  public bool HasErrors {
    get {return 0 != Errors.Count;}      
  }

クラス Notification.Error

  private string message;
  public Error(string message) {
    this.message = message;
  }

コマンドのrunメソッドは非常にシンプルです。

クラス RegisterClaim：ServerCommand...

  public RegisterClaim(RegisterClaimDTO claim) : base(claim) {}
  public void Run() {
    Validate();
    if (!notification.HasErrors)
      RegisterClaimInBackendSystems();    
  }

ここでも、レイヤースーパータイプは、DTOを格納し、通知にアクセスするための一部の一般的な機能を提供します。

クラス ServerCommand...

  public ServerCommand(DataTransferObject data){
    this._data = data;
  }
  protected DataTransferObject _data;
  protected Notification notification {
    get {return _data.Notification;}
  }

validateメソッドは、上記で説明した検証を実行します。本質的に、一連の条件チェックを実行し、何かが失敗した場合に通知にエラーを追加するだけです。

クラス RegisterClaim...

  private void Validate() {
    failIfNullOrBlank(Data.PolicyId, RegisterClaimDTO.MISSING_POLICY_NUMBER);
    failIfNullOrBlank(Data.Type, RegisterClaimDTO.MISSING_INCIDENT_TYPE);
    fail (Data.IncidentDate == RegisterClaimDTO.BLANK_DATE, RegisterClaimDTO.MISSING_INCIDENT_DATE);
    if (isNullOrBlank(Data.PolicyId)) return;
    Policy policy = FindPolicy(Data.PolicyId);
    if (policy == null) {
      notification.Errors.Add(RegisterClaimDTO.UNKNOWN_POLICY_NUMBER);
    }
    else {
      fail ((Data.IncidentDate.CompareTo(policy.InceptionDate) < 0), 
            RegisterClaimDTO.DATE_BEFORE_POLICY_START);
    }
  }

これのほとんどで最も複雑なことは、特定の検証チェックは、他のチェックが失敗していない場合にのみ意味があることです。これは、validateメソッドの条件付きロジックにつながります。より現実的なサイズのメソッドでは、それらをより小さなチャンクに分割することが重要です。

検証の一般的なジェネリックビットは、レイヤースーパータイプから抽出（および配置）できます。

protected bool isNullOrBlank(String s) {
  return (s == null || s == "");
}
protected void failIfNullOrBlank (string s, Notification.Error error) {
  fail (isNullOrBlank(s), error);
}
protected void fail(bool condition, Notification.Error error) {
  if (condition) notification.Errors.Add(error);
}

通知の最も単純な形式のエラーは、文字列をエラーメッセージとして使用することです。少なくとも最小限のラッピング、単純なエラークラスの定義、およびDTOでのインタラクションの固定エラーリストの定義を好みます。

クラス RegisterClaimDTO...

  public static Notification.Error MISSING_POLICY_NUMBER = new Notification.Error("Policy number is missing");
  public static Notification.Error UNKNOWN_POLICY_NUMBER = new Notification.Error("This policy number is unknown");
  public static Notification.Error MISSING_INCIDENT_TYPE = new Notification.Error("Incident type is missing");
  public static Notification.Error MISSING_INCIDENT_DATE = new Notification.Error("Incident Date is missing");
  public static Notification.Error DATE_BEFORE_POLICY_START 
    = new Notification.Error("Incident Date is before we started doing this business");

階層間で通信している場合は、エラーにIDフィールドを追加して、エラーが回線を介してシリアル化されているときに比較が正しく機能するようにする必要がある場合があります。

それは、ドメイン層のすべての興味深い動作とほぼ同じです。プレゼンテーションには、自律ビューを使用します。対象の動作は、送信ボタンが押されたときに発生します。

クラス FrmRegisterClaim...

  RegisterClaimDTO claim;
  public void Submit() {
    saveToClaim();
    service.RegisterClaim(claim);
    if (claim.Notification.HasErrors) {
      txtResponse.Text = "Not registered, see errors";
      indicateErrors();
    }
    else txtResponse.Text = "Registration Succeeded";
  }
  private void saveToClaim() {
    claim = new RegisterClaimDTO();
    claim.PolicyId = txtPolicyNumber.Text;
    claim.IncidentDate = pkIncidentDate.Value;
    claim.Type = (string) cmbType.SelectedItem;
  }

このメソッドは、コントロールから情報を引き出してDTOに入力し、データをドメイン層に送信します。返されるDTOにエラーが含まれている場合は、それらを表示する必要があります。

クラス FrmRegisterClaim...

  private void indicateErrors() {
    checkError(RegisterClaimDTO.MISSING_POLICY_NUMBER, txtPolicyNumber);
    checkError(RegisterClaimDTO.MISSING_INCIDENT_TYPE, cmbType);
    checkError(RegisterClaimDTO.DATE_BEFORE_POLICY_START, pkIncidentDate);
    checkError(RegisterClaimDTO.MISSING_INCIDENT_DATE, pkIncidentDate);
    checkError(RegisterClaimDTO.DATE_BEFORE_POLICY_START, pkIncidentDate);
  }
  private void checkError (Notification.Error error, Control control) {
    if (claim.Notification.IncludesError(error)) 
      showError(control, error.ToString());
  }

ここでは、DTOで定義されているエラーを使用して、それらをフォームのフィールドにマッピングしているため、正しいフィールドに正しいエラーが表示されます。

エラーを実際に表示するには、.NETに付属する標準のエラープロバイダーを使用します。これは、問題のあるフィールドの横にエラーアイコンと、問題の原因となっているエラーメッセージを表示するツールチップを表示します。

クラス FrmRegisterClaim...

  private ErrorProvider errorProvider = new ErrorProvider();
  void showError (Control arg, string message) {
    errorProvider.SetError(arg, message);
  }

フィールドの内容が変更された場合は、エラー情報をクリアします。

クラス FrmRegisterClaim...

  void clearError (Control arg) {
    errorProvider.SetError(arg, null);
  }
  private void txtPolicyNumber_TextChanged(object sender, EventArgs e) {
    clearError((Control)sender);
  }
  private void cmbType_TextChanged(object sender, EventArgs e) {
    clearError((Control)sender);
  }
  private void pkIncidentDate_ValueChanged(object sender, EventArgs e) {
    clearError((Control)sender);    
  }