转载

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 配置文件：

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 关闭。

原文 http://www.panchengming.com/2018/08/13/pancm91/

正文到此结束