Подтвердить что ты не робот

JSF2 Управление статическими ресурсами - комбинированное, сжатое

Кто-нибудь знает о способе динамического объединения/минимизации всех ресурсов h: outputStylesheet, а затем объединения/минимизации всех ресурсов h: outputScript в фазе визуализации? Предполагаемый/минимизированный ресурс, вероятно, нужно будет кэшировать с помощью ключа на основе объединенной строки ресурсов или чего-то, чтобы избежать чрезмерной обработки.

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

Спасибо за любые предложения!

Изменить: Чтобы показать, что я не ленив и действительно буду работать над этим с некоторыми указаниями, вот заглушка, которая захватывает Script имя/библиотеку ресурсов, а затем удаляет их из представления, Как вы можете видеть, у меня есть некоторые вопросы о том, что делать дальше... Должен ли я создавать HTTP-запросы и объединять ресурсы, а затем объединять их и сохранять их в кеш ресурсов?

package com.davemaple.jsf.listener;

import java.util.ArrayList;
import java.util.List;

import javax.faces.component.UIComponent;
import javax.faces.component.UIOutput;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.PhaseEvent;
import javax.faces.event.PhaseId;
import javax.faces.event.PhaseListener;
import javax.faces.event.PreRenderViewEvent;
import javax.faces.event.SystemEvent;
import javax.faces.event.SystemEventListener;

import org.apache.log4j.Logger;

/**
 * A Listener that combines CSS/Javascript Resources
 * 
 * @author David Maple<[email protected]>
 *
 */
public class ResourceComboListener implements PhaseListener, SystemEventListener {

    private static final long serialVersionUID = -8430945481069344353L;
    private static final Logger LOGGER = Logger.getLogger(ResourceComboListener.class);

    @Override
    public PhaseId getPhaseId() {
        return PhaseId.RESTORE_VIEW;
    }

    /*
     * (non-Javadoc)
     * @see javax.faces.event.PhaseListener#beforePhase(javax.faces.event.PhaseEvent)
     */
    public void afterPhase(PhaseEvent event) {
        FacesContext.getCurrentInstance().getViewRoot().subscribeToViewEvent(PreRenderViewEvent.class, this);
    }

    /*
     * (non-Javadoc)
     * @see javax.faces.event.PhaseListener#afterPhase(javax.faces.event.PhaseEvent)
     */
    public void beforePhase(PhaseEvent event) {
        //nothing here
    }

    /*
     * (non-Javadoc)
     * @see javax.faces.event.SystemEventListener#isListenerForSource(java.lang.Object)
     */
    public boolean isListenerForSource(Object source) {
        return (source instanceof UIViewRoot);
    }

    /*
     * (non-Javadoc)
     * @see javax.faces.event.SystemEventListener#processEvent(javax.faces.event.SystemEvent)
     */
    public void processEvent(SystemEvent event) throws AbortProcessingException {
        FacesContext context = FacesContext.getCurrentInstance();
        UIViewRoot viewRoot = context.getViewRoot();
        List<UIComponent> scriptsToRemove = new ArrayList<UIComponent>();

        if (!context.isPostback()) {

            for (UIComponent component : viewRoot.getComponentResources(context, "head")) {
                if (component.getClass().equals(UIOutput.class)) {
                    UIOutput uiOutput = (UIOutput) component;

                    if (uiOutput.getRendererType().equals("javax.faces.resource.Script")) {
                        String library = uiOutput.getAttributes().get("library").toString();
                        String name = uiOutput.getAttributes().get("name").toString();

                        // make https requests to get the resources?
                        // combine then and save to resource cache?
                        // insert new UIOutput script?

                        scriptsToRemove.add(component);
                    }


                }
            }

            for (UIComponent component : scriptsToRemove) {
                viewRoot.getComponentResources(context, "head").remove(component);
            }

        }
    }

}
4b9b3361

Ответ 1

Этот ответ не распространяется на минимизацию и сжатие. Минимизировать отдельные ресурсы CSS/JS лучше делегировать для создания скриптов, таких как задача YUI Compressor Ant. Вручную делать это по каждому запросу слишком дорого. Сжатие (я предполагаю, что вы имеете в виду GZIP?) Лучше всего делегировать в контейнер сервлетов, который вы используете. Вручную делать это сложно. Например, на Tomcat возникает вопрос добавить атрибут compression="on" к элементу <Connector> в /conf/server.xml.


SystemEventListener уже является хорошим первым шагом (кроме некоторой PhaseListener ненужности). Затем вам нужно будет выполнить пользовательский ResourceHandler и Resource. Эта часть не совсем тривиальна. Вам нужно многократно изобретать, если вы хотите быть независимой от JSF-реализации.

Во-первых, в SystemEventListener вам нужно создать новый UIOutput, представляющий объединенный ресурс, чтобы вы могли его добавить, используя UIViewRoot#addComponentResource(). Вам нужно установить для атрибута library что-то уникальное, что понимается вашим пользовательским обработчиком ресурсов. Вам нужно сохранить объединенные ресурсы в переменной приложения по уникальному имени на основе комбинации ресурсов (может быть, хеш MD5?), А затем установить этот ключ как атрибут name компонента. Сохранение в виде переменной приложения имеет преимущество кэширования как для сервера, так и для клиента.

