如何从服务类方法返回验证错误？

Question

您能否举一个示例，说明如何从Web应用程序中使用的服务类返回验证错误。 您如何看待以下这种方法？

using System;
using System.Linq;
using System.Web.Mvc;

using App.Data;
using App.Security;

public interface IMembershipService
{
    bool ValidateUser(string userName, string password, ModelStateDictionary model = null);
}

public class MembershipService : IMembershipService
{
    private DatabaseContext db;

    public MembershipService(DatabaseContext db)
    {
        this.db = db;
    }

    public bool ValidateUser(string userName, string password, ModelStateDictionary model)
    {
        if (string.IsNullOrWhiteSpace(userName) || userName.Length > 128 ||
            string.IsNullOrWhiteSpace(password) || password.Length > 256)
        {
            TryAddModelError(model, "Username or password provided is incorrect.");
            return false;
        }

        var user = this.db.Users.SingleOrDefault(u => u.UserName == userName);

        if (user == null || !PasswordHash.Validate(password, user.PasswordHash, user.PasswordSalt))
        {
            TryAddModelError(model, "Username or password provided is incorrect.");
            return false;
        }

        if (!user.IsApproved)
        {
            TryAddModelError(model, "Your account is suspended.");
            return false;
        }

        user.LastLoginDate = DateTime.UtcNow;
        this.db.SaveChanges();

        return true;
    }

    private static void TryAddModelError(ModelStateDictionary model, string errorMessage)
    {
        if (model != null)
        {
            model.AddModelError(string.Empty, errorMessage);
        }
    }
}

用法样本：

[Authorize]
public class AccountController : Controller
{
    private readonly IMembershipService membershipService;

    public AccountController(IMembershipService membershipService)
    {
        this.membershipService = membershipService;
    }

    [HttpPost, AllowAnonymous, ValidateAntiForgeryToken]
    public Login(LoginModel model, string returnUrl)
    {
        if (ModelState.IsValid && this.membershipService.ValidateUser(
            model.UserName, model.Password, modelState: ModelState))
        {
            FormsAuthentication.SetAuthCookie(userName, true);
            return RedirectToLocal(returnUrl);
        }

        return View(model);
    }
}

Answer 1

尝试以下方法：

public bool ValidateUser(string userName, string password)
{
    if (string.IsNullOrWhiteSpace(userName) || userName.Length > 128 ||
    string.IsNullOrWhiteSpace(password) || password.Length > 256)
    {
        throw new ProviderException("Username and password are required");
    }

    var user = this.db.Users.SingleOrDefault(u => u.UserName == userName);

    if (user == null || !PasswordHash.Validate(password, user.PasswordHash, user.PasswordSalt))
    {
        throw new ProviderException("Incorrect password or username");
    }

    return true;
}

会员服务的使用：

...
try
{
    var result = membership.ValidateUser(userName, password);
    ...
}
catch (ProviderException e)
{
    model.AddModelError(string.Empty, e.Message);
}
...

这样，您的MembershipService仅负责验证，而ValidateUser方法验证用户名和密码。 验证结果如何处理取决于MembershipService的用户。 这被称为单一责任原则

Answer 2

简短的答案是引发异常（通常是InvalidOperationException ）。

长话大说，您可以创建一个自定义例外来保存所需的信息。 例：

public class CustomValidationErrorException : Exception
{
    public string Id { get; set; } // Custom Id for the operation
    public IEnumerable<string> Messages { get; set; } // Multiple validation error message
}

根据要求，您还可以创建一个自定义验证类，并将ref作为参数。 此处的参数用法是要返回对象时避免冲突。

编辑：

似乎有一些关于在验证期间是否引发异常的讨论。 如果是性能问题，我不能争论，因为我不是专家。 在我做的一些简单测试中，我发现没有任何性能问题。 我将在可读性部分中解释为什么我更喜欢Exceptions ，什么时候不喜欢。

身高：

从API的角度来看，代码将更易于阅读。 考虑以下服务示例：

public interface ILoginService{
  void Login(string userName, string password);
}

从使用的角度来看，它非常简单易读

public void LoginServiceConsumer(ILoginService service){
  //declare username and password
  service.Login(userName, password);
  // do what after login, if throw exception then this operation will ensure to be cancelled automatically
}

从我的观点来看，实现没有问题。 现在，考虑返回错误消息：

public interface ILoginService{
  IEnumerable<string> Login(string userName, string password);
}

并且从使用角度来看

public void LoginServiceConsumer(ILoginService service){
  //declare username and password
  IEnumerable<string> validationResult = service.Login(userName, password);
  if(validationResult.Any())
  // do the next operation
}

现在，没有适当的文档或使用该对象的丰富知识 ，它弹出了一个问题。 它返回的IEnumerable<string>是什么？ 是否仅返回错误消息？ 验证成功后，它会返回“成功”作为消息吗？

该技术的另一个缺点是，当您返回对象作为执行结果时，需要首先对其进行验证：

public MyObject Convert(MySource source){
   if(!source.Valid){
     //give error message here
   }
}

你怎么能这样做？ 一种方法是对消息结果使用ref并将其分配。

public MyObject Convert(MySource source, ref List<string> errorMessage){
   if(!source.Valid){
     errorMessage.Add("The source is not valid");
     return null;
   }
}

但是从使用角度来看：

public void ConvertConsumer(MySource source){
  List<string> errorMessage = new List<string>(); //you should create a new list
  Convert(MySource source, ref errorMessage); //then pass it
}

首先，它需要一个新列表。 其次，用户是否知道验证无效时可以返回null？ 最后一件事是相同的问题，它设置的IEnumerable<string>是什么？ 是否仅设置错误消息？ 验证成功后，是否会将“成功”设置为消息？

不喜欢：

我不喜欢使用异常作为验证的一种情况是使用第三方（例如AVICode）跟踪您的应用程序的异常情况。 它会淹没您的异常报告。