簡(jiǎn)介

在軟件工程方面，軟件架構(gòu)是過去幾年中最重要的主題之一。羅伯特·C·馬丁（又名鮑勃叔叔）在他的書中深刻地提出了他對(duì)清潔架構(gòu)的看法，我強(qiáng)烈推薦看看。但是當(dāng)涉及到實(shí)施時(shí)，事情變得困難并且出現(xiàn)了許多問題。我從哪里開始？我如何構(gòu)建我的項(xiàng)目？如何將Bob叔叔的原則應(yīng)用于我想要使用的技術(shù)？我將嘗試從Java Web開發(fā)人員的角度回答這些問題，他們希望使用Java 9中的Java 11和Jigsaw模塊。這將為您提供更加具體的視野，讓您了解Uncle Bob的整潔架構(gòu)。

整潔架構(gòu)

在實(shí)現(xiàn)之前，讓我們來看看架構(gòu)圖：

圖片.png

一些核心概念:

• 任何層級(jí)都只能引用它下面的層級(jí)，而不知道上面發(fā)生了什么。
• 業(yè)務(wù)用例和實(shí)體是應(yīng)用程序的核心，應(yīng)該具有最小的外部庫(kù)依賴項(xiàng)。

實(shí)現(xiàn)

開始構(gòu)建這個(gè)項(xiàng)目

我們將使用Gradle多項(xiàng)目和Java Jigsaw模塊來強(qiáng)制執(zhí)行不同層之間的依賴關(guān)系。
我們要構(gòu)建的應(yīng)用程序非常簡(jiǎn)單，對(duì)于這樣的項(xiàng)目來說，該結(jié)構(gòu)可能看起來有點(diǎn)怪，但這是了解這一切是如何工作的最佳方式。
該應(yīng)用程序的功能主要有：

• 創(chuàng)建一個(gè)用戶
• 查詢一個(gè)用戶
• 列出所有的用戶
• 用戶使用自己的密碼進(jìn)行登錄

為此，我們將從內(nèi)層（實(shí)體/業(yè)務(wù)用例）開始，然后是接口適配器層，我們將完成外層。我們還將通過更改實(shí)現(xiàn)細(xì)節(jié)和在框架之間切換來演示架構(gòu)的靈活性。

下面這個(gè)是整個(gè)項(xiàng)目的整體預(yù)覽：

圖片.png

我們開始do it吧。

內(nèi)層

我們的實(shí)體和用例分為兩個(gè)子項(xiàng)目：“領(lǐng)域?qū)ο蟆焙汀皹I(yè)務(wù)用例”：

圖片.png

這兩個(gè)子項(xiàng)目代表了我們應(yīng)用的核心。
架構(gòu)必須非常明確。通過快速查看上面的示例，我們立即知道存在什么樣的操作以及在哪里。如果您要?jiǎng)?chuàng)建單個(gè)UserService，則很難說該服務(wù)中存在哪些操作，您需要深入了解實(shí)現(xiàn)以了解服務(wù)的作用。在我們整潔架構(gòu)中，我們只需要快速查看usecase包，就可以了解支持哪種操作。

在實(shí)體包中包含所有實(shí)體。在我們的例子中，我們將只有一個(gè)，那就是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子模塊包含我們的業(yè)務(wù)邏輯。我們將從一個(gè)簡(jiǎn)單的業(yè)務(wù)用例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<User> findById(final String id) {

return repository.findById(id);

}

public List<User> findAllUsers() {

return repository.findAllUsers();

}
}

我們有兩個(gè)操作，這兩個(gè)操作需要從存儲(chǔ)庫(kù)中查詢用戶。這在面向服務(wù)的體系結(jié)構(gòu)中看起來很標(biāo)準(zhǔn)。 UserRepository是一個(gè)未在我們當(dāng)前子項(xiàng)目中實(shí)現(xiàn)的接口。這被認(rèn)為是我們架構(gòu)中的細(xì)節(jié)，細(xì)節(jié)在外層實(shí)現(xiàn)。當(dāng)實(shí)例化用例時(shí)（例如通過依賴注入），將提供它的實(shí)現(xiàn)。這提供了一些優(yōu)點(diǎn)：

• 無論實(shí)現(xiàn)是什么，業(yè)務(wù)邏輯都保持不變。
• 實(shí)現(xiàn)中的任何更改都不會(huì)影響業(yè)務(wù)邏輯。
• 完全更改實(shí)現(xiàn)非常容易，因?yàn)樗鼘?duì)業(yè)務(wù)邏輯沒有影響。

