Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 胖包与瘦包的打包与部署
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • /zh/06_web/19.html
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • WebJars
    • JProtobuf
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板
    • 数据源配置与使用
    • ActiveRecord
    • Model
    • 生成器与 Model
    • Db 工具类
    • 批量操作
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • Java-DB 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • tio-core
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • ssl
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils 使用文档
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 整合 magic-script
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-linux

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • 简介
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • 成本核算
    • /zh/66_manim/33.html
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

胖包与瘦包的打包与部署

  • 简介
    • 胖包与瘦包概述
    • 瘦包的优势
    • 部署时间
  • 创建工程
    • 项目结构与依赖
    • 启动类与控制器
  • 打包
    • 配置 Maven
    • 执行打包命令
    • 启动应用
  • 部署
    • 使用 deploy 工具 部署到 Docker
    • 部署到 systemctl
    • 使用 Shell 脚本管理应用
  • 工具源码
  • 结语

在现代软件开发中,高效的打包与部署是确保应用程序稳定运行和快速迭代的关键。尤其是在使用 Java 开发的项目中,选择合适的打包方式不仅影响应用程序的体积和启动速度,还直接关系到部署的便捷性和灵活性。本文将深入探讨 胖包(Fat Package)与 瘦包(Thin Package)的概念、优势,并详细介绍如何使用 deploy 工具将 tio-boot 工程进行打包与部署。


简介

胖包与瘦包概述

在 Java 项目的打包过程中,胖包(Fat Package)和 瘦包(Thin Package)是两种常见的打包方式:

  • 胖包:包含所有的依赖 JAR 包,包括第三方库和自身代码。这种方式生成的可执行文件较大,但独立性强,适合在不同环境下快速部署,无需额外配置依赖环境。
  • 瘦包:仅包含自身代码和资源,不包含第三方库。依赖项需在目标环境中预先安装或单独管理。这种方式的优势在于打包文件体积较小,传输和部署更为快速,但对部署环境的依赖性更高。

瘦包的优势

  • 体积小:瘦包只包含应用程序自身的代码和资源,显著减少包体积,节省存储空间。
  • 部署快:由于体积更小,瘦包可以更快速地传输和部署,特别适用于网络传输或持续交付(CI/CD)场景。

部署时间

  • 胖包:50M 90 秒(大部分是消耗在了网络传输上)
  • 瘦包:152Kb 10 秒

创建工程

本文以 tio-boot 工程为例,展示如何创建一个包含底层依赖和代码的 Java 项目。

项目结构与依赖

首先,配置 pom.xml 文件,定义项目的依赖和构建属性:

