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 命令

生成器与 Model

本文档介绍了如何使用 ActiveRecord 模块下的 Generator 工具类,自动生成 JavaBean 相关的 Model、BaseModel、MappingKit、DataDictionary 四类文件。通过生成器,可以快速创建符合 JavaBean 规范的模型类,提升开发效率和代码质量。

1. 生成器使用

1.1 基本使用

ActiveRecord 模块的 com.litongjava.db.activerecord.generator 包下提供了 Generator 工具类,能够自动生成 Model、BaseModel、MappingKit、DataDictionary 四类文件。生成后的 Model 类将与 Java Bean 结合,立即拥有 getter 和 setter 方法,遵循传统的 Java Bean 规范,开发过程中无需手动记忆字段名。

使用生成器通常只需配置四个参数:baseModelPackageName、baseModelOutputDir、modelPackageName、modelOutputDir。以下是具体的使用示例:

// 模型所使用的包名 (MappingKit 默认使用的包名)
String modelPackageName = "com.xxx.common.model";

// BaseModel 所使用的包名
String baseModelPackageName = modelPackageName + ".base";

// BaseModel 文件保存路径
// 注意:从 JFinal 4.9.12 版本开始,PathKit.getWebRootPath() 的用法需改为 System.getProperty("user.dir")
String baseModelOutputDir = System.getProperty("user.dir") + "/src/main/java/" + baseModelPackageName.replace('.', '/');

// Model 文件保存路径 (MappingKit 与 DataDictionary 文件默认保存路径)
String modelOutputDir = baseModelOutputDir + "/..";

System.out.println("输出路径:" + baseModelOutputDir);

// 创建生成器
Generator gen = new Generator(getDataSource(), baseModelPackageName, baseModelOutputDir, modelPackageName, modelOutputDir);

// 设置数据库方言
gen.setDialect(new MysqlDialect());

// 在 getter、setter 方法上生成字段备注内容
gen.setGenerateRemarks(true);

// 开始生成代码
gen.generate();

四个参数的含义分别为:

  • baseModelPackageName:BaseModel 的包名
  • baseModelOutputDir:BaseModel 的输出路径
  • modelPackageName:Model 的包名
  • modelOutputDir:Model 的输出路径

由于后三个参数可以根据第一个参数生成,通常只需配置 modelPackageName 即可。

1.2 生成的相关文件

生成器会自动生成以下四类文件:

  • BaseModel:供最终的 Model 继承的基类,所有的 getter 和 setter 方法都生成在此文件内,保持最终 Model 的简洁。BaseModel 无需手动维护,数据库变化时只需重新生成即可。
  • Model:具体的模型类,继承自 BaseModel,包含业务逻辑。
  • MappingKit:用于生成数据库表与 Model 之间的映射关系,包括主键和复合主键的配置,无需在 configPlugin(Plugins me) 方法中编写映射代码。
  • DataDictionary:生成的数据字典,包含数据表所有字段的名称、类型、长度、备注、是否主键等信息。

1.3 表的过滤与排除

Generator 内部由 MetaBuilder、ModelGenerator、BaseModelGenerator、MappingKitGenerator、DataDictionaryGenerator 等组件组成。这些组件可以通过继承或独立配置后组装到 Generator 中,实现个性化定制。

从 JFinal 5.0.0 版本开始,Generator 提供了 addBlacklist 和 addWhitelist 方法,用于将需要生成的表添加到白名单或黑名单。例如:

// 添加多个表名到黑名单
generator.addBlacklist("login_log", "role_permission", "user_role");

// 添加多个表名到白名单
generator.addWhitelist("user", "order", "product");

在旧版本中,可以通过配置 MetaBuilder 的 filter 方法实现表的过滤:

MetaBuilder metaBuilder = new MetaBuilder(dataSource)
   // 使用 filter 方法定制过滤逻辑,返回 true 表示过滤掉当前表
   .filter(tableName -> {
      return tableName.startsWith("sys_");
   });

