1.3 jfinal-undertow 下部署

1、指定打包为类型为 jar

修改 pom.xml 文件，其中的 packaging 标签值要改成 jar

  1. <packaging>jar</packaging>

2、添加 maven-jar-plugin 插件

  1. <!--
  2.     jar 包中的配置文件优先级高于 config 目录下的 "同名文件"
  3.     因此，打包时需要排除掉 jar 包中来自 src/main/resources 目录的
  4.     配置文件，否则部署时 config 目录中的同名配置文件不会生效
  5.  -->
  6. <plugin>
  7.     <groupId>org.apache.maven.plugins</groupId>
  8.     <artifactId>maven-jar-plugin</artifactId>
  9.     <version>2.6</version>
  10.     <configuration>
  11.         <excludes>
  12.             <exclude>*.txt</exclude>
  13.             <exclude>*.xml</exclude>
  14.             <exclude>*.properties</exclude>
  15.         </excludes>
  16.     </configuration>
  17. </plugin>

maven-jar-plugin 仅为了避免将配置文件打入 jar 包，如果是打成 fatjar 包则不需要添加此插件

3、添加 maven-assembly-plugin 插件

修改 pom.xml ，在其中的 plugins 标签下面添加如下 maven-assembly-plugin 插件

  1. <!-- 
  2.     使用 mvn clean package 打包 
  3.     更多配置可参考官司方文档：http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html
  4. -->
  5. <plugin>
  6.   <groupId>org.apache.maven.plugins</groupId>
  7.   <artifactId>maven-assembly-plugin</artifactId>
  8.   <version>3.1.0</version>
  9.   <executions>
  10.     <execution>
  11.     <id>make-assembly</id>
  12.     <phase>package</phase>
  13.     <goals>
  14.       <goal>single</goal>
  15.     </goals>
  16.  
  17.     <configuration>
  18.       <!-- 打包生成的文件名 -->
  19.       <finalName>${project.artifactId}</finalName>
  20.       <!-- jar 等压缩文件在被打包进入 zip、tar.gz 时是否压缩，设置为 false 可加快打包速度 -->
  21.       <recompressZippedFiles>false</recompressZippedFiles>
  22.       <!-- 打包生成的文件是否要追加 release.xml 中定义的 id 值 -->
  23.       <appendAssemblyId>true</appendAssemblyId>
  24.       <!-- 指向打包描述文件 package.xml -->
  25.       <descriptors>
  26.         <descriptor>package.xml</descriptor>
  27.       </descriptors>
  28.       <!-- 打包结果输出的基础目录 -->
  29.       <outputDirectory>${project.build.directory}/</outputDirectory>
  30.       </configuration>
  31.       </execution>
  32.     </executions>
  33. </plugin>

maven-assembly-plugin 是 maven 官方提供的打包插件，功能十分完善，可以配置很多参数进行定制化构建，更详细的文件参考其官方文档：http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html

4、添加 package.xml 文件

在项目根目录下面添加 package.xml，该文件是在上述 maven-assembly-plugin 在 descriptor 标签中指定的打包描述文件，内容如下：

  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">
  4.  
  5.   <!-- 
  6.     assembly 打包配置更多配置可参考官司方文档：
  7.     http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
  8.   -->
  9.  
  10.   <id>release</id>
  11.  
  12.   <!--
  13.       设置打包格式，可同时设置多种格式，常用格式有：dir、zip、tar、tar.gz
  14.       dir 格式便于在本地测试打包结果
  15.       zip 格式便于 windows 系统下解压运行
  16.       tar、tar.gz 格式便于 linux 系统下解压运行
  17.   -->
  18.   <formats>
  19.     <format>dir</format>
  20.     <format>zip</format>
  21.     <!-- <format>tar.gz</format> -->
  22.   </formats>
  23.  
  24.   <!-- 打 zip 设置为 true 时，会在 zip 包中生成一个根目录，打 dir 时设置为 false 少层目录 -->
  25.   <includeBaseDirectory>true</includeBaseDirectory>
  26.  
  27.   <fileSets>
  28.     <!-- src/main/resources 全部 copy 到 config 目录下 -->
  29.     <fileSet>
  30.       <directory>${basedir}/src/main/resources</directory>
  31.       <outputDirectory>config</outputDirectory>
  32.     </fileSet>
  33.  
  34.     <!-- src/main/webapp 全部 copy 到 webapp 目录下 -->
  35.     <fileSet>
  36.       <directory>${basedir}/src/main/webapp</directory>
  37.       <outputDirectory>webapp</outputDirectory>
  38.     </fileSet>
  39.  
  40.     <!-- 项目根下面的脚本文件 copy 到根目录下 -->
  41.     <fileSet>
  42.       <directory>${basedir}</directory>
  43.       <outputDirectory></outputDirectory>
  44.       <!-- 脚本文件在 linux 下的权限设为 755，无需 chmod 可直接运行 -->
  45.       <fileMode>755</fileMode>
  46.       <includes>
  47.         <include>*.sh</include>
  48.         <include>*.bat</include>
  49.       </includes>
  50.     </fileSet>
  51.   </fileSets>    
  52.  
  53.   <!-- 依赖的 jar 包 copy 到 lib 目录下 -->
  54.   <dependencySets>
  55.     <dependencySet>
  56.       <outputDirectory>lib</outputDirectory>            
  57.     </dependencySet>
  58.   </dependencySets>
  59.  
  60. </assembly>

