强烈建议:强烈建议下载首页的 jfinal_demo_for_maven.zip,从中可以获取到本章所涉及的 pom.xml、package.xml、jfinal.sh 等配置文件与脚本文件。可以节省大量的学习成本。

2、添加 maven-jar-plugin 插件

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

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

3、添加 maven-assembly-plugin 插件

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

maven-assembly-plugin 是 maven 官方提供的打包插件,功能十分完善,可以配置很多参数进行定制化构建,更详细的文件参考其官方文档:

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

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

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

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

注意:以下脚本文件在 jfinal 官网首页右侧下载的 jfinal demo for maven 项目中已经提供,复制其中的 jfinal.sh / jfinal.bat 到自己的项目中修改 MAIN_CLASS 变量值,即可投入使用。

Linux 下的启动脚本 jfinal.sh 内容如下:

注意要首先根据项目入口类,修改一下上面内容中的 MAIN_CLASS 变量值,Windows 下的 jfinal.bat 脚本也同样如此

启动项目命令:./jfinal.sh start

关闭项目命令:./jfinal.sh stop

特别注意:使用以上命令行时,先要使用 mvn clean package 将项目打包,然后使用 cd 命令跳转到打好的包的目录下面执行命令。而不是 cd 跳转到项目根目录下面去执行命令,很多人犯这种错误。打包方法见紧接着的下一小节《6、打包》

限于篇幅在此不再贴出 windows 脚本内容,可下载官网首页右侧的 jfinal demo 获取。最新版本的脚本在此可以下载到:https://gitee.com/jfinal/jfinal-undertow

windows 脚本的使用方法如下:

启动项目命令:jfinal.bat start

关闭项目命令:jfinal.bat stop

重启项目命令:jfinal.bat restart

注意:linux、mac 下的脚本文件换行字符必须是 ‘\n’,而 windows 下必须是 “\r\n”,否则脚本无法执行,并会输出无法理解的错误信息,难以排错。如何查看脚本文件中的换行字符见文档:

强烈建议:强烈建议下载首页的 jfinal_demo_for_maven.zip,从中可以获取到以上 5 小节所涉及的 pom.xml、package.xml、jfinal.sh 等配置文件与脚本文件。确保下载到最新版本。

6、打包

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

    执行上述打包命令以后,在项目根下面的 target 目录下面会出现打好的 xxx.zip,解压该 zip 文件使用命令行 ./jfinal.sh start 即可运行

    除了 zip 文件还会在 target 下面生成一个目录,在该目录下面使用命令行 ./jfinal.sh start 可启动项目,该目录下面的内容与 zip 文件中的内容是完全一样的。

    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:开发、打包、部署一体化,整个过程无需对项目中的任何地方进行调整或修改,真正实现从极速开发到极速部署