Generator gen = new Generator(dataSource, baseModelPackageName, baseModelOutputDir);
gen.setMetaBuilder(metaBuilder);
gen.generate();

注意:自 JFinal 4.9.05 版本起,filter(...) 方法更名为 skip(...)。

此外,还可以通过继承 MetaBuilder、ModelGenerator、BaseModelGenerator 等组件,进一步实现个性化功能。

1.4 使用生成器的主要优势

  • 利用第三方工具:充分利用针对 Bean 设计的第三方工具,如 Jackson、FreeMarker 等。
  • 快速响应数据库变动:数据库表结构变化时,快速重构代码,提升开发效率和代码质量。
  • IDE 代码提示:生成的代码拥有完整的 getter 和 setter 方法,IDE 能提供智能提示,避免手动记忆字段名和手动输入错误。
  • 保持 Model 清爽:通过 BaseModel 设计,保持最终 Model 类的简洁,数据库表结构变化时仅需重生成 BaseModel 即可。
  • 自动化映射:自动化完成表与 Model 的映射,包括主键和复合主键的识别与映射。
  • 干净的 JFinalConfig:MappingKit 承载映射代码,保持 JFinalConfig 的干净简洁。
  • 适用于分布式场景:有利于分布式环境下的开发,以及在无数据源时使用 Model。
  • 性能与安全性提升:新的映射设计避免了自动扫描映射的性能问题和安全隐患,避免引入额外的学习成本(如注解)。

1.5 Model 与 Bean 合体后的注意事项

在 Model 与 Java Bean 合体后,需要注意以下事项:

  • JSP 模板输出:JSP 模板输出 Bean 中的数据依赖其 getter 方法。输出的变量名为 getter 方法去掉 "get" 前缀后,首字母小写。如果希望 JSP 继续使用原有的输出方式,可以在系统启动时调用 ModelRecordElResolver.setResolveBeanAsModel(true)。

  • Controller 中的使用:

    • getModel() 方法依赖于表单域名称对应于数据库字段名。
    • getBean() 方法依赖于 setter 方法,表单域名对应于 setter 方法去掉 "set" 前缀后,首字母小写。
  • 第三方工具兼容性:许多如 Jackson、FastJSON 等第三方工具依赖于 Bean 的 getter 方法进行操作,只有合体后才能正常使用。

  • JSON 序列化:

    • JFinalJson 将 Model 转换为 JSON 时,JSON 的 key 名为原始的数据表字段名。
    • Jackson、FastJSON 等依赖 getter 方法,生成的 JSON key 名为字段名转换后的驼峰命名。
  • 命名建议:

    • 建议 MySQL 数据表的字段名直接使用驼峰命名,这样生成的 JSON key 名与 JSP 中使用的属性名一致。
    • 数据表名称仍建议使用下划线命名方式并使用小写字母,便于在 Linux 与 Windows 系统之间移植。
  • 方法调用明确:合体后的 Bean 使用时,要明确使用的是 BaseModel 中的 getter、setter 方法,还是 Model 中的 get(String attrName) 方法。

1.6 常见问题解决

问题:在使用 SQL Server 数据库时,生成器会获取到系统自带的表,需对这些表进行过滤。

解决方案:参考 JFinal 官方文档,通过配置生成器的过滤规则,将系统表加入黑名单或白名单。

2. 生成器使用示例

以下是一个完整的生成器使用示例,包括依赖配置、生成器配置与运行、生成的代码示例以及映射配置和测试代码。

2.1 添加依赖

在 pom.xml 中添加以下依赖:

<dependency>
  <groupId>com.litongjava</groupId>
  <artifactId>java-db</artifactId>
  <version>${java-db.version}</version>
</dependency>
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.26</version>
</dependency>
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>druid</artifactId>
  <version>0.2.9</version>
</dependency>

2.2 生成器配置与运行

创建一个 Java 类 JavaDbGenerator,配置并运行生成器:

import javax.sql.DataSource;

