pwm波程序如何实现_秃顶程序员讲解如何用Java 11实现清洁架构Clean Architecture

在软件工程方面，软件架构是过去几年中最重要的主题之一。罗伯特·C·马丁(又名鲍勃大叔)在他的书中深刻地提出了他对清洁架构的看法，我强烈推荐！

但是当涉及到具体实施时，事情变得困难并且出现了许多问题。我该从哪里开始？我如何构建我的项目？如何将Bob叔叔的原则应用于我想要使用的技术？

这里我将尝试从Java Web开发人员的角度回答这些问题，他们希望使用Java 9中的Java 11和Jigsaw模块。这将为您提供更加具体的视图，了解Uncle Bob的干净架构。

在深入实现之前，让我们来看看架构：

• 实体：这些是应用程序的业务对象。这些不应受到外部任何更改的影响，这些应该是应用程序中最稳定的代码。这些可以是POJO，具有方法的对象，甚至是数据结构。
• 用例：实现并封装所有业务规则。
• 接口适配器：将数据转换并呈现​​给用例和实体层。
• 框架和驱动程序：包含运行应用程序所需的任何框架或工具。

这里的关键概念是：

• 任何层都只能引用它下面的层，而不知道上面发生了什么。
• 用例和实体是应用程序的核心，应该具有最小的外部库依赖项集。

实施项目

我们将使用Gradle多项目和Java Jigsaw模块来强制执行不同层之间的依赖关系。

我们要构建的应用程序非常简单，对于这样的项目来说，架构可能看起来有点过分，但这是了解这一切是如何工作的最佳方式。

该应用程序的功能将是：

• 创建用户。
• 找一个用户。
• 列出所有用户。
• 使用密码登录用户。

为此，我们将从内层(实体/用例)开始，然后是接口适配器层，我们将完成外层。我们还将通过更改实现细节和在框架之间切换来演示架构的灵活性。

以下是该项目的视图：

内层

我们的实体和用例分为两个子项目：“领域domain”和“用例usecase”：

这两个子项目代表了我们应用的核心。

架构必须非常明确。通过快速查看上面的示例，我们立即知道存在什么样的操作以及在哪里。如果您要创建单个UserService而不是很难分辨该服务中存在哪种操作，那么您需要深入了解实现以了解服务的作用。在我们干净的架构中，我们只需要快速查看usecase包，就可以了解支持哪种操作。

domain实体包中包含的所有实体。在我们的例子中，我们将只有一 User：

package com.slalom.example.domain.entity;

public class User {

private String id;

private String email;

private String password;

private String lastName;

private String firstName;

// Builder pattern & Getters

// ...

}

用例usecase子模块包含我们的业务逻辑。我们将从一个简单的用例开始FindUser：

package com.slalom.example.usecase;

import com.slalom.example.domain.entity.User;

import com.slalom.example.domain.port.UserRepository;

import java.util.List;

import java.util.Optional;

