CN107707625A - 基于Maven的前台资源打包并进行版本管理与使用的方法 - Google Patents

Abstract

本发明公开了一种基于Maven的前台资源打包并进行版本管理与使用的方法，将前台资源组件像后台资源一样打包，同时通过Maven上传至Maven仓库进行版本管理；使用时通过配置pom.xml下载前台资源包后，编写并配置特定的过滤器进行拦截与重定位；拦截匹配规则的URL并重定位的过滤器会优先在WebContent下查找相应地址的资源，定位不到之后才会在资源包中定位前台资源。这样J2EE项目可以自行覆盖、拓展前台组件的内容与样式而不影响到原始组件资源代码。本发明解决了前台资源的分散性及在J2EE项目中的升级和版本管理的困难问题。

Description

基于Maven的前台资源打包并进行版本管理与使用的方法

技术领域

本发明属于软件技术领域，涉及一种基于Maven配置的前台资源打包并对生成的前台资源包进行版本管理及使用的方法。

背景技术

在J2EE项目的开发过程中，涉及到的资源相关的内容主要有后台资源和前台资源。后台资源指的是需要服务器进行后台处理（编译、转换、解释）的资源，如java、class等类型的资源文件。前台资源指的是无需经服务器后台处理，直接可被浏览器（或其插件）处理解释的前台使用的资源，如gif、png图片、javascript文件、css样式文件、htm网页、swf文件等。

java类型的后台资源编译后（生成class文件），配合一些配置文件（xml、properties），可打成jar包（Java Archive File）文件。一般jar包具有某些通用功能，可作为J2EE项目中的组件被使用，以避免项目组重复造轮子的情况发生。同一个jar包的不同版本可能在功能上有较大区别，需要在项目的构建过程中纳入管理。

Maven是Apache开源社区推出的一款基于项目对象模型（POM）的，可通过描述信息（pom.xml）来管理项目的构建、报告和文档的软件项目管理工具，它是目前使用非常广泛且拥有较多插件的软件项目管理工具。Maven的使用依赖于Maven仓库，在项目中使用Maven管理jar包有两种情况较常见：一是从Maven库中下载java项目所依赖的jar包；二是将本身的项目生成jar包上传至Maven仓库。

Maven仓库的搭建依赖于OSS（Object Storage Service）工具。Nexus RepositoryManager OSS是一款仓库管理工具。它包含多种仓库的概念，包括主要的宿主仓库、代理仓库、仓库组等。不同的仓库可以提供不同配置、服务。代理仓库主要提供下载缓存构件和插件，宿主仓库主要用于存放项目部署的构建或第三方构建用于提供下载。

基于Maven机制下载、使用或生成、上传后台资源包在J2EE项目中是很常见的一种做法。在普通J2EE项目中，后台资源的jar包只需要统一放在WebContent下的WEB-INF\lib中即可被识别，方便统一管理。而前台资源一般则分散放在WebContent下，部署后应用服务器按照相应地址即可定位查找到。这样的方式导致了如果要使用前台资源相关组件（如jQuery、ExtJs或自定义的前台组件），则需要将相关的前台组件文件（javascript、css、gif等）连带文件夹一起拷贝至工作区，不利于前台组件版本的控制、升级和与项目源码的分离。更有甚者，如果由于项目需要而修改了前台组件的样式或图片，那就更难以升级前台的资源组件了。

发明内容

鉴于前台资源的分散性及在J2EE项目中的升级和版本管理的困难，本发明的目的是提供一种基于Maven的前台资源打包并进行版本管理与使用的方法，将前台资源组件像后台资源一样打包，同时通过Maven上传至Maven仓库进行版本管理；使用时通过配置pom.xml下载前台资源包后，编写并配置特定的过滤器进行拦截与重定位；拦截匹配规则的URL并重定位的过滤器会优先在WebContent下查找相应地址的资源，定位不到之后才会在资源包中定位前台资源。这样J2EE项目可以自行覆盖、拓展前台组件的内容与样式而不影响到原始组件资源代码。

本发明的目的通过以下技术方案实现：

一种基于Maven的前台资源打包并进行版本管理与使用的方法，其特征在于该方法包括以下内容：

1）Maven仓库及使用环境搭建配置

用Nexus Repository Manager OSS 2.14.2工具搭建OSS仓库，下载Maven库后进行索引和仓库组配置；在前台资源开发的工作区和将使用前台资源进行开发的J2EE工作区进行Maven配置； OSS管理Maven库，前台资源打包工作区通过Maven生成jar包并上传至Maven仓库，使用前台资源包的J2EE项目通过Maven从Maven库中下载前台资源包并使用；

2）前台资源打包上传配置

前台资源打包的工作区中，将前台资源统一放置，并配置打包至Jar包的路径/META-INF/resources，上传至Maven仓库的相关配置；

3）前台资源下载使用配置

