翻了一下之前剛入職時候的學習筆記,發現之前在熟悉業務代碼的時候曾經專門學習並整理過過設計模式中的責任鏈模式,之前只是對其簡單瞭解過常用的設計模式有哪些,並未結合實例和源碼深入對其探究,利用熟悉代碼契機進行系統學習並整理文檔如下。 ...
1.前言
emm,翻了一下之前剛入職時候的學習筆記,發現之前在熟悉業務代碼的時候曾經專門學習並整理過過設計模式中的責任鏈模式,之前只是對其簡單瞭解過常用的設計模式有哪些,並未結合實例和源碼深入對其探究,利用熟悉代碼契機進行系統學習並整理文檔如下。
2.什麼是責任鏈模式?
俗話說沒有規矩不成方圓,我們無論在工作還是生活中很多事情都需要按照規定的流程辦事,這樣的流程往往都是環環相扣的,上一部完成之後才會流轉到下一步執行。比如我們在做飯時都是先買菜、洗菜、切菜、炒菜、裝盤在這樣的過程中只有上一步完成之後才能開始下一步最後得到一道做好的菜;又比如在晉升提名時,首先我們要做一個述職報告進行述職,然後就是評審小組打分,評審小組篩選通過後,流轉到項目組領導處審批,項目組領導根據述職報告和評審小組分數決定是否晉升,項目組領導同意之後最後流轉到部門領導審批並給出最後結果。像這種一步一步完成流程都可以通過責任鏈模式來實現。
- 簡介: 責任鏈模式顧名思義是將不同職責的步驟串聯起來執行,並且一個步驟執行完成之後才能夠執行下一個步驟。從名字可以看出通常責任鏈模式使用鏈表來完成。因此當執行任務的請求發起時,從責任鏈上第一步開始往下傳遞,直到最後一個步驟完成。在責任鏈模式當中,客戶端只用執行一次流程開始的請求便不再需要參與到流程執行當中,責任鏈上的流程便能夠自己一直往下執行,客戶端同樣也並不關心執行流程細節,從而實現與流程之間的解耦。
- 模式結構:責任鏈模式主要角色如下:
◦抽象處理器(Handler):處理器抽象介面,定義了處理請求的方法和執行下一步處理的處理器。
◦具體處理器(ConcreteHandler):執行請求的具體實現,先根據請求執行處理邏輯,完成之後將請求交給下一個處理器執行。
◦調用者:調用者通過創建處理器並將請求交給處理器進行處理。
- 相關代碼:
// 抽象處理器
public abstract class Handler {
private Handler next;
public Handler getNext() {
return next;
}
public void setNext(Handler next) {
this.next = next;
}
public abstract void handle(Object request);
}
// 具體處理器 1
public class ConcreteHandler1 extends Handler {
@Override
public void handle(Object request) {
System.out.println("concrete handler 1 execute request. request: " + request);
if (getNext() != null) {
getNext().handle(request);
}
}
}
// 具體處理器 2
public class ConcreteHandler2 extends Handler {
@Override
public void handle(Object request) {
System.out.println("concrete handler 2 execute request. request: " + request);
if (getNext() != null){
getNext().handle(request);
}
}
}
// 具體處理器 3
public class ConcreteHandler3 extends Handler {
@Override
public void handle(Object request) {
System.out.println("concrete handler 3 execute request. request: " + request);
if (getNext() != null) {
getNext().handle(request);
}
}
}
public static void main(String[] args) {
Handler concreteHandler1 = new ConcreteHandler1();
Handler concreteHandler2 = new ConcreteHandler2();
Handler concreteHandler3 = new ConcreteHandler3();
concreteHandler1.setNext(concreteHandler2);
concreteHandler2.setNext(concreteHandler3);
concreteHandler1.handle("my request.");
}
從上面的代碼我們可以看到其實責任鏈模式是非常簡單的,但是其中有幾個點需要註意一下:
- 首先我們需要對整個責任鏈進行初始化,即設置每個處理器的 next。
- 在每個具體處理器處理完之後需要手動調用下一個處理器的 handle 方法來執行下一步處理,這裡其實還可以使用模板方法模式進行優化。
控制台輸出如下:
concrete handler 1 execute request. request: my request.
concrete handler 2 execute request. request: my request.
concrete handler 3 execute request. request: my request.
3.具體實例demo
以日常請假為例。請假申請會先到你的直屬 leader 處審批,審批通過後再到部門 leader 處審批,部門 leader 通過後,最後到人事處報備記錄請假天數。如果在傳統企業裡面,我們需要手寫一份請假表,然後跑到直屬 leader 辦公室,讓直屬 leader 簽字,然後再到部門 leader 辦公室簽字,最後還要跑到人事處上交請假單,這樣相當於發出了三次請求,才能走完整個請假流程。
但是在現代各種 OA 系統管理下,整個請假流程就變的簡單了,我們只需要發起一次請假請求,接下來你的請假請求便會自動的在審批人中間進行流轉,這個時候我們的責任鏈模式便派上用場。代碼如下:
// 請假抽象處理器
public abstract class DayOffHandler {
private DayOffHandler next;
public DayOffHandler getNext() {
return next;
}
public void setNext(DayOffHandler next) {
this.next = next;
}
public abstract void handle(String request);
}
// 直屬 leader 處理
public class GroupLeaderHandler extends DayOffHandler {
@Override
public void handle(String request) {
System.out.println("直屬 leader 審查: " + request);
System.out.println("同意請求");
if (getNext() != null) {
getNext().handle(request);
}
}
}
// 部門 leader 處理
public class DepartmentLeaderHandler extends DayOffHandler{
@Override
public void handle(String request) {
System.out.println("部門 leader 審查: " + request);
System.out.println("同意請求");
if (getNext() != null) {
getNext().handle(request);
}
}
}
// 人事處處理
public class HRHandler extends DayOffHandler {
@Override
public void handle(String request) {
System.out.println("人事處審查: " + request);
System.out.println("同意請求,記錄請假");
if (getNext() != null) {
getNext().handle(request);
}
}
}
上面的代碼定義了請假抽象處理類和三個具體的處理人,我們需要將這三個處理人的流程初始化串聯起來,並且一步步的執行下去,像下麵這張圖所示流程一樣,於是客戶端的代碼如下:
public static void main(String[] args) {
DayOffHandler groupLeaderHandler = new GroupLeaderHandler();
DayOffHandler departmentLeaderHandler = new DepartmentLeaderHandler();
DayOffHandler hrHandler = new HRHandler();
groupLeaderHandler.setNext(departmentLeaderHandler);
departmentLeaderHandler.setNext(hrHandler);
System.out.println("收到面試通知,需要請假");
String request = "家中有事,請假半天,望批准";
System.out.println("發起請求:");
groupLeaderHandler.handle(request);
}
從客戶端代碼中可以看到,我們首先實例化了三個具體處理人,然後通過 setNext 方法將他們串聯起來,而我們只需向直屬 leader 發起一次請假請求即可,整個審批流程便能夠自動的執行下去,不需要再挨個跑辦公室申請了。執行後的結果如下:
收到面試通知,需要請假
發起請求:
直屬 leader 審查: 家中有事,請假半天,望批准
同意請求
部門 leader 審查: 家中有事,請假半天,望批准
同意請求
人事處審查: 家中有事,請假半天,望批准
同意請求,記錄請假
4.責任鏈模式在源碼中的應用
說到責任鏈模式,那麼最著名的當然是 Servlet 中的過濾器 Filter 了,在這攔截器和過濾器的體系中都使用責任鏈模式來依次處理每個請求,首先看看過濾器 Filter 的使用方式。Filter 介面如下:
public interface Filter {
default void init(FilterConfig filterConfig) throws ServletException {
}
void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;
default void destroy() {
}
}
- FilterChain 便是過濾器 Filter 的一條責任鏈,其代碼如下:
public interface FilterChain {
void doFilter(ServletRequest var1, ServletResponse var2) throws IOException, ServletException;
}
public final class ApplicationFilterChain implements FilterChain {
public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {
if (Globals.IS_SECURITY_ENABLED) {
final ServletRequest req = request;
final ServletResponse res = response;
try {
AccessController.doPrivileged(new PrivilegedExceptionAction<Void>() {
public Void run() throws ServletException, IOException {
ApplicationFilterChain.this.internalDoFilter(req, res);
return null;
}
});
} catch (PrivilegedActionException var7) {
Exception e = var7.getException();
if (e instanceof ServletException) {
throw (ServletException)e;
}
if (e instanceof IOException) {
throw (IOException)e;
}
if (e instanceof RuntimeException) {
throw (RuntimeException)e;
}
throw new ServletException(e.getMessage(), e);
}
} else {
this.internalDoFilter(request, response);
}
}
private void internalDoFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {
if (this.pos < this.n) {
ApplicationFilterConfig filterConfig = this.filters[this.pos++];
try {
Filter filter = filterConfig.getFilter();
if (request.isAsyncSupported() && "false".equalsIgnoreCase(filterConfig.getFilterDef().getAsyncSupported())) {
request.setAttribute("org.apache.catalina.ASYNC_SUPPORTED", Boolean.FALSE);
}
if (Globals.IS_SECURITY_ENABLED) {
Principal principal = ((HttpServletRequest)request).getUserPrincipal();
Object[] args = new Object[]{request, response, this};
SecurityUtil.doAsPrivilege("doFilter", filter, classType, args, principal);
} else {
filter.doFilter(request, response, this);
}
} catch (ServletException | RuntimeException | IOException var15) {
throw var15;
} catch (Throwable var16) {
Throwable e = ExceptionUtils.unwrapInvocationTargetException(var16);
ExceptionUtils.handleThrowable(e);
throw new ServletException(sm.getString("filterChain.filter"), e);
}
} else {
try {
if (ApplicationDispatcher.WRAP_SAME_OBJECT) {
lastServicedRequest.set(request);
lastServicedResponse.set(response);
}
if (request.isAsyncSupported() && !this.servletSupportsAsync) {
request.setAttribute("org.apache.catalina.ASYNC_SUPPORTED", Boolean.FALSE);
}
if (request instanceof HttpServletRequest && response instanceof HttpServletResponse && Globals.IS_SECURITY_ENABLED) {
Principal principal = ((HttpServletRequest)request).getUserPrincipal();
Object[] args = new Object[]{request, response};
SecurityUtil.doAsPrivilege("service", this.servlet, classTypeUsedInService, args, principal);
} else {
this.servlet.service(request, response);
}
} catch (ServletException | RuntimeException | IOException var17) {
throw var17;
} catch (Throwable var18) {
Throwable e = ExceptionUtils.unwrapInvocationTargetException(var18);
ExceptionUtils.handleThrowable(e);
throw new ServletException(sm.getString("filterChain.servlet"), e);
} finally {
if (ApplicationDispatcher.WRAP_SAME_OBJECT) {
lastServicedRequest.set((Object)null);
lastServicedResponse.set((Object)null);
}
}
}
}
}
-
在 internalDoFilter() 方法中,可以看到整個 FilterChain 上使用數組 filters 存放每一個過濾器及其配置並使用 pos 記錄當前遍歷到哪一個過濾器,然後再執行獲取到的 Filter 的 doFilter 方法。與前面所講鏈表方式存放不同,這裡的鏈路使用數組來進行存放。
-
spring中的責任鏈模式
在 SpringMVC 中的 Interceptor 同樣也用到了責任鏈模式。首先來看看 Interceptor 的抽象處理類;
public interface HandlerInterceptor {
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
return true;
}
default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
}
default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
}
}
在抽象處理類中,定義了三個方法,分別是處理前置處理器、後置處理器和整個流程完成之後的處理。通過 HandlerExecutionChain 將攔截器串聯起來,在 HandlerExecutionChain 中,我們需要關註 applyPreHandle、applyPostHandle 和 triggerAfterCompletion 三個方法,這三個方法分別執行了攔截器中所定義的 preHandle 、postHandle 和 afterCompletion 方法。並且從代碼中也能夠看處,和前面的過濾器一樣,所有的攔截器都存放在 interceptors 數組中,併在三個方法中遍歷 interceptors 數組依次執行相應的方法
public class HandlerExecutionChain {
@Nullable
private HandlerInterceptor[] interceptors;
boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
HandlerInterceptor[] interceptors = this.getInterceptors();
if (!ObjectUtils.isEmpty(interceptors)) {
for(int i = 0; i < interceptors.length; this.interceptorIndex = i++) {
HandlerInterceptor interceptor = interceptors[i];
if (!interceptor.preHandle(request, response, this.handler)) {
this.triggerAfterCompletion(request, response, (Exception)null);
return false;
}
}
}
return true;
}
void applyPostHandle(HttpServletRequest request, HttpServletResponse response, @Nullable ModelAndView mv) throws Exception {
HandlerInterceptor[] interceptors = this.getInterceptors();
if (!ObjectUtils.isEmpty(interceptors)) {
for(int i = interceptors.length - 1; i >= 0; --i) {
HandlerInterceptor interceptor = interceptors[i];
interceptor.postHandle(request, response, this.handler, mv);
}
}
}
void triggerAfterCompletion(HttpServletRequest request, HttpServletResponse response, @Nullable Exception ex) throws Exception {
HandlerInterceptor[] interceptors = this.getInterceptors();
if (!ObjectUtils.isEmpty(interceptors)) {
for(int i = this.interceptorIndex; i >= 0; --i) {
HandlerInterceptor interceptor = interceptors[i];
try {
interceptor.afterCompletion(request, response, this.handler, ex);
} catch (Throwable var8) {
logger.error("HandlerInterceptor.afterCompletion threw exception", var8);
}
}
}
}
}
5.總結
責任鏈模式也是常見的設計模式,各個不同職責的處理器串聯起來,通過一次請求便能夠執行完每個處理器的處理方法。通過這樣的方式請求的發送者只需發出一次請求同時也不需要知道詳細的鏈路結構;而請求的接送方只關心自己的處理邏輯,自己處理完成之後將請求傳遞給下一個接收者,從而完成自己的任務,這樣便實現了請求發送者和接收者的解耦。而從源碼分析中可以看到,責任鏈模式雖然常見使用鏈表結構,但是使用數組和列表同樣能夠完成需求。
作者:京東科技 宋慧超
來源:京東雲開發者社區