Шаблонный метод - паттерн поведения объектов, определяющий функциональность конктерных методов в рамках лишь абстрактных сущностей. источник оригинал codelib.ru codelib.ru

Условия, Задача, Назначение

Например, графический редактор определит подклассы DrawApplication и DrawDocument, а электронная таблица — подклассы SpreadsheetApplication и SpreadsheetDocument. codelib.ru источник оригинал codelib.ru

оригинал источник codelib.ru codelib.ru

В абстрактном классе Application определен алгоритм открытия и считывания документа в операции OpenDocument:

void Application::OpenDocument (const char* name) {
  if (!CanOpenDocument(name)) {
    // работа с этим документом невозможна
    return;
  }
 
  Document* doc = DoCreateDocument();
 
  if (doc) {
    _docs->AddDocument(doc);
    AboutToOpenDocument(doc);
    doc->0pen();
    doc->DoRead();
  }
}

Application получить информацию о том, что документ вот-вот будет открыт (AboutToOpenDocument). Определяя некоторые шаги алгоритма с помощью абстрактных операций, шаблонный метод фиксирует их последовательность, но позволяет реализовать их в подклассах классов Application и Document. codelib.ru источник оригинал codelib.ru

1. Чтобы однократно использовать инвариантные части алгоритма.
   Оставляя реализацию изменяющегося поведения на усмотрение подклассов. источник codelib.ru оригинал codelib.ru
2. Когда нужно вычленить и локализовать в одном классе поведение.
   Т.е. общую логику, общее поведение для всех подклассов, дабы избежать дублирования кода. Это хороший пример техники «вынесения за скобки с целью обобщения», описанной в работе Уильяма Опдайка (William Opdyke) и Ральфа Джонсона (Ralph Johnson). Сначала идентифицируются различия в существующем коде, а затем они выносятся в отдельные операции. В конечном итоге различающиеся фрагменты кода заменяются шаблонным методом, из которого вызываются новые операции. источник codelib.ru codelib.ru оригинал
3. Для управления расширениями подклассов.
   Можно определить шаблонный метод так, что он будет вызывать операции-зацепки (hooks) - см. раздел «Результаты» - в определенных точках, разрешив тем самым расширение или изменение функциональности только в этих точках. оригинал источник codelib.ru codelib.ru

оригинал codelib.ru codelib.ru источник

1. AbstractClass (Application) - абстрактный класс.
   Определяет абстрактные примитивные операции, замещаемые в конкретных подклассах для реализации шагов алгоритма.
   Реализует шаблонный метод, определяющий скелет алгоритма. Шаблонный метод вызывает примитивные операции, а также операции, определенные в классе AbstractClass или в других объектах. оригинал источник codelib.ru codelib.ru
2. ConcreteClass (MyApplication) - конкретный класс.
   Реализует примитивные операции, выполняющие шаги алгоритма способом, который зависит от подкласса. codelib.ru оригинал источник codelib.ru

Схема использования паттерна Шаблонный метод (Template Method)

1. Использование контроля доступа в C++.
   В этом языке примитивные операции, которые вызывает шаблонный метод, можно объявить защищенными членами. Тогда гарантируется, что вызывать их сможет только сам шаблонный метод. Примитивные операции, которые обязательно нужно замещать, объявляются как чисто виртуальные функции. Сам шаблонный метод замещать не надо, так что его можно сделать невиртуальной функцией-членом. codelib.ru оригинал codelib.ru источник
2. Сокращение числа примитивных операций.
   Важной целью при проектировании шаблонных методов является значимое сокращение числа примитивных операций, которые должны быть замещены в подклассах. Чем больше операций нужно замещать, тем утомительнее становится программирование клиента. codelib.ru источник оригинал codelib.ru
3. Соглашение об именах.
   Выделить операции, которые необходимо заместить, можно путем добавления к их именам некоторого префикса. Например, в каркасе МасАрр для приложений на платформе Macintosh имена шаблонных методов начинаются с префикса Do: DoCreateDocument, DoRead и т.д. codelib.ru источник оригинал codelib.ru

• конкретные операции (либо из класса ConcreteClass, либо из классов клиента). оригинал источник codelib.ru codelib.ru
• конкретные операции из класса AbstractClass (то есть операции, полезные всем подклассам). codelib.ru оригинал codelib.ru источник
• примитивные операции (то есть абстрактные операции). оригинал codelib.ru источник codelib.ru
• фабричные методы (см. паттерн фабричный метод). codelib.ru codelib.ru оригинал источник
• операции-зацепки (hook operations), реализующие поведение по умолчанию, которое может быть расширено в подклассах. Часто такая операция по умолчанию не делает ничего. codelib.ru codelib.ru оригинал источник

