Шаблонный метод (Template Method)

Шаблонный метод (Template Method)

Aвтор:this
Дата: 08.10.2007
Просмотров: 112545
реализации(java: 1шт...) +добавить

Имя
Условия
- Мотивация
- Признаки применения
Решение
Результаты
Пример
История
"Коллеги"

Имя

«Паттерн Template Method»

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

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

Шаблонный метод определяет основу алгоритма в рамках абстрактных классов и методов, а подклассам позволяет переопределять отдельные шаги этого алгоритма (или все сразу), не изменяя, таким образом, его структуру и последовательность в целом.

Мотивация

Рассмотрим каркас приложения, в котором имеются классы Application и Document. Класс Application отвечает за открытие существующих документов, хранящихся во внешнем формате, например в виде файла. Объект класса Document представляет информацию документа после его прочтения из файла.

Приложения, построенные на базе этого каркаса, могут порождать подклассы от классов Application и Document, отвечающие конкретным потребностям.

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

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

открытие, считывание документа [C++] ссылка

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

void Application::OpenDocument (const char* name) {
  if (!CanOpenDocument(name)) {
    // работа с этим документом невозможна
    return;
  }

  Document* doc = DoCreateDocument();

  if (doc) {
    _docs->AddDocument(doc);
    AboutToOpenDocument(doc);
    doc->0pen();
    doc->DoRead();
  }
}

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

Операцию вида OpenDocument мы будем называть шаблонным методом, описывающим алгоритм в терминах абстрактных операций, которые замещены в подклассах для получения нужного поведения. Подклассы класса Application выполняют проверку возможности открытия (CanOpenDocument) и создания документа (DoCreateDocument). Подклассы класса Document считывают документ (DoRead).

Шаблонный метод определяет также операцию, которая позволяет подклассам

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

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

Паттерн шаблонный метод следует использовать:

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

Решение

Участники паттерна Шаблонный метод (Template Method)

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

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

ConcreteClass предполагает, что инвариантные (зафиксированные) шаги алгоритма будут выполнены в AbstractClass.

Вопросы, касающиеся реализации паттерна Шаблонный метод (Template Method)

Аспекты, касающихся реализации:

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

Результаты

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

Шаблонные методы приводят к инвертированной структуре кода, которую иногда называют принципом Голливуда, подразумевая часто употребляемую в этой киноимперии фразу «Не звоните нам, мы сами позвоним». В данном случае это означает, что родительский класс сам вызывает операции подкласса, а не наоборот.

Шаблонные методы вызывают операции следующих видов:

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

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

Подкласс может расширить поведение некоторой операции, заместив ее и явно

вызвав эту операцию из родительского класса:

пример [C++] ссылка

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

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

К сожалению, очень легко забыть о необходимости вызывать унаследованную операцию. У нас есть возможность трансформировать такую операцию в шаблонный метод с целью предоставить родителю контроль над тем, как подклассы расширяют его. Идея в том, чтобы вызывать операцию-зацепку из шаблонного метода в родительском классе. Тогда подклассы смогут переопределить именно эту операцию:

пример [C++] ссылка

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

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

В родительском же классе ParentClass эта операция HookOperation не делает ничего:

пример [C++] ссылка

void ParentClass::HookOperation () { }

void ParentClass::HookOperation () { }

Но она замещена в подклассах, которые расширяют поведение:

пример [C++] ссылка

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

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

Пример

Паттерн шаблонный метод широко применяется при написании разного рода каркасов.

Для примера рассмотрим основополагающий класс Struts веб-фреймворка: RequestProcessor. Метод этого класса process() запускается при обработке любого запроса на страницу, где задействуется Struts. Очевидно, что такого рода операция подразумевает четкую последовательность шагов обработки http-запроса, включающую все возможные разновидности алгоритма обработки, а также поддержку различных видов запроса и т.д. Но в то же время, чтобы данный фреймворк был довольно гибким необходимо дать возможность расширения этой базовой функциональности алгоритма, его модификации в разумных пределах: т.е. использование фабричных методов и операций-зацепок. Как видно – идеальный случай реализации шаблонного метода. Достаточно слов – просто взглянем на этот метод process():

RequestProcessor.process() [java] ссылка

    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);
    }

    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);
    }

Теперь просто по порядку:

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); } }

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);
    }

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);
        }
    }

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); } }
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); } }
processPreprocess() – операция-зацепка для процедур общего назначения, потребность в которых может возникнуть именно в данном месте – после полной идентификации запроса и до запуска Action-а на выполнение:
RequestProcessor.processPreprocess() [java] ссылка
```
    protected boolean processPreprocess(HttpServletRequest request,
        HttpServletResponse response) {
        return (true);
    }
```
protected boolean processPreprocess(HttpServletRequest request, HttpServletResponse response) { return (true); }

и т.д.

Дальше можно увидеть еще несколько зацепок: processRoles(), processValidate(), processForward() и processInclude(); и остальное все – фабричные методы: processMapping(), processActionForm(), processPopulate(), processActionCreate() и т.д. – все содержат продуманные реализации по-умалчанию, которые вполне подходят в большинстве случаев. Весь класс: RequestProcessor.

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

Шаблонные методы настолько фундаментальны, что встречаются почти в каждом абстрактном классе. Очень широко шаблонные методы используются в различных фреймворках, например, из самых известных это: Struts, Spring.

Родственные паттерны

Фабричные методы часто вызываются из шаблонных. В примере из раздела «Мотивация» шаблонный метод OpenDocument вызывал фабричный метод DoCreateDocument.

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

Реализации:

java(1) +добавить

1) RequestProcessor.java на java, code #528[автор:this]

<< назад наверх

*	можно кириллицей (недопустимые символы:?&+=\/%#)
**	только для зарегистрированных пользователей

Популярные задачи:

Шаблонный метод (Template Method)

Имя

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

Мотивация

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

Решение

Участники паттерна Шаблонный метод (Template Method)

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

Вопросы, касающиеся реализации паттерна Шаблонный метод (Template Method)

Результаты

Пример

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

Родственные паттерны

Реализации: