18 Star 29 Fork 7

hm-tools / hm-tools-js-css

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Maven Central 996.icu

hm-tools-js-css 功能

  • 根据URL请求参数将多个javascript文件合并成一个javascript文件返回给请求者。
  • 根据URL请求参数将多个css文件合并成一个css文件返回给请求者。
  • 支持从当前运行的spring boot工程jar包中读取javascript,css文件。
  • 支持在请求URL携带字符编码名称获取相应的字符编码格式的js、css文件。
  • 支持替换css文件中url引用资源的相对路径为可访问的绝对路径。
  • 支持使用yuicompressor对js,css文件内容进行实时压缩、混淆。

使用场景

一个html页面中必然会需要引用JavaScript文件及css文件,以JavaScript文件为例,比如要分别引用 a.js,b.js。一般情况下,会使用2个“<script>”标签引用,即:

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

这样会存在浏览器向服务器发送2次http请求,才能获取完所需要的JavaScript文件。 使用本工具后,则只需要一个标签就可以引入完2个JavaScript文件,即:

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

使用说明

本工具包是适配spring boot工程开发,在以spring boot框架为基础的项目工程中的pom.xml文件引入:

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

即可使用,若需要更改配置,请参照一下配置说明。

缺省的获取javascript文件URL示例:

  • 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类型,是否禁用优化

缺省的获取css文件URL示例:

  • 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 配置获取javascript文件内容的请求uri
  • hm_tools.js_css.css_uri=/get_css 配置获取CSS文件内容的请求uri
  • hm_tools.js_css.refresh_js_uri=/refresh_js 配置刷新javascript文件缓存内容的请求uri
  • hm_tools.js_css.refresh_css_uri=/refresh_css 配置刷新css文件缓存内容的请求uri
  • 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 获取所有javascript文件列表请求uri
  • hm_tools.js_css.list_css_uri=/list_css 获取所有css文件列表请求uri
  • hm_tools.js_css.src_uri=src 通用的获取静态资源文件内容uri,仅获取单个文件,且该文件必须在配置的js_files_paths、css_files_paths路径下,用于解决css文件中含有相对路径引用其它文件的问题。
  • hm_tools.js_css.yui.js_uri= /yui/get_js 配置获取使用yui压缩后javascript文件内容的请求uri
  • hm_tools.js_css.yui.css_uri= /yui/get_css 配置获取使用yui压缩后CSS文件内容的请求uri

如何使用本组件的快照版本

  1. 在自己的私服建立一个快照代理仓库即可。https://oss.sonatype.org/content/repositories/snapshots/ 如何使用快照版本

  2. 将建好的参考纳入公共库 如何使用快照版本

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

根据URL请求参数将多个javascript文件合并成一个javascript文件返回给请求者。根据URL请求参数将多个css文件合并成一个css文件返回给请求者。 展开 收起
Java 等 5 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/hm-tools/hm-tools-js-css.git
git@gitee.com:hm-tools/hm-tools-js-css.git
hm-tools
hm-tools-js-css
hm-tools-js-css
master

搜索帮助