Шаблоны проектирования | Шаблоны цепочки ответственности и типичные приложения

Java задняя часть Шаблоны проектирования Tomcat

Основное содержание этой статьи:

  • Знакомство с шаблоном цепочки ответственности
  • Пример оформления отпуска
  • Резюме модели цепочки ответственности
  • Режим цепочки ответственности анализа исходного кода в фильтре Tomcat

Больше материалов можно найти в моем личном блоге:laijianfeng.org
Обратите внимание на общедоступную учетную запись [Xiao Xuanfeng] WeChat и своевременно получайте сообщения в блогах.

长按关注【小旋锋】微信公众号
****

Модель цепочки ответственности

Это очень распространенный сценарий, когда событие должно обрабатываться несколькими объектами, такими как процесс утверждения закупки, процесс отпуска, процесс обработки исключений в разработке программного обеспечения, процесс обработки веб-запросов и другие процессы. модель цепочки ответственности.

Если взять в качестве примера процесс подачи заявления на отпуск, процесс подачи заявления на отпуск для рядовых сотрудников в обычных компаниях упрощается следующим образом:

普通员工请假简化流程图

Заявление на отпуск инициирует рядовой работник, при количестве дней отпуска менее 3-х дней его необходимо только утвердить руководителем, при количестве дней отпуска более 3-х дней его необходимо подать руководителю руководителю на утверждение, а руководитель его утверждает, далее отправляет на утверждение генеральному директору.

использоватьif-elseУпрощенный код для реализации этого процесса ухода выглядит следующим образом:

public class LeaveApproval {
    public boolean process(String request, int number) {
        boolean result = handleByDirector(request); // 主管处理
        if (result == false) {  // 主管不批准
            return false;
        } else if (number < 3) {    // 主管批准且天数小于 3
            return true;
        }

        result = handleByManager(request); // 准管批准且天数大于等于 3，提交给经理处理
        if (result == false) {   // 经理不批准
            return false;
        } else if (number < 7) { // 经理批准且天数小于 7
            return true;
        }

        result = handleByTopManager(request);   // 经理批准且天数大于等于 7，提交给总经理处理
        if (result == false) { // 总经理不批准
            return false;
        }
        return true;    // 总经理最后批准
    }

    public boolean handleByDirector(String request) {
        // 主管处理该请假申请
    }

    public boolean handleByManager(String request) {
        // 经理处理该请假申请
    }

    public boolean handleByTopManager(String request) {
        // 总经理处理该请假申请
    }
}

Задача кажется очень простой, и ее можно решить, разделив три и пять на два, ноЕсть несколько проблем с этой схемой:

  1. LeaveApprovalКласс относительно велик, и методы утверждения каждого вышестоящего сосредоточены в этом классе, что нарушает «принцип единой ответственности» и его сложно тестировать и поддерживать.

  2. Когда необходимо модифицировать процесс отпуска, например, если количество дней увеличено более чем на 30 дней, его нужно передать председателю на обработку, а исходный код этого типа необходимо модифицировать (и повторно -проверено строго), что нарушает принцип "открыто-закрыто"

  3. Процессу не хватает гибкости, процесс не может быть изменен (если не изменен исходный код) после того, как процесс определен, и клиент не может настроить процесс

Вышеуказанные проблемы могут быть решены с помощью шаблона цепочки ответственности.

определение

Схема цепочки ответственности: избегайте сопряжения отправителя и получателя запроса, сделайте возможным получение запроса несколькими объектами, соедините эти объекты в цепочку и передайте запрос по цепочке, пока объект не обработает его. Паттерн «Цепочка ответственности» — это поведенческий паттерн объекта.

Роль

Обработчик (абстрактный обработчик): он определяет интерфейс для обработки запросов, который обычно проектируется как абстрактный класс.Поскольку разные конкретные обработчики обрабатывают запросы по-разному, в нем определен абстрактный метод обработки запросов. Поскольку следующий дом каждого обработчика по-прежнему является обработчиком, объект абстрактного типа обработчика определяется в абстрактном обработчике как его ссылка на следующий дом. По этой ссылке обработчики могут быть связаны друг с другом в цепочку.

ConcreteHandler (бетонный погрузчик): это подкласс абстрактного обработчика и может обрабатывать запросы пользователей. Метод обработки абстрактного запроса, определенный в абстрактном обработчике, реализован в конкретном классе обработчика. Перед обработкой запроса необходимо оценить, имеет ли он соответствующий полномочия обработки.Если запрос может быть обработан, он обрабатывается, в противном случае запрос перенаправляется преемнику, в конкретном процессоре для пересылки запроса можно получить доступ к следующему объекту в цепочке.