打包描述文件是 maven-assembly-plugin 的一部分，描述文件可以非常方便地控制打包的各种细节动作，更详细的文档参考：http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

5、在项目根目录下面添加启动脚本

注意：以下三个脚本文件在 jfinal 官网首页右侧下载的 jfinal demo 项目中已经提供，建议下载后 copy 到自己的项目中使用

windows 下面的启动脚本 start.bat 内容如下：

  1. @echo off
  2. rem ———————————————————————————————-
    rem
    rem 使用说明：
    rem
    rem 1: 该脚本用于别的项目时只需要修改 MAIN_CLASS 即可运行
    rem
    rem 2: JAVA_OPTS 可通过 -D 传入 undertow.port 与 undertow.host 这类参数覆盖
    rem    配置文件中的相同值此外还有 undertow.resourcePath, undertow.ioThreads
    rem    undertow.workerThreads 共五个参数可通过 -D 进行传入
    rem
    rem 3: JAVA_OPTS 可传入标准的 java 命令行参数,例如 -Xms256m -Xmx1024m 这类常用参数
    rem
    rem
    rem ———————————————————————————————-
  3. setlocal & pushd
  4. rem 启动入口类,该脚本文件用于别的项目时要改这里
    set MAIN_CLASS=com.jfinal.club.common.JFinalClubConfig
  5. rem Java 命令行参数,根据需要开启下面的配置,改成自己需要的,注意等号前后不能有空格
    rem set "JAVA_OPTS=-Xms256m -Xmx1024m -Dundertow.port=80 -Dundertow.host=0.0.0.0"
    rem set "JAVA_OPTS=-Dundertow.port=80 -Dundertow.host=0.0.0.0"
  6. set APP_BASE_PATH=%~dp0
    set CP=%APP_BASE_PATH%config;%APP_BASE_PATH%lib*
    java -Xverify:none %JAVA_OPTS% -cp %CP% %MAIN_CLASS%
  7. endlocal & popd
    pause

如果项目的入口 main 方法有变动，修改一下上面内容中的 MAIN_CLASS 变量值即可，以下的 Linux 脚本也同样如此

