在使用assembly来打包springboot微服务项目前，我想说一说，目前springboot项目的几种常见的部署方式。
使用docker容器去部署，将springboot的应用构建成一个docker image，然后通过容器去启动镜像 ，这种方式在需要部署大规模的应用和应用扩展时是非常方便的，属于目前工业级的部署方案，但是需要掌握docker的生态圈技术。
使用fatjar直接部署启动，这是很多初学者或者极小规模情况下的一个简单应用部署方式。
本文主要针对第二种部署方式提供一种更加友好的打包方案，是部署管理更加轻松，第一种方式可能未来我会在自己博客中写。
一、为什么要将springboot服务化打包 ?
最近我看到一个项目团队，他们在采用springboot开发完项目构建交互给运维团队就是一个spring boot 的fatjar。而且这种原始打出的包在传统型项目开发公司，对于运维人员来说无疑是很致命的，项目交付后整个配置文件都被隐藏到打成的jar中，针对不同的环境修改配置文件就变成了一件很困难的事情。因此，我们在公司引入任何新技术时，一定要考虑怎么去做服务化和工程化，如果仅仅引用技术框架，很多时候可能只需要加入几个依赖，看下api写几行代码就能跑起来。
针对上面的这种问题，要去做服务化和工程化，大致要解决两点问题：
让springboot能够加载jar外的配置文件。
提供一个服务化的启动脚本，这个脚本一般是shell或者windows下的bat ，有了springboot的应用服务脚本后，就可以容器的去启动和停止springboot的应用了。
二、打包后的springboot应用结构图
这里先来看下使用assembly将springboot服务化打包后的效果图。
三、服务化打包重要步骤
下面是打包springboot的详细步骤。
3.1 加入assembly打包插件
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<plugin> <artifactid>maven-assembly-plugin</artifactid> <version>3.0.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> |
从上面代码看出了我把assembly的配置放在main目录下，这个是习惯，可以不放这里也可以，下面就是一个assembly在项目中的大致结构图：
3.2 assembly.xml配置
assembly的配置不同的应用和下面配置也差不多，无非就是打包服务脚本、jar、配置文件等。从下面的代码中config配置就会发现， assembly将配置文件打到了config下。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
<assembly> <id>1.0</id> <formats> <format>tar.gz</format> </formats> <filesets> <fileset> <directory>src/main/assembly/bin</directory> <outputdirectory>bin</outputdirectory> <filemode>0755</filemode> </fileset> <fileset> <directory>src/main/assembly/config</directory> <outputdirectory>config</outputdirectory> <filemode>0644</filemode> </fileset> <fileset> <directory>target</directory> <outputdirectory>lib</outputdirectory> <includes> <include>*.jar</include> </includes> </fileset> <fileset> <directory>src/main/resources</directory> <outputdirectory>logs</outputdirectory> <filemode>0755</filemode> <excludes> <exclude>**/*</exclude> </excludes> </fileset> </filesets></assembly> |
3.3 编写服务脚本
现在写linux环境的脚本。
第一个：start.sh启动脚本
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
#!/bin/bashserver_name='spring-vue'# jar名称jar_name='springboot-vue.jar'cd `dirname $0`bin_dir=`pwd`cd ..deploy_dir=`pwd`conf_dir=$deploy_dir/config# server_port=`sed '/server.port/!d;s/.*=//' config/application.properties | tr -d '\r'`# 获取应用的端口号server_port=`sed -nr '/port: [0-9]+/ s/.*port: +([0-9]+).*/\1/p' config/application.yml`pids=`ps -f | grep java | grep "$conf_dir" |awk '{print $2}'`if [ "$1" = "status" ]; then if [ -n "$pids" ]; then echo "the $server_name is running...!" echo "pid: $pids" exit 0 else echo "the $server_name is stopped" exit 0 fifiif [ -n "$pids" ]; then echo "error: the $server_name already started!" echo "pid: $pids" exit 1fiif [ -n "$server_port" ]; then server_port_count=`netstat -tln | grep $server_port | wc -l` if [ $server_port_count -gt 0 ]; then echo "error: the $server_name port $server_port already used!" exit 1 fifilogs_dir=$deploy_dir/logsif [ ! -d $logs_dir ]; then mkdir $logs_dirfistdout_file=$logs_dir/stdout.logjava_opts=" -djava.awt.headless=true -djava.net.preferipv4stack=true "java_debug_opts=""if [ "$1" = "debug" ]; then java_debug_opts=" -xdebug -xnoagent -djava.compiler=none -xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n "fijava_jmx_opts=""if [ "$1" = "jmx" ]; then java_jmx_opts=" -dcom.sun.management.jmxremote.port=1099 -dcom.sun.management.jmxremote.ssl=false -dcom.sun.management.jmxremote.authenticate=false "fijava_mem_opts=""bits=`java -version 2>&1 | grep -i 64-bit`if [ -n "$bits" ]; then java_mem_opts=" -server -xmx512m -xms512m -xmn256m -xx:permsize=128m -xss256k -xx:+disableexplicitgc -xx:+useconcmarksweepgc -xx:+cmsparallelremarkenabled -xx:+usecmscompactatfullcollection -xx:largepagesizeinbytes=128m -xx:+usefastaccessormethods -xx:+usecmsinitiatingoccupancyonly -xx:cmsinitiatingoccupancyfraction=70 "else java_mem_opts=" -server -xms512m -xmx512m -xx:permsize=128m -xx:survivorratio=2 -xx:+useparallelgc "ficonfig_files=" -dlogging.path=$logs_dir -dlogging.config=$conf_dir/log4j2.xml -dspring.config.location=$conf_dir/application.properties "echo -e "starting the $server_name ..."nohup java $java_opts $java_mem_opts $java_debug_opts $java_jmx_opts $config_files -jar $deploy_dir/lib/$jar_name > $stdout_file 2>&1 &count=0while [ $count -lt 1 ]; do echo -e ".\c" sleep 1 if [ -n "$server_port" ]; then count=`netstat -an | grep $server_port | wc -l` else count=`ps -f | grep java | grep "$deploy_dir" | awk '{print $2}' | wc -l` fi if [ $count -gt 0 ]; then break fidoneecho "ok!"pids=`ps -f | grep java | grep "$deploy_dir" | awk '{print $2}'`echo "pid: $pids"echo "stdout: $stdout_file" 脚本用例：# 启动应用./start.sh# 以debug方式启动./start debug# 启动任务并开启jmx监控./start jmx# 获取当前的运行状态./start status停止脚本：stop.sh#!/bin/bashcd `dirname $0`bin_dir=`pwd`cd ..deploy_dir=`pwd`conf_dir=$deploy_dir/configserver_name=$deploy_dirpids=`ps -ef | grep java | grep "$conf_dir" |awk '{print $2}'`if [ -z "$pids" ]; then echo "error: the $server_name does not started!" exit 1fiif [ "$1" != "skip" ]; then $bin_dir/dump.shfiecho -e "stopping the $server_name ...\c"for pid in $pids ; do kill $pid > /dev/null 2>&1donecount=0while [ $count -lt 1 ]; do echo -e ".\c" sleep 1 count=1 for pid in $pids ; do pid_exist=`ps -f -p $pid | grep java` if [ -n "$pid_exist" ]; then count=0 break fi donedoneecho "ok!"echo "pid: $pids" |
windows环境的启动脚本：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
echo offset app_name=springboot-vue.jarset config= -dlogging.path=../logs -dlogging.config=../config/log4j2.xml -dspring.config.location=../config/application.yml set debug_opts=if ""%1"" == ""debug"" ( set debug_opts= -xloggc:../logs/gc.log -verbose:gc -xx:+printgcdetails -xx:+heapdumponoutofmemoryerror -xx:heapdumppath=../logs goto debug)set jmx_opts=if ""%1"" == ""jmx"" ( set jmx_opts= -dcom.sun.management.jmxremote -dcom.sun.management.jmxremote.port=9888 -dcom.sun.management.jmxremote.ssl=false -dcom.sun.management.jmxremote.authenticate=false goto jmx)echo "starting the %app_name%"java -xms512m -xmx512m -server %debug_opts% %jmx_opts% %config% -jar ../lib/%app_name%goto end:debugecho "debug"java -xms512m -xmx512m -server %debug_opts% %config% -jar ../lib/%app_name%goto end:jmxjava -xms512m -xmx512m -server %jmx_opts% %config% -jar ../lib/%app_name%goto end:endpause |
对于不同的springboot项目，只需要适当修改一下脚本就可以了，为了节约篇幅这里就不列出其他的脚本了，可以参考我提交的demo:https://github.com/shalousun/springboot-vue.git
注意：以上脚本参考自dubbo官方。其实对于dubbo项目的轻量化构建也是类似的。
四、打包后应用的日志路径处理
在第二节的图中可以看到打包的应用日志一般统一输出到logs目录中，但是对于不同的系统平台，虽然配置的日志输出路径是一样的，但是最后不一定输出到logs中。经过测试在windows平台中使用相对的日志路径../logs是没有问题的，但是对于linux系统下使用相对路径就不能输出到logs下，因此建议在linux平台下就写绝对路径吧。不过在我提供的脚本中设置输出日志的路径
|
1
|
-dlogging.path=../logs |
因此结合log4j2的强大解析能力完全可以设置log42的日志路径：
|
1
|
<property name="log_home">${sys:logging.path}</property> |
但是对于springboot应用的访问日志在linux下似乎只能使用绝对路径了。
|
1
2
3
4
5
6
7
8
9
|
# server configserver: port: 8080 undertow: accesslog: enabled: true dir: /usr/xxx/logslogging: path: /usr/xxx/logs |
当然后面有使用配置解决的同学可以提醒纠正下。
总结：
这个方案本身并没有带来什么新东西，甚至脚本大多数是参考了dubbo官方的脚本，只是在上面做了些完善。但是重要的一点是怎么去根据实际的技术应用场景，思考使用这项技术需要做的服务化和工程化。
以上所述是小编给大家介绍的springboot基于assembly的服务化打包方案，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对服务器之家网站的支持！
原文链接：https://my.oschina.net/u/1760791/blog/1587996
