SpringBoot簡單打包部署(附工程)

前言

本文主要介紹SpringBoot的一些打包事項和項目部署以及在其中遇到一些問題的解決方案。

SpringBoot打包

在SpringBoot打包這塊，我們就用之前的一個web項目來進行打包。
首先需要明確的是，該項目打包的形態是可執行的jar包，還是在tomcat下運行的war包。
雖然本項目是用maven構建的，用maven打包也更加方便，但是這里也說明普通非maven打包的項目如何打包。

Maven打包

首先是maven方式打包:
如果是jar包
需在pom.xml指定打成的包為：

<packaging>jar</packaging> 

如果是war包。
需在pom.xml指定打成的包為：

<packaging>war</packaging>  

並通過<scope>標簽在打包的時候排除tomcat依賴

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-tomcat</artifactId>
 <scope>provided</scope>
</dependency>

然后添加SpringBoot自帶的打包方式
示例如下:

<build> <defaultGoal>compile</defaultGoal> <sourceDirectory>src</sourceDirectory> <finalName>springboot-package</finalName> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin </artifactId> <configuration> <fork>true</fork> <mainClass>com.pancm.App</mainClass> </configuration> <executions> <execution> <goals> <goal>repackage</goal> </goals> </execution> </executions> </plugin> </plugins> </build>

注：<finalName>標簽是指定打包之后的名稱，<mainClass>是指定main函數。

也可以不用SpringBoot自帶的打包方式，使用maven的assembly插件進行打包。
示例如下:

<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>2.5.5</version> <configuration> <archive> <manifest> <mainClass>com.pancm.App</mainClass> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> </plugin> </plugins> </build> 

在pom.xml中添加完相應的標簽之后，我們只需在項目同級（pom.xml同級）輸入

mvn clean package

即可完成打包
如果想排除測試代碼，則可以輸入:

mvn clean package  -Dmaven.test.skip=true

來進行打包。

一般我們是把application.properties和logback.xml文件放在resources文件夾中，但是進行打包之后，它們也會包含在jar或war包中，如果我們想更改配置，則會比較麻煩。
如果想將它們和項目放在同級目錄下，application.properties可以直接移出和項目同級的目錄下，因為Spring程序會按優先級從下面這些路徑來加載application.properties配置文件：

• 當前目錄下的/config目錄
• 當前目錄
• classpath里的/config目錄
• classpath 根目錄

springboot默認加載的logback是在classpath目錄下，這時我們只需要在application.properties配置文件指定logback.xml的路徑即可。
添加如下:

logging.config=logback.xml

如果引入了第三方的jar包，但是又無法通過maven私服進行下載，這時可以手動進行編譯。
例如，我寫了一個工具類為Mytools，然后把它打成了一個jar包，然后放在我的這個項目中lib目錄下，並且需要引用它，那么此時便可以對該jar包進行編譯到本地倉庫中，然后再pom.xml添加相應的名稱和版本號。
命令示例:

mvn install:install-file -Dfile=lib/pancmtools.jar -DgroupId=com.panncm.utils -DartifactId=pancm-utils -Dversion=1.0 -Dpackaging=jar

pom.xml添加

<dependency> <groupId>com.panncm.utils</groupId> <artifactId>pancm-utils</artifactId> <version>1.0</version> </dependency>

便可以進行打包了。

普通項目打包

如果是普通的項目，沒有使用maven構建的話，可以使用eclipse等工具進行打包。
如果是jar包
首先在eclipse中運行該項目(main方法運行)，然后在eclipse中右鍵項目 export ->java -> runnable jar file-> package required libraries into generated jar 指定main方法，然后選擇打包的名稱以及打包的路徑。點擊finish完成打包。

如果是war包
在eclipse中右鍵項目 export ->web -> war file，然后選擇打包的名稱以及打包的路徑。點擊finish完成打包。

Ant打包

介紹了上述兩種打包之后，這里介紹下通過ant方法進行打包(需要安裝ant環境，安裝方式基本和maven一致，指定路徑，配置環境變量，這里就不在過多講述了)。
一般打包之后，我們需要將包和配置文件放在一個目錄下，這時我們又不想手動進行復制粘貼的話，就可以用ant來進行打包，將打包的文件整合在一起。
這里我們就編寫一個build.xml的配置文件。