public final class FindUser {

private final UserRepository repository;

// All args constructor

public Optional findById(final String id) {

return repository.findById(id);

}

public List findAllUsers() {

return repository.findAllUsers();

}

我们有两个操作，这两个操作需要从存储库中检索用户。这在面向服务的体系结构SOA中看起来很标准。UserRepository是一个未在我们当前子项目中实现的接口。这被认为是我们架构中的细节，细节在外层实现。当实例化用例时(例如通过依赖注入)，将提供它的实现。这提供了一些优点：

• 无论实现是什么，业务逻辑都保持不变。
• 实现中的任何更改都不会影响业务逻辑。
• 完全更改实现非常容易，因为它对业务逻辑没有影响。

请注意，该接口也称为端口， 因为它构成了业务逻辑和外部世界之间的桥梁。

现在让我们构建CreateUser用例的第一次迭代：

package com.slalom.example.usecase;

import com.slalom.example.domain.entity.User;

import com.slalom.example.domain.port.IdGenerator;

import com.slalom.example.domain.port.PasswordEncoder;

import com.slalom.example.domain.port.UserRepository;

public final class CreateUser {

private final UserRepository repository;

private final PasswordEncoder passwordEncoder;

private final IdGenerator idGenerator;

// All args constructor

public User create(final User user) {

var userToSave = User.builder()

.id(idGenerator.generate())

.email(user.getEmail())

.password(passwordEncoder.encode(user.getEmail() + user.getPassword()))

.lastName(user.getLastName())

.firstName(user.getFirstName())

.build();

return repository.create(userToSave);

}

}

与FindUser用例一样，我们需要一个存储库，一种生成ID的方法，以及一种对密码进行编码的方法。这些也是细节，而不是业务规则，稍后将在外层实现。

我们还想验证提供的用户是否有效(包含正确的数据)，并且它已经不存在。这导致了我们对用例的最后一次迭代：

public final class CreateUser {

private final UserRepository repository;

private final PasswordEncoder passwordEncoder;

private final IdGenerator idGenerator;

// All args constructor

public User create(final User user) {

UserValidator.validateCreateUser(user);

if (repository.findByEmail(user.getEmail()).isPresent()) {

throw new UserAlreadyExistsException(user.getEmail());

}

var userToSave = User.builder()

.id(idGenerator.generate())

.email(user.getEmail())

.password(passwordEncoder.encode(user.getEmail() + user.getPassword()))

.lastName(user.getLastName())

.firstName(user.getFirstName())

.build();

return repository.create(userToSave);

}

}

如果用户无效或已存在，则抛出自定义运行时异常。这些自定义异常应由其他层处理。

我们的最后一个用例LoginUser非常简单，可以在GitHub中找到。

最后，为了强制执行边界，两个子项目都使用Jigsaw模块。Jigsaw模块允许我们仅向外界公开需要暴露的内容，因此不会泄露任何实现细节。例如，没有理由公开UserValidator该类：

// Domain module-info

module slalom.example.domain {

exports com.slalom.example.domain.entity;

exports com.slalom.example.domain.port;

exports com.slalom.example.domain.exception;

}

// Use case module-info

module slalom.example.usecase {

exports com.slalom.example.usecase;

requires slalom.example.domain;

requires org.apache.commons.lang3;

}

总结内层的作用：

• 内层包含域对象和业务规则。这应该是应用程序中最稳定和最受测试的部分。
• 内部层中没有实现与外部世界的任何交互(如数据库或外部服务)。我们使用端口(接口)来表示它们。
• 没有使用框架和最小的依赖关系。
• Jigsaw模块允许我们隐藏实现细节。

外层

1. 适配器

现在我们有了实体和用例，我们可以实现细节。为了能够证明该体系结构非常灵活，我们将创建多个实现并在不同的上下文中使用它们。

让我们从存储库开始。UserRepository实现简单HashMap：

package com.slalom.example.db;

import com.slalom.example.domain.entity.User;

import com.slalom.example.domain.port.UserRepository;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Optional;

public class InMemoryUserRepository implements UserRepository {

private final Map inMemoryDb = new HashMap<>();

@Override

public User create(final User user) {

inMemoryDb.put(user.getId(), user);

return user;

}

@Override

public Optional findById(final String id) {

return Optional.ofNullable(inMemoryDb.get(id));

}

@Override

public Optional findByEmail(final String email) {

return inMemoryDb.values().stream()

.filter(user -> user.getEmail().equals(email))

.findAny();

}

@Override

public List findAllUsers() {

return new ArrayList<>(inMemoryDb.values());

}

}

其他适配器：其他适配器仅通过实现域中声明的接口以相同的方式实现。你可以在GitGub上找到它们：

• Password encoder
• Jug Id Generator
• Uuid Generator

将所有东西放在一起

现在我们已经有了实现细节，我们需要将它们组合在一起。为此，我们需要创建一个包含应用程序配置的config文件夹和一个包含运行应用程序代码的应用程序文件夹。

这是其中一个配置：

public class ManualConfig {

private final UserRepository userRepository = new InMemoryUserRepository();

private final IdGenerator idGenerator = new JugIdGenerator();

private final PasswordEncoder passwordEncoder = new Sha256PasswordEncoder();

public CreateUser createUser() {

return new CreateUser(userRepository, passwordEncoder, idGenerator);

}

public FindUser findUser() {

return new FindUser(userRepository);

}

public LoginUser loginUser() {

return new LoginUser(userRepository, passwordEncoder);

}

}

此配置使用相关适配器初始化用例。如果您想要更改实现，您可以轻松地从一个适配器实现切换到另一个，而无需修改用例代码。

以下是运行应用程序的主类：

public class Main {

public static void main(String[] args) {

// Setup

var config = new ManualConfig();

var createUser = config.createUser();

var findUser = config.findUser();

var loginUser = config.loginUser();

var user = User.builder()

.email("john.doe@gmail.com")

.password("mypassword")

.lastName("doe")

.firstName("john")

.build();

// Create a user

var actualCreateUser = createUser.create(user);

System.out.println("User created with id " + actualCreateUser.getId());

// Find a user by id

var actualFindUser = findUser.findById(actualCreateUser.getId());

System.out.println("Found user with id " + actualFindUser.get().getId());

// List all users

var users = findUser.findAllUsers();

System.out.println("List all users: " + users);

// Login

loginUser.login("john.doe@gmail.com