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

Tio-Boot 整合 MyBatis

简介

Tio-Boot:Tio-Boot 是一个高性能的 Java 网络编程框架,用于快速构建 Web、WebSocket、TCP 等网络应用。在本教程中,我们将使用 Tio-Boot 启动一个简单的 Web 服务,以演示如何与 MyBatis 整合。

MyBatis:MyBatis 是一个持久层框架,简化了 Java 对象与关系型数据库之间的映射。在本教程中,我们将使用 MyBatis 配置数据源、映射文件和 Mapper 接口,以实现与数据库的交互。

使用工具类和配置文件整合 MyBatis

添加依赖

在您的 pom.xml 文件中添加以下依赖:

<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>
  <graalvm.version>23.1.1</graalvm.version>
  <tio-boot.version>1.9.5</tio-boot.version>
  <lombok-version>1.18.30</lombok-version>
  <jfinal-aop.version>1.3.3</jfinal-aop.version>
  <hotswap-classloader.version>1.2.6</hotswap-classloader.version>
  <final.name>web-hello</final.name>
  <main.class>demo.mybatis.MybatisApp</main.class>
</properties>

<dependencies>
  <!-- 日志框架 -->
  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
  </dependency>

  <!-- Tio-Boot 框架 -->
  <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>

  <!-- JFinal AOP -->
  <dependency>
    <groupId>com.litongjava</groupId>
    <artifactId>jfinal-aop</artifactId>
    <version>${jfinal-aop.version}</version>
  </dependency>

  <!-- Lombok -->
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>${lombok-version}</version>
    <optional>true</optional>
    <scope>provided</scope>
  </dependency>

  <!-- MyBatis -->
  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.4</version>
  </dependency>

  <!-- Druid 连接池 -->
  <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.10</version>
  </dependency>

  <!-- PostgreSQL 驱动 -->
  <dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.2.24</version>
  </dependency>

  <!-- JUnit 测试框架 -->
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
</dependencies>

说明:

  • MyBatis:mybatis 依赖用于使用 MyBatis 框架进行对象关系映射。
  • Druid:druid 依赖提供了高效的数据库连接池。
  • PostgreSQL 驱动:postgresql 依赖使您的应用能够连接到 PostgreSQL 数据库。

**注意:**如果您使用的是 MySQL 而非 PostgreSQL,请将 PostgreSQL 依赖替换为 MySQL 连接器:

<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.46</version>
</dependency>

准备模拟数据

在您的数据库中创建表并插入示例数据。

SQL 脚本:

CREATE TABLE system_admin (
  id SERIAL PRIMARY KEY,
  login_name VARCHAR(32),
  password VARCHAR(32)
);

INSERT INTO system_admin (login_name, password) VALUES ('litong', '00000000');

说明:

  1. 创建表:

    • 创建一个名为 system_admin 的表,包含以下字段:
      • id:自增主键。
      • login_name:最大长度为 32 的字符串。
      • password:最大长度为 32 的字符串。
  2. 插入数据:

    • 向 system_admin 表中插入一条记录,login_name 为 'litong',password 为 '00000000'。

验证:

运行以下查询以确保数据已正确插入:

SELECT * FROM system_admin;

启动 Tio-Boot

创建 IndexController

创建一个控制器类来处理传入的 HTTP 请求。

package demo.mybatis.controller;

import com.litongjava.annotation.RequestPath;

@RequestPath("/")
public class IndexController {

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

}

说明:

  • @RequestPath("/") 注解将控制器映射到根 URL(/)。
  • index() 方法响应根 URL 的 HTTP GET 请求,返回简单的字符串 "index"。

创建主应用程序类

创建主应用程序类以引导您的 Tio-Boot 应用。

package demo.mybatis;

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

@AComponentScan
public class MybatisApp {
  public static void main(String[] args) {
    TioApplication.run(MybatisApp.class, args);
  }
}

说明:

  • @AComponentScan 注解启用了组件扫描,使 Tio-Boot 能够检测并注册控制器等组件。
  • main 方法通过调用 TioApplication.run() 启动应用程序。

运行应用程序

启动 MybatisApp 类。如果应用程序成功启动,您应该能够在浏览器中访问 http://localhost 并看到来自 IndexController 的响应。

整合 MyBatis

创建模型类

创建与 system_admin 表对应的模型类。

package demo.mybatis.model;

import lombok.Data;

@Data
public class SystemAdmin {
  private int id;
  private String loginName;
  private String password;
}