Диаграмма классов выглядит так:

责任链模式.类图

Чистые и нечистые модели цепочки ответственности

Чистая модель цепочки ответственности:

  • Конкретный объект-обработчик может выбрать только одно из двух действий: либо взять на себя полную ответственность, либо передать ответственность следующему семейству, и конкретному объекту-обработчику не разрешается брать на себя часть или всю ответственность. Ситуация, когда ответственность снова передается
  • Запрос должен быть получен объектом-обработчиком, и не может быть ситуации, когда запрос не обрабатывается каким-либо объектом-обработчиком.

Нечистая модель цепочки ответственности:

  • Позволяет частично обрабатывать запрос определенным обработчиком перед передачей вниз
  • Или после того, как конкретный обработчик обработает запрос, его последующие обработчики могут продолжить обработку запроса.
  • И запрос может не быть получен каким-либо объектом-обработчиком.

Пример

Рефакторинг процесса увольнения с использованием шаблона цепочки ответственности (загрязнение)

Информация об отпуске, включая имя лица, просящего об отпуске, и количество дней отпуска.

@Data
@AllArgsConstructor
public class LeaveRequest {
    private String name;    // 请假人姓名
    private int numOfDays;  // 请假天数
}

Абстрактный класс-обработчик Handler поддерживаетnextHandlerСвойство, которое является ссылкой на следующий обработчик текущего обработчика; объявлен абстрактный методprocess

@Data
public abstract class Handler {
    protected String name; // 处理者姓名
    protected Handler nextHandler;  // 下一个处理者

    public Handler(String name) {
        this.name = name;
    }

    public abstract boolean process(LeaveRequest leaveRequest); // 处理请假
}

Три конкретных класса обработки, которые соответственно реализуют абстрактный класс обработки.processметод

// 主管处理者
public class Director extends Handler {
    public Director(String name) {
        super(name);
    }

    @Override
    public boolean process(LeaveRequest leaveRequest) {
        boolean result = (new Random().nextInt(10)) > 3; // 随机数大于3则为批准，否则不批准
        String log = "主管<%s> 审批 <%s> 的请假申请，请假天数： <%d> ，审批结果：<%s> ";
        System.out.println(String.format(log, this.name, leaveRequest.getName(), leaveRequest.getNumOfDays(), result == true ? "批准" : "不批准"));

        if (result == false) {  // 不批准
            return false;
        } else if (leaveRequest.getNumOfDays() < 3) { // 批准且天数小于3，返回true
            return true;
        }
        return nextHandler.process(leaveRequest);   // 批准且天数大于等于3，提交给下一个处理者处理
    }
}

// 经理
public class Manager extends Handler {
    public Manager(String name) {
        super(name);
    }

    @Override
    public boolean process(LeaveRequest leaveRequest) {
        boolean result = (new Random().nextInt(10)) > 3; // 随机数大于3则为批准，否则不批准
        String log = "经理<%s> 审批 <%s> 的请假申请，请假天数： <%d> ，审批结果：<%s> ";
        System.out.println(String.format(log, this.name, leaveRequest.getName(), leaveRequest.getNumOfDays(), result == true ? "批准" : "不批准"));

        if (result == false) {  // 不批准
            return false;
        } else if (leaveRequest.getNumOfDays() < 7) { // 批准且天数小于7
            return true;
        }
        return nextHandler.process(leaveRequest);   // 批准且天数大于等于7，提交给下一个处理者处理
    }
}

// 总经理
public class TopManager extends Handler {
    public TopManager(String name) {
        super(name);
    }

    @Override
    public boolean process(LeaveRequest leaveRequest) {
        boolean result = (new Random().nextInt(10)) > 3; // 随机数大于3则为批准，否则不批准
        String log = "总经理<%s> 审批 <%s> 的请假申请，请假天数： <%d> ，审批结果：<%s> ";
        System.out.println(String.format(log, this.name, leaveRequest.getName(), leaveRequest.getNumOfDays(), result == true ? "批准" : "不批准"));

        if (result == false) { // 总经理不批准
            return false;
        }
        return true;    // 总经理最后批准
    }
}

клиентский тест

