目重構(gòu)實(shí)戰(zhàn)：從混沌代碼到清晰架構(gòu)的演進(jìn)之路)
最近在折騰一個(gè)項(xiàng)目看著滿屏的代碼和日志我陷入了沉思我到底做了個(gè)什么東西啊啊啊啊啊相信很多開發(fā)者朋友在項(xiàng)目攻堅(jiān)期面對(duì)復(fù)雜的業(yè)務(wù)邏輯、層層嵌套的依賴和不斷涌現(xiàn)的 Bug 時(shí)都有過類似的靈魂拷問。這種感覺就像是在一片混沌中摸索代碼寫了不少功能也堆疊了很多但項(xiàng)目的整體輪廓和核心價(jià)值卻越來越模糊。本文正是源于這樣一次深刻的“項(xiàng)目復(fù)盤焦慮”。我將以一個(gè)典型的、功能逐漸“膨脹”的后臺(tái)管理系統(tǒng)為例完整拆解從需求混沌到架構(gòu)清晰的全過程。我們會(huì)一起梳理如何識(shí)別代碼中的“壞味道”如何使用設(shè)計(jì)模式進(jìn)行重構(gòu)并最終搭建一個(gè)可維護(hù)、易擴(kuò)展的 Spring Boot 項(xiàng)目骨架。無論你是正在為遺留系統(tǒng)焦頭爛額的初級(jí)開發(fā)者還是希望提升工程化思維的中高級(jí)工程師這篇從“混沌”到“秩序”的實(shí)戰(zhàn)筆記都能提供直接的參考。1. 項(xiàng)目背景與“混沌”現(xiàn)狀分析我們從一個(gè)常見的場(chǎng)景開始公司需要一個(gè)內(nèi)部使用的“員工信息管理平臺(tái)”。最初的版本可能非常簡單。1.1 初始需求與快速實(shí)現(xiàn)老板說“先做個(gè)能查員工信息和錄入請(qǐng)假的功能?！?于是一個(gè)典型的“速成”項(xiàng)目誕生了。為了趕時(shí)間我們可能會(huì)寫出類似下面的代碼結(jié)構(gòu)項(xiàng)目結(jié)構(gòu)初始版employee-manager/ ├── src/ │ └── main/ │ ├── java/ │ │ └── com/ │ │ └── example/ │ │ └── employeemanager/ │ │ ├── EmployeeController.java // 控制層 │ │ ├── EmployeeService.java // 服務(wù)層 │ │ ├── Employee.java // 實(shí)體類 │ │ ├── EmployeeRepository.java // 數(shù)據(jù)訪問層JPA │ │ ├── LeaveController.java // 請(qǐng)假控制層 │ │ ├── LeaveService.java // 請(qǐng)假服務(wù)層 │ │ └── Leave.java // 請(qǐng)假實(shí)體類 │ └── resources/ │ ├── application.properties │ └── ...數(shù)據(jù)庫配置 └── pom.xml核心代碼示例EmployeeService.java - 初始版Service public class EmployeeService { Autowired private EmployeeRepository employeeRepository; Autowired private EmailSender emailSender; // 一個(gè)直接注入的郵件發(fā)送類 Autowired private ReportGenerator reportGenerator; // 一個(gè)直接注入的報(bào)告生成類 public Employee getEmployeeById(Long id) { // 直接調(diào)用Repository return employeeRepository.findById(id).orElse(null); } public void applyLeave(LeaveRequest request) { // 1. 驗(yàn)證員工狀態(tài) Employee emp employeeRepository.findById(request.getEmployeeId()).orElseThrow(...); if (!ACTIVE.equals(emp.getStatus())) { throw new RuntimeException(員工狀態(tài)異常無法請(qǐng)假); } // 2. 業(yè)務(wù)邏輯檢查假期余額等這里混雜了大量邏輯 int usedLeaveDays calculateUsedLeaveDays(emp.getId()); if (request.getDays() (emp.getTotalLeaveDays() - usedLeaveDays)) { throw new RuntimeException(假期余額不足); } // 3. 保存請(qǐng)假記錄直接操作另一個(gè)實(shí)體 Leave leave new Leave(); leave.setEmployeeId(emp.getId()); leave.setStartDate(request.getStartDate()); // ... 其他字段設(shè)置 // 注意這里沒有LeaveRepository假設(shè)直接在Service里用JPA保存 // entityManager.persist(leave); // 4. 發(fā)送通知郵件緊耦合 emailSender.sendEmail(emp.getEmail(), 您的請(qǐng)假申請(qǐng)已提交, 請(qǐng)假詳情...); // 5. 生成月度報(bào)告為何在這里 reportGenerator.generateMonthlyReport(emp.getDepartment()); } // 一個(gè)私有方法可能越來越復(fù)雜 private int calculateUsedLeaveDays(Long employeeId) { // 直接寫SQL或調(diào)用其他Repository // 邏輯復(fù)雜且無法復(fù)用 return 0; } }1.2 “混沌”的典型特征隨著需求增加“再加個(gè)績效考核模塊”、“對(duì)接OA系統(tǒng)審批流”、“導(dǎo)出數(shù)據(jù)要支持多種格式”上面的代碼會(huì)迅速“膨脹”并出現(xiàn)以下問題單一職責(zé)原則被破壞EmployeeService變成了一個(gè)“上帝類”既管員工信息又管請(qǐng)假流程還負(fù)責(zé)發(fā)郵件、生成報(bào)告。緊耦合服務(wù)層直接依賴具體的郵件發(fā)送 (EmailSender) 和報(bào)告生成 (ReportGenerator) 實(shí)現(xiàn)。想換一個(gè)郵件服務(wù)商需要修改所有調(diào)用的地方。代碼重復(fù)計(jì)算假期余額的邏輯可能在其他服務(wù)如AttendanceService中又被復(fù)制粘貼了一遍。可測(cè)試性差由于緊耦合想要單元測(cè)試applyLeave方法你必須同時(shí) Mock 數(shù)據(jù)庫、郵件服務(wù)和報(bào)告服務(wù)測(cè)試變得極其笨重。擴(kuò)展困難老板說“請(qǐng)假成功后不僅要發(fā)郵件還要發(fā)企業(yè)微信消息?！?你就得去修改applyLeave方法添加新的依賴和調(diào)用違反了開閉原則。這就是“我到底做了個(gè)什么東西”的根源項(xiàng)目沒有清晰的架構(gòu)邊界代碼像一團(tuán)糾纏在一起的毛線任何改動(dòng)都牽一發(fā)而動(dòng)全身開發(fā)者的心智負(fù)擔(dān)極重。2. 重構(gòu)目標(biāo)與核心設(shè)計(jì)模式引入我們的目標(biāo)是將這個(gè)“混沌”的系統(tǒng)重構(gòu)成一個(gè)層次清晰、職責(zé)分明、易于擴(kuò)展的架構(gòu)。我們會(huì)引入幾個(gè)關(guān)鍵的設(shè)計(jì)模式和架構(gòu)思想。2.1 目標(biāo)架構(gòu)概覽重構(gòu)后的項(xiàng)目應(yīng)該遵循經(jīng)典的分層架構(gòu)并引入領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)DDD的一些概念精簡版和設(shè)計(jì)模式employee-manager-refactored/ ├── src/main/java/com/example/employeemanager/ │ ├── common/ # 通用組件 │ │ ├── exception/ # 全局異常處理 │ │ ├── response/ # 統(tǒng)一響應(yīng)體 │ │ └── utils/ # 工具類 │ ├── config/ # 配置類如Swagger, 線程池 │ ├── domain/ # 領(lǐng)域?qū)雍诵臉I(yè)務(wù)邏輯 │ │ ├── model/ # 領(lǐng)域?qū)嶓w/值對(duì)象 │ │ ├── service/ # 領(lǐng)域服務(wù)純業(yè)務(wù)邏輯無依賴 │ │ └── event/ # 領(lǐng)域事件 │ ├── application/ # 應(yīng)用層協(xié)調(diào)領(lǐng)域服務(wù)事務(wù)邊界 │ │ ├── service/ # 應(yīng)用服務(wù) │ │ └── dto/ # 數(shù)據(jù)傳輸對(duì)象 │ ├── infrastructure/ # 基礎(chǔ)設(shè)施層技術(shù)實(shí)現(xiàn)細(xì)節(jié) │ │ ├── persistence/ # 持久化JPA實(shí)現(xiàn) │ │ ├── client/ # 外部服務(wù)客戶端郵件、消息 │ │ └── message/ # 消息隊(duì)列發(fā)送 │ └── interfaces/ # 接口層對(duì)外暴露 │ ├── web/ # Web控制器RESTful API │ └── assembler/ # DTO與領(lǐng)域?qū)ο筠D(zhuǎn)換器 └── ...2.2 核心設(shè)計(jì)模式應(yīng)用場(chǎng)景策略模式Strategy Pattern用于處理多種類型的報(bào)告生成PDF、Excel、CSV或消息通知郵件、微信、短信。工廠模式Factory Pattern用于根據(jù)類型創(chuàng)建不同的策略實(shí)例。觀察者模式/領(lǐng)域事件Observer Pattern / Domain Event用于解耦核心業(yè)務(wù)邏輯與副作用操作。例如員工請(qǐng)假成功這個(gè)“事件”發(fā)生后監(jiān)聽該事件的處理器可以異步去發(fā)送郵件和消息而不是在請(qǐng)假方法內(nèi)同步調(diào)用。依賴注入Dependency InjectionSpring 核心用于管理對(duì)象生命周期和解耦。門面模式Facade Pattern應(yīng)用服務(wù)層可以作為門面對(duì)外提供粗粒度的業(yè)務(wù)接口內(nèi)部協(xié)調(diào)多個(gè)領(lǐng)域服務(wù)。3. 環(huán)境準(zhǔn)備與項(xiàng)目搭建我們使用 Spring Boot 2.7.x 和 Java 11 作為基準(zhǔn)環(huán)境。確保你的開發(fā)環(huán)境已準(zhǔn)備好。3.1 基礎(chǔ)環(huán)境與依賴操作系統(tǒng)Windows 10/11, macOS, Linux 均可。JDK11 或 17LTS版本。構(gòu)建工具M(jìn)aven 3.6 或 Gradle。IDEIntelliJ IDEA推薦或 Eclipse。核心 Maven 依賴 (pom.xml)?xml version1.0 encodingUTF-8? project xmlnshttp://maven.apache.org/POM/4.0.0 xmlns:xsihttp://www.w3.org/2001/XMLSchema-instance xsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd modelVersion4.0.0/modelVersion parent groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-parent/artifactId version2.7.18/version !-- 使用穩(wěn)定的版本 -- relativePath/ /parent groupIdcom.example/groupId artifactIdemployee-manager-refactored/artifactId version0.0.1-SNAPSHOT/version nameemployee-manager-refactored/name descriptionRefactored Employee Management System/description properties java.version11/java.version /properties dependencies !-- Web -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency !-- Data JPA -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-data-jpa/artifactId /dependency !-- 數(shù)據(jù)庫以H2內(nèi)存數(shù)據(jù)庫為例方便演示 -- dependency groupIdcom.h2database/groupId artifactIdh2/artifactId scoperuntime/scope /dependency !-- Lombok簡化代碼 -- dependency groupIdorg.projectlombok/groupId artifactIdlombok/artifactId optionaltrue/optional /dependency !-- 測(cè)試 -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-test/artifactId scopetest/scope /dependency !-- 可選用于參數(shù)校驗(yàn) -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-validation/artifactId /dependency !-- 可選用于領(lǐng)域事件Spring自帶 -- !-- spring-boot-starter-data-jpa 已包含相關(guān)事務(wù)支持 -- /dependencies build plugins plugin groupIdorg.springframework.boot/groupId artifactIdspring-boot-maven-plugin/artifactId configuration excludes exclude groupIdorg.projectlombok/groupId artifactIdlombok/artifactId /exclude /excludes /configuration /plugin /plugins /build /project基礎(chǔ)配置 (application.yml)spring: application: name: employee-manager datasource: url: jdbc:h2:mem:testdb;DB_CLOSE_DELAY-1;DB_CLOSE_ON_EXITFALSE driver-class-name: org.h2.Driver username: sa password: jpa: hibernate: ddl-auto: update # 開發(fā)環(huán)境生產(chǎn)環(huán)境請(qǐng)使用validate或none配合Flyway/Liquibase show-sql: true properties: hibernate: format_sql: true h2: console: enabled: true # 開啟H2控制臺(tái)訪問 http://localhost:8080/h2-console path: /h2-console server: port: 8080 logging: level: com.example.employeemanager: DEBUG4. 核心重構(gòu)實(shí)戰(zhàn)從“混沌”到“清晰”我們將一步步重構(gòu)最初的EmployeeService應(yīng)用之前提到的模式。4.1 第一步定義清晰的領(lǐng)域模型首先將核心業(yè)務(wù)概念抽象成領(lǐng)域?qū)嶓w和值對(duì)象放在domain/model/下。Employee.java (領(lǐng)域?qū)嶓w)package com.example.employeemanager.domain.model; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import javax.persistence.*; import java.time.LocalDate; Entity Table(name employees) Data NoArgsConstructor AllArgsConstructor public class Employee { Id GeneratedValue(strategy GenerationType.IDENTITY) private Long id; private String name; private String email; private String department; Enumerated(EnumType.STRING) private EmployeeStatus status; // 枚舉ACTIVE, INACTIVE private Integer totalLeaveDays; // 值對(duì)象可以嵌入這里簡化 private LocalDate joinDate; public enum EmployeeStatus { ACTIVE, INACTIVE } // 領(lǐng)域方法判斷是否可請(qǐng)假 public boolean canApplyLeave() { return this.status EmployeeStatus.ACTIVE; } }LeaveApplication.java (領(lǐng)域?qū)嶓w - 請(qǐng)假申請(qǐng))package com.example.employeemanager.domain.model; import lombok.Data; import javax.persistence.*; import java.time.LocalDate; Entity Table(name leave_applications) Data public class LeaveApplication { Id GeneratedValue(strategy GenerationType.IDENTITY) private Long id; private Long employeeId; private LocalDate startDate; private LocalDate endDate; private Integer days; Enumerated(EnumType.STRING) private LeaveStatus status; // PENDING, APPROVED, REJECTED private String reason; public enum LeaveStatus { PENDING, APPROVED, REJECTED } }4.2 第二步引入領(lǐng)域服務(wù)與領(lǐng)域事件將核心的、不依賴于外部資源的業(yè)務(wù)邏輯放入領(lǐng)域服務(wù)。同時(shí)使用領(lǐng)域事件來解耦。LeavePolicyService.java (領(lǐng)域服務(wù))package com.example.employeemanager.domain.service; import com.example.employeemanager.domain.model.Employee; import com.example.employeemanager.domain.model.LeaveApplication; import org.springframework.stereotype.Service; import javax.transaction.Transactional; /** * 請(qǐng)假策略領(lǐng)域服務(wù)。 * 只包含核心業(yè)務(wù)規(guī)則不依賴外部系統(tǒng)如郵件、報(bào)告。 */ Service Transactional // 事務(wù)放在領(lǐng)域服務(wù)或應(yīng)用服務(wù)層視情況而定 public class LeavePolicyService { /** * 驗(yàn)證請(qǐng)假申請(qǐng)是否合法。 * param employee 員工 * param application 請(qǐng)假申請(qǐng) * param usedLeaveDays 已使用的假期天數(shù) * throws IllegalArgumentException 如果驗(yàn)證不通過 */ public void validateLeaveApplication(Employee employee, LeaveApplication application, Integer usedLeaveDays) { // 規(guī)則1員工狀態(tài)必須為活躍 if (!employee.canApplyLeave()) { throw new IllegalArgumentException(員工狀態(tài)異常無法請(qǐng)假); } // 規(guī)則2請(qǐng)假天數(shù)不能超過剩余假期 int remainingDays employee.getTotalLeaveDays() - usedLeaveDays; if (application.getDays() remainingDays) { throw new IllegalArgumentException(假期余額不足剩余天數(shù): remainingDays); } // 規(guī)則3開始日期不能晚于結(jié)束日期已在DTO或?qū)嶓w中校驗(yàn) // ... 可以添加更多業(yè)務(wù)規(guī)則 } /** * 計(jì)算剩余假期。 * 這是一個(gè)純計(jì)算邏輯屬于領(lǐng)域知識(shí)。 */ public int calculateRemainingLeaveDays(Integer totalDays, Integer usedDays) { return totalDays - usedDays; } }LeaveAppliedEvent.java (領(lǐng)域事件)package com.example.employeemanager.domain.event; import lombok.AllArgsConstructor; import lombok.Data; import java.time.LocalDateTime; /** * 請(qǐng)假申請(qǐng)已提交的領(lǐng)域事件。 * 事件是過去式命名通常使用過去分詞。 */ Data AllArgsConstructor public class LeaveAppliedEvent { private Long employeeId; private String employeeName; private String employeeEmail; private Long leaveApplicationId; private Integer leaveDays; private LocalDateTime occurredOn; }4.3 第三步基礎(chǔ)設(shè)施層 - 實(shí)現(xiàn)外部依賴我們將郵件發(fā)送、消息通知等外部系統(tǒng)交互放在基礎(chǔ)設(shè)施層并通過接口抽象。NotificationService.java (接口 - 在domain或application層定義)package com.example.employeemanager.application.service; // 放在應(yīng)用層接口包 /** * 通知服務(wù)接口。 * 領(lǐng)域?qū)雍蛻?yīng)用層依賴此抽象而非具體實(shí)現(xiàn)。 */ public interface NotificationService { void sendLeaveAppliedNotification(String toEmail, String employeeName, Integer leaveDays); }EmailNotificationServiceImpl.java (基礎(chǔ)設(shè)施層實(shí)現(xiàn))package com.example.employeemanager.infrastructure.client; import com.example.employeemanager.application.service.NotificationService; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Service; /** * 郵件通知的具體實(shí)現(xiàn)。 * 這里可以集成JavaMailSender、第三方郵件SDK等。 */ Service(emailNotificationService) // 指定Bean名稱便于策略模式使用 Slf4j public class EmailNotificationServiceImpl implements NotificationService { Override public void sendLeaveAppliedNotification(String toEmail, String employeeName, Integer leaveDays) { // 模擬發(fā)送郵件 String subject 請(qǐng)假申請(qǐng)?zhí)峤怀晒? String content String.format(尊敬的%s您的%d天請(qǐng)假申請(qǐng)已提交正在審批中。, employeeName, leaveDays); log.info(發(fā)送郵件到 {}: 主題-{} 內(nèi)容-{}, toEmail, subject, content); // 實(shí)際調(diào)用 mailSender.send(...); } }WeChatNotificationServiceImpl.java (另一個(gè)實(shí)現(xiàn))package com.example.employeemanager.infrastructure.client; import com.example.employeemanager.application.service.NotificationService; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Service; Service(wechatNotificationService) Slf4j public class WeChatNotificationServiceImpl implements NotificationService { Override public void sendLeaveAppliedNotification(String toEmail, String employeeName, Integer leaveDays) { // 模擬發(fā)送企業(yè)微信消息 log.info(發(fā)送企業(yè)微信消息給員工{}: 您的{}天請(qǐng)假申請(qǐng)已提交。, employeeName, leaveDays); } }4.4 第四步應(yīng)用服務(wù)層 - 協(xié)調(diào)與編排應(yīng)用服務(wù)作為門面負(fù)責(zé)協(xié)調(diào)多個(gè)領(lǐng)域服務(wù)處理事務(wù)發(fā)布領(lǐng)域事件并調(diào)用基礎(chǔ)設(shè)施層。LeaveApplicationService.java (應(yīng)用服務(wù))package com.example.employeemanager.application.service; import com.example.employeemanager.domain.event.LeaveAppliedEvent; import com.example.employeemanager.domain.model.Employee; import com.example.employeemanager.domain.model.LeaveApplication; import com.example.employeemanager.domain.service.LeavePolicyService; import com.example.employeemanager.infrastructure.persistence.EmployeeRepository; import com.example.employeemanager.infrastructure.persistence.LeaveApplicationRepository; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.context.ApplicationEventPublisher; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; import java.time.LocalDateTime; Service RequiredArgsConstructor // Lombok生成構(gòu)造器用于依賴注入 Slf4j public class LeaveApplicationService { private final EmployeeRepository employeeRepository; private final LeaveApplicationRepository leaveApplicationRepository; private final LeavePolicyService leavePolicyService; private final ApplicationEventPublisher eventPublisher; // Spring事件發(fā)布器 // 注意這里不直接依賴具體的NotificationService而是通過事件監(jiān)聽 /** * 提交請(qǐng)假申請(qǐng) - 應(yīng)用服務(wù)方法 * param employeeId 員工ID * param startDate 開始日期 * param endDate 結(jié)束日期 * param reason 原因 * return 創(chuàng)建的請(qǐng)假申請(qǐng)ID */ Transactional public Long applyForLeave(Long employeeId, LocalDateTime startDate, LocalDateTime endDate, String reason) { // 1. 獲取領(lǐng)域?qū)嶓w Employee employee employeeRepository.findById(employeeId) .orElseThrow(() - new RuntimeException(員工不存在)); // 2. 計(jì)算已使用假期這里調(diào)用一個(gè)查詢服務(wù)為了演示假設(shè)已有 Integer usedLeaveDays leaveApplicationRepository.sumApprovedLeaveDaysByEmployee(employeeId); // 3. 創(chuàng)建請(qǐng)假申請(qǐng)領(lǐng)域?qū)ο?LeaveApplication application new LeaveApplication(); application.setEmployeeId(employeeId); application.setStartDate(startDate.toLocalDate()); application.setEndDate(endDate.toLocalDate()); // 計(jì)算天數(shù)簡化 long days java.time.temporal.ChronoUnit.DAYS.between(startDate.toLocalDate(), endDate.toLocalDate()) 1; application.setDays((int) days); application.setReason(reason); application.setStatus(LeaveApplication.LeaveStatus.PENDING); // 4. 調(diào)用領(lǐng)域服務(wù)進(jìn)行業(yè)務(wù)規(guī)則校驗(yàn) leavePolicyService.validateLeaveApplication(employee, application, usedLeaveDays); // 5. 持久化請(qǐng)假申請(qǐng) LeaveApplication savedApplication leaveApplicationRepository.save(application); log.info(請(qǐng)假申請(qǐng)已保存ID: {}, savedApplication.getId()); // 6. 發(fā)布領(lǐng)域事件解耦關(guān)鍵步驟 LeaveAppliedEvent event new LeaveAppliedEvent( employee.getId(), employee.getName(), employee.getEmail(), savedApplication.getId(), savedApplication.getDays(), LocalDateTime.now() ); eventPublisher.publishEvent(event); // 發(fā)布事件觸發(fā)后續(xù)監(jiān)聽器 // 7. 返回結(jié)果 return savedApplication.getId(); } }4.5 第五步事件監(jiān)聽器 - 處理副作用創(chuàng)建監(jiān)聽器來響應(yīng)LeaveAppliedEvent執(zhí)行發(fā)送郵件、生成報(bào)告等非核心業(yè)務(wù)邏輯。LeaveAppliedEventListener.javapackage com.example.employeemanager.interfaces.listener; import com.example.employeemanager.application.service.NotificationService; import com.example.employeemanager.domain.event.LeaveAppliedEvent; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.context.event.EventListener; import org.springframework.scheduling.annotation.Async; // 可選異步處理 import org.springframework.stereotype.Component; import java.util.List; Component RequiredArgsConstructor Slf4j public class LeaveAppliedEventListener { // 注入所有的通知服務(wù)策略模式集合 private final ListNotificationService notificationServices; // 或者注入特定的服務(wù)這里演示策略集合 // private final NotificationService emailNotificationService; // private final NotificationService wechatNotificationService; /** * 監(jiān)聽請(qǐng)假申請(qǐng)事件發(fā)送通知。 * 使用Async實(shí)現(xiàn)異步避免阻塞主業(yè)務(wù)流程。 */ Async // 需要配置EnableAsync EventListener public void handleLeaveAppliedEvent(LeaveAppliedEvent event) { log.info(監(jiān)聽到請(qǐng)假申請(qǐng)事件: {}, event); // 策略模式遍歷所有通知服務(wù)并執(zhí)行 for (NotificationService service : notificationServices) { try { service.sendLeaveAppliedNotification( event.getEmployeeEmail(), event.getEmployeeName(), event.getLeaveDays() ); } catch (Exception e) { log.error(發(fā)送通知失敗服務(wù): {}, 錯(cuò)誤: {}, service.getClass().getSimpleName(), e.getMessage()); // 根據(jù)業(yè)務(wù)決定是重試、記錄日志還是忽略 } } // 這里也可以調(diào)用ReportGenerator生成報(bào)告 // reportGenerator.generateMonthlyReport(...); } }啟用異步支持 (AsyncConfig.java)package com.example.employeemanager.config; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.EnableAsync; Configuration EnableAsync public class AsyncConfig { // 可以配置線程池等 }4.6 第六步Web接口層 - 對(duì)外暴露API最后我們創(chuàng)建干凈、簡潔的Controller它只負(fù)責(zé)接收請(qǐng)求、調(diào)用應(yīng)用服務(wù)、返回響應(yīng)。LeaveController.javapackage com.example.employeemanager.interfaces.web; import com.example.employeemanager.application.service.LeaveApplicationService; import com.example.employeemanager.interfaces.web.dto.LeaveApplyRequest; import com.example.employeemanager.interfaces.web.dto.ApiResponse; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.*; import javax.validation.Valid; RestController RequestMapping(/api/leaves) RequiredArgsConstructor public class LeaveController { private final LeaveApplicationService leaveApplicationService; PostMapping(/apply) public ApiResponseLong applyForLeave(Valid RequestBody LeaveApplyRequest request) { Long applicationId leaveApplicationService.applyForLeave( request.getEmployeeId(), request.getStartDate(), request.getEndDate(), request.getReason() ); return ApiResponse.success(applicationId); } }LeaveApplyRequest.java (DTO)package com.example.employeemanager.interfaces.web.dto; import lombok.Data; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; Data public class LeaveApplyRequest { NotNull(message 員工ID不能為空) private Long employeeId; NotNull(message 開始時(shí)間不能為空) private LocalDateTime startDate; NotNull(message 結(jié)束時(shí)間不能為空) private LocalDateTime endDate; private String reason; }ApiResponse.java (統(tǒng)一響應(yīng)體)package com.example.employeemanager.interfaces.web.dto; import lombok.Data; Data public class ApiResponseT { private boolean success; private String message; private T data; private String code; // 可擴(kuò)展錯(cuò)誤碼 public static T ApiResponseT success(T data) { ApiResponseT response new ApiResponse(); response.setSuccess(true); response.setMessage(success); response.setData(data); return response; } public static T ApiResponseT error(String message) { ApiResponseT response new ApiResponse(); response.setSuccess(false); response.setMessage(message); return response; } }5. 運(yùn)行與驗(yàn)證啟動(dòng)應(yīng)用運(yùn)行EmployeeManagerRefactoredApplication的 main 方法。初始化數(shù)據(jù)可選可以寫一個(gè)CommandLineRunner或使用data.sql插入測(cè)試員工數(shù)據(jù)。調(diào)用API使用 Postman 或 curl 測(cè)試請(qǐng)假接口。POST http://localhost:8080/api/leaves/apply Content-Type: application/json { employeeId: 1, startDate: 2024-05-27T09:00:00, endDate: 2024-05-28T18:00:00, reason: 身體不適 }觀察日志控制臺(tái)應(yīng)依次打印“請(qǐng)假申請(qǐng)已保存ID: ...”“監(jiān)聽到請(qǐng)假申請(qǐng)事件: ...”“發(fā)送郵件到 ...”“發(fā)送企業(yè)微信消息給員工 ...”6. 重構(gòu)前后對(duì)比與核心收益維度重構(gòu)前混沌重構(gòu)后清晰職責(zé)劃分EmployeeService大而全承擔(dān)過多職責(zé)。領(lǐng)域服務(wù)、應(yīng)用服務(wù)、基礎(chǔ)設(shè)施層各司其職。耦合度高度耦合郵件、報(bào)告邏輯硬編碼在業(yè)務(wù)方法中。松耦合通過接口和領(lǐng)域事件解耦核心業(yè)務(wù)邏輯純凈?？蓽y(cè)試性難以單元測(cè)試需要 Mock 大量外部依賴。領(lǐng)域服務(wù)可獨(dú)立測(cè)試應(yīng)用服務(wù)通過 Mock 領(lǐng)域服務(wù)和事件發(fā)布器測(cè)試監(jiān)聽器可單獨(dú)測(cè)試?？删S護(hù)性修改一處如換郵件服務(wù)可能影響多處。修改通知方式只需新增/替換NotificationService實(shí)現(xiàn)或修改監(jiān)聽器。業(yè)務(wù)規(guī)則修改在領(lǐng)域服務(wù)內(nèi)。可擴(kuò)展性新增一個(gè)通知渠道如短信需修改核心業(yè)務(wù)代碼。新增通知渠道只需實(shí)現(xiàn)NotificationService接口并在監(jiān)聽器中自動(dòng)生效或通過配置選擇。代碼復(fù)用業(yè)務(wù)規(guī)則如假期計(jì)算散落在各處。業(yè)務(wù)規(guī)則集中在領(lǐng)域服務(wù)可被多個(gè)應(yīng)用服務(wù)復(fù)用。核心收益總結(jié)清晰度通過分層和模式代碼結(jié)構(gòu)一目了然“我到底在做什么”變得清晰。靈活性應(yīng)對(duì)需求變更如新增審批流、新的通知方式更加從容?？删S護(hù)性每個(gè)類/方法職責(zé)單一便于閱讀、修改和調(diào)試?？蓽y(cè)試性模塊邊界清晰便于編寫單元測(cè)試和集成測(cè)試。7. 常見問題與排查思路在按照上述架構(gòu)實(shí)踐時(shí)你可能會(huì)遇到以下問題問題現(xiàn)象可能原因解決思路領(lǐng)域事件未觸發(fā)1. 事件監(jiān)聽器未被 Spring 管理缺少Component。2. 事件發(fā)布和監(jiān)聽不在同一個(gè)事務(wù)上下文中默認(rèn)在事務(wù)提交后發(fā)布。3.Async未生效未加EnableAsync。1. 檢查監(jiān)聽器類是否有Component。2. 檢查事件發(fā)布是否在事務(wù)方法內(nèi)理解TransactionalEventListener的相位。3. 檢查主類或配置類是否有EnableAsync。依賴注入失敗1. 接口有多個(gè)實(shí)現(xiàn)未指定Qualifier。2. 包掃描未覆蓋到相關(guān)類。3. 循環(huán)依賴。1. 使用Qualifier(beanName)指定注入哪個(gè)實(shí)現(xiàn)。2. 確保SpringBootApplication主類在根包或使用ComponentScan。3. 使用Lazy或重構(gòu)代碼消除循環(huán)依賴。事務(wù)不生效1. 方法不是public。2. 在同一個(gè)類內(nèi)部調(diào)用帶Transactional的方法。3. 異常類型未被回滾默認(rèn)只回滾RuntimeException和Error。1. 確保事務(wù)方法是public。2. 通過代理對(duì)象調(diào)用如從 Spring 容器獲取 Bean 再調(diào)用。3. 使用Transactional(rollbackFor Exception.class)。H2 控制臺(tái)無法訪問1.spring.h2.console.enabled未設(shè)置為true。2. 路徑配置錯(cuò)誤。3. 安全配置攔截。1. 檢查application.yml配置。2. 默認(rèn)路徑是/h2-console。3. 如果是 Spring Security 項(xiàng)目需放行該路徑。8. 最佳實(shí)踐與工程建議領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)DDD的適度應(yīng)用對(duì)于復(fù)雜核心業(yè)務(wù)如電商交易、風(fēng)控深入使用聚合根、倉儲(chǔ)、領(lǐng)域服務(wù)。對(duì)于簡單 CRUD過度設(shè)計(jì)反而增加復(fù)雜度。本文是“精簡版DDD”適合大多數(shù)后臺(tái)管理系統(tǒng)。依賴方向永遠(yuǎn)保持高層模塊領(lǐng)域?qū)?、?yīng)用層不依賴低層模塊基礎(chǔ)設(shè)施層的具體實(shí)現(xiàn)而是依賴其抽象接口。這是依賴倒置原則。領(lǐng)域事件的合理使用事件用于解耦核心業(yè)務(wù)與副作用如發(fā)送通知、更新冗余數(shù)據(jù)、記錄審計(jì)日志。對(duì)于強(qiáng)一致性要求的操作如扣減庫存仍需在事務(wù)內(nèi)完成。異常處理定義清晰的業(yè)務(wù)異常體系如BusinessException在應(yīng)用層或全局異常處理器中統(tǒng)一捕獲并轉(zhuǎn)換為友好的 API 響應(yīng)。日志記錄在關(guān)鍵業(yè)務(wù)節(jié)點(diǎn)如領(lǐng)域事件發(fā)布、外部服務(wù)調(diào)用記錄 INFO 級(jí)別日志在異常處記錄 ERROR 級(jí)別日志并帶上上下文信息。配置管理將郵件服務(wù)器地址、消息隊(duì)列連接等外部依賴配置放在application.yml或 Apollo/Nacos 中與代碼分離。測(cè)試策略領(lǐng)域服務(wù)重點(diǎn)進(jìn)行單元測(cè)試驗(yàn)證業(yè)務(wù)規(guī)則。應(yīng)用服務(wù)進(jìn)行集成測(cè)試Mock 倉儲(chǔ)和外部服務(wù)。API 層進(jìn)行端到端測(cè)試如使用SpringBootTest和TestRestTemplate。代碼審查關(guān)注點(diǎn)審查時(shí)除了功能正確性更要關(guān)注架構(gòu)邊界是否被破壞、是否有新的“上帝類”產(chǎn)生、依賴關(guān)系是否合理。通過這樣一套從“混沌”到“清晰”的重構(gòu)過程我們不僅得到了一個(gè)結(jié)構(gòu)良好的項(xiàng)目更重要的是建立了一套應(yīng)對(duì)復(fù)雜性的思維框架。下次當(dāng)你再面對(duì)一團(tuán)亂麻的代碼感覺“我到底做了個(gè)什么東西”時(shí)不妨停下來從識(shí)別職責(zé)、解耦依賴、定義邊界開始一步步將它梳理清晰。這個(gè)過程本身就是工程師成長中最有價(jià)值的修煉。 Spring Boot項(xiàng)目重構(gòu)實(shí)戰(zhàn)：從混沌代碼到清晰架構(gòu)的演進(jìn)之路
最近在折騰一個(gè)項(xiàng)目看著滿屏的代碼和日志我陷入了沉思我到底做了個(gè)什么東西啊啊啊啊啊相信很多開發(fā)者朋友在項(xiàng)目攻堅(jiān)期面對(duì)復(fù)雜的業(yè)務(wù)邏輯、層層嵌套的依賴和不斷涌現(xiàn)的 Bug 時(shí)都有過類似的靈魂拷問。這種感覺就像是在一片混沌中摸索代碼寫了不少功能也堆疊了很多但項(xiàng)目的整體輪廓和核心價(jià)值卻越來越模糊。本文正是源于這樣一次深刻的“項(xiàng)目復(fù)盤焦慮”。我將以一個(gè)典型的、功能逐漸“膨脹”的后臺(tái)管理系統(tǒng)為例完整拆解從需求混沌到架構(gòu)清晰的全過程。我們會(huì)一起梳理如何識(shí)別代碼中的“壞味道”如何使用設(shè)計(jì)模式進(jìn)行重構(gòu)并最終搭建一個(gè)可維護(hù)、易擴(kuò)展的 Spring Boot 項(xiàng)目骨架。無論你是正在為遺留系統(tǒng)焦頭爛額的初級(jí)開發(fā)者還是希望提升工程化思維的中高級(jí)工程師這篇從“混沌”到“秩序”的實(shí)戰(zhàn)筆記都能提供直接的參考。1. 項(xiàng)目背景與“混沌”現(xiàn)狀分析我們從一個(gè)常見的場(chǎng)景開始公司需要一個(gè)內(nèi)部使用的“員工信息管理平臺(tái)”。最初的版本可能非常簡單。1.1 初始需求與快速實(shí)現(xiàn)老板說“先做個(gè)能查員工信息和錄入請(qǐng)假的功能?！?于是一個(gè)典型的“速成”項(xiàng)目誕生了。為了趕時(shí)間我們可能會(huì)寫出類似下面的代碼結(jié)構(gòu)項(xiàng)目結(jié)構(gòu)初始版employee-manager/ ├── src/ │ └── main/ │ ├── java/ │ │ └── com/ │ │ └── example/ │ │ └── employeemanager/ │ │ ├── EmployeeController.java // 控制層 │ │ ├── EmployeeService.java // 服務(wù)層 │ │ ├── Employee.java // 實(shí)體類 │ │ ├── EmployeeRepository.java // 數(shù)據(jù)訪問層JPA │ │ ├── LeaveController.java // 請(qǐng)假控制層 │ │ ├── LeaveService.java // 請(qǐng)假服務(wù)層 │ │ └── Leave.java // 請(qǐng)假實(shí)體類 │ └── resources/ │ ├── application.properties │ └── ...數(shù)據(jù)庫配置 └── pom.xml核心代碼示例EmployeeService.java - 初始版Service public class EmployeeService { Autowired private EmployeeRepository employeeRepository; Autowired private EmailSender emailSender; // 一個(gè)直接注入的郵件發(fā)送類 Autowired private ReportGenerator reportGenerator; // 一個(gè)直接注入的報(bào)告生成類 public Employee getEmployeeById(Long id) { // 直接調(diào)用Repository return employeeRepository.findById(id).orElse(null); } public void applyLeave(LeaveRequest request) { // 1. 驗(yàn)證員工狀態(tài) Employee emp employeeRepository.findById(request.getEmployeeId()).orElseThrow(...); if (!ACTIVE.equals(emp.getStatus())) { throw new RuntimeException(員工狀態(tài)異常無法請(qǐng)假); } // 2. 業(yè)務(wù)邏輯檢查假期余額等這里混雜了大量邏輯 int usedLeaveDays calculateUsedLeaveDays(emp.getId()); if (request.getDays() (emp.getTotalLeaveDays() - usedLeaveDays)) { throw new RuntimeException(假期余額不足); } // 3. 保存請(qǐng)假記錄直接操作另一個(gè)實(shí)體 Leave leave new Leave(); leave.setEmployeeId(emp.getId()); leave.setStartDate(request.getStartDate()); // ... 其他字段設(shè)置 // 注意這里沒有LeaveRepository假設(shè)直接在Service里用JPA保存 // entityManager.persist(leave); // 4. 發(fā)送通知郵件緊耦合 emailSender.sendEmail(emp.getEmail(), 您的請(qǐng)假申請(qǐng)已提交, 請(qǐng)假詳情...); // 5. 生成月度報(bào)告為何在這里 reportGenerator.generateMonthlyReport(emp.getDepartment()); } // 一個(gè)私有方法可能越來越復(fù)雜 private int calculateUsedLeaveDays(Long employeeId) { // 直接寫SQL或調(diào)用其他Repository // 邏輯復(fù)雜且無法復(fù)用 return 0; } }1.2 “混沌”的典型特征隨著需求增加“再加個(gè)績效考核模塊”、“對(duì)接OA系統(tǒng)審批流”、“導(dǎo)出數(shù)據(jù)要支持多種格式”上面的代碼會(huì)迅速“膨脹”并出現(xiàn)以下問題單一職責(zé)原則被破壞EmployeeService變成了一個(gè)“上帝類”既管員工信息又管請(qǐng)假流程還負(fù)責(zé)發(fā)郵件、生成報(bào)告。緊耦合服務(wù)層直接依賴具體的郵件發(fā)送 (EmailSender) 和報(bào)告生成 (ReportGenerator) 實(shí)現(xiàn)。想換一個(gè)郵件服務(wù)商需要修改所有調(diào)用的地方。代碼重復(fù)計(jì)算假期余額的邏輯可能在其他服務(wù)如AttendanceService中又被復(fù)制粘貼了一遍。可測(cè)試性差由于緊耦合想要單元測(cè)試applyLeave方法你必須同時(shí) Mock 數(shù)據(jù)庫、郵件服務(wù)和報(bào)告服務(wù)測(cè)試變得極其笨重。擴(kuò)展困難老板說“請(qǐng)假成功后不僅要發(fā)郵件還要發(fā)企業(yè)微信消息?！?你就得去修改applyLeave方法添加新的依賴和調(diào)用違反了開閉原則。這就是“我到底做了個(gè)什么東西”的根源項(xiàng)目沒有清晰的架構(gòu)邊界代碼像一團(tuán)糾纏在一起的毛線任何改動(dòng)都牽一發(fā)而動(dòng)全身開發(fā)者的心智負(fù)擔(dān)極重。2. 重構(gòu)目標(biāo)與核心設(shè)計(jì)模式引入我們的目標(biāo)是將這個(gè)“混沌”的系統(tǒng)重構(gòu)成一個(gè)層次清晰、職責(zé)分明、易于擴(kuò)展的架構(gòu)。我們會(huì)引入幾個(gè)關(guān)鍵的設(shè)計(jì)模式和架構(gòu)思想。2.1 目標(biāo)架構(gòu)概覽重構(gòu)后的項(xiàng)目應(yīng)該遵循經(jīng)典的分層架構(gòu)并引入領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)DDD的一些概念精簡版和設(shè)計(jì)模式employee-manager-refactored/ ├── src/main/java/com/example/employeemanager/ │ ├── common/ # 通用組件 │ │ ├── exception/ # 全局異常處理 │ │ ├── response/ # 統(tǒng)一響應(yīng)體 │ │ └── utils/ # 工具類 │ ├── config/ # 配置類如Swagger, 線程池 │ ├── domain/ # 領(lǐng)域?qū)雍诵臉I(yè)務(wù)邏輯 │ │ ├── model/ # 領(lǐng)域?qū)嶓w/值對(duì)象 │ │ ├── service/ # 領(lǐng)域服務(wù)純業(yè)務(wù)邏輯無依賴 │ │ └── event/ # 領(lǐng)域事件 │ ├── application/ # 應(yīng)用層協(xié)調(diào)領(lǐng)域服務(wù)事務(wù)邊界 │ │ ├── service/ # 應(yīng)用服務(wù) │ │ └── dto/ # 數(shù)據(jù)傳輸對(duì)象 │ ├── infrastructure/ # 基礎(chǔ)設(shè)施層技術(shù)實(shí)現(xiàn)細(xì)節(jié) │ │ ├── persistence/ # 持久化JPA實(shí)現(xiàn) │ │ ├── client/ # 外部服務(wù)客戶端郵件、消息 │ │ └── message/ # 消息隊(duì)列發(fā)送 │ └── interfaces/ # 接口層對(duì)外暴露 │ ├── web/ # Web控制器RESTful API │ └── assembler/ # DTO與領(lǐng)域?qū)ο筠D(zhuǎn)換器 └── ...2.2 核心設(shè)計(jì)模式應(yīng)用場(chǎng)景策略模式Strategy Pattern用于處理多種類型的報(bào)告生成PDF、Excel、CSV或消息通知郵件、微信、短信。工廠模式Factory Pattern用于根據(jù)類型創(chuàng)建不同的策略實(shí)例。觀察者模式/領(lǐng)域事件Observer Pattern / Domain Event用于解耦核心業(yè)務(wù)邏輯與副作用操作。例如員工請(qǐng)假成功這個(gè)“事件”發(fā)生后監(jiān)聽該事件的處理器可以異步去發(fā)送郵件和消息而不是在請(qǐng)假方法內(nèi)同步調(diào)用。依賴注入Dependency InjectionSpring 核心用于管理對(duì)象生命周期和解耦。門面模式Facade Pattern應(yīng)用服務(wù)層可以作為門面對(duì)外提供粗粒度的業(yè)務(wù)接口內(nèi)部協(xié)調(diào)多個(gè)領(lǐng)域服務(wù)。3. 環(huán)境準(zhǔn)備與項(xiàng)目搭建我們使用 Spring Boot 2.7.x 和 Java 11 作為基準(zhǔn)環(huán)境。確保你的開發(fā)環(huán)境已準(zhǔn)備好。3.1 基礎(chǔ)環(huán)境與依賴操作系統(tǒng)Windows 10/11, macOS, Linux 均可。JDK11 或 17LTS版本。構(gòu)建工具M(jìn)aven 3.6 或 Gradle。IDEIntelliJ IDEA推薦或 Eclipse。核心 Maven 依賴 (pom.xml)?xml version1.0 encodingUTF-8? project xmlnshttp://maven.apache.org/POM/4.0.0 xmlns:xsihttp://www.w3.org/2001/XMLSchema-instance xsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd modelVersion4.0.0/modelVersion parent groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-parent/artifactId version2.7.18/version !-- 使用穩(wěn)定的版本 -- relativePath/ /parent groupIdcom.example/groupId artifactIdemployee-manager-refactored/artifactId version0.0.1-SNAPSHOT/version nameemployee-manager-refactored/name descriptionRefactored Employee Management System/description properties java.version11/java.version /properties dependencies !-- Web -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency !-- Data JPA -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-data-jpa/artifactId /dependency !-- 數(shù)據(jù)庫以H2內(nèi)存數(shù)據(jù)庫為例方便演示 -- dependency groupIdcom.h2database/groupId artifactIdh2/artifactId scoperuntime/scope /dependency !-- Lombok簡化代碼 -- dependency groupIdorg.projectlombok/groupId artifactIdlombok/artifactId optionaltrue/optional /dependency !-- 測(cè)試 -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-test/artifactId scopetest/scope /dependency !-- 可選用于參數(shù)校驗(yàn) -- dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-validation/artifactId /dependency !-- 可選用于領(lǐng)域事件Spring自帶 -- !-- spring-boot-starter-data-jpa 已包含相關(guān)事務(wù)支持 -- /dependencies build plugins plugin groupIdorg.springframework.boot/groupId artifactIdspring-boot-maven-plugin/artifactId configuration excludes exclude groupIdorg.projectlombok/groupId artifactIdlombok/artifactId /exclude /excludes /configuration /plugin /plugins /build /project基礎(chǔ)配置 (application.yml)spring: application: name: employee-manager datasource: url: jdbc:h2:mem:testdb;DB_CLOSE_DELAY-1;DB_CLOSE_ON_EXITFALSE driver-class-name: org.h2.Driver username: sa password: jpa: hibernate: ddl-auto: update # 開發(fā)環(huán)境生產(chǎn)環(huán)境請(qǐng)使用validate或none配合Flyway/Liquibase show-sql: true properties: hibernate: format_sql: true h2: console: enabled: true # 開啟H2控制臺(tái)訪問 http://localhost:8080/h2-console path: /h2-console server: port: 8080 logging: level: com.example.employeemanager: DEBUG4. 核心重構(gòu)實(shí)戰(zhàn)從“混沌”到“清晰”我們將一步步重構(gòu)最初的EmployeeService應(yīng)用之前提到的模式。4.1 第一步定義清晰的領(lǐng)域模型首先將核心業(yè)務(wù)概念抽象成領(lǐng)域?qū)嶓w和值對(duì)象放在domain/model/下。Employee.java (領(lǐng)域?qū)嶓w)package com.example.employeemanager.domain.model; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; import javax.persistence.*; import java.time.LocalDate; Entity Table(name employees) Data NoArgsConstructor AllArgsConstructor public class Employee { Id GeneratedValue(strategy GenerationType.IDENTITY) private Long id; private String name; private String email; private String department; Enumerated(EnumType.STRING) private EmployeeStatus status; // 枚舉ACTIVE, INACTIVE private Integer totalLeaveDays; // 值對(duì)象可以嵌入這里簡化 private LocalDate joinDate; public enum EmployeeStatus { ACTIVE, INACTIVE } // 領(lǐng)域方法判斷是否可請(qǐng)假 public boolean canApplyLeave() { return this.status EmployeeStatus.ACTIVE; } }LeaveApplication.java (領(lǐng)域?qū)嶓w - 請(qǐng)假申請(qǐng))package com.example.employeemanager.domain.model; import lombok.Data; import javax.persistence.*; import java.time.LocalDate; Entity Table(name leave_applications) Data public class LeaveApplication { Id GeneratedValue(strategy GenerationType.IDENTITY) private Long id; private Long employeeId; private LocalDate startDate; private LocalDate endDate; private Integer days; Enumerated(EnumType.STRING) private LeaveStatus status; // PENDING, APPROVED, REJECTED private String reason; public enum LeaveStatus { PENDING, APPROVED, REJECTED } }4.2 第二步引入領(lǐng)域服務(wù)與領(lǐng)域事件將核心的、不依賴于外部資源的業(yè)務(wù)邏輯放入領(lǐng)域服務(wù)。同時(shí)使用領(lǐng)域事件來解耦。LeavePolicyService.java (領(lǐng)域服務(wù))package com.example.employeemanager.domain.service; import com.example.employeemanager.domain.model.Employee; import com.example.employeemanager.domain.model.LeaveApplication; import org.springframework.stereotype.Service; import javax.transaction.Transactional; /** * 請(qǐng)假策略領(lǐng)域服務(wù)。 * 只包含核心業(yè)務(wù)規(guī)則不依賴外部系統(tǒng)如郵件、報(bào)告。 */ Service Transactional // 事務(wù)放在領(lǐng)域服務(wù)或應(yīng)用服務(wù)層視情況而定 public class LeavePolicyService { /** * 驗(yàn)證請(qǐng)假申請(qǐng)是否合法。 * param employee 員工 * param application 請(qǐng)假申請(qǐng) * param usedLeaveDays 已使用的假期天數(shù) * throws IllegalArgumentException 如果驗(yàn)證不通過 */ public void validateLeaveApplication(Employee employee, LeaveApplication application, Integer usedLeaveDays) { // 規(guī)則1員工狀態(tài)必須為活躍 if (!employee.canApplyLeave()) { throw new IllegalArgumentException(員工狀態(tài)異常無法請(qǐng)假); } // 規(guī)則2請(qǐng)假天數(shù)不能超過剩余假期 int remainingDays employee.getTotalLeaveDays() - usedLeaveDays; if (application.getDays() remainingDays) { throw new IllegalArgumentException(假期余額不足剩余天數(shù): remainingDays); } // 規(guī)則3開始日期不能晚于結(jié)束日期已在DTO或?qū)嶓w中校驗(yàn) // ... 可以添加更多業(yè)務(wù)規(guī)則 } /** * 計(jì)算剩余假期。 * 這是一個(gè)純計(jì)算邏輯屬于領(lǐng)域知識(shí)。 */ public int calculateRemainingLeaveDays(Integer totalDays, Integer usedDays) { return totalDays - usedDays; } }LeaveAppliedEvent.java (領(lǐng)域事件)package com.example.employeemanager.domain.event; import lombok.AllArgsConstructor; import lombok.Data; import java.time.LocalDateTime; /** * 請(qǐng)假申請(qǐng)已提交的領(lǐng)域事件。 * 事件是過去式命名通常使用過去分詞。 */ Data AllArgsConstructor public class LeaveAppliedEvent { private Long employeeId; private String employeeName; private String employeeEmail; private Long leaveApplicationId; private Integer leaveDays; private LocalDateTime occurredOn; }4.3 第三步基礎(chǔ)設(shè)施層 - 實(shí)現(xiàn)外部依賴我們將郵件發(fā)送、消息通知等外部系統(tǒng)交互放在基礎(chǔ)設(shè)施層并通過接口抽象。NotificationService.java (接口 - 在domain或application層定義)package com.example.employeemanager.application.service; // 放在應(yīng)用層接口包 /** * 通知服務(wù)接口。 * 領(lǐng)域?qū)雍蛻?yīng)用層依賴此抽象而非具體實(shí)現(xiàn)。 */ public interface NotificationService { void sendLeaveAppliedNotification(String toEmail, String employeeName, Integer leaveDays); }EmailNotificationServiceImpl.java (基礎(chǔ)設(shè)施層實(shí)現(xiàn))package com.example.employeemanager.infrastructure.client; import com.example.employeemanager.application.service.NotificationService; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Service; /** * 郵件通知的具體實(shí)現(xiàn)。 * 這里可以集成JavaMailSender、第三方郵件SDK等。 */ Service(emailNotificationService) // 指定Bean名稱便于策略模式使用 Slf4j public class EmailNotificationServiceImpl implements NotificationService { Override public void sendLeaveAppliedNotification(String toEmail, String employeeName, Integer leaveDays) { // 模擬發(fā)送郵件 String subject 請(qǐng)假申請(qǐng)?zhí)峤怀晒? String content String.format(尊敬的%s您的%d天請(qǐng)假申請(qǐng)已提交正在審批中。, employeeName, leaveDays); log.info(發(fā)送郵件到 {}: 主題-{} 內(nèi)容-{}, toEmail, subject, content); // 實(shí)際調(diào)用 mailSender.send(...); } }WeChatNotificationServiceImpl.java (另一個(gè)實(shí)現(xiàn))package com.example.employeemanager.infrastructure.client; import com.example.employeemanager.application.service.NotificationService; import lombok.extern.slf4j.Slf4j; import org.springframework.stereotype.Service; Service(wechatNotificationService) Slf4j public class WeChatNotificationServiceImpl implements NotificationService { Override public void sendLeaveAppliedNotification(String toEmail, String employeeName, Integer leaveDays) { // 模擬發(fā)送企業(yè)微信消息 log.info(發(fā)送企業(yè)微信消息給員工{}: 您的{}天請(qǐng)假申請(qǐng)已提交。, employeeName, leaveDays); } }4.4 第四步應(yīng)用服務(wù)層 - 協(xié)調(diào)與編排應(yīng)用服務(wù)作為門面負(fù)責(zé)協(xié)調(diào)多個(gè)領(lǐng)域服務(wù)處理事務(wù)發(fā)布領(lǐng)域事件并調(diào)用基礎(chǔ)設(shè)施層。LeaveApplicationService.java (應(yīng)用服務(wù))package com.example.employeemanager.application.service; import com.example.employeemanager.domain.event.LeaveAppliedEvent; import com.example.employeemanager.domain.model.Employee; import com.example.employeemanager.domain.model.LeaveApplication; import com.example.employeemanager.domain.service.LeavePolicyService; import com.example.employeemanager.infrastructure.persistence.EmployeeRepository; import com.example.employeemanager.infrastructure.persistence.LeaveApplicationRepository; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.context.ApplicationEventPublisher; import org.springframework.stereotype.Service; import org.springframework.transaction.annotation.Transactional; import java.time.LocalDateTime; Service RequiredArgsConstructor // Lombok生成構(gòu)造器用于依賴注入 Slf4j public class LeaveApplicationService { private final EmployeeRepository employeeRepository; private final LeaveApplicationRepository leaveApplicationRepository; private final LeavePolicyService leavePolicyService; private final ApplicationEventPublisher eventPublisher; // Spring事件發(fā)布器 // 注意這里不直接依賴具體的NotificationService而是通過事件監(jiān)聽 /** * 提交請(qǐng)假申請(qǐng) - 應(yīng)用服務(wù)方法 * param employeeId 員工ID * param startDate 開始日期 * param endDate 結(jié)束日期 * param reason 原因 * return 創(chuàng)建的請(qǐng)假申請(qǐng)ID */ Transactional public Long applyForLeave(Long employeeId, LocalDateTime startDate, LocalDateTime endDate, String reason) { // 1. 獲取領(lǐng)域?qū)嶓w Employee employee employeeRepository.findById(employeeId) .orElseThrow(() - new RuntimeException(員工不存在)); // 2. 計(jì)算已使用假期這里調(diào)用一個(gè)查詢服務(wù)為了演示假設(shè)已有 Integer usedLeaveDays leaveApplicationRepository.sumApprovedLeaveDaysByEmployee(employeeId); // 3. 創(chuàng)建請(qǐng)假申請(qǐng)領(lǐng)域?qū)ο?LeaveApplication application new LeaveApplication(); application.setEmployeeId(employeeId); application.setStartDate(startDate.toLocalDate()); application.setEndDate(endDate.toLocalDate()); // 計(jì)算天數(shù)簡化 long days java.time.temporal.ChronoUnit.DAYS.between(startDate.toLocalDate(), endDate.toLocalDate()) 1; application.setDays((int) days); application.setReason(reason); application.setStatus(LeaveApplication.LeaveStatus.PENDING); // 4. 調(diào)用領(lǐng)域服務(wù)進(jìn)行業(yè)務(wù)規(guī)則校驗(yàn) leavePolicyService.validateLeaveApplication(employee, application, usedLeaveDays); // 5. 持久化請(qǐng)假申請(qǐng) LeaveApplication savedApplication leaveApplicationRepository.save(application); log.info(請(qǐng)假申請(qǐng)已保存ID: {}, savedApplication.getId()); // 6. 發(fā)布領(lǐng)域事件解耦關(guān)鍵步驟 LeaveAppliedEvent event new LeaveAppliedEvent( employee.getId(), employee.getName(), employee.getEmail(), savedApplication.getId(), savedApplication.getDays(), LocalDateTime.now() ); eventPublisher.publishEvent(event); // 發(fā)布事件觸發(fā)后續(xù)監(jiān)聽器 // 7. 返回結(jié)果 return savedApplication.getId(); } }4.5 第五步事件監(jiān)聽器 - 處理副作用創(chuàng)建監(jiān)聽器來響應(yīng)LeaveAppliedEvent執(zhí)行發(fā)送郵件、生成報(bào)告等非核心業(yè)務(wù)邏輯。LeaveAppliedEventListener.javapackage com.example.employeemanager.interfaces.listener; import com.example.employeemanager.application.service.NotificationService; import com.example.employeemanager.domain.event.LeaveAppliedEvent; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.context.event.EventListener; import org.springframework.scheduling.annotation.Async; // 可選異步處理 import org.springframework.stereotype.Component; import java.util.List; Component RequiredArgsConstructor Slf4j public class LeaveAppliedEventListener { // 注入所有的通知服務(wù)策略模式集合 private final ListNotificationService notificationServices; // 或者注入特定的服務(wù)這里演示策略集合 // private final NotificationService emailNotificationService; // private final NotificationService wechatNotificationService; /** * 監(jiān)聽請(qǐng)假申請(qǐng)事件發(fā)送通知。 * 使用Async實(shí)現(xiàn)異步避免阻塞主業(yè)務(wù)流程。 */ Async // 需要配置EnableAsync EventListener public void handleLeaveAppliedEvent(LeaveAppliedEvent event) { log.info(監(jiān)聽到請(qǐng)假申請(qǐng)事件: {}, event); // 策略模式遍歷所有通知服務(wù)并執(zhí)行 for (NotificationService service : notificationServices) { try { service.sendLeaveAppliedNotification( event.getEmployeeEmail(), event.getEmployeeName(), event.getLeaveDays() ); } catch (Exception e) { log.error(發(fā)送通知失敗服務(wù): {}, 錯(cuò)誤: {}, service.getClass().getSimpleName(), e.getMessage()); // 根據(jù)業(yè)務(wù)決定是重試、記錄日志還是忽略 } } // 這里也可以調(diào)用ReportGenerator生成報(bào)告 // reportGenerator.generateMonthlyReport(...); } }啟用異步支持 (AsyncConfig.java)package com.example.employeemanager.config; import org.springframework.context.annotation.Configuration; import org.springframework.scheduling.annotation.EnableAsync; Configuration EnableAsync public class AsyncConfig { // 可以配置線程池等 }4.6 第六步Web接口層 - 對(duì)外暴露API最后我們創(chuàng)建干凈、簡潔的Controller它只負(fù)責(zé)接收請(qǐng)求、調(diào)用應(yīng)用服務(wù)、返回響應(yīng)。LeaveController.javapackage com.example.employeemanager.interfaces.web; import com.example.employeemanager.application.service.LeaveApplicationService; import com.example.employeemanager.interfaces.web.dto.LeaveApplyRequest; import com.example.employeemanager.interfaces.web.dto.ApiResponse; import lombok.RequiredArgsConstructor; import org.springframework.web.bind.annotation.*; import javax.validation.Valid; RestController RequestMapping(/api/leaves) RequiredArgsConstructor public class LeaveController { private final LeaveApplicationService leaveApplicationService; PostMapping(/apply) public ApiResponseLong applyForLeave(Valid RequestBody LeaveApplyRequest request) { Long applicationId leaveApplicationService.applyForLeave( request.getEmployeeId(), request.getStartDate(), request.getEndDate(), request.getReason() ); return ApiResponse.success(applicationId); } }LeaveApplyRequest.java (DTO)package com.example.employeemanager.interfaces.web.dto; import lombok.Data; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; Data public class LeaveApplyRequest { NotNull(message 員工ID不能為空) private Long employeeId; NotNull(message 開始時(shí)間不能為空) private LocalDateTime startDate; NotNull(message 結(jié)束時(shí)間不能為空) private LocalDateTime endDate; private String reason; }ApiResponse.java (統(tǒng)一響應(yīng)體)package com.example.employeemanager.interfaces.web.dto; import lombok.Data; Data public class ApiResponseT { private boolean success; private String message; private T data; private String code; // 可擴(kuò)展錯(cuò)誤碼 public static T ApiResponseT success(T data) { ApiResponseT response new ApiResponse(); response.setSuccess(true); response.setMessage(success); response.setData(data); return response; } public static T ApiResponseT error(String message) { ApiResponseT response new ApiResponse(); response.setSuccess(false); response.setMessage(message); return response; } }5. 運(yùn)行與驗(yàn)證啟動(dòng)應(yīng)用運(yùn)行EmployeeManagerRefactoredApplication的 main 方法。初始化數(shù)據(jù)可選可以寫一個(gè)CommandLineRunner或使用data.sql插入測(cè)試員工數(shù)據(jù)。調(diào)用API使用 Postman 或 curl 測(cè)試請(qǐng)假接口。POST http://localhost:8080/api/leaves/apply Content-Type: application/json { employeeId: 1, startDate: 2024-05-27T09:00:00, endDate: 2024-05-28T18:00:00, reason: 身體不適 }觀察日志控制臺(tái)應(yīng)依次打印“請(qǐng)假申請(qǐng)已保存ID: ...”“監(jiān)聽到請(qǐng)假申請(qǐng)事件: ...”“發(fā)送郵件到 ...”“發(fā)送企業(yè)微信消息給員工 ...”6. 重構(gòu)前后對(duì)比與核心收益維度重構(gòu)前混沌重構(gòu)后清晰職責(zé)劃分EmployeeService大而全承擔(dān)過多職責(zé)。領(lǐng)域服務(wù)、應(yīng)用服務(wù)、基礎(chǔ)設(shè)施層各司其職。耦合度高度耦合郵件、報(bào)告邏輯硬編碼在業(yè)務(wù)方法中。松耦合通過接口和領(lǐng)域事件解耦核心業(yè)務(wù)邏輯純凈?？蓽y(cè)試性難以單元測(cè)試需要 Mock 大量外部依賴。領(lǐng)域服務(wù)可獨(dú)立測(cè)試應(yīng)用服務(wù)通過 Mock 領(lǐng)域服務(wù)和事件發(fā)布器測(cè)試監(jiān)聽器可單獨(dú)測(cè)試?？删S護(hù)性修改一處如換郵件服務(wù)可能影響多處。修改通知方式只需新增/替換NotificationService實(shí)現(xiàn)或修改監(jiān)聽器。業(yè)務(wù)規(guī)則修改在領(lǐng)域服務(wù)內(nèi)。可擴(kuò)展性新增一個(gè)通知渠道如短信需修改核心業(yè)務(wù)代碼。新增通知渠道只需實(shí)現(xiàn)NotificationService接口并在監(jiān)聽器中自動(dòng)生效或通過配置選擇。代碼復(fù)用業(yè)務(wù)規(guī)則如假期計(jì)算散落在各處。業(yè)務(wù)規(guī)則集中在領(lǐng)域服務(wù)可被多個(gè)應(yīng)用服務(wù)復(fù)用。核心收益總結(jié)清晰度通過分層和模式代碼結(jié)構(gòu)一目了然“我到底在做什么”變得清晰。靈活性應(yīng)對(duì)需求變更如新增審批流、新的通知方式更加從容?？删S護(hù)性每個(gè)類/方法職責(zé)單一便于閱讀、修改和調(diào)試?？蓽y(cè)試性模塊邊界清晰便于編寫單元測(cè)試和集成測(cè)試。7. 常見問題與排查思路在按照上述架構(gòu)實(shí)踐時(shí)你可能會(huì)遇到以下問題問題現(xiàn)象可能原因解決思路領(lǐng)域事件未觸發(fā)1. 事件監(jiān)聽器未被 Spring 管理缺少Component。2. 事件發(fā)布和監(jiān)聽不在同一個(gè)事務(wù)上下文中默認(rèn)在事務(wù)提交后發(fā)布。3.Async未生效未加EnableAsync。1. 檢查監(jiān)聽器類是否有Component。2. 檢查事件發(fā)布是否在事務(wù)方法內(nèi)理解TransactionalEventListener的相位。3. 檢查主類或配置類是否有EnableAsync。依賴注入失敗1. 接口有多個(gè)實(shí)現(xiàn)未指定Qualifier。2. 包掃描未覆蓋到相關(guān)類。3. 循環(huán)依賴。1. 使用Qualifier(beanName)指定注入哪個(gè)實(shí)現(xiàn)。2. 確保SpringBootApplication主類在根包或使用ComponentScan。3. 使用Lazy或重構(gòu)代碼消除循環(huán)依賴。事務(wù)不生效1. 方法不是public。2. 在同一個(gè)類內(nèi)部調(diào)用帶Transactional的方法。3. 異常類型未被回滾默認(rèn)只回滾RuntimeException和Error。1. 確保事務(wù)方法是public。2. 通過代理對(duì)象調(diào)用如從 Spring 容器獲取 Bean 再調(diào)用。3. 使用Transactional(rollbackFor Exception.class)。H2 控制臺(tái)無法訪問1.spring.h2.console.enabled未設(shè)置為true。2. 路徑配置錯(cuò)誤。3. 安全配置攔截。1. 檢查application.yml配置。2. 默認(rèn)路徑是/h2-console。3. 如果是 Spring Security 項(xiàng)目需放行該路徑。8. 最佳實(shí)踐與工程建議領(lǐng)域驅(qū)動(dòng)設(shè)計(jì)DDD的適度應(yīng)用對(duì)于復(fù)雜核心業(yè)務(wù)如電商交易、風(fēng)控深入使用聚合根、倉儲(chǔ)、領(lǐng)域服務(wù)。對(duì)于簡單 CRUD過度設(shè)計(jì)反而增加復(fù)雜度。本文是“精簡版DDD”適合大多數(shù)后臺(tái)管理系統(tǒng)。依賴方向永遠(yuǎn)保持高層模塊領(lǐng)域?qū)?、?yīng)用層不依賴低層模塊基礎(chǔ)設(shè)施層的具體實(shí)現(xiàn)而是依賴其抽象接口。這是依賴倒置原則。領(lǐng)域事件的合理使用事件用于解耦核心業(yè)務(wù)與副作用如發(fā)送通知、更新冗余數(shù)據(jù)、記錄審計(jì)日志。對(duì)于強(qiáng)一致性要求的操作如扣減庫存仍需在事務(wù)內(nèi)完成。異常處理定義清晰的業(yè)務(wù)異常體系如BusinessException在應(yīng)用層或全局異常處理器中統(tǒng)一捕獲并轉(zhuǎn)換為友好的 API 響應(yīng)。日志記錄在關(guān)鍵業(yè)務(wù)節(jié)點(diǎn)如領(lǐng)域事件發(fā)布、外部服務(wù)調(diào)用記錄 INFO 級(jí)別日志在異常處記錄 ERROR 級(jí)別日志并帶上上下文信息。配置管理將郵件服務(wù)器地址、消息隊(duì)列連接等外部依賴配置放在application.yml或 Apollo/Nacos 中與代碼分離。測(cè)試策略領(lǐng)域服務(wù)重點(diǎn)進(jìn)行單元測(cè)試驗(yàn)證業(yè)務(wù)規(guī)則。應(yīng)用服務(wù)進(jìn)行集成測(cè)試Mock 倉儲(chǔ)和外部服務(wù)。API 層進(jìn)行端到端測(cè)試如使用SpringBootTest和TestRestTemplate。代碼審查關(guān)注點(diǎn)審查時(shí)除了功能正確性更要關(guān)注架構(gòu)邊界是否被破壞、是否有新的“上帝類”產(chǎn)生、依賴關(guān)系是否合理。通過這樣一套從“混沌”到“清晰”的重構(gòu)過程我們不僅得到了一個(gè)結(jié)構(gòu)良好的項(xiàng)目更重要的是建立了一套應(yīng)對(duì)復(fù)雜性的思維框架。下次當(dāng)你再面對(duì)一團(tuán)亂麻的代碼感覺“我到底做了個(gè)什么東西”時(shí)不妨停下來從識(shí)別職責(zé)、解耦依賴、定義邊界開始一步步將它梳理清晰。這個(gè)過程本身就是工程師成長中最有價(jià)值的修煉。