Tôi làm cách nào để chuyển các thông báo xác thực lớp dịch vụ cho người gọi?

Question

Tôi đã thực hiện rất nhiều nghiên cứu, bao gồm cả ở đây trên SO, và tôi dường như không thể tìm thấy hướng rõ ràng. Tôi hiện đang có một ứng dụng ASP.NET MVC3, với một lớp dịch vụ nằm trên đầu trang của một kho lưu trữ.

Trong lớp dịch vụ của tôi, tôi có các chức năng như:

public class MyService{ 

    public void CreateDebitRequest(int userId, int cardId, decimal Amount, ....) 
    { 
    //perform some sort of validation on parameters, save to database 
    } 

    public void CreateCreditRequest(.....) 
    } 
     //perform some sort of validation on parameters, save to database 
    } 

    public void CreateBatchFile() 
    { 
     //construct a file using a semi-complex process which could fail 
     //write the file to the server, which could fail 
    } 


    public PaymentTransaction ChargePaymentCard(int paymentCardId, decimal amount) 
    { 
     //validate customer is eligible for amount, call 3rd party payments api call, 
     //...save to database, other potential failures, etc. 
    } 

} 

tôi đã nhìn thấy người ta nói rằng xác nhận tham số không phải là rất đặc biệt, và do đó ném một ngoại lệ không phải là rất phù hợp. Tôi cũng không thích ý tưởng đi qua trong một paramater ra, chẳng hạn như một chuỗi, và kiểm tra cho một giá trị sản phẩm nào. Tôi đã xem xét việc triển khai lớp ValidationDictionary và biến nó thành thuộc tính của bất kỳ lớp dịch vụ nào (nó có chứa một boolean IsValid, và Danh sách các thông báo lỗi, và có thể được kiểm tra sau bất kỳ cuộc gọi hàm nào trong lớp dịch vụ để xem cách mọi thứ đã đi). Tôi có thể kiểm tra tình trạng ValidationDictionary sau khi chạy bất kỳ chức năng đưa ra:

var svc = new MyService(); 
svc.CreateBatchFile(); 
if (svc.ValidationDictionary.IsValid) 
    //proceed 
else 
    //display values from svc.ValidationDictionary.Messages... 

Điều tôi không thích về vấn đề này là tôi sẽ phải cập nhật nó cho mỗi lớp dịch vụ cuộc gọi chức năng, để tránh việc nó giữ lại giá trị cũ (nếu tôi chọn không sử dụng nó cho nhiều hoặc nhiều chức năng nhất, người ta vẫn mong đợi nó có một giá trị có ý nghĩa hoặc vô giá trị sau khi chạy bất kỳ hàm nào đã cho). Một điều tôi đã xem xét là đi qua trong ValidationDictionary cho mỗi cuộc gọi chức năng có thể có thông tin xác thực chi tiết, nhưng sau đó tôi trở lại để sử dụng một tham số ...

Bạn có đề xuất nào không? Tôi dường như không thể tìm ra cách làm sạch nào. Đôi khi trả về null cho một hàm là đủ thông tin, nhưng đôi khi tôi muốn có thêm một ít thông tin xác thực được truyền lại cho người gọi. Lời khuyên nào sẽ được đánh giá cao!

Chỉnh sửa để làm rõ: Lớp dịch vụ của tôi không biết rằng đó là ứng dụng MVC đang sử dụng nó. Tầng dịch vụ chỉ có một số chức năng công cộng nhất định như CreateBatchFile() hoặc AddDebitRequest(). Đôi khi trả về null là đủ cho người tiêu dùng (trong trường hợp này là bộ điều khiển, nhưng có thể là cái gì đó khác) để biết điều gì đã xảy ra, và đôi khi người tiêu dùng muốn thêm một số thông tin từ lớp dịch vụ (có thể chuyển sang ModelState nếu người tiêu dùng một bộ điều khiển). Làm cách nào để tôi tự động điều này lên từ chính lớp dịch vụ?

Answer 1

Tôi đã sử dụng một hệ thống mà nó đang truyền một mảng thông điệp (hoặc tập hợp các lớp), mỗi phần tử có mã, mô tả, thông điệp thân thiện. Chúng tôi chỉ đơn giản là kiểm tra xem có gì ở đó không. Nó hoạt động tốt giữa UI và một lớp "dịch vụ" khác, tất cả ngoại lệ đều được phát hiện độc đáo, chúng được dịch thành các quy tắc xác nhận này ... chỉ cần một ý tưởng

Answer 2

Sử dụng các đối tượng ViewModel được truyền giữa các phương thức Views và Controller. Các đối tượng ViewModel có thể xử lý xác nhận bằng phương thức Validate(ValidationDictionary validationDictionary).

Bộ điều khiển sẽ phải gọi phương thức Xác thực trên đối tượng ViewModel trước khi gọi bất kỳ phương thức nào trong lớp dịch vụ. Điều này chỉ cần thiết cho các hành động http POST.

Lượt xem của bạn sau đó sẽ phải hiển thị thông báo xác thực.

Giải pháp này yêu cầu các đối tượng viewmodel được truyền giữa hành động điều khiển và khung nhìn, nhưng hiện nay chủ yếu được xử lý bởi ModelBinder trong MVC.

