OSCHINA-MIRROR/hm-tools-hm-tools-js-css

hm-tools-js-css функции

Согласно параметрам запроса URL объединяет несколько файлов JavaScript в один файл JavaScript и возвращает его запрашивающему.
Согласно параметрам запроса URL объединяет несколько файлов CSS в один файл CSS и возвращает его запрашивающему.
Поддерживает чтение файлов JavaScript и CSS из текущего запущенного jar-пакета spring boot проекта.
Поддерживает получение соответствующего формата кодировки символов для файлов JavaScript и CSS по имени кодировки, указанному в запросе URL.
Заменяет относительные пути ресурсов в файлах CSS на доступные абсолютные пути.
Использует yuicompressor для сжатия и запутывания содержимого файлов JavaScript и CSS в реальном времени.

Сценарии использования

На одной HTML-странице обязательно будут использоваться файлы JavaScript и файлы CSS. Например, для файла JavaScript необходимо использовать a.js и b.js. Обычно используются два тега <script> для ссылки:

<script src="a.js"></script>
<script src="b.js"></script>

Это приведёт к отправке двух HTTP-запросов браузером для получения необходимых файлов JavaScript. После использования этого инструмента достаточно одного тега для импорта двух файлов JavaScript:

<script src="a.js,b.js"></script>

Инструкция по использованию

Этот набор инструментов адаптирован для разработки spring boot проектов. В файле pom.xml проекта на основе spring boot добавьте следующую зависимость:

<dependency>
    <groupId>top.hmtools</groupId>
    <artifactId>spring-boot-starter-js-css</artifactId>
    <version>0.3.0</version>
</dependency>

Для изменения конфигурации обратитесь к разделу «Конфигурация».

Пример получения URL файла JavaScript по умолчанию

http://{адрес}:{порт}/js/encoding/{имя кодировки}/aaa.js,bbb.js
или: http://{адрес}:{порт}/js/aaa.js,bbb.js.
- {имя кодировки} — необязательный параметр, если не указан, используется UTF-8 по умолчанию. Можно использовать GBK, UTF-8, GB2312, UTF-16 и другие поддерживаемые Java форматы имён кодировок символов, иначе будет выдана ошибка.
- По умолчанию страница списка всех файлов JavaScript (URI можно изменить через конфигурационный файл): http://{адрес}:{порт}/list/js.

Использование yui для сжатия файлов JavaScript

По умолчанию URL для получения содержимого файла: http://{адрес}:{порт}/yui/js/aaa.js,bbb.js, например:

http://localhost:8080/yui/js/javascript__munge.js,demoJs_empty.js,javascript_utf-8Demo.js?munge=false&preserveAllSemiColons=true

Параметры запроса для сжатия с помощью yui:

charset: string, формат кодировки, по умолчанию utf-8.
linebreak: integer, указывает столбец для вставки символа переноса строки, -1 означает отсутствие переноса строк.
munge: Boolean, выполнять ли запутывание.
preserveAllSemiColons: Boolean, сохранять ли все точки с запятой ";".
disableOptimizations: Boolean, отключить ли оптимизацию.

Пример получения URL файла CSS по умолчанию

http://{адрес}:{порт}/css/encoding/{имя кодировки}/aaa.css,bbb.css
или: http://{адрес}:{порт}/css/aaa.css,bbb.css.
- {имя кодировки} — необязательный параметр, если не указан, используется UTF-8 по умолчанию. Можно использовать GBK, UTF-8, GB2312, UTF-16 и другие поддерживаемые Java форматы имён кодировок символов, иначе будет выдана ошибка.
- По умолчанию страница списка всех файлов CSS (URI можно изменить через конфигурационный файл): http://{адрес}:{порт}/list/css.

Использование yui для сжатия файлов CSS

По умолчанию URL для получения содержимого файла: http://{адрес}:{порт}/yui/css/aaa.css,bbb.css, например:

http://localhost:8080/yui/css/css_border-none.css?charset=gbk&linebreak=2

Параметры запроса для сжатия с помощью yui:

charset: string, формат кодировки, по умолчанию utf-8.
linebreak: integer, указывает столбец для вставки символа переноса строки, -1 означает отсутствие переноса строк.

Конфигурация

hm_tools.js_css.enabled = true: включить ли компонент jar пакета, когда значение конфигурации равно «true» или конфигурация отсутствует, это означает включение, а значение «false» означает отключение.
hm_tools.js_css.js_uri = /get_js: настроить URL запроса для получения содержимого файла JavaScript.
hm_tools.js_css.css_uri = /get_css: настроить URL запроса для получения содержимого файла CSS.
hm_tools.js_css.refresh_js_uri = /refresh_js: настроить URL запроса для обновления кэша содержимого файла JavaScript.
hm_tools.js_css.refresh_css_uri = /refresh_css: настроить URL запроса для обновления кэша содержимого файла CSS.
hm_tools.js_css.js_files_paths = static: настроить коллекцию путей к файлам JavaScript на диске (относительно classpath проекта), разделенных запятыми.
hm_tools.js_css.css_files_paths = static: настроить коллекцию путей к файлам CSS на диске (относительно classpath проекта), разделённых запятыми.
hm_tools.js_css.encoding = UTF-8: формат кодировки для полученного содержимого файла, по умолчанию UTF-8.
hm_tools.js_css.list_js_uri = /list_js: URL запроса для получения списка файлов JavaScript.
hm_tools.js_css.list_css_uri = /list_css: URL запроса для получения списка файлов CSS.
hm_tools.js_css.src_uri = src: общий URL запроса для получения статических ресурсов, может получить только один файл, и этот файл должен находиться в настроенных путях js_files_paths и css_files_paths, используется для решения проблемы ссылок на другие файлы в файлах CSS.
hm_tools.js_css.yui.js_uri = /yui/get_js: URL запроса для получения сжатого содержимого файла JavaScript с использованием yui.
hm_tools.js_css.yui.css_uri = /yui/get_css: URL запроса для получения сжатого содержимого файла CSS с использованием yui.