launcher通用启动器

launcher是一个Java应用通用启动器，它不仅规范了应用的打包结构并且提供了众多可选的启动参数。

用户可以通过Maven插件的方式引入launcher，通过一些简单的配置即可将Java通过launcher启动起来。

快速接入

launcher的新用户如果想要快速接入项目，可以参考本工程launcher-sample模块下的pom.xml文件。

移除当前打包工具

在项目pom.xml中删除已有的打包工具配置，例如：maven-assembly-plugin、spring-boot-maven-plugin

添加launcher打包插件

添加launcher-maven-plugin到pom.xml中

<plugin>
    <groupId>org.gy.framework</groupId>
    <artifactId>launcher-maven-plugin</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <executions>
        <execution>
            <goals>
                <goal>launcher</goal>
            </goals>
            <configuration>
                <apps>
                    <app>
                        <!-- 应用名 -->
                        <name>${APP_NAME}</name>
                        <!-- 启动类 -->
                        <mainClass>${MAIN_CLASS}</mainClass>
                    </app>
                </apps>
            </configuration>
        </execution>
    </executions>
</plugin>

替换配置文件中的${APP_NAME}为服务名称，例如：launcher-sample

替换配置文件中的${MAIN_CLASS}启动类名称，例如：org.gy.framework.launcher.sample.Main

开始构建

接入完成后，使用mvn package构建工程

package执行完毕后，会自动在模块中的target目录下生成${PROJECT_MODULE_NAME}-${VERSION}.tar.gz文件

启动工程

解压缩${PROJECT_MODULE_NAME}-${VERSION}.tar.gz文件

启动器主文件为 ./bin/launcher.sh

使用 ./launcher.sh start -n ${APP_NAME} 启动

使用 ./launcher.sh stop -n ${APP_NAME} 停止

使用 ./launcher.sh restart -n ${APP_NAME} 重启

想要查看更多选项请使用 launcher.sh -h 以及 launcher.sh [start/stop/restart/status] -h

Change Log

更新说明

更多

启动器使用说明

Maven插件配置

日志配置指南

Dockerfile扩展支持

测试用例