Что-то вроде этого:

String combinedResourceName = CombinedResourceInfo.createAndPutInCacheIfAbsent(resourceNames);
UIOutput component = new UIOutput();
component.setRendererType(rendererType);
component.getAttributes().put(ATTRIBUTE_RESOURCE_LIBRARY, CombinedResourceHandler.RESOURCE_LIBRARY);
component.getAttributes().put(ATTRIBUTE_RESOURCE_NAME, combinedResourceName + extension);
context.getViewRoot().addComponentResource(context, component, TARGET_HEAD);

Затем в вашей реализации ResourceHandler вам нужно будет реализовать createResource(), чтобы создать пользовательскую Resource, когда библиотека соответствует требуемому значению:

@Override
public Resource createResource(String resourceName, String libraryName) {
    if (RESOURCE_LIBRARY.equals(libraryName)) {
        return new CombinedResource(resourceName);
    } else {
        return super.createResource(resourceName, libraryName);
    }
}

Конструктор пользовательской Resource должен захватить объединенную информацию о ресурсе, основанную на имени:

public CombinedResource(String name) {
    setResourceName(name);
    setLibraryName(CombinedResourceHandler.RESOURCE_LIBRARY);
    setContentType(FacesContext.getCurrentInstance().getExternalContext().getMimeType(name));
    this.info = CombinedResourceInfo.getFromCache(name.split("\\.", 2)[0]);
}

Эта пользовательская Resource реализация должна обеспечить надлежащее getRequestPath() возвращает URI, который затем будет включен в отображаемый элемент <script> или <link>:

@Override
public String getRequestPath() {
    FacesContext context = FacesContext.getCurrentInstance();
    String path = ResourceHandler.RESOURCE_IDENTIFIER + "/" + getResourceName();
    String mapping = getFacesMapping();
    path = isPrefixMapping(mapping) ? (mapping + path) : (path + mapping);
    return context.getExternalContext().getRequestContextPath()
        + path + "?ln=" + CombinedResourceHandler.RESOURCE_LIBRARY;
}

Теперь часть рендеринга HTML должна быть в порядке. Это будет выглядеть примерно так:

<link type="text/css" rel="stylesheet" href="/playground/javax.faces.resource/dd08b105bf94e3a2b6dbbdd3ac7fc3f5.css.xhtml?ln=combined.resource" />
<script type="text/javascript" src="/playground/javax.faces.resource/2886165007ccd8fb65771b75d865f720.js.xhtml?ln=combined.resource"></script>

Затем вам нужно перехватить комбинированные запросы ресурсов, сделанные браузером. Это самая сложная часть. Во-первых, в вашей реализации ResourceHandler вам нужно реализовать handleResourceRequest() соответственно:

@Override
public void handleResourceRequest(FacesContext context) throws IOException {
    if (RESOURCE_LIBRARY.equals(context.getExternalContext().getRequestParameterMap().get("ln"))) {
        streamResource(context, new CombinedResource(getCombinedResourceName(context)));
    } else {
        super.handleResourceRequest(context);
    }
}

Затем вам нужно выполнить всю работу по реализации других методов пользовательской Resource соответственно, например getResponseHeaders(), который должен возвращать правильные заголовки кеширования, getInputStream(), которые должны верните InputStream объединенных ресурсов в один InputStream и userAgentNeedsUpdate(), который должен правильно реагировать на кеширование связанных запросов.

@Override
public Map<String, String> getResponseHeaders() {
    Map<String, String> responseHeaders = new HashMap<String, String>(3);
    SimpleDateFormat sdf = new SimpleDateFormat(PATTERN_RFC1123_DATE, Locale.US);
    sdf.setTimeZone(TIMEZONE_GMT);
    responseHeaders.put(HEADER_LAST_MODIFIED, sdf.format(new Date(info.getLastModified())));
    responseHeaders.put(HEADER_EXPIRES, sdf.format(new Date(System.currentTimeMillis() + info.getMaxAge())));
    responseHeaders.put(HEADER_ETAG, String.format(FORMAT_ETAG, info.getContentLength(), info.getLastModified()));
    return responseHeaders;
}

@Override
public InputStream getInputStream() throws IOException {
    return new CombinedResourceInputStream(info.getResources());
}

@Override
public boolean userAgentNeedsUpdate(FacesContext context) {
    String ifModifiedSince = context.getExternalContext().getRequestHeaderMap().get(HEADER_IF_MODIFIED_SINCE);

    if (ifModifiedSince != null) {
        SimpleDateFormat sdf = new SimpleDateFormat(PATTERN_RFC1123_DATE, Locale.US);

        try {
            info.reload();
            return info.getLastModified() > sdf.parse(ifModifiedSince).getTime();
        } catch (ParseException ignore) {
            return true;
        }
    }

    return true;
}

