使用外部API调用分离验证器和服务

本文关键字：验证 服务 分离 调用 外部 API | 更新日期: 2023-09-27 17:50:43

我目前正在构建一个web应用程序，并试图按照良好的MVC和面向服务的架构来设计它。

然而，在连接表示层(即我的控制器)和后端服务时，我遇到了一点障碍，同时仍然保持良好的错误/验证报告返回给用户。

我在这里读了一篇非常好的关于如何从服务层分离验证逻辑的文章，大部分都是有意义的。然而，这个模型中有一个"缺陷"(如果可以这样称呼的话)让我感到困扰:在查找验证器和服务都需要的对象时，如何避免重复工作?

我想用一个相当简单的例子来解释会更容易:

假设我有一个允许用户共享代码片段的应用程序。现在，我决定添加一个新功能，允许用户将他们的GitHub帐户附加到他们在我网站上的帐户(即建立一个配置文件)。为了这个例子的目的，我将简单地假设我的所有用户都是值得信赖的，并且只会尝试添加他们自己的GitHub帐户，而不是其他人的:)

根据前面提到的SO文章，我设置了一个基本的GitHub服务来检索GitHub用户信息。

interface IGitHubUserService {
    GitHubUser FindByUserName(string username);
}

GitHubUserService的具体实现通过调用https://api.github.com/users/{0}来获取用户信息。同样，按照本文的模型，我实现了以下命令来将用户帐户链接到GitHub用户:

// Command for linking a GitHub account to an internal user account
public class GitHubLinkCommand {
    public int UserId { get; set; }
    public string GitHubUsername { get; set }
};

我的验证器需要验证用户输入的用户名是一个有效的GitHub帐户。这非常简单:在GitHubUserService上调用FindByUserName，并确保结果不是null:

public sealed class GitHubLinkCommandValidator : Validator<GitHubLinkCommand> {
    private readonly IGitHubUserService _userService;
    public GitHubLinkCommandValidator(IGitHubUserService userService) {
        this._userService = userService;
    }
    protected override IEnumerable<ValidationResult> Validate(GitHubLinkCommand command) {
        try {
            var user = this._userService.FindByUserName(command.GitHubUsername);
            if (user == null)
                yield return new ValidationResult("Username", string.Format("No user with the name '{0}' found on GitHub's servers."));
        }
        catch(Exception e) {
            yield return new ValidationResult("Username", "There was an error contacting GitHub's API.");
        }
    }
}

很好!验证器非常简单且有意义。现在是时候制作GitHubLinkCommandHandler:

了
public class GitHubLinkCommandHandler : ICommandHandler<GitHubLinkCommand>
{
    private readonly IGitHubUserService _userService;
    public GitHubLinkCommandHandler(IGitHubUserService userService)
    {
        this._userService = userService;
    }
    public void Handle(GitHubLinkCommand command)
    {
        // Get the user details from GitHub:
        var user = this._userService.FindByUserName(command.GitHubUsername);
        // implementation of this entity isn't really relevant, just assume it's a persistent entity to be stored in a backing database
        var entity = new GitHubUserEntity
        {
            Name = user.Login,
            AvatarUrl = user.AvatarUrl
            // etc.
        };
        // store the entity:
        this._someRepository.Save(entity);
    }
}

同样，这看起来非常整洁和直接。但是有一个明显的问题:对IGitHubUserService::FindByUserName的重复调用，一个来自验证器，一个来自服务。在糟糕的情况下，如果没有服务器端缓存，这样的调用可能需要1-2秒，使得使用这种架构模型的复制成本太高。

在围绕外部api编写验证器/服务时，是否有人遇到过这样的问题?您如何减少在具体类中实现缓存之外的重复工作?

使用外部API调用分离验证器和服务

从我的角度来看，问题是LinkCommandHandler和LinkCommandValidator都不应该首先检索GitHub用户。如果您按照单一职责原则来考虑，Validator只有一个任务来验证用户的存在，而linkcommandhandler只有一个任务来将实体加载到存储库中。他们都不应该有从GitHub拉实体/用户的工作。