<?xml version="1.0" encoding="UTF-8"?> <project name="springboot-package" default="copyAll" basedir="."> <property name="build" value="build" /> <property name="target" value="target" /> <target name="clean"> <delete dir="${target}" /> <delete dir="${build}" /> </target> <target name="create-path" depends="clean"> <mkdir dir="${build}" /> </target> <target name="mvn_package" depends="create-path"> <exec executable="cmd" failonerror="true"> <arg line="/c mvn install:install-file -Dfile=lib/pancmtools.jar -DgroupId=com.panncm.utils -DartifactId=pancm-utils -Dversion=1.0 -Dpackaging=jar" /> </exec> <exec executable="cmd" failonerror="true"> <arg line="/c mvn clean package" /> </exec> </target> <target name="copyAll" depends="mvn_package"> <copy todir="${build}" file="${target}/springboot-package.jar"></copy> <copy todir="${build}" file="logback.xml"></copy> <copy todir="${build}" file="application.properties"></copy> <copy todir="${build}" file="run.bat"></copy> </target> </project>

 

注：<mkdir dir="${build}" />是指定文件存放的文件夾，executable是使用cmd命令，line是執行的語句， 標簽是將文件復制到指定的文件夾中。

然后再新建一個 build.bat文件，里面只需要填寫 ant就行了。
准備完之后，只需雙擊build.bat，項目和配置文件就自動到build文件中了，省去了很多操作。

雖然現在流行通過jenkins進行打包部署，不過使用ant加maven進行打包也不錯的，比較簡單。

打包遇到的一些問題

問題:source-1.5 中不支持 diamond運算符

解決辦法一:
在properties添加

<maven.compiler.source>1.8</maven.compiler.source>和<maven.compiler.target>1.8</maven.compiler.target> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> <fastjson>1.2.41</fastjson> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties>

 

解決方案二:
在plugin中添加 <source>1.8</source> 和 <target>1.8</target>

<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.3</version> <configuration> <source>1.8</source> <target>1.8</target> </configuration> </plugin> </plugins> </build>  

問題二:打包出現某jar包無法打入

實際是可以下載，但是無法將此打入包中

解決辦法:
在pom.xml中添加

 <repositories> <repository> <id>spring-milestone</id> <url>http://repo.spring.io/libs-release</url>  </repository> </repositories> 

問題三:mvn clean 失敗，出現Failed to execute goal

原因: 在clean的時候，target里面的文件被占用了。
解決辦法: 不占用就行了。

SpringBoot部署

如果是jar項目
Windows系統在項目同級目錄下輸入:

java -jar springboot-package 

即可啟動項目。
關閉項目，只需關掉dos界面就可以了。
也可以寫一個bat文件進行運行。
示例:

@echo off title "springboot-package" java -jar springboot-package.jar

Linux系統在項目同級目錄下輸入:

nohup -jar springboot-package &

即可啟動。
關閉輸入:

kill -9 pid（jar的進程id）

也可以在init.d注冊一個服務
示例:

ln -s /home/jars/app/springboot-package.jar /etc/init.d/springboot-package chmod +x /etc/init.d/springboot-package

然后輸入:

service springboot-package start|stop|restart

進行啟動或者停止。
當然也可以編寫xshell腳本進行啟動和關閉。
示例:

#!/bin/bash APPDIR=`pwd` PIDFILE=$APPDIR/springboot-package.pid if [ -f "$PIDFILE" ] && kill -0 $(cat "$PIDFILE"); then echo "springboot-package is already running..." exit 1 fi nohup java -jar $APPDIR/springboot-package.jar >/dev/null 2>&1 & echo $! > $PIDFILE echo "start springboot-package..."

 

如果是war項目
將war放在tomcat/webapp目錄下，然后啟動tomcat就可以了。Windows系統 在tomcat/bin目錄下雙擊startup.bat即可啟動，雙擊shutdown.bat關閉。
Linux系統則在tomcat/bin 目錄下輸入startup.sh即可啟動， 輸入shutdown.sh關閉。

其它

關於SpringBoot打包部署就講解到這里了，如有不妥，歡迎指正！
SpringBoot打包部署的項目工程地址:
https://github.com/xuwujing/springBoot-study/tree/master/springboot-package

SpringBoot整合系列:

• springBoot配置文件的讀取以及過濾器和攔截器的使用

• SpringBoot的Restful風格的服務

• SpringBoot+Mybatis+ Druid+PageHelper實現多數據源並分頁

• SpringBoot整合ElasticSearch實現多版本的兼容

• SpringBoot整合Kafka和Storm

• SpringBoot整合Jsp和Thymeleaf

• SpringBoot整合Netty並使用Protobuf進行數據傳輸