说明:

  • @Data 注解来自 Lombok,自动生成 getter、setter 和其他实用方法。
  • 类字段 id、loginName 和 password 直接映射到 system_admin 表的列。

创建 Mapper 接口

为 SystemAdmin 模型创建一个 Mapper 接口。

package demo.mybatis.mapper;

import demo.mybatis.model.SystemAdmin;

public interface SystemAdminMapper {
  SystemAdmin getSystemAdmin(SystemAdmin systemAdmin);
}

说明:

  • SystemAdminMapper 接口定义了一个方法 getSystemAdmin,用于从数据库中检索 SystemAdmin 对象。

创建 Mapper XML 配置

创建 SystemAdminMapper.xml 以定义 SQL 映射。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="demo.mybatis.mapper.SystemAdminMapper">
  <resultMap type="SystemAdmin" autoMapping="true" id="SystemAdminResult">
    <id column="id" jdbcType="INTEGER" property="id" />
    <result column="login_name" jdbcType="VARCHAR" property="loginName" />
    <result column="password" jdbcType="VARCHAR" property="password" />
  </resultMap>

  <select id="getSystemAdmin" resultMap="SystemAdminResult">
    SELECT * FROM system_admin WHERE 1=1
    <if test="loginName != null and loginName != ''">
      AND login_name = #{loginName}
    </if>
  </select>
</mapper>

说明:

  • 命名空间: namespace 属性应与 SystemAdminMapper 接口的全限定名匹配。
  • ResultMap:
    • <resultMap> 元素定义了数据库列如何映射到 SystemAdmin 类的字段。
    • autoMapping="true" 启用了基于字段名的自动映射。
  • Select 语句:
    • <select> 元素为 getSystemAdmin 方法定义了 SQL 查询。
    • <if> 元素在提供 loginName 时向查询添加条件。

创建 MyBatis 配置文件

在您的资源目录中创建 mybatis.xml。

<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
  <!-- 启用 SQL 语句的日志记录 -->
  <settings>
    <setting name="logImpl" value="STDOUT_LOGGING" />
  </settings>

  <!-- 类型别名 -->
  <typeAliases>
    <package name="demo.mybatis.model" />
  </typeAliases>

  <!-- 环境配置 -->
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC" />

      <dataSource type="UNPOOLED">
        <property name="driver" value="org.postgresql.Driver" />
        <property name="url" value="jdbc:postgresql://192.168.3.9/defaultdb" />
        <property name="username" value="postgres" />
        <property name="password" value="123456" />
      </dataSource>
    </environment>
  </environments>

  <!-- 映射器 -->
  <mappers>
    <mapper resource="SystemAdminMapper.xml" />
  </mappers>
</configuration>

说明:

  • 设置:
    • <setting name="logImpl" value="STDOUT_LOGGING" /> 将 SQL 语句的日志输出到控制台。
  • 类型别名:
    • <package name="demo.mybatis.model" /> 允许您在映射文件中使用简化的类名。
  • 环境配置:
    • 定义数据库连接设置。
    • 事务管理器: 设置为 JDBC 以使用 JDBC 事务。
    • 数据源: 指定数据库驱动、URL、用户名和密码。
  • 映射器:
    • 注册 SystemAdminMapper.xml 文件到 MyBatis。

**注意:**请根据您的环境替换数据库连接属性。

创建 MyBatis 的工具类

创建 MybatisUtils,以管理 SqlSessionFactory 并提供打开 SqlSession 的方法。

package demo.mybatis.utils;

import java.io.IOException;
import java.io.InputStream;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class MybatisUtils {

  private static final String RESOURCE = "mybatis.xml";
  private static SqlSessionFactory factory;

  static {
    try (InputStream inputStream = Resources.getResourceAsStream(RESOURCE)) {
      factory = new SqlSessionFactoryBuilder().build(inputStream);
    } catch (IOException e) {
      e.printStackTrace();
      throw new RuntimeException("Error initializing SqlSessionFactory", e);
    }
  }

  /**
   * 返回 SqlSessionFactory。
   */
  public static SqlSessionFactory getFactory() {
    return factory;
  }

  /**
   * 打开新的 SqlSession。
   *
   * @param autoCommit 是否自动提交事务
   * @return 新的 SqlSession
   */
  public static SqlSession openSession(boolean autoCommit) {
    return factory.openSession(autoCommit);
  }

  /**
   * 打开自动提交的 SqlSession。
   *
   * @return 新的 SqlSession
   */
  public static SqlSession openSession() {
    return factory.openSession(true);
  }

}