<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
         http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.litongjava.full</groupId>
    <artifactId>thin</artifactId>
    <version>1.0.0</version>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
        <maven.compiler.source>${java.version}</maven.compiler.source>
        <maven.compiler.target>${java.version}</maven.compiler.target>
        <lombok-version>1.18.30</lombok-version>
        <tio-boot.version>1.9.5</tio-boot.version>
        <jfinal-aop.version>1.2.6</jfinal-aop.version>
        <fastjson2.version>2.0.52</fastjson2.version>
        <hotswap-classloader.version>1.2.4</hotswap-classloader.version>
        <final.name>web-hello</final.name>
        <main.class>com.litongjava.full.thin.HelloApp</main.class>
        <assembly>full</assembly>
    </properties>
    <dependencies>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>
        <dependency>
            <groupId>com.litongjava</groupId>
            <artifactId>tio-boot</artifactId>
            <version>${tio-boot.version}</version>
        </dependency>
        <dependency>
            <groupId>com.litongjava</groupId>
            <artifactId>hotswap-classloader</artifactId>
            <version>${hotswap-classloader.version}</version>
        </dependency>
        <dependency>
            <groupId>com.litongjava</groupId>
            <artifactId>jfinal-aop</artifactId>
            <version>${jfinal-aop.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba.fastjson2</groupId>
            <artifactId>fastjson2</artifactId>
            <version>${fastjson2.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok-version}</version>
            <optional>true</optional>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

启动类与控制器

创建项目的启动类 HelloApp:

package com.litongjava.full.thin;

import com.litongjava.jfinal.aop.annotation.AComponentScan;
import com.litongjava.tio.boot.TioApplication;

@AComponentScan
public class HelloApp {
    public static void main(String[] args) {
        long start = System.currentTimeMillis();
        TioApplication.run(HelloApp.class, args);
        long end = System.currentTimeMillis();
        System.out.println((end - start) + "ms");
    }
}

创建一个简单的控制器 IndexController:

package com.litongjava.full.thin.controller;

import com.litongjava.annotation.RequestPath;

@RequestPath("/")
public class IndexController {
    @RequestPath()
    public String index() {
        return "index";
    }
}

以上代码完成了一个简单的 tio-boot 工程的创建,包含必要的依赖和基础代码。

打包

配置 Maven

为了灵活地管理不同环境下的打包需求,我们在 pom.xml 中配置了多个 profiles,分别适用于开发和生产环境。并使用 maven-assembly-plugin 插件来实现胖包与瘦包的打包。

pom.xml 配置

在 pom.xml 中定义不同的 profiles,如下所示:

<profiles>
    <!-- 开发环境配置 -->
    <profile>
        <id>development</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <build>
            <plugins>
                <!-- Spring Boot Maven 插件 -->
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.7.4</version>
                    <configuration>
                        <fork>true</fork>
                        <mainClass>${main.class}</mainClass>
                        <excludeGroupIds>org.projectlombok</excludeGroupIds>
                        <arguments>
                            <argument>--mode=dev</argument>
                        </arguments>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </profile>

    <!-- 生产环境配置 -->
    <profile>
        <id>production</id>
        <build>
            <plugins>
                <!-- Spring Boot Maven 插件 -->
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.7.4</version>
                    <configuration>
                        <mainClass>${main.class}</mainClass>
                        <excludeGroupIds>org.projectlombok</excludeGroupIds>
                    </configuration>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>

    <!-- Assembly 配置 -->
    <profile>
        <id>assembly</id>
        <build>
            <plugins>
                <!-- Maven Assembly 插件 -->
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-assembly-plugin</artifactId>
                    <version>3.3.0</version>
                    <configuration>
                        <!-- 不在发布文件名中追加 assembly id -->
                        <appendAssemblyId>false</appendAssemblyId>
                        <descriptors>
                            <descriptor>assembly-${assembly}.xml</descriptor>
                        </descriptors>
                    </configuration>
                    <executions>
                        <execution>
                            <id>make-assembly</id>
                            <phase>package</phase>
                            <goals>
                                <goal>single</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
            <!-- 资源配置 -->
            <resources>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.*</include>
                    </includes>
                </resource>
            </resources>
        </build>
    </profile>
</profiles>

说明:

  • 开发环境 (development):使用 spring-boot-maven-plugin 插件进行打包和运行,支持快速迭代和调试。默认激活。
  • 生产环境 (production):同样使用 spring-boot-maven-plugin,但配置略有不同,适用于生成生产环境所需的包。
  • Assembly 配置 (assembly):使用 maven-assembly-plugin 插件,根据不同的 assembly 描述文件(assembly-full.xml 或 assembly-thin.xml)生成胖包或瘦包。

assembly-full.xml 配置

assembly-full.xml 用于定义胖包的打包规则。将所有依赖的 JAR 包和必要的脚本文件打包到最终的 ZIP 文件中。

文件路径:项目根目录下创建 assembly-full.xml

<assembly
    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0
                        http://maven.apache.org/xsd/assembly-1.1.0.xsd">
    <id>zipPackage</id>
    <formats>
        <format>zip</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <fileSets>
        <!-- 所有的 JAR 包 -->
        <fileSet>
            <directory>${project.build.directory}/lib</directory>
            <outputDirectory>lib</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>

        <!-- Linux 启动脚本 -->
        <fileSet>
            <directory>${basedir}/src/main/bin</directory>
            <lineEnding>unix</lineEnding>
            <outputDirectory></outputDirectory>
            <!-- 脚本文件在 Linux 下的权限设为 755,无需 chmod 可直接运行 -->
            <fileMode>755</fileMode>
            <includes>
                <include>*.sh</include>
            </includes>
        </fileSet>

        <!-- 复制 Service 文件 -->
        <fileSet>
            <directory>${basedir}/src/main/bin</directory>
            <lineEnding>unix</lineEnding>
            <outputDirectory>service</outputDirectory>
            <includes>
                <include>*.service</include>
            </includes>
        </fileSet>

        <!-- Windows 启动脚本 -->
        <fileSet>
            <directory>${basedir}/src/main/bin</directory>
            <lineEnding>windows</lineEnding>
            <outputDirectory></outputDirectory>
            <includes>
                <include>*.bat</include>
            </includes>
        </fileSet>
    </fileSets>
    <!-- 依赖的 JAR 包复制到 lib 目录下 -->
    <dependencySets>
        <dependencySet>
            <outputDirectory>lib</outputDirectory>
        </dependencySet>
    </dependencySets>
</assembly>

主要内容:

  • 格式 (formats):定义最终生成的包的格式为 ZIP。
  • 文件集合 (fileSets):指定需要打包的文件及其在目标路径中的存放位置。
    • lib 目录下的所有 JAR 包。
    • src/main/bin 目录下的 Linux 和 Windows 启动脚本及 Service 文件。
  • 依赖集合 (dependencySets):将项目的所有依赖包复制到 lib 目录下,确保运行时所需的所有依赖均已包含在包内。

assembly-thin.xml 配置

assembly-thin.xml 用于定义瘦包的打包规则。仅包含应用程序自身的代码和资源,不包含第三方依赖。

文件路径:项目根目录下创建 assembly-thin.xml

<assembly
    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0
                        http://maven.apache.org/xsd/assembly-1.1.0.xsd">
    <id>zipPackage</id>
    <formats>
        <format>zip</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <fileSets>
        <!-- 仅包含应用程序自身的 JAR 包 -->
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory>lib</outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
        </fileSet>
    </fileSets>
</assembly>

主要内容:

  • 文件集合 (fileSets):仅包含项目构建输出目录下的 JAR 包,排除第三方依赖。

执行打包命令

根据不同的打包需求,执行以下命令:

  • 全量包(胖包):

    set JAVA_HOME=D:\java\jdk1.8.0_121
    mvn clean package -DskipTests -Passembly -Dassembly=full
    

    该命令使用 assembly-full.xml 配置文件,生成包含所有依赖的胖包。

  • 瘦包:

    set JAVA_HOME=D:\java\jdk1.8.0_121
    mvn clean package -DskipTests -Passembly -Dassembly=thin
    

    该命令使用 assembly-thin.xml 配置文件,生成仅包含自身代码的瘦包。

启动应用

根据不同操作系统,使用相应的命令启动应用程序:

  • Windows 启动:

    java -Xverify:none -cp config;lib\*;static ${MAIN_CLASS}
    

    示例:

    java -Xverify:none -cp config;lib\*;static com.litongjava.full.thin.HelloApp
    
  • Linux 启动:

    java -Xverify:none -cp ./config:./lib/*:./static ${MAIN_CLASS}
    

    示例:

    java -Xverify:none -cp ./config:./lib/*:./static com.litongjava.full.thin.HelloApp
    
  • 指定启动参数:

    可以通过在命令行中添加参数,指定应用程序的运行配置:

    java -Xverify:none -cp ./config:./lib/*:./static com.litongjava.full.thin.HelloApp --server.port=1003
    

部署

打包完成后,接下来是将应用程序部署到目标服务器。本文将介绍如何使用 deploy 工具实现自动化部署,支持多平台,并通过配置文件定义不同环境的部署步骤。

使用 deploy 工具 部署到 Docker

deploy 工具旨在简化部署流程,提高部署效率。它支持多平台,通过配置文件来定义不同环境的部署步骤。

配置文件说明

部署过程涉及两个主要配置文件:

  1. .build.txt:定义打包时的环境变量和命令。
  2. .deploy.toml:定义部署时的服务器地址、压缩包路径、解压路径等。
.build.txt 配置

该文件用于配置项目在不同操作系统上的打包命令。以下是示例配置:

[win.env]
set JAVA_HOME=D:\java\jdk1.8.0_121

[win.build]
mvn clean package -DskipTests -Passembly -Dassembly=full

[linux.env]
export JAVA_HOME=/usr/java/jdk1.8.0_121

[linux.build]
mvn clean package -DskipTests -Passembly -Dassembly=full

[mac.env]
export JAVA_HOME=~/java/jdk1.8.0_121

[mac.build]
mvn clean package -DskipTests -Passembly -Dassembly=full

说明:

  • 环境变量配置:分别为 Windows、Linux 和 macOS 系统配置 JAVA_HOME 环境变量。
  • 打包命令:在不同系统下执行相应的 Maven 打包命令,生成胖包或瘦包。
.deploy.toml 配置

该文件用于定义不同环境(如开发、测试、生产)的部署操作。以下是示例配置:

[dev.upload-run]
url = "http://192.168.1.2:10405/deploy/file/upload-run/"
p = "123456"
b = ".build.txt"
file = "target/tio-boot-full-thin-demo01-1.0.0.zip"
d = "unzip/tio-boot-full-thin-demo01"
c1 = "mkdir -p /data/apps/tio-boot-full-thin-demo01 && mkdir -p backup/tio-boot-full-thin-demo01"
c2 = "[ -d /data/apps/tio-boot-full-thin-demo01 ] && cp -r /data/apps/tio-boot-full-thin-demo01 backup/tio-boot-full-thin-demo01/$(date +%Y%m%d_%H%M%S)"
c3 = "cp -r unzip/tio-boot-full-thin-demo01/* /data/apps/tio-boot-full-thin-demo01/"
c4 = "if [ $(docker ps -qa -f name=tio-boot-full-thin-demo01) ]; then docker stop tio-boot-full-thin-demo01 && docker rm -f tio-boot-full-thin-demo01; fi"
c5 = "cd /data/apps/tio-boot-full-thin-demo01/tio-boot-full-thin-demo01-1.0.0 && docker run -dit --name tio-boot-full-thin-demo01 --restart=always --net=host -v $(pwd):/app -w /app -e TZ=Asia/Shanghai -e LANG=C.UTF-8 litongjava/jdk:8u391-stable-slim java -Xverify:none -cp ./config:./lib/*:./static com.litongjava.full.thin.HelloApp"
c = "docker ps | grep tio-boot-full-thin-demo01"

配置项说明:

  • url: 上传文件的服务端地址。
  • p: 密码,用于身份验证。
  • b: 指定打包配置文件(即 .build.txt)。
  • file: 上传的压缩包文件名。
  • d: 解压路径。
  • c1-c5: 一系列 Shell 命令,依次执行创建目录、备份旧版本、复制新文件、停止并删除旧容器、启动新容器等操作。
  • c: 检查容器是否成功启动的命令。

部署到 Docker

根据 .build.txt 和 .deploy.toml 配置文件,执行以下步骤将应用程序部署到 Docker 环境:

  1. 胖包部署:

    使用全量包进行部署,执行以下命令:

    deploy
    

    该命令将根据 .deploy.toml 中 dev.upload-run 配置,将胖包上传至服务器,解压并通过 Docker 启动新的容器。

  2. 瘦包部署:

    修改 .build.txt 中的 -Dassembly=full 为 -Dassembly=thin,然后执行:

    deploy
    

    该命令将生成瘦包并进行相应的部署操作。

部署到 systemctl

除了使用 Docker,deploy 工具还支持通过 systemctl 管理应用程序的部署。以下是具体步骤:

  1. 配置 .deploy.toml:

    [test.upload-run]
    url = "http://52.9.164.136:10405/deploy/file/upload-run/"
    p = "123456"
    b = ".build.txt"
    file = "target/max-blog-app-backend-1.0.0.zip"
    d = "unzip/max-blog-app-backend"
    c1 = "mkdir -p backup/max-blog-app-backend"
    c2 = "[ -d /data/apps/max-blog-app-backend ] && cp -r /data/apps/max-blog-app-backend backup/max-blog-app-backend/$(date +%Y%m%d_%H%M%S)"
    c3 = "mkdir -p /data/apps/max-blog-app-backend"
    c4 = "cp -r unzip/max-blog-app-backend/* /data/apps/max-blog-app-backend/"
    c = "systemctl restart max-blog-app-backend"
    
  2. 执行部署命令:

    deploy -e test
    

    该命令将根据 test.upload-run 配置,上传并解压瘦包,然后通过 systemctl 重启服务。

配置 Systemd 服务

为确保应用程序能够在系统启动时自动运行,并提供便捷的管理方式,我们需要配置 Systemd 服务。

创建 Service 文件

在服务器上创建一个 Systemd Service 文件,以管理 max-blog-app-backend 应用。

创建文件:

vi /etc/systemd/system/max-blog-app-backend.service

填写内容:

[Unit]
Description=max-blog-app-backend
After=network.target

[Service]
Type=simple
User=root
Restart=on-failure
RestartSec=5s
WorkingDirectory=/data/apps/max-blog-app-backend/max-blog-app-backend-1.0.0
ExecStart=/usr/java/jdk1.8.0_411/bin/java -Xverify:none -cp ./config:./lib/*:./static com.litongjava.max.blog.MaxBlogApp --app.env=test

[Install]
WantedBy=multi-user.target

配置说明:

  • [Unit]:
    • Description: 服务描述。
    • After: 指定服务启动的先后顺序,此处为网络服务启动后再启动本服务。
  • [Service]:
    • Type: 服务类型,此处为简单类型。
    • User: 运行服务的用户。
    • Restart: 服务失败时的重启策略。
    • RestartSec: 重启前的等待时间。
    • WorkingDirectory: 服务的工作目录。
    • ExecStart: 启动服务的命令。
  • [Install]:
    • WantedBy: 指定服务的目标状态,此处为多用户运行级别。

启动并启用服务

执行以下命令以启动并启用服务:

systemctl daemon-reload
systemctl start max-blog-app-backend
systemctl status max-blog-app-backend
systemctl enable max-blog-app-backend

命令说明:

  • daemon-reload:重新加载 Systemd 配置文件。
  • start:启动服务。
  • status:查看服务状态。
  • enable:设置服务开机自启。

.deploy.toml 配置

[test.upload-run]
url = "http://192.168.1.2:10405/deploy/file/upload-run/"
p = "123456"
b = ".build.txt"
file = "target/max-blog-app-backend-1.0.0.zip"
d = "unzip/max-blog-app-backend"
c1 = "mkdir -p backup/max-blog-app-backend"
c2 = "[ -d /data/apps/max-blog-app-backend ] && cp -r /data/apps/max-blog-app-backend backup/max-blog-app-backend/$(date +%Y%m%d_%H%M%S)"
c3 = "mkdir -p /data/apps/max-blog-app-backend"
c4 = "cp -r unzip/max-blog-app-backend/* /data/apps/max-blog-app-backend/"
c = "systemctl restart max-blog-app-backend"

使用 Shell 脚本管理应用

为了更灵活地管理应用程序的启动、停止和重启,可以使用 Shell 脚本进行控制。

启动脚本 tio.sh

创建一个 Shell 脚本 tio.sh,用于在 Unix 系统中管理应用程序。该脚本提供了标准的服务管理功能,如启动、停止、重启和查看状态。

脚本内容:

#!/bin/sh
# chkconfig: 345 99 01
# description:tio

##########################
# 获取应用主目录
###########################
PRG="$0"
while [ -h "$PRG" ] ; do
  ls=`ls -ld "$PRG"`
  link=`expr "$ls" : '.*-> \(.*\)$'`
  if expr "$link" : '/.*' > /dev/null; then
    PRG="$link"
  else
    PRG=`dirname "$PRG"`/"$link"
  fi
done

##########################
# 自定义变量
###########################
MAIN_CLASS=""
JAVA_HOME=""
if [ -z "$JAVA_HOME" ]; then
  JAVA_HOME=${JAVA_HOME:-$(dirname $(readlink -f $(which java)))/..}
fi
APP_HOME=`dirname "$PRG"`
APP_NAME=`basename "$PRG"`
PID_FILE=$APP_HOME/$APP_NAME.pid
CP=$APP_HOME/config:$APP_HOME/lib/*:$APP_HOME/static

# 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"

#########################
# 定义函数
##########################
lock_dir=/var/lock/subsys
lock_file=$lock_dir/$APP_NAME
createLockFile(){
  [ -w $lock_dir ] && touch $lock_file
}

start(){
  # 检查 Java 命令是否存在
  if [ ! -x "$JAVA_HOME/bin/java" ]; then
    echo "Error: Java command not found at $JAVA_HOME/bin/java"
    exit 1
  fi

  # 检查 MAIN_CLASS 是否定义
  if [ -z "$MAIN_CLASS" ]; then
    echo "Error: MAIN_CLASS is not defined. Please provide a valid main class."
    exit 1
  fi

  [ -e $APP_HOME/logs ] || mkdir $APP_HOME/logs -p

  if [ -f $PID_FILE ]
  then
    echo '应用已在运行...'
  else
    CMD="$JAVA_HOME/bin/java -Xverify:none ${JAVA_OPTS} -cp ${CP} ${MAIN_CLASS}"
    echo $CMD
    nohup $CMD >> $APP_HOME/logs/$APP_NAME.log 2>&1 &
    echo $! > $PID_FILE
    createLockFile
    echo "[启动成功]"
  fi
}

stop(){
  if [ -f $PID_FILE ]
  then
    kill `cat $PID_FILE`
    rm -f $PID_FILE
    echo "[停止成功]"
  else
    echo '应用未在运行...'
  fi
}

restart(){
  stop
  start
}

status(){
  if [ -f $PID_FILE ]; then
    echo "应用正在运行,PID:$(cat $PID_FILE)"
  else
    echo "应用未运行"
  fi
}

##########################
# 执行动作
##########################
ACTION=$1
if [ -n "$2" ]; then
  MAIN_CLASS=$2
fi

case $ACTION in
  start)
    start
    ;;
  stop)
    stop
    ;;
  restart)
    restart
    ;;
  status)
    status
    ;;
  *)
    echo "用法: $0 {start|stop|restart|status} [main class]"
    ;;
esac

脚本说明:

  • 获取应用主目录:通过解析符号链接,确定脚本的实际位置,从而获取应用的主目录。
  • 自定义变量:
    • MAIN_CLASS:应用的主类,需要在执行脚本时提供。
    • JAVA_HOME:Java 安装目录,若未设置则自动检测。
    • APP_HOME:应用的主目录。
    • APP_NAME:应用名称。
    • PID_FILE:存储应用进程 ID 的文件。
    • CP:类路径,包含配置、库和静态资源目录。
    • JAVA_OPTS:Java 启动参数,可根据需要进行配置。
  • 函数定义:
    • start:启动应用程序。
    • stop:停止应用程序。
    • restart:重启应用程序。
    • status:查看应用程序状态。
  • 执行动作:根据传入的参数执行相应的操作(启动、停止、重启或查看状态)。

配置 Service 文件

为方便使用 Systemd 管理应用程序,通过 tio.sh 脚本创建 Service 文件。

创建文件:

vi /etc/systemd/system/tio.service

填写内容:

[Unit]
Description=tio
After=network.target

[Service]
ExecStart=/opt/tio-hello/tio-hello-1.0/tio.sh start com.litongjava.full.thin.HelloApp
ExecStop=/opt/tio-hello/tio-hello-1.0/tio.sh stop
ExecReload=/opt/tio-hello/tio-hello-1.0/tio.sh restart com.litongjava.full.thin.HelloApp
Type=forking
PrivateTmp=true

[Install]
WantedBy=multi-user.target

配置说明:

  • [Unit]:
    • Description: 服务描述。
    • After: 指定服务启动的先后顺序,此处为网络服务启动后再启动本服务。
  • [Service]:
    • ExecStart: 启动服务的命令,包含主类参数。
    • ExecStop: 停止服务的命令。
    • ExecReload: 重启服务的命令,包含主类参数。
    • Type: 服务类型,此处为 forking,表示服务启动后会派生出子进程。
    • PrivateTmp: 为服务提供独立的临时目录。
  • [Install]:
    • WantedBy: 指定服务的目标状态,此处为多用户运行级别。

启动并启用服务:

systemctl daemon-reload
systemctl start tio.service
systemctl status tio.service
systemctl enable tio.service

命令说明:

  • daemon-reload:重新加载 Systemd 配置文件。
  • start:启动服务。
  • status:查看服务状态。
  • enable:设置服务开机自启。

工具源码

本文中提到的 deploy 工具已开源,欢迎开发者参考和贡献。以下是相关源码仓库的链接:

  • deploy 工具
  • max-blog-app-backend 工具

通过这些工具,您可以实现高效、自动化的项目部署流程,显著提升开发与运维效率。

结语

本文详细介绍了 胖包 与 瘦包 的概念及其在 Java 项目中的应用,并通过 tio-boot 工程示例,展示了如何使用 Maven 进行不同类型的打包,以及如何使用 deploy 工具实现自动化部署。无论是基于 Docker 还是 Systemd 的部署方式,都能够满足不同环境下的需求。希望本文档能够帮助您快速上手并顺利完成项目的打包与部署。

如有任何疑问或建议,欢迎在项目的 GitHub 仓库中提出。

Edit this page
Last Updated:
Contributors: Tong Li
Prev
使用 Deploy 工具部署
Next
使用 Jenkins 部署 Tio-Boot 项目