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

Question

我目前正在构建一个Web应用程序,并尝试按照良好的MVC和面向服务的体系结构进行设计.

但是,我在连接表示层(即我的控制器)和后端服务时遇到了一些障碍,同时仍然保持良好的错误/验证报告给用户.

我在这里阅读了一篇非常好的SO帖子,关于如何将验证逻辑与服务层分开,并且大部分都是有意义的.然而,有一个"缺陷",如果你可以称之为,在这个模型中,我嘻嘻哈哈:在查找验证器和服务所需的对象时,如何避免重复工作？

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

假设我有一个允许用户共享代码片段的应用程序.现在,我决定添加一项新功能,允许用户将他们的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帐户.这是非常简单的:调用FindByUserName上GitHubUserService,并确保结果不为空:

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编写验证器/服务时是否有其他人遇到过这样的问题？您是如何减少在具体类中实现缓存之外的重复工作？

Answer 1

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

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

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

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

因此，在您的示例中，我将有一个 GitHubLinkProcessor 对象，一个名为 LinkUser(string username) 的方法。在该类中，我将实例化 GitHubPeristenceLayer 类并调用其 FindUserByName(string username) 方法。接下来，我们继续实例化 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;
        }
    }
}