void DerivedClass::Operation () {
  ParentClass::Operation();
  // Расширенное поведение класса DerivedClass
}
 

void ParentClass::Operation () {
  // Поведение родительского класса ParentClass
  HookOperation();
}
 

void ParentClass::HookOperation () { }

void DerivedClass::HookOperation () {
  // расширение в производном классе
}
 

    public void process(HttpServletRequest request, HttpServletResponse response)
        throws IOException, ServletException {
        // Wrap multipart requests with a special wrapper
        request = processMultipart(request);
 
        // Identify the path component we will use to select a mapping
        String path = processPath(request, response);
 
        if (path == null) {
            return;
        }
 
        if (log.isDebugEnabled()) {
            log.debug("Processing a '" + request.getMethod() + "' for path '"
                + path + "'");
        }
 
        // Select a Locale for the current user if requested
        processLocale(request, response);
 
        // Set the content type and no-caching headers if requested
        processContent(request, response);
        processNoCache(request, response);
 
        // General purpose preprocessing hook
        if (!processPreprocess(request, response)) {
            return;
        }
 
        this.processCachedMessages(request, response);
 
        // Identify the mapping for this request
        ActionMapping mapping = processMapping(request, response, path);
 
        if (mapping == null) {
            return;
        }
 
        // Check for any role required to perform this action
        if (!processRoles(request, response, mapping)) {
            return;
        }
 
        // Process any ActionForm bean related to this request
        ActionForm form = processActionForm(request, response, mapping);
 
        processPopulate(request, response, form, mapping);
 
        // Validate any fields of the ActionForm bean, if applicable
        try {
            if (!processValidate(request, response, form, mapping)) {
                return;
            }
        } catch (InvalidCancelException e) {
            ActionForward forward = processException(request, response, e, form, mapping);
            processForwardConfig(request, response, forward);
            return;
        } catch (IOException e) {
            throw e;
        } catch (ServletException e) {
            throw e;
        }
 
        // Process a forward or include specified by this mapping
        if (!processForward(request, response, mapping)) {
            return;
        }
 
        if (!processInclude(request, response, mapping)) {
            return;
        }
 
        // Create or acquire the Action instance to process this request
        Action action = processActionCreate(request, response, mapping);
 
        if (action == null) {
            return;
        }
 
        // Call the Action instance itself
        ActionForward forward =
            processActionPerform(request, response, action, form, mapping);
 
        // Process the returned ActionForward instance
        processForwardConfig(request, response, forward);
    }

1. processMultipart() – фабричный метод задействования специальной обработки multipart запросов:
    RequestProcessor.processMultipart() [java]  ссылка
   

       protected HttpServletRequest processMultipart(HttpServletRequest request) {
           if (!"POST".equalsIgnoreCase(request.getMethod())) {
               return (request);
           }
    
           String contentType = request.getContentType();
    
           if ((contentType != null)
               && contentType.startsWith("multipart/form-data")) {
               return (new MultipartRequestWrapper(request));
           } else {
               return (request);
           }
       }

   protected HttpServletRequest processMultipart(HttpServletRequest request) { if (!"POST".equalsIgnoreCase(request.getMethod())) { return (request); } String contentType = request.getContentType(); if ((contentType != null) && contentType.startsWith("multipart/form-data")) { return (new MultipartRequestWrapper(request)); } else { return (request); } } оригинал codelib.ru codelib.ru источник