import com.litongjava.db.activerecord.dialect.MysqlDialect;
import com.litongjava.db.activerecord.generator.Generator;
import com.litongjava.db.druid.DruidPlugin;
import com.litongjava.tio.utils.environment.EnvUtils;

public class JavaDbGenerator {
  public static String modelPackageName = "com.litongjava.common.model";

  public static void main(String[] args) {
    EnvUtils.load();
    DataSource dataSource = getDataSource();

    // BaseModel 的包名
    String baseModelPackageName = modelPackageName + ".base";
    // BaseModel 的输出路径
    String baseModelOutputDir = getBaseModelOutputDir(baseModelPackageName);

    // Model 的输出路径 (MappingKit 与 DataDictionary 默认保存路径)
    String modelOutputDir = baseModelOutputDir + "/..";

    // 创建生成器
    Generator generator = new Generator(dataSource, baseModelPackageName, baseModelOutputDir, modelPackageName, modelOutputDir);

    // 配置生成器
    generator.setGenerateRemarks(true); // 生成字段备注
    generator.setDialect(new MysqlDialect()); // 设置数据库方言
    generator.setGenerateChainSetter(true); // 生成链式 setter 方法
    // generator.addExcludedTable("t_db_connect_info"); // 添加不需要生成的表名
    generator.setGenerateDaoInModel(true); // 在 Model 中生成 dao 对象
    generator.setGenerateDataDictionary(false); // 不生成数据字典
    generator.setRemovedTableNamePrefixes("t_"); // 移除表名前缀,如 "t_",生成的 Model 名为 "User" 而非 "TUser"

    // 开始生成
    generator.generate();
  }

  public static String getBaseModelOutputDir(String modelPackageName) {
    String replace = modelPackageName.replace('.', '/');
    return "src/main/java/" + replace;
  }

  public static DruidPlugin createDruidPlugin() {
    String url = EnvUtils.get("jdbc.url").trim();
    String user = EnvUtils.get("jdbc.user").trim();
    String pswd = EnvUtils.get("jdbc.pswd").trim();
    return new DruidPlugin(url, user, pswd);
  }

  public static DataSource getDataSource() {
    DruidPlugin druidPlugin = createDruidPlugin();
    druidPlugin.start();
    return druidPlugin.getDataSource();
  }
}

2.3 生成的代码示例

生成的 Model 类示例:

package com.litongjava.common.model;

import com.litongjava.common.model.base.BaseTioBootAdminSystemConstantsConfig;

/**
 * Generated by java-db.
 */
public class TioBootAdminSystemConstantsConfig extends BaseTioBootAdminSystemConstantsConfig<TioBootAdminSystemConstantsConfig> {
  private static final long serialVersionUID = 1L;

  public static final TioBootAdminSystemConstantsConfig dao = new TioBootAdminSystemConstantsConfig().dao();
}

生成的 BaseModel 类示例:

package com.litongjava.common.model.base;

import com.litongjava.db.activerecord.Model;
import com.litongjava.model.db.IBean;

/**
 * Generated by java-db, do not modify this file.
 */
@SuppressWarnings({"serial", "unchecked"})
public abstract class BaseTioBootAdminSystemConstantsConfig<M extends BaseTioBootAdminSystemConstantsConfig<M>> extends Model<M> implements IBean {

  public M setId(java.lang.Long id) {
    set("id", id);
    return (M)this;
  }

  public java.lang.Long getId() {
    return getLong("id");
  }

  public M setKeyName(java.lang.String keyName) {
    set("key_name", keyName);
    return (M)this;
  }

  public java.lang.String getKeyName() {
    return getStr("key_name");
  }

  public M setKeyValue(java.lang.String keyValue) {
    set("key_value", keyValue);
    return (M)this;
  }

  public java.lang.String getKeyValue() {
    return getStr("key_value");
  }

  public M setRemark(java.lang.String remark) {
    set("remark", remark);
    return (M)this;
  }

  public java.lang.String getRemark() {
    return getStr("remark");
  }

