c# - 验证器和服务与外部 API 调用的分离

Question

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

但是，我在连接表示层(即我的 Controller )和后端服务时遇到了一些困难，同时仍然保持向用户返回良好的错误/验证报告。

我读了一篇非常好的 SO 帖子 here关于如何将验证逻辑与服务层分开，并且在大多数情况下都是有意义的。 然而，在这个模型中有一个“缺陷”，如果你可以这么调用它的话:在查找验证器和服务都需要的对象时，如何避免重复工作？

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

假设我有一个允许用户共享代码片段的应用程序。现在，我决定添加一项新功能，允许用户将他们的 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 并确保结果不为空:

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 用户。如果您根据单一职责原则考虑，Validator 有一个单一的工作来验证用户的存在，而 LinkCommandHanlder 有一个单一的工作来将实体加载到存储库中。他们都不应该有从 GitHub 中拉取实体/用户的工作。

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

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

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

所以在您的示例中，我将有一个 GitHubLinkProcessor 对象和一个名为 LinkUser(string username) 的方法。在该类中，我将实例化我的 GitHubPeristenceLayer 类并调用其 FindUserByName(string username) 方法。接下来，我们继续实例化 GitHubUserValidator 类以验证用户不为空并且存在所有必要的数据。一个验证通过后，一个 LinkRepositoryPersistence 对象被实例化，并将 GitHubUser 传递给 AccessLayer 以实现持久化。

但我想强烈指出，这只是我的做法，我绝不想暗示其他方法的有效性较低。

编辑:

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

那么让我们假设您的本地用户对象有一个不能为空的 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;
        }
    }
}