成果物需要部署到用户内网的童鞋应该都遇到过该问题:引入的maven依赖越来越多,jar包越来越大,我之间甚至见过一两个G的依赖,想改个代码换到现场测试,包传到现场要一二十分钟,真正实现了改代码两分钟分钟,部署一小时,为了避免该问题,此次我使用assembly进行打包,将自己的代码还有依赖彻底拆分开,另外,因为不想单独另外部署一套nginx,所以我打算将前端(vue2)打包后一起放在后端。前端文件为了方便后面替换,和application一起打包到外部config文件夹下,避免以后每次前端文件修改了,后端都要重新打包。
1、后端部分
最外层pom需要做如下修改:
1)、其中需要注意的是,启动类需要改成自己的
2)、还有以下部分,是为了将前端资源也打包进config文件夹下。
<profiles><profile><id>local</id><properties><profileActive>local</profileActive></properties><activation><activeByDefault>false</activeByDefault></activation></profile><profile><id>dev</id><properties><profileActive>dev</profileActive></properties><activation><activeByDefault>true</activeByDefault></activation></profile><profile><id>test</id><properties><profileActive>test</profileActive></properties><activation><activeByDefault>false</activeByDefault></activation></profile><profile><id>uat</id><properties><profileActive>uat</profileActive></properties><activation><activeByDefault>false</activeByDefault></activation></profile><profile><id>prod</id><properties><profileActive>prod</profileActive></properties><activation><activeByDefault>false</activeByDefault></activation></profile></profiles><build><!-- 打包后的启动jar名称 --><finalName>Alarm2WechatService</finalName><resources><!-- 资源文件配置 --><resource><directory>${project.basedir}/src/main/resources</directory><filtering>true</filtering><includes><include>application.properties</include><include>application-${profileActive}.properties</include><include>mapper/**/*.xml</include>
<!-- <include>static/**</include>--><include>templates/**</include><include>*.xml</include><include>*.properties</include><include>*.jks</include></includes><excludes><exclude>static/**</exclude></excludes></resource><!-- 添加不经过过滤的资源声明 --><resource><directory>${project.basedir}/src/main/resources</directory><filtering>false</filtering><includes><include>static/**</include></includes></resource></resources><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>3.1.0</version><configuration><archive><manifest><!-- 项目启动类 --><mainClass>com.w.alarm2wechat.Alarm2WechatServiceApplication</mainClass><!-- 依赖的jar的目录前缀 --><classpathPrefix>../lib</classpathPrefix><addClasspath>true</addClasspath></manifest></archive><includes><include>**/*.class</include> <!-- 包含所有类文件 --><include>**/*.xml</include> <!-- 包含XML配置文件 --></includes></configuration></plugin><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><layout>ZIP</layout><includes><!-- 项目启动jar包中排除依赖包 --><include><groupId>non-exists</groupId><artifactId>non-exists</artifactId></include></includes></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><version>3.1.0</version><executions><execution><phase>prepare-package</phase><goals><goal>copy-dependencies</goal></goals><configuration><outputDirectory>target/lib</outputDirectory><overWriteReleases>false</overWriteReleases><overWriteSnapshots>false</overWriteSnapshots><overWriteIfNewer>true</overWriteIfNewer><includeScope>compile</includeScope></configuration></execution></executions></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-resources-plugin</artifactId><version>3.1.0</version></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><configuration><source>${java.version}</source><target>${java.version}</target></configuration></plugin><!-- 打包时跳过测试 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>2.22.1</version><configuration><skipTests>true</skipTests></configuration></plugin><!-- 打包插件 --><plugin><artifactId>maven-assembly-plugin</artifactId><version>3.1.0</version><configuration><descriptors><descriptor>src/main/assembly/assembly.xml</descriptor></descriptors></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></build>
main文件夹下需要新增assembly文件夹和assembly.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<assembly><!-- 可自定义,这里指定的是项目环境 --><!-- spring-boot-assembly-local-1.0.RELEASE.tar.gz --><id>${profileActive}-${project.version}</id><!-- 打包的类型,如果有N个,将会打N个类型的包 --><formats><format>tar.gz</format><format>zip</format></formats><includeBaseDirectory>true</includeBaseDirectory><fileSets><!--0755->即用户具有读/写/执行权限,组用户和其它用户具有读写权限;0644->即用户具有读写权限,组用户和其它用户具有只读权限;--><!-- 将src/bin目录下的所有文件输出到打包后的bin目录中 --><fileSet><directory>${basedir}/src/bin</directory><outputDirectory>bin</outputDirectory><fileMode>0755</fileMode><includes><include>**.sh</include><include>**.bat</include></includes></fileSet><!-- 指定输出target/classes中的配置文件到config目录中 --><fileSet><directory>${basedir}/target/classes</directory><outputDirectory>config</outputDirectory><fileMode>0644</fileMode><includes><include>application.properties</include><include>application-${profileActive}.properties</include><include>mapper/**/*.xml</include><include>static/**</include><include>templates/**</include><include>*.xml</include><include>*.properties</include><include>*.jks</include></includes></fileSet><!-- 将第三方依赖打包到lib目录中 --><fileSet><directory>${basedir}/target/lib</directory><outputDirectory>lib</outputDirectory><fileMode>0755</fileMode></fileSet><!-- 将项目启动jar打包到boot目录中 --><fileSet><directory>${basedir}/target</directory><outputDirectory>boot</outputDirectory><fileMode>0755</fileMode><includes><include>${project.build.finalName}.jar</include></includes></fileSet><!-- 包含根目录下的文件 --><fileSet><directory>${basedir}</directory><includes><include>NOTICE</include><include>LICENSE</include><include>*.md</include></includes></fileSet></fileSets></assembly>
src下还要新建bin文件夹
文件夹下是工程启动脚本,需要注意的是 XXXXX 需要替换成自己实际的。
restart.sh
#! /bin/shell#======================================================================
# 项目重启shell脚本
# 先调用shutdown.sh停服
# 然后调用startup.sh启动服务
#
# author: geekidea
# date: 2018-12-2
#======================================================================# 项目名称
APPLICATION="XXXXX"# 停服
echo stop ${APPLICATION} Application...
sh shutdown.sh# 启动服务
echo start ${APPLICATION} Application...
sh startup.sh
shutdown.sh
#! /bin/shell#======================================================================
# 项目停服shell脚本
# 通过项目名称查找到PID
# 然后kill -9 pid
#
# author: geekidea
# date: 2018-12-2
#======================================================================# 项目名称
APPLICATION="XXXXX"# 项目启动jar包名称
APPLICATION_JAR="${APPLICATION}.jar"PID=$(ps -ef | grep "${APPLICATION_JAR}" | grep -v grep | awk '{ print $2 }')
if [[ -z "$PID" ]]
thenecho ${APPLICATION} is already stopped
elseecho kill ${PID}kill -9 ${PID}echo ${APPLICATION} stopped successfully
fi
startup.bat
@echo off
rem ======================================================================
rem windows startup script
rem
rem author: geekidea
rem date: 2018-12-2
rem ======================================================================rem Open in a browser
start "" "http://localhost:18083/#/"rem startup jar
java -jar ../boot/XXXXX.jar --spring.config.location=../config/pause
startup.sh
#! /bin/shell#======================================================================
# 项目启动shell脚本
# boot目录: spring boot jar包
# config目录: 配置文件目录
# logs目录: 项目运行日志目录
# logs/spring-boot-assembly_startup.log: 记录启动日志
# logs/back目录: 项目运行日志备份目录
# nohup后台运行
#
# author: geekidea
# date: 2018-12-2
#======================================================================# 项目名称
APPLICATION="XXXXX"# 项目启动jar包名称
APPLICATION_JAR="${APPLICATION}.jar"# bin目录绝对路径
BIN_PATH=$(cd `dirname $0`; pwd)
# 进入bin目录
cd `dirname $0`
# 返回到上一级项目根目录路径
cd ..
# 打印项目根目录绝对路径
# `pwd` 执行系统命令并获得结果
BASE_PATH=`pwd`# 外部配置文件绝对目录,如果是目录需要/结尾,也可以直接指定文件
# 如果指定的是目录,spring则会读取目录中的所有配置文件
CONFIG_DIR=${BASE_PATH}"/config/"# 项目日志输出绝对路径
LOG_DIR=${BASE_PATH}"/logs"
LOG_FILE="${APPLICATION}.log"
LOG_PATH="${LOG_DIR}/${LOG_FILE}"
# 日志备份目录
LOG_BACK_DIR="${LOG_DIR}/back/"# 项目启动日志输出绝对路径
LOG_STARTUP_PATH="${LOG_DIR}/${APPLICATION}_startup.log"# 当前时间
NOW=`date +'%Y-%m-%m-%H-%M-%S'`
NOW_PRETTY=`'date +%Y-%m-%m %H:%M:%S'`# 启动日志
STARTUP_LOG="================================================ ${NOW_PRETTY} ================================================\n"# 如果logs文件夹不存在,则创建文件夹
if [[ ! -d "${LOG_DIR}" ]]; thenmkdir "${LOG_DIR}"
fi# 如果logs/back文件夹不存在,则创建文件夹
if [[ ! -d "${LOG_BACK_DIR}" ]]; thenmkdir "${LOG_BACK_DIR}"
fi# 如果项目运行日志存在,则重命名备份
if [[ -f "${LOG_PATH}" ]]; thenmv ${LOG_PATH} "${LOG_BACK_DIR}/${APPLICATION}_back_${NOW}.log"
fi# 创建新的项目运行日志
echo "" > ${LOG_PATH}# 如果项目启动日志不存在,则创建,否则追加
echo "${STARTUP_LOG}" >> ${LOG_STARTUP_PATH}#==========================================================================================
# JVM Configuration
# -Xmx256m:设置JVM最大可用内存为256m,根据项目实际情况而定,建议最小和最大设置成一样。
# -Xms256m:设置JVM初始内存。此值可以设置与-Xmx相同,以避免每次垃圾回收完成后JVM重新分配内存
# -Xmn512m:设置年轻代大小为512m。整个JVM内存大小=年轻代大小 + 年老代大小 + 持久代大小。
# 持久代一般固定大小为64m,所以增大年轻代,将会减小年老代大小。此值对系统性能影响较大,Sun官方推荐配置为整个堆的3/8
# -XX:MetaspaceSize=64m:存储class的内存大小,该值越大触发Metaspace GC的时机就越晚
# -XX:MaxMetaspaceSize=320m:限制Metaspace增长的上限,防止因为某些情况导致Metaspace无限的使用本地内存,影响到其他程序
# -XX:-OmitStackTraceInFastThrow:解决重复异常不打印堆栈信息问题
#==========================================================================================
JAVA_OPT="-server -Xms256m -Xmx256m -Xmn512m -XX:MetaspaceSize=64m -XX:MaxMetaspaceSize=256m"
JAVA_OPT="${JAVA_OPT} -XX:-OmitStackTraceInFastThrow"#=======================================================
# 将命令启动相关日志追加到日志文件
#=======================================================# 输出项目名称
STARTUP_LOG="${STARTUP_LOG}application name: ${APPLICATION}\n"
# 输出jar包名称
STARTUP_LOG="${STARTUP_LOG}application jar name: ${APPLICATION_JAR}\n"
# 输出项目bin路径
STARTUP_LOG="${STARTUP_LOG}application bin path: ${BIN_PATH}\n"
# 输出项目根目录
STARTUP_LOG="${STARTUP_LOG}application root path: ${BASE_PATH}\n"
# 打印日志路径
STARTUP_LOG="${STARTUP_LOG}application log path: ${LOG_PATH}\n"
# 打印JVM配置
STARTUP_LOG="${STARTUP_LOG}application JAVA_OPT : ${JAVA_OPT}\n"# 打印启动命令
STARTUP_LOG="${STARTUP_LOG}application background startup command: nohup java ${JAVA_OPT} -jar ${BASE_PATH}/boot/${APPLICATION_JAR} --spring.config.location=${CONFIG_DIR} > ${LOG_PATH} 2>&1 &\n"#======================================================================
# 执行启动命令:后台启动项目,并将日志输出到项目根目录下的logs文件夹下
#======================================================================
nohup java ${JAVA_OPT} -jar ${BASE_PATH}/boot/${APPLICATION_JAR} --spring.config.location=${CONFIG_DIR} > ${LOG_PATH} 2>&1 &# 进程ID
PID=$(ps -ef | grep "${APPLICATION_JAR}" | grep -v grep | awk '{ print $2 }')
STARTUP_LOG="${STARTUP_LOG}application pid: ${PID}\n"# 启动日志追加到启动日志文件中
echo -e ${STARTUP_LOG} >> ${LOG_STARTUP_PATH}
# 打印启动日志assembly
echo -e ${STARTUP_LOG}# 打印项目日志
tail -f ${LOG_PATH}
application.properties需要新增如下配置
spring.web.resources.static-locations=file:../config/static/
spring.mvc.static-path-pattern=/static/**
另外需要新增配置类WebConfig
如果不新增配置类,上面的spring.web.resources.static-locations=file:../config/static/不会生效,导致404。
package com.w.config;import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.resource.PathResourceResolver;@Controller
public class WebConfig implements ErrorController {private static final Logger LOGGER = LoggerFactory.getLogger(WebConfig.class);// 注入配置文件中的路径@Value("${spring.web.resources.static-locations}")private String[] staticLocations;private static final String PATH = "/error";@RequestMapping(value = PATH)public String error() {return "forward:/index.html";}@Beanpublic WebMvcConfigurer webMvcConfigurer() {return new WebMvcConfigurer() {@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {// 添加字体文件类型支持registry.addResourceHandler("/**").addResourceLocations(staticLocations).setCachePeriod(3600).resourceChain(true).addResolver(new PathResourceResolver());}};}
}
2、前端部分
router下的index.js,主要修改红框部分
const router = new VueRouter({mode: 'history',base: '/XXXX/', // 必须与publicPath保持一致routes
})
vue.config.js文件
修改前的代码
调整后的代码
const path = require('path');
function resolve(dir) {return path.join(__dirname, dir);
}
module.exports = {publicPath: '/XXXX/', // 新增公共路径lintOnSave: false,devServer: {port: 18083,publicPath: '/XXXX/', // 保持与publicPath一致historyApiFallback: {rewrites: [{ from: /^\/XXXX/, to: '/XXXX/index.html' } // 修正重写规则]},proxy:{'/alarmWechat':{target: 'http://localhost:18082',changeOrigin: true,pathRewrite: {'^/XXXX': '' // 移除接口路径中的/alarmWechat}}}},configureWebpack: {devtool: 'source-map',optimization: {minimize: false}},chainWebpack(config) {config.module.rule('svg').exclude.add(resolve('src/icons')).end()config.module.rule('icons').test(/\.svg$/).include.add(resolve('src/icons')).end().use('svg-sprite-loader').loader('svg-sprite-loader').options({symbolId: 'icon-[name]'}).end()}
};
3、结果
1、clean package后,target下会生成zip文件,解压开,文件如下。执行bin下脚本即可启动工程