  public M setCreator(java.lang.String creator) {
    set("creator", creator);
    return (M)this;
  }

  public java.lang.String getCreator() {
    return getStr("creator");
  }

  public M setCreateTime(java.util.Date createTime) {
    set("create_time", createTime);
    return (M)this;
  }

  public java.util.Date getCreateTime() {
    return getDate("create_time");
  }

  public M setUpdater(java.lang.String updater) {
    set("updater", updater);
    return (M)this;
  }

  public java.lang.String getUpdater() {
    return getStr("updater");
  }

  public M setUpdateTime(java.util.Date updateTime) {
    set("update_time", updateTime);
    return (M)this;
  }

  public java.util.Date getUpdateTime() {
    return getDate("update_time");
  }

  public M setDeleted(java.lang.Integer deleted) {
    set("deleted", deleted);
    return (M)this;
  }

  public java.lang.Integer getDeleted() {
    return getInt("deleted");
  }

  public M setTenantId(java.lang.Long tenantId) {
    set("tenant_id", tenantId);
    return (M)this;
  }

  public java.lang.Long getTenantId() {
    return getLong("tenant_id");
  }
}
package com.enoleap.maliang.app.db.model;

import com.enoleap.maliang.app.db.model.base.BaseTioBootAdminSystemConstantsConfig;

/**
 * Generated by java-db.
 */
public class TioBootAdminSystemConstantsConfig extends BaseTioBootAdminSystemConstantsConfig<TioBootAdminSystemConstantsConfig> {
  private static final long serialVersionUID = 1L;
	public static final TioBootAdminSystemConstantsConfig dao = new TioBootAdminSystemConstantsConfig().dao();
	/**
	 *
	 */
  public static final String tableName = "tio_boot_admin_system_constants_config";
  public static final String primaryKey = "id";
  // private java.lang.Long id
  // private java.lang.String keyName
  // private java.lang.String keyValue
  // private java.lang.String remark
  // private java.lang.String creator
  // private java.util.Date createTime
  // private java.lang.String updater
  // private java.util.Date updateTime
  // private java.lang.Integer deleted
  // private java.lang.Long tenantId
}

2.4 添加 MappingKit 映射

在项目中添加 _MappingKit.mapping(mysqlArp); 以完成表与模型的映射。以下是配置示例:

import com.jfinal.template.Engine;
import com.jfinal.template.source.ClassPathSourceFactory;
import com.litongjava.annotation.AConfiguration;
import com.litongjava.annotation.Initialization;
import com.litongjava.common.model._MappingKit;
import com.litongjava.db.activerecord.ActiveRecordPlugin;
import com.litongjava.db.activerecord.OrderedFieldContainerFactory;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.boot.utils.TioRequestParamUtils;
import com.litongjava.tio.utils.environment.EnvUtils;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import lombok.extern.slf4j.Slf4j;

@AConfiguration
@Slf4j
public class EnoteMysqlDbConfig {

  /*
   * 配置 ActiveRecordPlugin
   */
  @Initialization
  public void config() {
    String jdbcUrl = EnvUtils.get("jdbc.url");
    log.info("jdbcUrl:{}", jdbcUrl);
    String jdbcUser = EnvUtils.get("jdbc.user");
    String jdbcPswd = EnvUtils.get("jdbc.pswd");
    int maximumPoolSize = EnvUtils.getInt("jdbc.MaximumPoolSize", 2);

    HikariConfig config = new HikariConfig();
    // 设置基本参数
    config.setJdbcUrl(jdbcUrl);
    config.setUsername(jdbcUser);
    config.setPassword(jdbcPswd);
    config.setMaximumPoolSize(maximumPoolSize);
    config.setConnectionTimeout(30000);

    HikariDataSource hikariDataSource = new HikariDataSource(config);
    HookCan.me().addDestroyMethod(hikariDataSource::close);

    ActiveRecordPlugin mysqlArp = new ActiveRecordPlugin(hikariDataSource);
    mysqlArp.setContainerFactory(new OrderedFieldContainerFactory());

    Engine engine = mysqlArp.getEngine();
    engine.setSourceFactory(new ClassPathSourceFactory());
    engine.setCompressorOn(' ');
    engine.setCompressorOn('\n');

    if (EnvUtils.isDev()) {
      mysqlArp.setDevMode(true);
      engine.setDevMode(true);
      mysqlArp.setShowSql(true);
    }

    mysqlArp.addSqlTemplate("/sql/all_sqls.sql");
    _MappingKit.mapping(mysqlArp);
    mysqlArp.start();
    HookCan.me().addDestroyMethod(mysqlArp::stop);
    // 添加自定义类型
    TioRequestParamUtils.types.add("bigint");
  }
}

