项目构建

目录

  • 单模块 maven 项目构建
  • 多模块 maven 项目构建

单模块 maven 项目构建

在单一模块的maven项目开发中，我们通常在 src/main/resources 编写我们的配置文件，因此，在 maven 构建的时候，我们需要添加如下配置：

  1. <resources>
  2.     <resource>
  3.         <directory>src/main/resources</directory>
  4.         <includes>
  5.             <include>**/*.*</include>
  6.         </includes>
  7.         <filtering>false</filtering>
  8.     </resource>
  9. </resources>

把 src/main/resources 目录下的文件拷贝到 classpath 目录去。

同时，在 jboot 开发的应用中，建议把 html、css、js等资源文件存放在 src/main/webapp 目录下。

以上配置完毕之后，我们需要再配置 maven-assembly-plugin 插件，配置内容如下。

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-assembly-plugin</artifactId>
  4.     <version>3.1.0</version>
  5.     <executions>
  6.         <execution>
  7.             <id>make-assembly</id>
  8.             <phase>package</phase>
  9.             <goals>
  10.                 <goal>single</goal>
  11.             </goals>
  12.             <configuration>
  13.                 <recompressZippedFiles>false</recompressZippedFiles>
  14.                 <appendAssemblyId>false</appendAssemblyId>
  15.                 <descriptors>
  16.                     <descriptor>package.xml</descriptor>
  17.                 </descriptors>
  18.                 <outputDirectory>${project.build.directory}/</outputDirectory>
  19.             </configuration>
  20.         </execution>
  21.     </executions>
  22. </plugin>

package.xml

  1. <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
  2.           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.           xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
  5.     <id>release</id>
  7.     <formats>
  8.         <format>dir</format>
  9.         <format>zip</format>
  10.         <!-- <format>tar.gz</format> -->
  11.     </formats>
  13.     <!-- 打 zip 设置为 true 时，会在 zip 包中生成一个根目录，打 dir 时设置为 false 少层目录 -->
  14.     <includeBaseDirectory>false</includeBaseDirectory>
  16.     <fileSets>
  18.         <fileSet>
  19.             <directory>${basedir}/src/main/resources</directory>
  20.             <outputDirectory>config</outputDirectory>
  21.         </fileSet>
  23.         <fileSet>
  24.             <directory>${basedir}/target/classes/webapp</directory>
  25.             <outputDirectory>webapp</outputDirectory>
  26.         </fileSet>
  28.         <!-- 项目根下面的脚本文件 copy 到根目录下 -->
  29.         <fileSet>
  30.             <directory>${basedir}</directory>
  31.             <outputDirectory></outputDirectory>
  32.             <!-- 脚本文件在 linux 下的权限设为 755，无需 chmod 可直接运行 -->
  33.             <fileMode>755</fileMode>
  34.             <includes>
  35.                 <include>*.sh</include>
  36.                 <include>*.bat</include>
  37.             </includes>
  38.         </fileSet>
  39.     </fileSets>
  41.     <!-- 依赖的 jar 包 copy 到 lib 目录下 -->
  42.     <dependencySets>
  43.         <dependencySet>
  44.             <outputDirectory>lib</outputDirectory>
  45.         </dependencySet>
  46.     </dependencySets>
  48. </assembly>

在 项目的根目录下，创建 jboot.sh 文件，内容如下：

#!/bin/bash
# ----------------------------------------------------------------------
# name:         jboot.sh
# version:      1.0
# author:       yangfuhai
# email:        fuhai999@gmail.com
# use : ./jboot.sh {start, stop, restart}
# ----------------------------------------------------------------------

# 启动入口类，该脚本文件用于别的项目时要改这里
MAIN_CLASS=io.jboot.app.JbootApplication
COMMAND="$1"

if [[ "$COMMAND" != "start" ]] && [[ "$COMMAND" != "stop" ]] && [[ "$COMMAND" != "restart" ]]; then
    echo "./jboot.sh {start, stop, restart}"
    exit 0
fi



# Java 命令行参数，根据需要开启下面的配置，改成自己需要的，注意等号前后不能有空格
# JAVA_OPTS="-Xms256m -Xmx1024m -Dundertow.port=80 -Dundertow.host=0.0.0.0"
# JAVA_OPTS="-Dundertow.port=80 -Dundertow.host=0.0.0.0"

# 生成 class path 值
APP_BASE_PATH=$(cd `dirname $0`; pwd)
CP=${APP_BASE_PATH}/config:${APP_BASE_PATH}/lib/*

function start()
{
    # 运行为后台进程，并在控制台输出信息
    java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} &

    # 运行为后台进程，并且不在控制台输出信息
    # nohup java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} >/dev/null 2>&1 &

    # 运行为后台进程，并且将信息输出到 output.log 文件
    # nohup java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} > output.log &

    # 运行为非后台进程，多用于开发阶段，快捷键 ctrl + c 可停止服务
    # java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS}
}

function stop()
{
    kill `pgrep -f ${MAIN_CLASS}` 2>/dev/null

    # 以下代码与上述代码等价
    # kill $(pgrep -f ${MAIN_CLASS}) 2>/dev/null

}

if [[ "$COMMAND" == "start" ]]; then
    start
elif [[ "$COMMAND" == "stop" ]]; then
    stop
else
    stop
    start
fi

以上内容配置完毕之后，支持 maven 命令 mvn clean install ，待命令执行完毕之后，会在 target 目录下生成一个文件名为： 项目-版本 的文件夹。

复制该文件夹到服务器，然后执行里面的 jboot.sh start 命令即可上线。

多模块 maven 项目构建

多模块项目在以上配置的基础上，添加 maven-resources-plugin maven 插件，用于拷贝其他maven模块的资源文件和html等内容到此运行模块。

maven 配置如下：

<plugin>
    <artifactId>maven-resources-plugin</artifactId>
    <executions>
        <execution>
            <id>copy-resources</id>
            <phase>validate</phase>
            <goals>
                <goal>copy-resources</goal>
            </goals>
            <configuration>
                <outputDirectory>${basedir}/target/classes/webapp</outputDirectory>
                <resources>
                    <resource>
                        <directory>${basedir}/../otherModule1/src/main/webapp</directory>
                    </resource>
                    <resource>
                        <directory>${basedir}/../otherModule2/src/main/webapp</directory>
                    </resource>
                    <resource>
                        <directory>${basedir}/../otherModule3/src/main/webapp</directory>
                    </resource>
                </resources>
            </configuration>
        </execution>
    </executions>
</plugin>

这部分可以参考 jpress 项目，网址：https://gitee.com/fuhai/jpress/blob/v2.0/starter/pom.xml