public class Client {
    public static void main(String[] args) {
        Handler zhangsan = new Director("张三");
        Handler lisi = new Manager("李四");
        Handler wangwu = new TopManager("王五");

        // 创建责任链
        zhangsan.setNextHandler(lisi);
        lisi.setNextHandler(wangwu);

        // 发起请假申请
        boolean result1 = zhangsan.process(new LeaveRequest("小旋锋", 1));
        System.out.println("最终结果：" + result1 + "\n");

        boolean result2 = zhangsan.process(new LeaveRequest("小旋锋", 4));
        System.out.println("最终结果：" + result2 + "\n");

        boolean result3 = zhangsan.process(new LeaveRequest("小旋锋", 8));
        System.out.println("最终结果：" + result3 + "\n");
    }
}

Возможные результаты следующие: (Поскольку одобрение или нет моделируется случайными числами, ваши результаты могут отличаться от моих)

主管<张三> 审批 <小旋锋> 的请假申请，请假天数： <1> ，审批结果：<批准> 
最终结果：true

主管<张三> 审批 <小旋锋> 的请假申请，请假天数： <4> ，审批结果：<不批准> 
最终结果：false

主管<张三> 审批 <小旋锋> 的请假申请，请假天数： <8> ，审批结果：<批准> 
经理<李四> 审批 <小旋锋> 的请假申请，请假天数： <8> ，审批结果：<批准> 
总经理<王五> 审批 <小旋锋> 的请假申请，请假天数： <8> ，审批结果：<批准> 
最终结果：true

Диаграмма классов показана ниже

示例.责任链类图

Суммировать

Ключевые преимущества модели цепочки ответственности

  • Объекту нужно только знать, что запрос будет обработан, а объектам в цепочке не обязательно знать структуру цепочки, за создание цепочки отвечает клиент.Уменьшить связанность системы

  • Объекту обработчика запроса нужно только поддерживать ссылку на своего преемника, не сохраняя свои ссылки на все обработчики-кандидаты,Упрощает взаимосвязь объектов

  • При распределении обязанностей по объектам цепочка ответственности может дать нам больше информации.гибкость, вы можете динамически добавлять, удалять и изменять цепочку во время выполнения, чтобы изменить ответственность за обработку запроса.

  • При добавлении нового конкретного обработчика запросов вам не нужно изменять исходный код, вам нужно только перестроить цепочку на стороне клиента.Соблюдайте принцип «открыто-закрыто»

Основные недостатки шаблона цепочки ответственности

  • Запрос может завершиться ошибкой, поскольку цепочка ответственности настроена неправильно.не рассматривается

  • При относительно длинной цепочке ответственности обработка запроса может включать несколько обрабатывающих объектов.Производительность системы будет затронута в некоторой степени, и неудобно отлаживать

  • Это может быть вызвано неправильным созданием цепочки ответственности, что приводит к циклическим звонкам, в результате чего система падает.бесконечный цикл

Применимая сцена

  • Существует несколько объектов, которые могут обрабатывать один и тот же запрос. Конкретный объект для обработки запроса будет определен во время выполнения. Клиенту нужно только отправить запрос в цепочку, и ему не нужно заботиться о том, кто является объектом обработки запроса. и как это обрабатывается.

  • Отправить запрос на один из нескольких объектов без явного указания получателя

  • Набор объектов может быть динамически указан для обработки запросов, клиент может динамически создавать цепочку ответственности для обработки запросов, а порядок процессоров в цепочке может быть изменен.

Типичное применение шаблона цепочки ответственности

Шаблон цепочки ответственности в фильтрах Tomcat

Servletфильтр доступен дляServletКласс программирования Java, который может достигать следующих целей: перехватывать запросы клиентов до того, как они получат доступ к внутренним ресурсам; обрабатывать ответы от сервера до того, как они будут отправлены обратно клиенту.

ServletОпределяет интерфейс фильтраFilterи интерфейс цепочки фильтровFilterChainИсходный код выглядит следующим образом

public interface Filter {
    public void init(FilterConfig filterConfig) throws ServletException;
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException;
    public void destroy();
}

public interface FilterChain {
    void doFilter(ServletRequest var1, ServletResponse var2) throws IOException, ServletException;
}

мыШаги по настройке фильтраДа:

1) Напишите класс фильтра, реализующийjavax.servlet.Filterинтерфейс, как показано ниже

public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
                         FilterChain chain) throws IOException, ServletException {
        // 做一些自定义处理....
        System.out.println("执行doFilter()方法之前...");
        chain.doFilter(request, response);              // 传递请求给下一个过滤器
        System.out.println("执行doFilter()方法之后...");
    }

    @Override
    public void destroy() {
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
}