2.5 测试生成的 Model

编写测试类,验证生成的 Model 是否能正常操作数据库:

package com.litongjava.common.model;

import java.util.List;

import org.junit.Test;

import com.enoleap.maliang.app.config.EnoteMysqlDbConfig;
import com.enoleap.maliang.app.db.model.TioBootAdminSystemConstantsConfig;
import com.litongjava.tio.boot.tesing.TioBootTest;
import com.litongjava.tio.utils.json.JsonUtils;
import com.litongjava.tio.utils.snowflake.SnowflakeIdUtils;

public class TioBootAdminSystemConstantsConfigTest {

  @Test
  public void test() {
    TioBootTest.runWith(EnoteMysqlDbConfig.class);
    //save
    new TioBootAdminSystemConstantsConfig().setId(SnowflakeIdUtils.id()).setKeyName("key_001").setKeyValue("key_002").save();

    //find
    List<TioBootAdminSystemConstantsConfig> all = TioBootAdminSystemConstantsConfig.dao.findAll();

    System.out.println(JsonUtils.toJson(all));

    //delete
    boolean deleted = TioBootAdminSystemConstantsConfig.dao.deleteById(437975050078142464L);
    System.out.println(deleted);
  }
}

运行日志示例:

2024-10-20 21:44:05.394 [main] INFO  c.l.t.u.e.EnvUtils.load:171 - app.env:dev
2024-10-20 21:44:05.467 [main] INFO  c.e.m.a.c.EnoteMysqlDbConfig.config:29 - jdbcUrl:jdbc:mysql://192.168.3.9/enote?useSSL=false&characterEncoding=UTF-8&allowMultiQueries=true&serverTimezone=UTC
2024-10-20 21:44:05.475 [main] INFO  c.z.h.HikariDataSource.<init>:80 - HikariPool-1 - Starting...
2024-10-20 21:44:05.721 [main] INFO  c.z.h.HikariDataSource.<init>:82 - HikariPool-1 - Start completed.
Sql: select * from `tio_boot_admin_system_constants_config`
[{}{}]
true

3. 附录

3.1 自定义模板文件

Generator 提供了多种 setter 方法,可以方便地控制生成结果。例如,可以指定生成器依赖的模板文件:

// 指定 BaseModel 文件生成的模板文件
generator.setBaseModelTemplate("templates/baseModel.jf");

// 指定 Model 文件生成的模板文件
generator.setModelTemplate("templates/model.jf");

// 指定 MappingKit 文件生成的模板文件
generator.setMappingKitTemplate("templates/mappingKit.jf");

将模板文件放入 src/main/resources 目录下,生成器即可获取。定制模板文件通常需要在原有模板基础上修改,原模板文件位于 JFinal 源码中:JFinal GitHub 仓库

模板文件后缀为 .jf,采用 enjoy 模板引擎语法。

4. 结论

使用 Generator 工具类能够显著提升 Java 项目中模型类的开发效率和代码质量。通过自动生成符合 JavaBean 规范的 Model 和相关文件,开发者可以专注于业务逻辑的实现,减少重复性劳动,并确保代码的一致性和可维护性。

Edit this page
Last Updated:
Contributors: Tong Li
Prev
Model
Next
Db 工具类