У меня есть полное доказательство концепции, но это слишком много кода для публикации в качестве ответа SO. Выше было всего лишь частичное, чтобы помочь вам в правильном направлении. Я предполагаю, что пропущенные декларации метода/переменной/константы достаточно объясняют себя, чтобы написать свои собственные, в противном случае дайте мне знать.


Обновление: в соответствии с комментариями, здесь, как вы можете собирать ресурсы в CombinedResourceInfo:

private synchronized void loadResources(boolean forceReload) {
    if (!forceReload && resources != null) {
        return;
    }

    FacesContext context = FacesContext.getCurrentInstance();
    ResourceHandler handler = context.getApplication().getResourceHandler();
    resources = new LinkedHashSet<Resource>();
    contentLength = 0;
    lastModified = 0;

    for (Entry<String, Set<String>> entry : resourceNames.entrySet()) {
        String libraryName = entry.getKey();

        for (String resourceName : entry.getValue()) {
            Resource resource = handler.createResource(resourceName, libraryName);
            resources.add(resource);

            try {
                URLConnection connection = resource.getURL().openConnection();
                contentLength += connection.getContentLength();
                long lastModified = connection.getLastModified();

                if (lastModified > this.lastModified) {
                    this.lastModified = lastModified;
                }
            } catch (IOException ignore) {
                // Can't and shouldn't handle it here anyway.
            }
        }
    }
}

(вышеупомянутый метод вызывается методом reload() и геттерами в зависимости от одного из свойств, которые должны быть установлены)

И вот как выглядит CombinedResourceInputStream:

final class CombinedResourceInputStream extends InputStream {

    private List<InputStream> streams;
    private Iterator<InputStream> streamIterator;
    private InputStream currentStream;

    public CombinedResourceInputStream(Set<Resource> resources) throws IOException {
        streams = new ArrayList<InputStream>();

        for (Resource resource : resources) {
            streams.add(resource.getInputStream());
        }

        streamIterator = streams.iterator();
        streamIterator.hasNext(); // We assume it to be always true; CombinedResourceInfo won't be created anyway if it empty.
        currentStream = streamIterator.next();
    }

    @Override
    public int read() throws IOException {
        int read = -1;

        while ((read = currentStream.read()) == -1) {
            if (streamIterator.hasNext()) {
                currentStream = streamIterator.next();
            } else {
                break;
            }
        }

        return read;
    }

    @Override
    public void close() throws IOException {
        IOException caught = null;

        for (InputStream stream : streams) {
            try {
                stream.close();
            } catch (IOException e) {
                if (caught == null) {
                    caught = e; // Don't throw it yet. We have to continue closing all other streams.
                }
            }
        }

        if (caught != null) {
            throw caught;
        }
    }

}

Обновление 2: конкретное и повторно используемое решение доступно в OmniFaces. См. Также CombinedResourceHandler страница витрины и документация по API для получения дополнительной информации. деталь.

Ответ 2

Вы можете оценить JAWR перед тем, как реализовать свое собственное решение. Я использовал его в нескольких проектах, и это было большим успехом. Он используется в проектах JSF 1.2, но я думаю, что будет легко расширить его для работы с JSF 2.0. Просто попробуйте.

Ответ 3

Omnifaces при условии CombinedResourceHandler - отличная утилита, но мне также нравится делиться этим прекрасным плагином maven: - resources-optimizer-maven-plugin, который может использоваться для минимизации/сжатия js/css файлов и/или объединения их в меньшее количество ресурсов во время сборки, а не динамически во время выполнения, что делает его Я считаю, что более эффективное решение.

Также посмотрите на эту отличную библиотеку: - webutilities

Ответ 4

У меня есть другое решение для JSF 2. Могу также работать с JSF 1, но я не знаю JSF 1, поэтому не могу сказать. Идея работает в основном с компонентами из h: head и работает также для таблиц стилей. Результат всегда один файл JavaScript (или файл стилей) для страницы! Мне сложно описать, но я стараюсь.

Я перегружаю стандартный JSF ScriptRenderer (или StylesheetRenderer) и настраиваю средство визуализации для компонента h: outputScript в файле faces-config.xml. Новый Renderer теперь больше не будет писать script -Tag, но он будет собирать все ресурсы в списке. Таким образом, первый ресурс, который будет отображаться, будет первым элементом в списке, следующий следующий и так далее. После последнего h: outputScript компонент ist rendered, вы должны отобразить 1 script -Tag для файла JavaScript на этой странице. Я делаю это путем перегрузки рендерера h: head.

Теперь приходит идея: Я зарегистрирую фильтр! Фильтр будет искать этот запрос script -Tag. Когда этот запрос приходит, я получу список ресурсов для этой страницы. Теперь я могу заполнить ответ из списка Ресурсы. Порядок будет правильным, потому что рендеринг JSF помещает ресурсы в правильном порядке в список. После заполнения ответа список должен быть очищен. Также вы можете сделать больше оптимизация, потому что у вас есть код в фильтре....

У меня есть код, который работает превосходно. Мой код также может обрабатывать кеширование браузера и динамический рендеринг script. Если кому-то интересно, я могу поделиться кодом.