使用前台资源的J2EE项目通过Maven的pom配置下载需要的前台静态资源Jar包；如果最终J2EE应用发布在遵循Servlet3及以上版本规范的应用服务器上则无需进行特殊配置；否则需要使用或编写可读取按标准资源路径/META-INF/resources生成jar包的过滤器。

该过滤器的实现算法如下：

判断访问url是否目录

A）是，直接给出禁止访问的错误并返回；

B）否，则通过ServletContext判断webcontent下是否有对应资源：

B1）有，则直接过滤器放行由后续过滤器处理；

B2）无，则在jar包中定位其/META-INF/resources下的资源；

B21）定位不到给出资源未找到的404错误并返回

B22）定位到了，则将资源作为二进制流数据返回，同时按照是否需要浏览器缓存的配置进行设置相应的缓存与过期信息。

本发明将前台资源组件像后台资源一样打包，同时通过Maven上传至Maven仓库进行版本管理；使用时通过配置pom.xml下载前台资源包后，编写并配置特定的过滤器进行拦截与重定位；拦截匹配规则的URL并重定位的过滤器会优先在WebContent下查找相应地址的资源，定位不到之后才会在资源包中定位前台资源。这样J2EE项目可以自行覆盖、拓展前台组件的内容与样式而不影响到原始组件资源代码，解决了前台资源的分散性及在J2EE项目中的升级和版本管理的困难问题。

附图说明

图1仓库OSS、Maven打包上传、下载使用关系图；

图2读取包内前台资源过滤器的实现算法图；

图3浏览器访问使用静态资源包的J2EE项目资源时序图。

具体实施方式

以下结合附图和具体实施例对本发明进行详细说明。

前台资源组件打包、上传并进行版本管理，以及J2EE下载前台资源组件并使用的框架。包括：仓库搭建、Maven安装配置、前台资源打包上传、资源包的过滤器编写、前台资源包下载使用五个方面。

仓库搭建：由于Internet网的Maven中央仓库不允许开发者随意上传自己的组件，同时考虑到一些特殊的行业（如电力、银行）的保密隔绝性，将搭建私有的Maven仓库。下载OSS工具Nexus Repository Manager OSS，在局域网中选择一台存储较大的服务器（可用存储大小400G以上）搭建Maven仓库。从因特网的Maven库（可使用目前国内最大的aliyun的Maven仓库）下载仓库中的所有jar包资源，将这些资源连带文件夹拷贝到局域网搭建好的仓库下载文件的放置路径内。启动局域网仓库，使用提供默认的用户名密码登录访问地址，配置仓库进行下载索引。然后对仓库组进行管理，把已下载的Maven库的多个Repository（Releases、Snapshots等）放入Nexus预定义的Public Repositories仓库组。这样，Maven只需要依赖于这一个Public Repositories仓库组的服务，就能使用该仓库组包含的所有仓库的内容。

Maven安装配置：Maven的安装配置是在开发机器上进行的。从Apache官网下载Apache Maven的压缩包，解压至本地磁盘。在开发工具Eclipse中下载maven插件MavenIntegration for Eclipse并安装。在Eclipse的Maven插件设置中（window->preferences->Maven->Installations）指定maven放置目录，并指定Maven全局配置文件放置的地址（window->preferences->Maven->User Settings）。在Maven的全局配置文件settings.xml中将镜像（mirror）选项配置为提供的Public Repositories仓库组的地址，同时配置Maven打包发布所需要的服务器账号相关项。

前台资源打包上传：在Eclipse项目工作区中，开发前台资源组件（不含任何后台资源），然后配置项目的pom.xml进行打包。由于打包成jar包，因此需要设置<packaging>jar</packaging>或不设置（默认为jar包）。

查找servlet协议规范，在servlet3（JSR 315: Java™ Servlet Specification）final版。（在WEB-INF/lib目录下除了打包在JAR文件中META-INF/resources目录下的静态资源和JSP文件之外，WEB-INF目录下包含的其他任何文件都不能由容器直接提供给客户端访问。）

也就是说生成jar项目时如果相关资源打到/META-INF/resources下，java的web项目就可如同将资源放到了其根目录下一样使用该jar包中的资源。因此考虑到对高版本servlet的友好性与兼容性，将静态资源按照遵循servelt3规范的要求，放到jar包的/META-INF/resources下打包，反映到maven的pom.xml即添加如下配置。其中定义的属性destDir表示生成jar包时的包内目的地路径目录，构建时的资源来自于项目基本路径目录下的/src/main/resources文件夹。

同时添加需要将组件上传Maven库的配置（url按照仓库实际提供的地址配置），置完后，在Maven项目的运行配置中通过设置目标部署（deploy -e），运行即可将编写的对应GAV（Maven坐标最基本最重要的组成部分）的前台资源组件打包并上传至Maven仓库，以供其他项目使用。