2. processPath() – фабричный метод определения запрошенного пути ресурса:
    RequestProcessor.processPath() [java]  ссылка
   

       protected String processPath(HttpServletRequest request,
           HttpServletResponse response)
           throws IOException {
           String path;
    
           // For prefix matching, match on the path info (if any)
           path = (String) request.getAttribute(INCLUDE_PATH_INFO);
    
           if (path == null) {
               path = request.getPathInfo();
           }
    
           if ((path != null) && (path.length() > 0)) {
               return (path);
           }
    
           // For extension matching, strip the module prefix and extension
           path = (String) request.getAttribute(INCLUDE_SERVLET_PATH);
    
           if (path == null) {
               path = request.getServletPath();
           }
    
           String prefix = moduleConfig.getPrefix();
    
           if (!path.startsWith(prefix)) {
               String msg = getInternal().getMessage("processPath");
    
               log.error(msg + " " + request.getRequestURI());
               response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg);
    
               return null;
           }
    
           path = path.substring(prefix.length());
    
           int slash = path.lastIndexOf("/");
           int period = path.lastIndexOf(".");
    
           if ((period >= 0) && (period > slash)) {
               path = path.substring(0, period);
           }
    
           return (path);
       }

   protected String processPath(HttpServletRequest request, HttpServletResponse response) throws IOException { String path; // For prefix matching, match on the path info (if any) path = (String) request.getAttribute(INCLUDE_PATH_INFO); if (path == null) { path = request.getPathInfo(); } if ((path != null) && (path.length() > 0)) { return (path); } // For extension matching, strip the module prefix and extension path = (String) request.getAttribute(INCLUDE_SERVLET_PATH); if (path == null) { path = request.getServletPath(); } String prefix = moduleConfig.getPrefix(); if (!path.startsWith(prefix)) { String msg = getInternal().getMessage("processPath"); log.error(msg + " " + request.getRequestURI()); response.sendError(HttpServletResponse.SC_BAD_REQUEST, msg); return null; } path = path.substring(prefix.length()); int slash = path.lastIndexOf("/"); int period = path.lastIndexOf("."); if ((period >= 0) && (period > slash)) { path = path.substring(0, period); } return (path); } codelib.ru оригинал источник codelib.ru
3. processLocale() – фабричный метод получения локали обратившегося по http-пользователя:
    RequestProcessor.processLocale() [java]  ссылка
   

       protected void processLocale(HttpServletRequest request,
           HttpServletResponse response) {
           // Are we configured to select the Locale automatically?
           if (!moduleConfig.getControllerConfig().getLocale()) {
               return;
           }
    
           // Has a Locale already been selected?
           HttpSession session = request.getSession();
    
           if (session.getAttribute(Globals.LOCALE_KEY) != null) {
               return;
           }
    
           // Use the Locale returned by the servlet container (if any)
           Locale locale = request.getLocale();
    
           if (locale != null) {
               if (log.isDebugEnabled()) {
                   log.debug(" Setting user locale '" + locale + "'");
               }
    
               session.setAttribute(Globals.LOCALE_KEY, locale);
           }
       }

   protected void processLocale(HttpServletRequest request, HttpServletResponse response) { // Are we configured to select the Locale automatically? if (!moduleConfig.getControllerConfig().getLocale()) { return; } // Has a Locale already been selected? HttpSession session = request.getSession(); if (session.getAttribute(Globals.LOCALE_KEY) != null) { return; } // Use the Locale returned by the servlet container (if any) Locale locale = request.getLocale(); if (locale != null) { if (log.isDebugEnabled()) { log.debug(" Setting user locale '" + locale + "'"); } session.setAttribute(Globals.LOCALE_KEY, locale); } } оригинал codelib.ru источник codelib.ru
4. processContent() – фабричный метод выставления Content-Type-а ответа сервера:
    RequestProcessor.processContent() [java]  ссылка
   

       protected void processContent(HttpServletRequest request,
           HttpServletResponse response) {
           String contentType =
               moduleConfig.getControllerConfig().getContentType();
    
           if (contentType != null) {
               response.setContentType(contentType);
           }
       }

   protected void processContent(HttpServletRequest request, HttpServletResponse response) { String contentType = moduleConfig.getControllerConfig().getContentType(); if (contentType != null) { response.setContentType(contentType); } } codelib.ru codelib.ru источник оригинал
5. processNoCache() – фабричный метод выставления заголовков запрета кеширования на стороне клиента (браузера):
    RequestProcessor.processNoCache() [java]  ссылка
   

       protected void processNoCache(HttpServletRequest request,
           HttpServletResponse response) {
           if (moduleConfig.getControllerConfig().getNocache()) {
               response.setHeader("Pragma", "No-cache");
               response.setHeader("Cache-Control", "no-cache,no-store,max-age=0");
               response.setDateHeader("Expires", 1);
           }
       }

   protected void processNoCache(HttpServletRequest request, HttpServletResponse response) { if (moduleConfig.getControllerConfig().getNocache()) { response.setHeader("Pragma", "No-cache"); response.setHeader("Cache-Control", "no-cache,no-store,max-age=0"); response.setDateHeader("Expires", 1); } } оригинал codelib.ru источник codelib.ru
6. processPreprocess() – операция-зацепка для процедур общего назначения, потребность в которых может возникнуть именно в данном месте – после полной идентификации запроса и до запуска Action-а на выполнение:
    RequestProcessor.processPreprocess() [java]  ссылка
   

       protected boolean processPreprocess(HttpServletRequest request,
           HttpServletResponse response) {
           return (true);
       }

   protected boolean processPreprocess(HttpServletRequest request, HttpServletResponse response) { return (true); } оригинал источник codelib.ru codelib.ru

и т.д. оригинал codelib.ru источник codelib.ru