记一次Spring项目打包问题排查
in 开发 with 0 comment

记一次Spring项目打包问题排查

in 开发 with 0 comment

一个 Spring 项目,打成 jar 包之后运行,在有网络的时候是正常的,但是一旦无网络就会报错,具体是怎么回事呢?这篇文章就来记录下这次问题排查经过。

背景介绍

一个图形化的界面,带本地数据库,要求可以在无网络环境下运行,我帮朋友用的 Java 写的图形化界面,虽然不是很美观,但是胜在熟悉 Java。

项目使用的是 idea 的「Build Artifacts」打包,打包之后运行正常,界面和数据库访问都正常,最开始报过几次错,后来就没出现了,也没找到原因,就先那样了。

后来发给别人了,完全打不开,跟之前的报错一样,看来必须要搞清楚报错的原因了。

问题排查

报错内容

首先贴一下报错的信息:

org.springframework.beans.factory.xml.XmlBeanDefinitionStoreException: 
Line 8 in XML document from class path resource [spring.xml] is invalid; 
nested exception is org.xml.sax.SAXParseException; 
lineNumber: 8; columnNumber: 76; 
cvc-elt.1: 找不到元素 'beans' 的声明。

spring.xml 代码截取如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       https://www.springframework.org/schema/context/spring-context.xsd">
</beans>

问题复现

因为我之前也碰到过这个报错,所以想着复现一下问题,方便排查。

我直接在虚拟机中运行,无论是覆盖安装还是卸载再次安装都没问题,我就想可能是环境问题导致的吧,就想着装一个新的虚拟机试一下。

新系统装完之后,一运行,果然崩溃了,报错信息一样。能复现问题,可以说为解决问题开了个好头。

问题排查

找到原因

通过关键字 cvc-elt.1: 找不到元素 'beans' 的声明 开始搜索,搜索到的结果基本都是以下的内容。

配置文件头部配置的 xsd 版本信息不正确,造成解析时出错。spring 头部 xsd 或 dtd 校验文件的查找分两步,第一先从本地 jar 包中找,如果找到则用本地jar包的进行校验(可以在 spring-beans.jar 或 spring-context.jar 里的 META-INF 下的 spring.schemas 文件中找到 xsd 文件位置的定义),如果没有找到则进行第二步查找,它会尝试从网络中下载该文件然后校验,如果系统断网或下载不下来,则会抛出上述异常。

照着这个思路,朋友也提醒我,看下虚拟机的系统是否联网了,我一看,果然没联网,赶紧联网测试发现能正常运行,问题的原因找到了。

再次困惑

找到了问题原因,好像就马上就能解决了,但事实并不是我想的那样。

网上的解决办法是:

将 applicationContext.xml 中 xsd 文件定义的版本改为 spring jar 包中定义的 xsd 的版本,如果版本定义的太高在本地会无法找到,只能从网络上下载。

但是,查看 spring-beans.jarMETA-INF 下的 spring.schemas 文件,发现无论版本号是多少,最后指向的都是一个。

截取了部分代码如下:

http\://www.springframework.org/schema/beans/spring-beans-2.0.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-2.5.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-3.0.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-3.1.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-3.2.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-4.0.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-4.1.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-4.2.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans-4.3.xsd=org/springframework/beans/factory/xml/spring-beans.xsd
http\://www.springframework.org/schema/beans/spring-beans.xsd=org/springframework/beans/factory/xml/spring-beans.xsd

后来又搜到一篇文章「spring5之SAXParseException:cvc-elt.1: 找不到元素 “beans” 的声明」,说 Spring 5 之后就不需要写版本号了。

那跟我看到的情况是一样的,确实各个版本号指向的都是同一个,看来不是版本号的问题,那到底是怎么回事?

一波三折

既然 xsd 的版本没错,那问题出在哪里呢?

继续搜索之后,看到了这篇文章「系统启动时,spring配置文件解析失败,报”cvc-elt.1: 找不到元素 'beans' 的声明“异常」。

打包之后,spring.schemas 位于 jar 包的 META-INF 目录下,但是 spring.schemas 里并没有 spring-beans.xsd,看来问题是在这了,我仿照作者的方法,把上面提到的 spring-beans.jarMETA-INF 下的 spring.schemas 里的关于 spring-beans.xsd 的部分添加到了压缩包的 spring.schemas 里。

重新打包之后仍然报错,但是报的错不是之前的错了,是说我的主函数类找不到了,真的是让人摸不着头脑,情况类似啊,为什么我的不好使。

豁然开朗

还是上面的操作,我让朋友试了一下,他测试之后居然好使!

我问他怎么操作的,他说跟我的操作一样,只不过把 https 部分的也加上了,我心想不应该啊,也没引用 httpsspring-beans.xsd,不应该是这个问题吧。

我按照他的操作,在我电脑上重新打包,发现还是不好使;我又把他给我的文件替换到我打的包里,还是不好使。真的是蒙了,操作是一样的,为什么我的不好使。

后来朋友说让我把修改好的包发给他,他看了之后发现我打的包大小不一样,正常应该是 14MB,但是我的包是 500KB,我又重新操作了一遍,发现我把文件替换之后,整个 jar 包的大小变小了,原来是我的压缩包软件有问题。

朋友的电脑是 Windows,是直接用 WinRAR 打开 jar 包,然后把文件替换;我的是 Mac,用的 eZip 软件打开 jar 包,然后替换文件。最后,我使用虚拟机按照朋友的操作测试后发现 ok 了。

谁能料到是压缩软件的问题呢?但是也不能全怪软件,毕竟人家是解压缩软件,并不是专门处理 jar 文件的。

完美解决

虽然找到了问题原因,也有了解决办法,但是解决的办法却不够好,总不能每次打好包再手动替换文件吧?

我觉得既然我们能遇到的问题,肯定也有其他人遇到,我就使用关键字 spring.schemas 打包之后没有把 beans 打进去 进行了搜索,发现了完美的解决方案:「spring打包到jar问题」。

问题的根本原因是,由于 spring 多个 jar 包都包含 spring.schemas,「Build Artifacts」和「Maven」默认打包只会把第一次遇到的 schemas 文件打入 jar 包。

解决办法是使用 maven shade 打包,具体的代码如下:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.2.2</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                        <mainClass>xxx.xxx.xxx.App</mainClass>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.handlers</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.schemas</resource>
                    </transformer>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                        <resource>META-INF/spring.tooling</resource>
                    </transformer>
                </transformers>
            </configuration>
        </execution>
    </executions>
</plugin>

将代码放在项目 pom.xml<plugins> 节点里,其中代码里的 <mainClass> 节点里要写主函数的完整目录。

感受

问题解决了,从中也得到一些感受:

欢迎关注我的公众号,及时获取最新文章推送。
0评论