Question

我做了很多研究，包括SO，我似乎无法找到明确的方向。我目前有一个ASP.NET MVC3应用程序，其中一个服务层位于存储库之上。

在我的服务层中，我有以下功能：

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.
    }

}

我见过人们说参数验证不是很特别，因此抛出异常并不合适。我也不喜欢传递一个out-paramater的想法，比如一个字符串，并检查一个空值。我已经考虑过实现一个ValidationDictionary类，并使它成为任何给定服务类的属性（它将包含一个IsValid布尔值和一个错误消息列表，并且可以在服务层中的任何给定函数调用之后检查以查看如何事情发生了）。我可以在运行任何给定函数后检查ValidationDictionary状态：

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

我不喜欢这样的事情是我必须为每个服务层函数调用更新它，以避免它保留旧值（如果我选择不将它用于许多或大多数功能，那么仍然希望它在运行任何给定函数后具有有意义或空值。我考虑的另一件事是为每个可能有详细验证信息的函数调用传递ValidationDictionary，但后来我又回到了使用out参数......

你们有没有建议？我似乎无法弄清楚这样做的任何干净方式。有时为函数返回null是足够的信息，但有时我想将更多的验证信息传递回调用者。任何建议将不胜感激！

修改以澄清： 我的服务层不知道它是一个消耗它的MVC应用程序。服务层只有一些公共函数，如CreateBatchFile（）或AddDebitRequest（）。有时返回null足以让消费者（在这种情况下是控制器，但可能是其他东西）知道发生了什么，有时消费者会想要来自服务层的更多信息（如果消费者是，则可能传递给ModelState）控制器）。如何从服务层本身冒泡出来？

Answer 1

这就是我的工作。有一个类用于验证，而不是传递参数传递视图模型。所以在你的情况下是这样的，其中ValidationResult只是一个带有MemberName和ErrorMessage属性的简单类：

public class DebitRequestValidator{

  public IEnumerable<ValidationResult> Validate(DebitRequestModel model){

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

}

然后创建一个控制器扩展方法，将这些验证结果复制到模型状态。

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);
        }
    }
}

然后在您的控制器中执行类似

的操作

[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
}

然后在您的视图中，您可以显示正常的错误。

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

Answer 2

我使用了一个传递消息数组（或类集合）的系统，每个元素都有代码，描述和友好消息。我们过去只是检查是否有任何东西。它在UI和另一个“服务”层之间运行良好，所有异常都被很好地捕获，它们被翻译成这些验证规则......只是一个想法

Answer 3

使用在Views和Controller操作方法之间传递的ViewModel对象。 ViewModel对象可以通过Validate(ValidationDictionary validationDictionary)方法处理验证。

在调用服务层中的任何方法之前，控制器必须在ViewModel对象上调用Validate方法。这只应该是http POST操作所必需的。

您的观点必须显示验证消息。

此解决方案要求viewmodel对象在控制器操作和视图之间传递，但现在主要由MVC中的ModelBinder处理。

您的控制器（http post）操作将如下所示：

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

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

    // Calls to servicelayer
}

ViewModel中的Validate方法如下所示：

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

Answer 4

如果你只是在进行ViewModel验证， FluentValidation 是一个很棒的库。

如果您希望将业务验证作为反馈添加到用户，则可以使用适配器模式，它会为您提供所需内容。

创建一个接口（IValidationDictionary或类似的东西）。此接口将定义AddError方法，并将传递给您的服务以添加错误消息。

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

为您的mvc应用程序创建一个ModelStateAdapter。

public class ModelStateAdapter : IValidationDictionary
{
    private ModelStateDictionary _modelState;

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

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

您需要验证的服务电话需要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");
          }
     }

然后你会依赖IValidationDictionary但不依赖于MVC，这也会使你的解决方案变得可测试。

如果您需要在没有ModelStateDictionary的应用中实施服务，您只需在用于保存错误的类上实现IValidationDictionary接口。

控制器示例：

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);
}

这种方法的专家：

不依赖于调用库
可以模拟IValidationDictionary进行测试。

这种方法的结论：

您需要将IValidationDictionary传递给您要对其进行验证的每个方法都将返回给用户。

或

您需要在要验证的每个控制器操作中初始化服务的验证字典（如果您决定将IValidationDictionary作为私有字段）。

如何将服务层验证消息传递回调用方？

4 个答案: