六邊形架構 Java 實現

六邊形架構是一種設計風格,經過分層實現核心邏輯與外部對象隔離。其核心邏輯是業務模塊,外部元素是整合點,好比數據庫、外部 API、界面等。它將軟件分爲內部與外部,內部包含了核心業務邏輯與領域層(所謂分層架構),外部包含界面、數據庫、消息傳遞及其餘內容。內部與外部經過端口和適配器相互通訊。java


*譯註:六邊形架構(Hexagonal Architecture)由Alistair Cockburn 提出,解決了傳統的分層架構所帶來的問題。*git


1. 優勢github


  • 使用六邊形架構開發的軟件與通道獨立,所以能支持多通道數據庫

  • 易於置換入站和出站整合點架構

  • 測試軟件變得更簡單,由於能夠很容易地模擬集成點app


2. Java 實現ide


按照上面的描述,六邊形架構更多地是圍繞端口和適配器開展工做。在 Java 中,用 interface 定義端口,實現類做爲適配器。下面用一個簡單的 Spring Boot 應用示例瞭解如何應用六邊形架構。測試


示例應用主要功能是建立並查看僱員信息,核心業務邏輯在 `EmployeeService` 中實現,領域對象定義爲 `Employee` ,這些均可以看作內部模塊。spa


**EmployeeService.java**

```java
@Service
public class EmployeeService {
   @Autowired
   private EmployeeRepositoryPort employeeRepository;

   public void create(String name, String role, long salary){
       employeeRepository.create(name, role, salary);
   }
   
   public Employee view(Integer userId){
       return employeeRepository.getEmployee(userId);
   }
}
```


**Employee.java**

```java
@Entity
@Table(name = "employee")
public class Employee{
   @Id
   @GeneratedValue
   @Column(name = "id")
   private Integer id;

   @Column(name = "name", nullable = false)
   private String name;

   @Column(name = "role", nullable = false)
   private String role;

   @Column(name = "salary", nullable = false)
   private long salary;
   // Setter、Getter 方法
}
```


如今,示例應用能夠經過 REST 或消息機制提供服務。建立實現了`EmployeeUIPort` 接口的 `EmployeeControllerAdapter` 類提供 REST 服務。設計


**EmployeeControllerAdapter.java**

```java
RestController
@RequestMapping("/employees/")
public class EmployeeControllerAdapter implements EmployeeUIPort{
   @Autowired
   private EmployeeService employeeService;

   @Override
   public void create(@RequestBody Employee request)
{
       employeeService.create(request.getName(), request.getRole(), request.getSalary());
   }

   @Override
   public Employee view(@PathVariable Integer id)
{
       Employee employee = employeeService.view(id);
       return employee;
   }
}
```


```java
public interface EmployeeUIPort {
   @PostMapping("create")
   public void create(@RequestBody Employee request);

   @GetMapping("view/{id}")
   public Employee view(@PathVariable Integer userId);
}
```


做爲業務邏輯的一部分,`EmployeeService` 還須要調用外部 DB 集成點。所以,咱們建立了 `EmployeeRepositoryPort` 以及實現了該接口的`EmployeeServiceAdapter`


**EmployeeServiceAdapter.java**

```java
@Service
public class EmployeeServiceAdapter implements EmployeeRepositoryPort {
   @PersistenceContext
   private EntityManager entityManager;

   @Transactional
   @Override
   public void create(String name, String role, long salary)
{
       Employee employee = new Employee();
       employee.setName(name);
       employee.setRole(role);
       employee.setSalary(salary);
       entityManager.persist(employee);
   }

   @Override
   public Employee getEmployee(Integer userId)
{
       return entityManager.find(Employee.class, userId);
   }
}
```


**EmployeeRepositoryPort.java**

```java
public interface EmployeeRepositoryPort {
   void create(String name, String role, long salary);

   Employee getEmployee(Integer userId);
}
```


至此,咱們能夠看到 `EmployeeService` 是如何使用 `EmployeeUIPort` 端口提供服務,經過 `EmployeeRepositoryPort` 調用 DB 並經過 `EmployeeControllerAdapter`和 `EmployeeServiceAdapter` 提供 REST API 服務。


3. 總結


總結一下,六邊形架構是一種將應用劃分紅內外兩部分的設計方法。經過內部公開的端口與外部實現的適配器進行溝通。應用這種方法,在保持核心用例代碼不變的狀況下,能夠服務多個通道、支持多種不一樣協議。 不只如此,它還能有效提升應用程序的可測性。儘管如此,不建議在整個應用中徹底實現六邊形架構,而是有選擇地使用接口與適配器。


示例代碼可在 [GitHub][1] 中找到。


[1]:https://github.com/RajeshBhojwani/hexagonal.git

相關文章
相關標籤/搜索