Microsoft Windows/Systemd服务打包Maven插件

简述

这是一个Maven插件项目,主要用于将Maven工程打包成一个可独立运行的Microsoft Windows/Systemd服务.

功能特性

• 复制工程运行所需的第三方依赖库,Java运行时到输出目录,对于Java 11.0.11+支持定制Java运行时.
• 零配置,自动检测入口类,根据Maven工程信息生成Microsoft Windows/Systemd服务信息.
• 支持生成Microsoft Windows/Systemd服务的安装,启动,停止,卸载脚本.
• 支持生成控制台启动脚本.
• 支持Spring Boot项目.
• 支持提取Git中的版本信息.
• 支持输出RPM Package spec文件.

使用

加入插件坐标

    <plugin>
        <groupId>com.hngd.tool</groupId>
        <artifactId>service-maven-plugin</artifactId>
        <version>0.2.2-SNAPSHOT</version>
        <executions>
            <execution>
                <id>service-package</id>
                <goals>
                    <goal>service-package</goal>
                </goals>
                <phase>package</phase>
            </execution>
        </executions>
    </plugin>

执行

# cd ${项目根路径}
mvn clean package #-DskipTests

执行后,你可以在${project.build.directory}/${project.artifactId}目录下看到打包生成的脚本.

详细配置说明

插件配置项说明

• jreDirectory,Jre目录,配置后,插件将会复制此目录到输出目录,如果此项为空,那么插件会将执行插件的Jre复制到输出目录.
• customRuntimeImage,默认为false,如果设置为true,配置项jreDirectory未设置,Java版本大于等于11,那么插件将使用jdeps,jlink自定义Java运行时并输出到输出目录下的jre子目录中.
• targetJreVersion,当程序依赖了多发行版的Jar时,指定处理多发行版 jar 文件时的版本,应大于等于 9.
• compressLevel,指定自定义Java运行时的压缩级别,可取值0,1,2;0: No compression,1: Constant string sharing,2: ZIP.
• scriptConfigFile,指定打包配置文件路径.
• outputDirectory,指定打包输出目录,默认值为${project.build.directory}/${project.artifactId}
• resources,资源目录或者文件,配置后将复制到输出目录.
• serviceType,服务类型,可取值有:Windows,Systemd,在Windows环境下默认为Windows,Linux环境下默认为Systemd;Windows表示打包生成Microsoft Windows服务脚本,Systemd表示打包生成Systemd服务脚本.

备注:以上所有配置项都是可选的

打包配置文件说明

#服务名称,如果为空,插件会取POM文件中的${project.name}或者${project.artifactId}作为此项的值
serviceName=demo-service        
#Microsoft Windows服务显示名称,如果此项为空,,插件会取serviceName作为此项的值,此配置项仅对Microsoft Windows服务有效
serviceDisplayName=demo-service
#服务描述内容,如果为空,插件会取POM文件中的${project.description}或者serviceName作为此项的值
serviceDescription=测试服务
#Java程序启动类,如果为空,那么插件会去寻找一个合适的类作为此项的值
mainClass=com.test.ServiceMain
#Microsoft Windows服务启动时，调用的Java方法,默认值为onStart,此配置项仅对Microsoft Windows服务有效
startMethod=onStart     
#Microsoft Windows服务停止时，调用的Java方法,默认值为onStop,此配置项仅对Microsoft Windows服务有效
stopMethod=onStop
#是否生成服务的安装，启动，停止，卸载脚本,默认为false,
#如果存在合适的入口类(同时存在main,onStart,onStop方法),那么此项值默认为true
supportService=true
#java虚拟机内存配置
jvmMs=512m
jvmMx=1024m
#服务启动方式,可取值为delayed(延迟启动), auto(自动启动) or manual(手动启动),默认为manual,此配置项仅对Microsoft Windows服务有效,Systemd服务默认安装为开机自启动
startup=auto
#配置生成其他主入口类控制台启动脚本,生成文件名称为run.${类名}.bat
additionalMainClass=com.test.Main1,com.test.Main2,com.test.Main3
#更多参数设置将在后续支持

配置文件不是必须的,如果你的项目中存在一个以下形式的类,那么配置文件是可以省略的

public class EntryClass{
    public static void main(String[] args){
        //TODO,这个方法是必须的,
    }
    public static void onStart(String[] args){
        //TODO,这个方法是可选的,如果要生成Microsoft Windows服务相关操作脚本,那么这个方法是必须的
    }
    public static void onStop(String[] args){
        //TODO,这个方法是可选的,如果要生成Microsoft Windows服务相关操作脚本,那么这个方法是必须的
    }
}

输出目录结构说明

Microsoft Windows服务

├── build-info.properties                  #编译版本信息,只有Git版本库才会生成
├── install.bat                            #Microsoft Windows服务安装脚本
├── jre                                    #Java运行时
├── libs                                   #依赖的第三方库
├── logs                                   #日志文件目录
├── service-demo-0.0.1-SNAPSHOT.jar      #主jar文件
├── prunsrv.exe                            #Apache Commons Daemon可执行文件
├── run.bat                                #控制台启动脚本
├── start.bat                              #Microsoft Windows服务启动脚本
├── stop.bat                               #Microsoft Windows服务停止脚本
└── uninstall.bat                          #Microsoft Windows服务卸载脚本

Systemd服务

├── build-info.properties                     #编译版本信息,只有Git版本库才会生成
├── env.sh                                    #服务相关变量配置脚本
├── service-demo-0.0.1-SNAPSHOT.jar          #主jar文件
├── jre                                       #Java运行时
├── libs                                      #依赖的第三方库
├── run-foreground.sh                         #控制台启动脚本
├── sample.service                            #Systemd Service Unit模板文件
└── svc.sh                                    #Systemd服务操作脚本

编译环境

1. OpenJDK 1.8.
2. Apache Maven 3.3.3及以上.

安装

mvn clean package install -DskipTests

注意事项

1. 在Windows环境下无法定制Linux JRE运行时,同理,在Linux环境下无法定制Windows JRE运行时.

参考

1. Maven Plugin Development
2. commons-daemon
3. jlink
4. jdeps
5. Microsoft Windows服务
6. Systemd
7. shc