請(qǐng)注意，該接口也稱為端口，因?yàn)樗鼧?gòu)成了業(yè)務(wù)邏輯和外部世界之間的橋梁。

現(xiàn)在讓我們構(gòu)建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用例一樣，我們需要一個(gè)存儲(chǔ)庫(kù)，一種生成ID的方法以及一種對(duì)密碼進(jìn)行編碼的方法。這些是細(xì)節(jié)，而不是業(yè)務(wù)規(guī)則，稍后將在外層實(shí)現(xiàn)。

我們還想驗(yàn)證提供的用戶是否有效（包含正確的數(shù)據(jù)）并且它在數(shù)據(jù)庫(kù)中不存在。這導(dǎo)致了我們對(duì)用例的最后一次迭代：

package com.slalom.example.domain.usecase;



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

import com.slalom.example.domain.exception.UserAlreadyExistsException;

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

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

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

import com.slalom.example.domain.usecase.validator.UserValidator;



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);

}

}

如果用戶無效或已存在，則拋出自定義運(yùn)行時(shí)異常。這些自定義異常應(yīng)由其他層處理。

我們的最后一個(gè)用例LoginUser非常簡(jiǎn)單，可以在GitHub中使用。

最后，為了強(qiáng)制執(zhí)行邊界，兩個(gè)子項(xiàng)目都使用Jigsaw模塊。 Jigsaw模塊允許我們僅向外界公開需要暴露的內(nèi)容，因此不會(huì)泄露任何實(shí)現(xiàn)細(xì)節(jié)。例如，沒有理由公開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;

}

總結(jié)一下內(nèi)層的作用：

• 內(nèi)層包含領(lǐng)域?qū)ο蠛蜆I(yè)務(wù)規(guī)則。這應(yīng)該是應(yīng)用程序中最穩(wěn)定和最應(yīng)該測(cè)試的部分。
• 內(nèi)部層中沒有實(shí)現(xiàn)與外部世界的任何交互（如數(shù)據(jù)庫(kù)或外部服務(wù)）。我們使用端口（接口）來表示它們。
• 沒有使用框架和最小的依賴關(guān)系。
• Jigsaw模塊允許我們隱藏實(shí)現(xiàn)細(xì)節(jié)。

外層

適配器

現(xiàn)在我們有了實(shí)體和業(yè)務(wù)用例，我們可以實(shí)現(xiàn)細(xì)節(jié)。為了能夠證明該體系結(jié)構(gòu)非常靈活，我們將創(chuàng)建多個(gè)實(shí)現(xiàn)并在不同的上下文中使用它們。

圖片.png

讓我們從倉(cāng)儲(chǔ)開始弄吧。
使用簡(jiǎn)單HashMap的UserRepository實(shí)現(xiàn)：

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<String, User> inMemoryDb = new HashMap<>();
    
    @Override
    public User create(final User user) {
        inMemoryDb.put(user.getId(), user);
        return user;
    }
  
    @Override
    public Optional<User> findById(final String id) {
        return Optional.ofNullable(inMemoryDb.get(id));
    }
  
    @Override
    public Optional<User> findByEmail(final String email) {
        return inMemoryDb.values().stream()
            .filter(user -> user.getEmail().equals(email))
            .findAny();
    }
  
    @Override
    public List<User> findAllUsers() {
        return new ArrayList<>(inMemoryDb.values());
    }
}

你也可以在GitHub上找到Hazelcast的另一個(gè)實(shí)現(xiàn)。

其他適配器：

其他適配器可以使用領(lǐng)域?qū)ο笾新暶鞯慕涌谙嗤姆绞絹韺?shí)現(xiàn)。你可以在GitGub上找到它們：
密碼封裝器
Jug ID生成器
UUID生成器

將所有的組件組合在一起

現(xiàn)在我們已經(jīng)有了實(shí)現(xiàn)細(xì)節(jié)，我們需要將它們組合在一起。為此，我們需要?jiǎng)?chuàng)建一個(gè)包含應(yīng)用程序配置的config文件夾和一個(gè)包含運(yùn)行應(yīng)用程序代碼的應(yīng)用程序文件夾。
下面是他們的配置信息：

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);
    }
}

此配置使用相關(guān)適配器初始化用例。如果您想要更改實(shí)現(xiàn)，您可以輕松地從一個(gè)適配器實(shí)現(xiàn)切換到另一個(gè)，而無需修改用例代碼。

下面是運(yùn)行應(yīng)用程序的類：

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", "mypassword");
        System.out.println("Allowed to login with email 'john.doe@gmail.com' and password 'mypassword'");
    }
}

Web 框架