说明:

  • 静态初始化块:
    • 在类加载时初始化 SqlSessionFactory。
    • 从 mybatis.xml 加载 MyBatis 配置。
  • 方法:
    • getFactory():返回 SqlSessionFactory。
    • openSession(boolean autoCommit):使用指定的 autoCommit 设置打开新的 SqlSession。
    • openSession():打开 autoCommit 设置为 true 的新 SqlSession。

在控制器中使用 Mapper

创建 MybatisController,使用 SystemAdminMapper 并检索数据。

package demo.mybatis.controller;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;

import com.jfinal.kit.Kv;
import com.litongjava.annotation.RequestPath;

import demo.mybatis.mapper.SystemAdminMapper;
import demo.mybatis.model.SystemAdmin;
import demo.mybatis.utils.MybatisUtils;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@RequestPath("/mybatis")
public class MybatisController {

  @RequestPath("/getMapper")
  public Kv getMapper() {
    SqlSessionFactory factory = MybatisUtils.getFactory();
    log.info("factory: {}", factory);

    try (SqlSession sqlSession = MybatisUtils.openSession()) {
      log.info("sqlSession: {}", sqlSession);

      SystemAdminMapper mapper = sqlSession.getMapper(SystemAdminMapper.class);
      log.info("mapper: {}", mapper);

      SystemAdmin systemAdmin = mapper.getSystemAdmin(null);
      log.info("systemAdmin: {}", systemAdmin);

      Kv kv = Kv.by("data", systemAdmin);
      return kv;
    } catch (Exception e) {
      log.error("Error fetching SystemAdmin", e);
      return Kv.by("error", e.getMessage());
    }
  }
}

说明:

  • 日志记录:
    • @Slf4j 注解为类提供了一个日志记录器。
    • 添加日志以跟踪执行流程并捕获重要信息。
  • 接口:
    • @RequestPath("/getMapper") 注解将 getMapper 方法映射到 /mybatis/getMapper URL。
  • 数据库交互:
    • 获取 SqlSessionFactory 并打开新的 SqlSession。
    • 从 SqlSession 获取 SystemAdminMapper。
    • 调用 getSystemAdmin 从数据库中检索数据。
  • 响应:
    • 返回包含检索到的数据的 Kv 对象。

错误处理:

  • 捕获并记录异常。
  • 如果发生异常,在响应中返回错误消息。

测试整合

访问端点以测试 MyBatis 的整合。

URL:

http://localhost/mybatis/getMapper

预期的 JSON 响应:

{
  "data": {
    "id": 1,
    "loginName": "litong",
    "password": "00000000"
  }
}

说明:

  • 响应包含从数据库检索到的 SystemAdmin 数据。
  • 如果数据与先前插入的示例数据匹配,则整合成功。

示例日志输出:

INFO  [main] MybatisController - factory: org.apache.ibatis.session.defaults.DefaultSqlSessionFactory@23e97c4d
INFO  [main] MybatisController - sqlSession: org.apache.ibatis.session.defaults.DefaultSqlSession@303eef5f
INFO  [main] MybatisController - mapper: org.apache.ibatis.binding.MapperProxy@7a1b8606
INFO  [main] MybatisController - systemAdmin: SystemAdmin(id=1, loginName=litong, password=00000000)

其他注意事项

  • 配置管理:
    • 考虑使用属性文件或环境变量将数据库 URL、用户名和密码等配置属性外部化。
  • 异常处理:
    • 增强错误处理,提供更友好的用户消息或错误代码。
  • 日志级别:
    • 适当调整日志级别,以避免在生产环境中产生过多的日志。
  • 安全考虑:
    • 在日志中记录敏感信息(如密码)时要谨慎。
  • 依赖版本:
    • 保持依赖项的更新,以利用安全补丁和新功能。
  • 资源管理:
    • 始终关闭 SqlSession 和其他资源,以防止资源泄漏。

结论

通过本教程,您已经成功地将 MyBatis 与 Tio-Boot 整合,并使用 MyBatis 的 Mapper 执行了数据库操作。此设置为构建具有高效数据库交互的可扩展 Web 应用程序提供了坚实的基础。

使用配置类和配置文件整合 MyBatis

使用配置类整合 MyBatis

在本节中,我们将通过使用配置类来整合 MyBatis,并演示如何在代码中配置 MyBatis,同时仍然使用 mybatis.xml 配置文件。

添加依赖

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