Linux 下的启动脚本 start.sh 内容如下：

  1. #!/bin/bash
  2.  
  3. # -----------------------------------------------------------------
  4. #
  5. # 使用说明：
  6. #
  7. # 1: 该脚本用于别的项目时只需要修改 MAIN_CLASS 即可运行
  8. #
  9. # 2: JAVA_OPTS 可通过 -D 传入 undertow.port 与 undertow.host 这类参数覆盖
  10. #    配置文件中的相同值此外还有 undertow.resourcePath、undertow.ioThreads、
  11. #    undertow.workerThreads 共五个参数可通过 -D 进行传入，该功能尽可能减少了
  12. #    修改 undertow 配置文件的必要性
  13. #
  14. # 3: JAVA_OPTS 可传入标准的 java 命令行参数，例如 -Xms256m -Xmx1024m 这类常用参数
  15. #
  16. # 4: 脚本最后一部分给出了 4 种启动项目的命令行，根据注释中的提示自行选择合适的方式
  17. #
  18. # -----------------------------------------------------------------
  19.  
  20. # 启动入口类，该脚本文件用于别的项目时要改这里
  21. MAIN_CLASS=com.jfinal.club.common.JFinalClubConfig
  22.  
  23. # Java 命令行参数，根据需要开启下面的配置，改成自己需要的，注意等号前后不能有空格
  24. # JAVA_OPTS="-Xms256m -Xmx1024m -Dundertow.port=80 -Dundertow.host=0.0.0.0"
  25. # JAVA_OPTS="-Dundertow.port=80 -Dundertow.host=0.0.0.0"
  26.  
  27. # 生成 class path 值
  28. APP_BASE_PATH=$(cd `dirname $0`; pwd)
  29. CP=${APP_BASE_PATH}/config:${APP_BASE_PATH}/lib/*
  30.  
  31. # 运行为后台进程，并在控制台输出信息
  32. java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} &
  33.  
  34. # 运行为后台进程，并且不在控制台输出信息
  35. # nohup java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} >/dev/null 2>&1 &
  36.  
  37. # 运行为后台进程，并且将信息输出到 output.log 文件
  38. # nohup java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS} > output.log &
  39.  
  40. # 运行为非后台进程，多用于开发阶段，快捷键 ctrl + c 可停止服务
  41. # java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS}

Linux 下的服务停止脚本 stop.sh 内容如下：

  1. #!/bin/bash
  2.  
  3. # -----------------------------------------------------------------
  4. #
  5. # 使用说明：
  6. #
  7. # 1: MAIN_CLASS 必须要与配对的 start.sh 文件中的 MAIN_CLASS 完全相同
  8. #
  9. # 2: 该脚本用于别的项目时只需要修改 MAIN_CLASS 即可使用
  10. #
  11. # 3: 注意：如果有其它项目的 MAIN_CLASS 与本项目一样则不能使用本脚本关闭服务
  12. #         同理同一个项目使用了不同端口启动的，也会拥有相同的 MAIN_CLASS 值
  13. #         也不能使用本脚本关闭服务，这种情况使用下面的命令先查 pid 值：
  14. #            ps aux | grep java
  15. #
  16. #         确认好 pid 以后，使用 kill pid 关闭服务
  17. #         
  18. #         注意 kill 命令不要带 -9 这个参数，否则 jfinal 中的一些与服务关闭
  19. #         有关的回调方法将不会被回调，例如 JFinalConfig.onStop()
  20. #
  21. # 4: 如果不需要上述的 onStop() 回调，使用 kill -9 可加快关闭服务的速度
  22. #
  23. # -----------------------------------------------------------------
  24.  
  25. # 启动入口类，该脚本文件用于别的项目时要改这里
  26. MAIN_CLASS=com.jfinal.club.common.JFinalClubConfig
  27.  
  28. # kill 命令不使用 -9 参数时，会回调 onStop() 方法，确定不需要此回调建议使用 -9 参数
  29. kill `pgrep -f ${MAIN_CLASS}` 2>/dev/null
  30.  
  31. # 以下代码与上述代码等价
  32. # kill $(pgrep -f ${MAIN_CLASS}) 2>/dev/null

如上述过程出现任何问题，请下载官网首页的 jfinal demo，里面有所有配置与脚本，可直接拿来使用

特别注意：linux、mac 下的脚本文件换行字符必须是 '\n'，而 windows 下必须是 "\r\n"，否则脚本无法执行，并会输出无法理解的错误信息，难以排错。如何查看脚本文件中的换行字符见文档：https://www.jfinal.com/doc/1-5

6、打包

打开命令行终端，cd 命令进入项目根目录，运行以下命令即可打包

  1. mvn clean package

执行上述打包命令以后，在项目根下面的 target 目录下面会出现打好的 xxx.zip，解压该 zip 文件运行里面的 start 脚本即可

除了 zip 文件还会在 target 下面生成一个目录，运行该目录下面的 start 也可以运行项目，该目录下面的内容与 zip 文件中的内容是完全一样的。

7、部署

将上述打包命令生成的 zip 文件上传到服务器并解压即完成了部署工作，基于 jfinal-undertow 开发项目的最大优势就是不需要下载、安装、配置 tomcat 这类 server

8、fatjar 打包部署

fatjar 打包是指将项目中所有 class、所有资源以及所有 jar 包依赖全部打包到一个单独的 jar 包之中，打包好的独立 jar 包可以很方便复制、部署、运行，非常适合于做微服务项目开发，也很适合没有 web 资源或者 web 资源很少的项目

具体的用法可以在官网首页下载 jfinal-demo-for-maven，其中的 doc 目录下面有文档详细介绍了此方法，后续会在文档频道添加 fatjar 打包方法

9、jfinal-undertow 的主要优势

1：极速启动，启动速度比 tomcat 快 5 到 8 倍。jfinal.com 官网启动时间在 1.5 秒内

2：Undertow 是红帽公司的开源产品，是 Wildfly 默认的 Web 服务器，Java Web 服务器市场占有率高于 Jetty，仅次于 Tomcat

3：极简精妙的热部署设计，实现极速轻量级热部署，让开发体验再次提升一个档次

4：性能高于 tomcat、jetty，可替代 tomcat、jetty 用于生产环境

5：undertow 为嵌入式而生，可直接用于生产环境部署，部署时无需下载服务，无需配置服务，十分适合微服务开发、部署

6：告别 web.xml、告别 tomcat、告别 jetty，节省大量打包与部署时间。令开发、打包、部署成为一件开心的事

7：功能丰富，支持 classHotSwap、WebSocket、gzip 压缩、servlet、filter、sessionHotSwap 等功能

8：支持 fatjar 与 非 fatjar 打包模式，便于支持微服务

9：开发、打包、部署一体化，整个过程无需对项目中的任何地方进行调整或修改，真正实现从极速开发到极速部署

< 1.2 jfinal-undertow 下开发

1.4 jfinal-undertow 高级用法 >