• 如果您想使用Spring Boot或Vert.x等Web框架，該怎么辦？這很簡(jiǎn)單 - 我們只需要：
• 為Web應(yīng)用程序創(chuàng)建新配置。
• 創(chuàng)建一個(gè)新的應(yīng)用程序運(yùn)行器。
• 在適配器文件夾中添加Controller。Controller將負(fù)責(zé)與內(nèi)層通信。
  這是Spring Controller的例子：

package com.slalom.example.spring.controller;

@RestController
public class UserController {
    private final CreateUser createUser;
    private final FindUser findUser;
    private final LoginUser loginUser;
  
    // All args constructor with @Autowired
  
    @RequestMapping(value = "/users", method = RequestMethod.POST)
    public UserWeb createUser(@RequestBody final UserWeb userWeb) {
        var user = userWeb.toUser();
        return UserWeb.toUserWeb(createUser.create(user));
    }
    
    @RequestMapping(value = "/login", method = RequestMethod.GET)
    public UserWeb login(@RequestParam("email") final String email, @RequestParam("password") final String password) {
        return UserWeb.toUserWeb(loginUser.login(email, password));
    }
    
    @RequestMapping(value = "/users/{userId}", method = RequestMethod.GET)
    public UserWeb getUser(@PathVariable("userId") final String userId) {
        return UserWeb.toUserWeb(findUser.findById(userId).orElseThrow(() -> new RuntimeException("user not found")));
    }
    
    @RequestMapping(value = "/users", method = RequestMethod.GET)
    public List<UserWeb> allUsers() {
        return findUser.findAllUsers()
            .stream()
            .map(UserWeb::toUserWeb)
            .collect(Collectors.toList());
    }
}

您可以使用Spring Boot和Vert.x在GitHub中找到此應(yīng)用程序的完整示例。

總結(jié)：

我們?cè)诒疚闹性噲D展示Uncle Bob的整潔架構(gòu)是多么強(qiáng)大。希望現(xiàn)在你有點(diǎn)清楚這個(gè)玩意兒了。

優(yōu)點(diǎn)：

Power：您的業(yè)務(wù)邏輯是受到保護(hù)的，外部任何東西都無法使其失敗。您的代碼不依賴于任何外部框架。
Flexibility(靈活性)：任何適配器都可以隨時(shí)由您選擇的任何其他實(shí)現(xiàn)來進(jìn)行替換。從Spring啟動(dòng)切換到Vert.x或Dropwizard可以非?？焖俚赝瓿?。
Defer decisions(延遲決定)：我需要什么數(shù)據(jù)庫(kù)？我需要什么樣的Web框架？您可以在不了解這些細(xì)節(jié)的情況下構(gòu)建業(yè)務(wù)邏輯。
High maintainability(強(qiáng)大的可維護(hù)性): 很容易識(shí)別哪個(gè)組件出現(xiàn)故障。
Implement faster(快速實(shí)現(xiàn)): 由于架構(gòu)將問題分開，您可以一次專注于一項(xiàng)任務(wù)并更快地發(fā)展。這也應(yīng)該減少技術(shù)債務(wù)的數(shù)額。
Tests(測(cè)試): 單元測(cè)試更容易，因?yàn)橐蕾囮P(guān)系是明確定義的，它很容易模擬測(cè)試。
Integration tests(集成測(cè)試): 您可以在集成測(cè)試期間創(chuàng)建要訪問的任何外部服務(wù)的自定義實(shí)現(xiàn)。例如，如果您不希望因?yàn)榘凑?qǐng)求付費(fèi)而訪問云中托管的數(shù)據(jù)庫(kù)，只需使用適配器中的內(nèi)存實(shí)現(xiàn)即可。

缺點(diǎn):

Learning curve(學(xué)習(xí)曲線)，一開始架構(gòu)可能會(huì)非常龐大，尤其對(duì)是初級(jí)開發(fā)人員不友好。
更多類，更多包，更多子項(xiàng)目。據(jù)我所知，沒有什么可以做的。作為一名polygot開發(fā)人員，我鼓勵(lì)Java開發(fā)人員探索其他語言，如Kotlin。在這種情況下，Kotlin可以幫助減少創(chuàng)建的文件數(shù)量。
使項(xiàng)目的復(fù)雜性變得更高。
對(duì)于小型項(xiàng)目來說，這可能只是過度設(shè)計(jì)。

GitHub上的項(xiàng)目提供了有關(guān)如何處理Web框架的更多詳細(xì)信息。如果您有興趣，我會(huì)鼓勵(lì)您查看代碼并使用它。

原文地址：https://medium.com/slalom-engineering/clean-architecture-with-java-11-f78bba431041