Springboot项目打包成jar运行2种方式

时间:2023-11-13 23:51:38

最近公司有个项目需要移植到SpringBoot框架上,项目里面又有许多第三方jar包,在linux服务器上最方便的就是用jar的方式来运行SpringBoot项目了,因此我研究了2种打jar包的方式,记录如下,供大家参考:

1、通过maven插件,将所有依赖包都打包成一个jar包,然后通过java -jar xxx.jar方式运行

由于项目中有些jar包是第三方的,maven官方仓库没有,需要使用mvn install命令打包到本地,然后将其写入到pom.xml的依赖中,maven仓库有的jar包则从maven官网找到对应版本的depdency写入pom文件里面,这样maven打包就可以包含第三方jar包了,否则maven只会打包pom文件里面的,不会包括第三方jar包,程序运行将报错。这里推荐2种打包第三方jar包的方式:

第一种:打包第三方jar包到本地仓库,然后在pom.xml中引入

例如:将alipay-sdk-abc.jar 打包到本地仓库

mvn命令:

‪mvn install:install-file -Dfile=‪G:\thirdpartyjar\alipay-sdk-abc.jar -DgroupId=com.thirdparty -DartifactId=alipay-sdk-abc -Dversion=3.1.0.8 -Dpackaging=jar

pom.xml配置:

<dependency>

    <groupId>com.thirdparty</groupId>

    <artifactId>alipay-sdk-abc</artifactId>

    <version>3.1.0.8</version>

</dependency>

然后在cmd或者IDEA的terminal里面使用mvn clean package -X命令清理、打包成jar文件,-X命令可以看到具体的打包输出,便于分析。

这里用到了2个plugin,一个是普通的maven插件用于将各种jar包打包到一起,可是这样的jar包是无法运行的,因为jar包里面没有启动类信息,还需要SpringBoot的maven插件进行repackage,这样生成的jar包就包含启动信息,才可以运行,关键配置如下:

<plugin>

    <groupId>org.apache.maven.plugins</groupId>

    <artifactId>maven-compiler-plugin</artifactId>

    <version>3.5.1</version>

    <configuration>

    <source>1.8</source>

    <target>1.8</target>

    <compilerArgs>

    <!-- 过期的方法的警告-->

    <arg>-Xlint:deprecation</arg>

    </compilerArgs>

    <compilerArguments>

    <!-- 是否输出所有的编译信息(包括类的加载等)-->

    <!--<verbose />-->

    <!-- 解决maven命令编译报错,因为rt.jar 和jce.jar在jre的lib下面,不在jdk的lib下面,

导致maven找不到(java7以后会出现这个问题),将这2个jar包拷贝到jdk的lib下面估计也好使-->

        <bootclasspath>${java.home}/lib/rt.jar;${java.home}/lib/jce.jar</bootclasspath>

    </compilerArguments>

</configuration>

</plugin>

<plugin>

    <groupId>org.springframework.boot</groupId>

    <artifactId>spring-boot-maven-plugin</artifactId>

    <executions>

        <execution>

            <goals>

                <goal>repackage</goal>

            </goals>

        </execution>

    </executions>

</plugin>        

 第二种:通过在pom.xml中指定第三方jar包路径来引入依赖

比如第三方jar包在lib文件夹下,对pom.xml的配置如下:

<dependencies>标签里面引入第三方jar包的依赖
pom.basedir指的是pom文件所在的目录,
systemPath指的是第三方jar包所在路径。
<dependency>
<groupId>com.abc</groupId>
<artifactId>cryptokit</artifactId>
<version>1.0</version>
<scope>system</scope>
<systemPath>${pom.basedir}/lib/cryptokit-1.0.jar</systemPath>
</dependency>

还必须修改<plugins>标签里面的maven plugin,增加includeSystemScope属性并设置为true

<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<includeSystemScope>true</includeSystemScope>
</configuration>
</plugin>

第二种方式相比第一种方式,省事、方便。

2、将主程序打成jar包,然后和其他依赖jar包放在一起(包括maven下载的和第三方jar包),这样也可以通过java -jar xxx.jar方式运行

