maven assembly打包生成Java应用启动脚本bat和sh

男娘i 2024-03-31 08:03 40阅读 0赞

## 1. maven插件介绍 ##

springboot应用通过maven插件appassembler-maven-plugi生成启动脚本bat和sh。根据官网介绍，这个插件主要用于生成启动 java应用程序的脚本，能将项目依赖jar能够打包目录中，并且它们加入启动脚本类路径中。

主要命令  
appassembler:assemble 打包项目并且配置bin 启动脚本，可以理解为使用类似spring-boot-maven-plugin打包出来项目，可以通过java -jar 方式启动项目，但是不支持stop、satus、restart这些操作，比较原始。  
appassembler:create-repository 创建一个 appassembler 存储库，就是将工程打成jar  
appassembler:generate-daemons 生成基于 JSW 的守护进程包装器,大多数人都是使用这个。

参考文档  
[appassembler-maven-plugin 插件为 SpringBoot 项目生成启动脚本][appassembler-maven-plugin _ SpringBoot]  
[https://www.jb51.net/article/191442.htm][https_www.jb51.net_article_191442.htm]

## 2. 生成启动脚本 ##

### 2.1 创建springboot应用 ###

### 2.2 创建启动测试类 ###

MavenAssemblyDemoApplication

package com.zrj.maven.assembly.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * MavenAssemblyDemoApplication
     *
     * @author zrj
     * @since 20221117
     */
    @RestController
    @SpringBootApplication
    public class MavenAssemblyDemoApplication {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(MavenAssemblyDemoApplication.class, args);
        }
    
        /**
         * Hello World!
         * If you open a web browser to localhost:8080, you should see the following output:
         *
         * @see 1 https://docs.spring.io/spring-boot/docs/2.7.5/reference/htmlsingle/
         */
        @RequestMapping("/")
        String home() {
        
            long currentTime = System.currentTimeMillis();
            String helloTime = currentTime + "：Hello World!";
            System.out.println(helloTime);
            return helloTime;
        }
    }

### 2.3 maven依赖配置 ###

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.7.5</version>
            <relativePath/> 
        </parent>
    
        <groupId>com.zrj</groupId>
        <artifactId>maven-assembly-demo</artifactId>
        <version>1.0.0-SNAPSHOT</version>
        <name>maven-assembly-demo</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        
        <build>
            <plugins>
                <plugin>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>appassembler-maven-plugin</artifactId>
                    <version>2.1.0</version>
    
                    
                    
                    <executions>
                        <execution>
                            <id>make-assembly</id>
                            <phase>package</phase>
                            <goals>
                                <goal>assemble</goal>
                            </goals>
                        </execution>
                    </executions>
    
                    <configuration>
                        
                        <repositoryLayout>flat</repositoryLayout>
                        
                        <configurationSourceDirectory>src/main/resources</configurationSourceDirectory>
                        <includeConfigurationDirectoryInClasspath>true</includeConfigurationDirectoryInClasspath>
                        
                        <copyConfigurationDirectory>true</copyConfigurationDirectory>
                        
                        <assembleDirectory>${project.build.directory}/client</assembleDirectory>
                        
                        <configurationDirectory>conf</configurationDirectory>
                        
                        <repositoryName>lib</repositoryName>
                        
                        <binFolder>bin</binFolder>
    
                        
                        <platforms>
                            <platform>windows</platform>
                            <platform>unix</platform>
                        </platforms>
    
                        
                        <binFileExtensions>
                            <unix>.sh</unix>
                            <windows>.bat</windows>
                        </binFileExtensions>
    
                        
                        <encoding>UTF-8</encoding>
                        <logsDirectory>logs</logsDirectory>
                        <tempDirectory>tmp</tempDirectory>
    
                        
                        <extraJvmArguments>-Xms128m</extraJvmArguments>
    
                        <programs>
                            <program>
                                
                                <mainClass>com.zrj.maven.assembly.demo.MavenAssemblyDemoApplication</mainClass>
                                
                                <name>start</name>
                            </program>
                        </programs>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    
    </project>

## 3. 测试验证 ##

### 3.1 执行命令 ###

执行命令或者使用idea  
执行命令：maven install  
idea：maven-lifecycle依次执行clean，install

### 3.2 生成脚本 ###

![在这里插入图片描述][4b8cd779befe486da9dd66b244a424df.png]

### 3.3 启动脚本验证 ###

./start.bat 或者./start.sh

浏览器访问：[http://localhost:8080/][http_localhost_8080]  
刷新页面：1668682483758：Hello World!

[appassembler-maven-plugin _ SpringBoot]: https://www.kancloud.cn/king_om/java_houduan_kuangjia_01/3044135
[https_www.jb51.net_article_191442.htm]: https://www.jb51.net/article/191442.htm
[4b8cd779befe486da9dd66b244a424df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/7447235dde16481691fb55b402da1836.png
[http_localhost_8080]: http://localhost:8080/