我喜欢按照以下模式构建我的代码，每个模式代表一个可归属的层。每一层都可以与上一层和下一层对话，但它不能跳过另一层。

  1. 数据层——这代表一个数据源，如数据库或服务。通常你不需要为它写代码，你只需要使用它。
  2. 访问层——这表示与数据层
    3. 交互的代码
  3. 持久化层——这表示为访问层调用准备项目的代码，例如数据转换、从数据构建实体、或将对访问层的多个调用分组为单个请求以检索数据或存储数据。此外，缓存的决定以及缓存和清除缓存的机制将驻留在这一层。
  4. 处理器层——这表示执行业务逻辑的代码。它也是您将使用验证器、其他处理器、解析器等的地方。

然后我将上面的所有内容与我的表示层分开。核心代码和功能不应该知道它是来自网站、桌面应用程序还是WCF服务。

所以在你的例子中，我会有一个GitHubLinkProcessor对象一个名为LinkUser(字符串用户名)的方法。在这个类中，我将实例化我的GitHubPeristenceLayer类并调用它的FindUserByName(字符串用户名)方法。接下来，我们继续实例化一个GitHubUserValidator类，以验证用户不为空并且所有必要的数据都存在。通过一次验证后，实例化LinkRepositoryPersistence对象，并将用于持久化的GitHubUser传递给AccessLayer。

但是我要强烈地指出这正是我要做的方式，我绝不想暗示其他方法不那么有效。

编辑:

我想要一个简单的答案，因为我担心我的回答已经太长太无聊了。我要在这里分辩一下，所以请原谅我。对我来说，您不是通过调用Git来验证用户。您正在检查是否存在远程资源，该资源可能失败，也可能不失败。打个比方，您可以验证(800)555-1212是美国电话号码的有效格式，但不能验证该电话号码是否存在并且属于正确的人。这是一个单独的过程。就像我说的，这是在吹毛求疵，但是通过这样做，它允许我描述的整体代码模式。

那么让我们假设你的本地用户对象有一个UserName和Email的属性，不能为空。您将对这些进行验证，并且只有在验证正确的情况下才继续检查资源。

public class User 
{
    public string UserName { get; set; }
    public string Email { get; set; }
    //git related properties
    public string Login { get; set; }
    public string AvataUrl { get; set; }
}
//A processor class to model the process of linking a local system user
//to a remote GitHub User
public class GitHubLinkProcessor()
{
    public int LinkUser(string userName, string email, string gitLogin) 
    {
            //first create our local user instance
            var myUser = new LocalNamespace.User { UserName = userName, Email = email };
        var validator = new UserValidator(myUser);
        if (!validator.Validate())
            throw new Exception("Invalid or missing user data!");
        var GitPersistence = new GitHubPersistence();
        var myGitUser = GitPersistence.FindByUserName(gitLogin);
        if (myGitUser == null)
            throw new Exception("User doesnt exist in Git!");
        myUser.Login = myGitUser.Login;
        myUser.AvatorUrl = myGitUser.AvatarUrl;
        //assuming your persistence layer is returning the Identity
        //for this user added to the database
        var userPersistence = new UserPersistence();
        return userPersistence.SaveLocalUser(myUser);
        }
}
public class UserValidator
{
    private LocalNamespace.User _user;
    public UserValidator(User user)
    {
        this._user = user;
    }
    public bool Validate()
    {
        if (String.IsNullOrEmpty(this._user.UserName) ||
            String.IsNullOrEmpty(this._user.Email))
        {
            return false;
        }
    }
}

我会有一个比Peter Lange更短的答案，但我认为这很简单，你的UserCommandValidator应该验证UserCommand是否有效，而不是用户。

将命令验证器视为一种临时措施，以确保您永远不会花费1-2秒的时间为空白用户名或具有无效字符的用户名打开github api。一旦您确定命令本身是有效的，就可以提交它。从那里你可以让User本身，或者UserValidator来决定用户是否有效。

你是100%正确的，复制是错误的，但这是一个代码气味，你正在验证错误的东西在那一部分。

相关文章：