<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>
  <graalvm.version>23.1.1</graalvm.version>
  <tio-boot.version>1.9.5</tio-boot.version>
  <lombok-version>1.18.30</lombok-version>
  <jfinal-aop.version>1.3.3</jfinal-aop.version>
  <hotswap-classloader.version>1.2.6</hotswap-classloader.version>
  <final.name>web-hello</final.name>
  <main.class>demo.mybatis.MybatisApp</main.class>
</properties>

<dependencies>
  <!-- 日志框架 -->
  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
  </dependency>

  <!-- Tio-Boot 框架 -->
  <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>

  <!-- JFinal AOP -->
  <dependency>
    <groupId>com.litongjava</groupId>
    <artifactId>jfinal-aop</artifactId>
    <version>${jfinal-aop.version}</version>
  </dependency>

  <!-- Lombok -->
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>${lombok-version}</version>
    <optional>true</optional>
    <scope>provided</scope>
  </dependency>

  <!-- MyBatis -->
  <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.4</version>
  </dependency>

  <!-- Druid 连接池 -->
  <dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.10</version>
  </dependency>

  <!-- PostgreSQL 驱动 -->
  <dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.2.24</version>
  </dependency>

  <!-- JUnit 测试框架 -->
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
  </dependency>
</dependencies>

说明:

  • MyBatis:用于对象关系映射的持久层框架。
  • Druid:阿里巴巴提供的高性能数据库连接池。
  • PostgreSQL 驱动:连接 PostgreSQL 数据库所需的 JDBC 驱动。

创建 MySqlSessionManager

MySqlSessionManager 用于管理 SqlSession,以便在应用程序中共享 SqlSession 实例。

package demo.mybatis.config;

import org.apache.ibatis.session.SqlSession;

public class MySqlSessionManager {

  private static SqlSession sqlSession;

  public static SqlSession getSqlSession() {
    return sqlSession;
  }

  public static void setSqlSession(SqlSession sqlSession) {
    MySqlSessionManager.sqlSession = sqlSession;
  }

  public static <T> T getMapper(Class<T> clazz) {
    return sqlSession.getMapper(clazz);
  }
}

说明:

  • getSqlSession():获取当前的 SqlSession 实例。
  • setSqlSession(SqlSession sqlSession):设置当前的 SqlSession 实例。
  • getMapper(Class<T> clazz):从 SqlSession 获取指定类型的 Mapper。

创建 MybatisConfig 配置类

MybatisConfig 使用 MyBatis 框架来配置数据库会话,并通过配置类的方式管理 SqlSession 的创建。

package demo.mybatis.config;

import java.io.IOException;
import java.io.Reader;

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import com.litongjava.annotation.ABean;
import com.litongjava.annotation.AConfiguration;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@AConfiguration
public class MybatisConfig {

  // 配置文件名称
  private String mybatisConfigXml = "mybatis.xml";

  /**
   * 获取 SqlSession,并将其注册为 Bean,应用关闭时自动销毁。
   *
   * @return SqlSession 实例
   */
  @ABean(destroyMethod = "close")
  public SqlSession getSqlSession() {
    Reader reader = null;
    try {
      reader = Resources.getResourceAsReader(mybatisConfigXml);
      SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
      // 打开一个新的数据库会话
      SqlSession sqlSession = sqlSessionFactory.openSession();
      MySqlSessionManager.setSqlSession(sqlSession);
      return sqlSession;
    } catch (IOException e) {
      log.error("无法获取 SqlSession", e);
      return null;
    }
  }
}

说明:

  • 加载配置文件:通过 Resources.getResourceAsReader(mybatisConfigXml) 加载 mybatis.xml 配置文件。
  • 创建 SqlSessionFactory:使用 SqlSessionFactoryBuilder 构建 SqlSessionFactory。
  • 获取 SqlSession:从 SqlSessionFactory 打开一个新的 SqlSession。
  • 注册 SqlSession:将 SqlSession 设置到 MySqlSessionManager 中,方便全局使用。

配置文件

在上述配置中,mybatis.xml 文件依然被使用,因此需要确保该文件存在并正确配置。

mybatis.xml:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
  <!-- 日志配置 -->
  <settings>
    <setting name="logImpl" value="STDOUT_LOGGING" />
  </settings>

  <!-- 类型别名 -->
  <typeAliases>
    <package name="demo.mybatis.model" />
  </typeAliases>

  <!-- 环境配置 -->
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC" />
      <dataSource type="UNPOOLED">
        <property name="driver" value="org.postgresql.Driver" />
        <property name="url" value="jdbc:postgresql://localhost:5432/your_database" />
        <property name="username" value="your_username" />
        <property name="password" value="your_password" />
      </dataSource>
    </environment>
  </environments>

  <!-- 映射器 -->
  <mappers>
    <mapper resource="SystemAdminMapper.xml" />
  </mappers>