jar方式运行的前提是主程序jar包中的META-INF文件夹下的MANIFEST.MF文件必须有正确的Class-Path、Main-Class

Class-Path指定了主程序依赖的jar,若配置错误,运行jar时将报ClassNotFoundException;若新增或删除了一些jar包,需要删除该文件,并重新生成。

Main-Class指定了程序的运行入口,这里配置成SpringBoot的主函数。

MANIFEST.MF文件若配置不当,运行jar时将报xxxxxx.jar中没有主清单属性

MANIFEST.MF示例如下:

Manifest-Version: 1.0

Class-Path: spring-expression-4.3..RELEASE.jar jboss-logging-3.3..F

 inal.jar jcl-over-slf4j-1.7..jar SADK-CMBC-3.1.0.8.jar slf4j-api-.

 7.25.jar spring-boot-starter-web-1.5..RELEASE.jar spring-webmvc-4.3

 ..RELEASE.jar spring-boot-starter-tomcat-1.5..RELEASE.jar spring-

 aop-4.3..RELEASE.jar spring-boot-1.5..RELEASE.jar spring-boot-sta

 rter-logging-1.5..RELEASE.jar spring-core-4.3..RELEASE.jar snakey

 aml-1.17.jar tomcat-embed-websocket-8.5..jar spring-beans-4.3..RE

 LEASE.jar spring-boot-autoconfigure-1.5..RELEASE.jar log4j-over-slf

 4j-1.7..jar hibernate-validator-5.3..Final.jar classmate-1.3..jar

  spring-web-4.3..RELEASE.jar jul-to-slf4j-1.7..jar logback-classi

 c-1.1..jar spring-context-4.3..RELEASE.jar spring-boot-starter-.

 5.17.RELEASE.jar jackson-databind-2.8.11.2.jar jackson-annotations-.

 8.0.jar tomcat-annotations-api-8.5..jar tomcat-embed-el-8.5..jar

 jackson-core-2.8..jar logback-core-1.1..jar tomcat-embed-core-8.5

 ..jar validation-api-1.1..Final.jar

Main-Class: com.example.testmaven.TestmavenApplication

3、IDEA打包步骤

3.1打包多个jar包

按Ctrl+Alt+Shift+S打开项目配置,点击Atrifacts,然后按如下截图进行:

Springboot项目打包成jar运行2种方式Springboot项目打包成jar运行2种方式

Springboot项目打包成jar运行2种方式

点击testmaven.jar,可以看到Main Class和Class Path都有内容了:

Springboot项目打包成jar运行2种方式

Springboot项目打包成jar运行2种方式

src下也生成了META-INFO文件夹和MAINFEST.MF文件:

Springboot项目打包成jar运行2种方式

构建Artifacts:

Springboot项目打包成jar运行2种方式

点击Build或者Rebuild后将在对应文件下生成artifacts文件,里面有依赖的jar包和主程序包;

Springboot项目打包成jar运行2种方式

Springboot项目打包成jar运行2种方式

文件夹地址栏输入cmd来打开cmd:

Springboot项目打包成jar运行2种方式

然后输入java -jar testmaven.jar,就能正确运行Spring Boot项目了:

Springboot项目打包成jar运行2种方式

 3.2 使用maven打包成一个jar包

3.2.1 使用maven工具栏打包项目

通过点击view-tool windows -maven projects显示maven侧边栏

Springboot项目打包成jar运行2种方式

点击maven projects侧边栏,展开Lifecycle,第一步先双击clean按钮进行清理,该步会删除之前打包的文件夹。第二步双击package,进行打包操作,需要等待一段时间。

Springboot项目打包成jar运行2种方式

Springboot项目打包成jar运行2种方式

target下的红色框圈出的就是最终的目标jar:

Springboot项目打包成jar运行2种方式

3.2.2 使用maven命令打包并运行项目

(1)按Alt+F12打开Terminal;

(2)输入 mvn clean package;该命令首先清理了target文件夹,然后进行打包。等待一段时间后,打包完毕。

(3)输入cd target 进入jar包文件夹;

(4) 输入java -jar xxxxx.jar 运行jar包。