điều khiển của bạn (http bưu điện) hành động này sẽ giống như thế này:

[HttpPost] 
public ActionResult Foo(BarViewModel viewModel) 
{ 
    viewModel.Validate(ValidationDictionary); 

    if (!ModelState.IsValid) 
    { 
     return View(viewModel); 
    } 

    // Calls to servicelayer 
} 

phương pháp Validate của bạn trong ViewModel của bạn sẽ trông như thế này:

public void Validate(ValidationDictionary validationDictionary) 
{ 
    if (SomeProperty.Length > 30) 
    { 
     validationDictionary.AddError("SomeProperty", "Max length is 30 chars"); 
    } 
} 

Answer 3

Đây là những gì tôi làm. Có một lớp để xác thực của bạn và thay vì truyền các tham số, hãy vượt qua một mô hình khung nhìn. Vì vậy, trong trường hợp một cái gì đó của bạn như thế này, nơi ValidationResult chỉ là một lớp đơn giản w MemberName và ErrorMessage tính /:

public class DebitRequestValidator{ 

    public IEnumerable<ValidationResult> Validate(DebitRequestModel model){ 

    //do some validation 
    yield return new ValidationResult { 
     MemberName = "cardId", 
     ErrorMessage = "Invalid CardId." 
    } 
    } 

}

Sau đó, tạo ra một phương pháp mở rộng điều khiển để sao chép các kết quả này xác nhận lại tình trạng mô hình.

public static class ControllerExtensions 
{ 
    public static void AddModelErrors(this ModelStateDictionary modelState, IEnumerable<ValidationResult> validationResults) 
    { 
     if (validationResults == null) return; 

     foreach (var validationResult in validationResults) 
     { 
      modelState.AddModelError(validationResult.MemberName, validationResult.ErrorMessage); 
     } 
    } 
} 

Sau đó, trong điều khiển của bạn làm điều gì đó như

[HttpPost] 
public ActionResult DebitRequest(DebitRequestModel model) { 
    var validator = new DebitRequestValidator(); 
    var results = validator.Validate(model); 
    ModelState.AddModelErrors(results); 
    if (!ModelState.IsValid) 
    return View(model) 

    //else do other stuff here 
} 

Sau đó, theo quan điểm của bạn, bạn có thể hiển thị lỗi như bình thường.

@Html.ValidationMessageFor(m => m.CardId) 

Answer 4

Nếu bạn chỉ cần làm ViewModel Validation, FluentValidation là một thư viện tuyệt vời.

Nếu bạn muốn bao gồm xác thực doanh nghiệp làm phản hồi cho người dùng, bạn có thể sử dụng mẫu bộ điều hợp, mẫu này sẽ cung cấp cho bạn những gì bạn muốn.

Tạo giao diện (IValidationDictionary hoặc tương tự). Giao diện này sẽ định nghĩa một phương thức AddError và sẽ được chuyển tới dịch vụ của bạn để thêm các thông báo lỗi.

public interface IValidationDictionary 
{ 
    void AddError(string key, string errorMessage); 
} 

Tạo ModelStateAdapter cho ứng dụng mvc của bạn.

public class ModelStateAdapter : IValidationDictionary 
{ 
    private ModelStateDictionary _modelState; 

    public ModelStateAdapter(ModelStateDictionary modelState) 
    { 
     _modelState = modelState; 
    } 

    public void AddError(string key, string errorMessage) 
    { 
     _modelState.AddModelError(key, errorMessage); 
    } 
} 

cuộc gọi dịch vụ của bạn cần xác nhận sẽ yêu cầu các IValidationDictionary

public class MyService 
    {   
     public void CreateDebitRequest(int userId, int cardId, decimal Amount, .... , IValidationDictionary validationDictionary) 
      { 
       if(userId == 0) 
        validationDictionary.AddError("UserId", "UserId cannot be 0"); 
      } 
    } 

Sau đó bạn sẽ có một sự phụ thuộc vào IValidationDictionary nhưng không phải trên MVC mà cũng sẽ làm cho giải pháp của bạn kiểm chứng.

Nếu bạn cần triển khai các dịch vụ trong ứng dụng không có ModelStateDictionary, bạn sẽ chỉ triển khai giao diện IValidationDictionary trên lớp được sử dụng để giữ lỗi của bạn.

khiển dụ:

public ActionResult Test(ViewModel viewModel) 
{ 
    var modelStateAdapter = new ModelStateAdapter(ModelState); 
    _serviceName.CreateDebitRequest(viewModel.UserId, viewModel.CardId, ... , modelStateAdapter); 

    if(ModelState.IsValid) 
     return View("Success") 

    return View(viewModel); 
} 

Pro của phương pháp này:

• Không phụ thuộc vào các thư viện gọi
• Có thể thử các IValidationDictionary để kiểm tra.

Con của phương pháp này:

• Bạn cần phải vượt qua IValidationDictionary cho mọi phương pháp mà bạn muốn làm xác nhận trên đó sẽ được trả lại cho người dùng.

  Hoặc

  bạn cần phải khởi từ điển xác nhận của dịch vụ (nếu bạn quyết định có IValidationDictionary như một lĩnh vực tư nhân), trong mỗi hành động điều khiển bạn muốn xác nhận đối với.