</configuration>

说明:

  • 数据源配置:在 <dataSource> 节点中配置数据库连接信息,请根据实际情况修改。
  • 映射器注册:在 <mappers> 节点中注册 SystemAdminMapper.xml,确保映射器文件被 MyBatis 识别。

在 Controller 中获取 Mapper

创建 MybatisController2,演示如何获取所有注册的 Mapper 并返回其信息。

package demo.mybatis.controller;

import java.util.Collection;

import org.apache.ibatis.binding.MapperRegistry;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSession;

import com.litongjava.annotation.RequestPath;

import demo.mybatis.config.MySqlSessionManager;
import lombok.extern.slf4j.Slf4j;

@Slf4j
@RequestPath("/mybatis2")
public class MybatisController2 {

  @RequestPath("/getMappers")
  public String getMappers() {
    SqlSession sqlSession = MySqlSessionManager.getSqlSession();
    Configuration configuration = sqlSession.getConfiguration();
    MapperRegistry mapperRegistry = configuration.getMapperRegistry();
    Collection<Class<?>> mappers = mapperRegistry.getMappers();
    for (Class<?> c : mappers) {
      log.info("已注册的 Mapper:{}", c.getName());
    }
    return mappers.toString();
  }
}

说明:

  • 获取 SqlSession:从 MySqlSessionManager 获取当前的 SqlSession。
  • 获取配置:通过 sqlSession.getConfiguration() 获取 MyBatis 的配置对象。
  • 获取 Mapper 注册表:从配置中获取 MapperRegistry。
  • 遍历 Mapper:获取所有已注册的 Mapper 并输出其类名。

测试接口:

访问 http://localhost/mybatis2/getMappers,将返回所有已注册的 Mapper 的信息。

测试 SystemAdminController

创建 SystemAdminController,演示如何通过 Mapper 获取数据库中的数据。

package demo.mybatis.controller;

import com.litongjava.annotation.RequestPath;

import demo.mybatis.config.MySqlSessionManager;
import demo.mybatis.mapper.SystemAdminMapper;
import demo.mybatis.model.SystemAdmin;

@RequestPath("/SystemAdmin")
public class SystemAdminController {

  @RequestPath("/getSystemAdmin")
  public SystemAdmin getSystemAdmin() {
    SystemAdminMapper mapper = MySqlSessionManager.getMapper(SystemAdminMapper.class);
    SystemAdmin systemAdmin = mapper.getSystemAdmin(null);
    return systemAdmin;
  }
}

说明:

  • 获取 Mapper:使用 MySqlSessionManager.getMapper(SystemAdminMapper.class) 获取 SystemAdminMapper 实例。
  • 查询数据:调用 mapper.getSystemAdmin(null) 方法,从数据库中查询 SystemAdmin 数据。
  • 返回结果:将查询到的 SystemAdmin 对象返回。

测试接口:

访问 http://localhost/SystemAdmin/getSystemAdmin,将返回数据库中的 SystemAdmin 数据,例如:

{
  "id": 1,
  "loginName": "litong",
  "password": "00000000"
}

重要说明

  • 仍然使用了 mybatis.xml:尽管使用了配置类 MybatisConfig,但仍然通过读取 mybatis.xml 文件来加载 MyBatis 的配置。这种方式结合了配置类和 XML 配置文件的优点。

  • 配置类的作用:MybatisConfig 的主要作用是通过代码方式管理 SqlSession 的创建和生命周期,使其更符合应用程序的管理方式。

  • 为什么使用 mybatis.xml:使用 XML 配置文件可以集中管理 MyBatis 的各种配置,如环境、数据源、Mapper 映射等,使配置更直观清晰。

总结

通过本节的内容,我们了解了如何使用配置类来整合 MyBatis,同时仍然使用 mybatis.xml 配置文件。我们创建了 MySqlSessionManager 来管理 SqlSession,并通过 MybatisConfig 配置类来加载 MyBatis 配置和创建 SqlSession。

在控制器中,我们展示了如何获取 Mapper 并查询数据库数据。通过这些步骤,成功地实现了 MyBatis 与 Tio-Boot 的整合。

完全使用配置类方式整合

下一篇

Edit this page
Last Updated:
Contributors: Tong Li
Next
使用配置类方式整合 MyBatis