资源包过滤器编写：要使用上述jar包中的前台资源，在遵循servlet3及以上版本规范的应用服务器中（Oracle Weblogic 12C、Apache Tomcat 7.0.62等以上版本）无需进行特殊配置，直接如同访问其根目录下的对应路径资源一样即可。但是对于不支持servlet3版本的服务器，就需要通过编写servlet或过滤器拦截重定位，考虑到拦截的路径未必都是访问的静态资源，因此使用过滤器更通用。通过过滤器的配置可设置浏览器是否可缓存静态资源文件。该过滤器可写成单独的后台组件上传至Maven以供下载使用。

前台资源包下载使用：在开发J2EE项目过程中使用前台资源组件包时，需要进行一些配置。在pom.xml中添加需下载的前台资源包的配置，添加完后Maven会将相应前台资源包自动下载。若部署在不支持servlet3的应用服务器的情况下，还需要在pom.xml中添加读取前台资源包内资源所用过滤器的后台资源包配置（也可将过滤器的实现代码拷贝本项目后进行定制化开发），同时在web.xml中进行拦截的URL模式配置。由于多通过一层过滤器添加了逻辑判断，性能方面多少会有一丝损耗，因此拦截的URL模式配置应该尽量精准只用来定位前台资源包中的资源。若需对前台资源包中的资源进行改动，只需在工作区的根目录下建立相同的路径，将变动的文件拷贝并进行修改即可。

一种基于Maven的前台资源打包并进行版本管理与使用的方法，包括以下内容：Maven仓库及使用环境搭建配置、前台资源打包上传配置、前台资源下载使用配置。

1.Maven仓库及使用环境搭建配置

用Nexus Repository Manager OSS 2.14.2工具搭建OSS仓库，下载Maven库后进行索引和仓库组配置。在前台资源开发的工作区和将使用前台资源进行开发的J2EE工作区进行Maven配置。图1展示了几者之间的关系图，OSS管理Maven库，前台资源打包工作区通过Maven生成jar包并上传至Maven仓库，需要使用前台资源包的J2EE项目通过Maven从Maven库中下载前台资源包并使用。

2.前台资源打包上传配置

前台资源打包的工作区中，需要将前台资源统一放置，并配置打包至Jar包的路径（/META-INF/resources）和上传至Maven仓库的相关配置。

3.前台资源下载使用配置

使用前台资源的J2EE项目通过Maven的pom配置下载需要的前台静态资源Jar包。如果最终J2EE应用发布在遵循Servlet3及以上版本规范的应用服务器上则无需进行特殊配置；否则需要使用或编写可读取按标准资源路径（/META-INF/resources）生成jar包的过滤器。该过滤器的实现算法如下（图2为该过滤器的算法图）：

判断访问url是否目录

A）是，直接给出禁止访问的错误并返回；

B）否，则通过ServletContext判断webcontent下是否有对应资源：

B1）有，则直接过滤器放行由后续过滤器处理

B2）无，则在jar包中定位其/META-INF/resources下的资源

B21）定位不到给出资源未找到的404错误并返回

B22）定位到了，则将资源作为二进制流数据返回，同时按照是否需要浏览器缓存的配置进行设置相应的缓存与过期信息。

使用静态资源包的J2EE项目最终打包发布后，浏览器对打包的前台静态资源的访问对外与其他资源的访问没有任何区别，其内在的实际时序过程请参照浏览器访问使用静态资源包的J2EE项目资源时序图（图3）中的文字说明。

Claims (2)

1.一种基于Maven的前台资源打包并进行版本管理与使用的方法，其特征在于该方法包括以下内容：

1）Maven仓库及使用环境搭建配置

用Nexus Repository Manager OSS 2.14.2工具搭建OSS仓库，下载Maven库后进行索引和仓库组配置；在前台资源开发的工作区和将使用前台资源进行开发的J2EE工作区进行Maven配置； OSS管理Maven库，前台资源打包工作区通过Maven生成jar包并上传至Maven仓库，使用前台资源包的J2EE项目通过Maven从Maven库中下载前台资源包并使用；

2）前台资源打包上传配置

前台资源打包的工作区中，将前台资源统一放置，并配置打包至Jar包的路径/META-INF/resources，上传至Maven仓库的相关配置；

3）前台资源下载使用配置

使用前台资源的J2EE项目通过Maven的pom配置下载需要的前台静态资源Jar包；如果最终J2EE应用发布在遵循Servlet3及以上版本规范的应用服务器上则无需进行特殊配置；否则需要使用或编写可读取按标准资源路径/META-INF/resources生成jar包的过滤器。

2.根据权利要求1所述的基于Maven的前台资源打包并进行版本管理与使用的方法，其特征在于：该过滤器的实现算法如下：

判断访问url是否目录

A）是，直接给出禁止访问的错误并返回；

B）否，则通过ServletContext判断webcontent下是否有对应资源：

B1）有，则直接过滤器放行由后续过滤器处理；

B2）无，则在jar包中定位其/META-INF/resources下的资源；

B21）定位不到给出资源未找到的404错误并返回

B22）定位到了，则将资源作为二进制流数据返回，同时按照是否需要浏览器缓存的配置进行设置相应的缓存与过期信息。