2) вweb.xmlДобавьте конфигурацию фильтра в файл, например, следующий для перехвата всех запросов

<filter>  
        <filter-name>MyFilter</filter-name>  
        <filter-class>com.whirly.filter.MyFilter</filter-class>  
</filter>
  
<filter-mapping>  
        <filter-name>MyFilter</filter-name>  
        <url-pattern>/*</url-pattern>  
</filter-mapping>

При запуске Tomcat в игру вступает наш фильтр.Итак, как работает фильтр?

Томкэт имеетPipeline Valve机制, также использует режим цепочки ответственности, запрос будет проходить в конвейере, и конвейер вызовет соответствующий клапан для завершения конкретной логической обработки;
Один из базовых клапановStandardWrapperValve, одним из которых является вызовApplicationFilterFactoryгенерироватьFilter链, конкретный код находится вinvokeметод

Требуется перед запуском фильтраЗавершите загрузку и инициализацию фильтров и создайте цепочки фильтров на основе информации о конфигурации.:

  1. Загрузка фильтра конкретно вContextConfigКатегорияconfigureContextметод, загрузить отдельноfilterиfilterMapрелевантная информация и сохраняется в контексте

  2. Инициализация фильтра находится вStandardContextКатегорияstartInternalметод, сохранить вfilterConfigsсосуществовать в контексте

  3. Поток запросов идет кStandardWrapperValveкогда, вinvokeдля каждого запроса будет создана соответствующая информация о конфигурации сопоставления фильтров.ApplicationFilterChain, который содержит цельServletи соответствующую цепочку фильтров, и вызвать цепочку фильтровdoFilterфильтр выполнения метода

StandardWrapperValveперечислитьApplicationFilterFactoryКлючевой код для создания цепочки фильтров для запроса и вызова цепочки фильтров выглядит следующим образом:

final class StandardWrapperValve extends ValveBase {
    public final void invoke(Request request, Response response) throws IOException, ServletException {
        // 省略其他的逻辑处理...
        // 调用 ApplicationFilterChain.createFilterChain() 创建过滤器链
        ApplicationFilterChain filterChain = ApplicationFilterFactory.createFilterChain(request, wrapper, servlet);
        
        if (servlet != null && filterChain != null) {
            // 省略
        } else if (request.isAsyncDispatching()) {
            request.getAsyncContextInternal().doInternalDispatch();
        } else if (comet) {
            filterChain.doFilterEvent(request.getEvent());
        } else {
            // 调用过滤器链的 doFilter 方法开始过滤
            filterChain.doFilter(request.getRequest(), response.getResponse());
        }

цепочка фильтровApplicationFilterChainКод ключа выглядит следующим образом, цепочка фильтров на самом деле представляет собойApplicationFilterConfigмножество

final class ApplicationFilterChain implements FilterChain, CometFilterChain {
    private ApplicationFilterConfig[] filters = new ApplicationFilterConfig[0]; // 过滤器链
    private Servlet servlet = null; // 目标
    // ...
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {
        if( Globals.IS_SECURITY_ENABLED ) {
            // ...
        } else {
            internalDoFilter(request,response); // 调用 internalDoFilter 方法
        }
    }
    
    private void internalDoFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException {
        // Call the next filter if there is one
        if (pos < n) {
            // 从过滤器数组中取出当前过滤器配置，然后下标自增1
            ApplicationFilterConfig filterConfig = filters[pos++];
            Filter filter = null;
            try {
                filter = filterConfig.getFilter();  // 从过滤器配置中取出该 过滤器对象

                if( Globals.IS_SECURITY_ENABLED ) {
                    final ServletRequest req = request;
                    final ServletResponse res = response;
                    Principal principal = ((HttpServletRequest) req).getUserPrincipal();

                    Object[] args = new Object[]{req, res, this};
                    SecurityUtil.doAsPrivilege("doFilter", filter, classType, args, principal);
                } else {
                    // 调用过滤器的 doFilter，完成一个过滤器的过滤功能
                    filter.doFilter(request, response, this);
                }
            return;  // 这里很重要，不会重复执行后面的  servlet.service(request, response)
        }
        
        // 执行完过滤器链的所有过滤器之后，调用 Servlet 的 service 完成请求的处理
        if ((request instanceof HttpServletRequest) && (response instanceof HttpServletResponse)) {
            if( Globals.IS_SECURITY_ENABLED ) {
                
            } else {
                servlet.service(request, response);
            }
        } else {
            servlet.service(request, response);
        }
    }
    // 省略...
}

фильтр

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("执行doFilter()方法之前...");
        chain.doFilter(request, response);              // 传递请求给下一个过滤器
        System.out.println("执行doFilter()方法之后...");
    }

Когда нижний индекс меньше длины n массива фильтров, это означает, что цепочка фильтров не была выполнена, поэтому текущий фильтр выносится из массива, аdoFilterспособ завершения процесса фильтрации, в фильтреdoFilterснова позвонил вFilterChainизdoFilter, вернуться кApplicationFilterChain, и продолжайте судить о том, была ли выполнена цепочка фильтров, в зависимости от того, меньше ли индекс длины массива.ПродолжатьВозьмите фильтр из массива и вызовитеdoFilterметод, поэтому цепочка фильтров здесь проходит черезвложенная рекурсияспособ сформировать цепочку.

Когда все фильтры выполнены, последняя записьApplicationFilterChain.doFilterметодpos < nневерно, не вводитьif (pos < n), но выполните следующий код, судя по(request instanceof HttpServletRequest) && (response instanceof HttpServletResponse), если это http-запрос, он будет вызванservlet.service(request, response);для обработки запроса.

После завершения обработки стек переворачивается в том порядке, в котором были вызваны фильтры, и фильтры выполняются соответственно.chain.doFilter()После логики обработкидолжен быть в курсесуществуетif (pos < n)В конце тела метода естьreturn;, что гарантирует, что только последняя записьApplicationFilterChain.doFilterВызов метода может выполнить следующееservlet.service(request, response)метод

Нарисуйте краткий стек вызовов следующим образом:

Tomcat 过滤器链调用栈

ApplicationFilterChainКласс играет роль абстрактного обработчика, а роль конкретного обработчика определяется каждымFilterиграть в

Другие типичные применения шаблона цепочки ответственности

Применение других моделей цепочки ответственности в основном такое же.

FilterChain 的实现类

Вот несколько типичных приложений:

  1. в НеттиPipelineиChannelHandlerОрганизуйте логику кода с помощью шаблона проектирования «Цепочка ответственности».
  2. Spring Security использует шаблон цепочки ответственности, который может динамически добавлять или удалять обязанности (обработка запросов запросов).
  3. Spring AOP управляет советниками с помощью шаблона цепочки ответственности.
  4. Цепочка фильтров Dubbo Filter также использует режим цепочки ответственности (связный список), который может выполнять некоторую фильтрацию при вызовах методов, таких как тайм-аут (TimeoutFilter), исключение (ExceptionFilter), токен (TokenFilter) и т. д.
  5. Механизм плагинов в Mybatis использует режим цепочки ответственности для настройки различных официальных или пользовательских плагинов.Подобно фильтру, он может выполнять некоторые операции при выполнении операторов Sql.

Ссылаться на:
Лю Вэй: Шаблоны проектирования Java Edition
MOOC Java Design Patterns Интенсивный метод отладки + анализ памяти
Шаблоны проектирования цепочки ответственности (фильтры, перехватчики)

постскриптум

Добро пожаловать, чтобы комментировать, пересылать, делиться, ваша поддержка - моя самая большая мотивация

Рекомендуемое чтение

Шаблоны проектирования | Простые фабричные шаблоны и типовые приложения
Шаблоны проектирования | Шаблоны фабричных методов и типичные приложения
Шаблоны проектирования | Абстрактные фабричные шаблоны и типовые приложения
Шаблоны проектирования | Шаблоны построителей и типичные приложения
Шаблоны проектирования | Шаблоны прототипов и типовые приложения
Шаблоны проектирования | Шаблоны внешнего вида и типичные приложения
Шаблоны проектирования | Шаблоны декораторов и типичные приложения
Шаблоны проектирования | Шаблоны адаптеров и типичные приложения
Шаблоны проектирования | Легковесные шаблоны и типичные приложения
Шаблоны проектирования | Комбинированные шаблоны и типичные приложения
Шаблоны проектирования | Шаблоны методов шаблонов и типичные приложения
Шаблоны проектирования | Шаблоны итераторов и типичные приложения
Шаблоны проектирования | Шаблоны стратегий и типичные приложения
Шаблоны проектирования | Шаблоны Observer и типичные приложения
Шаблоны проектирования | Меморандумные шаблоны и типовые приложения
Шаблоны проектирования | Шаблоны посредников и типичные приложения

Категории