介绍
dbVisitor 是一个全功能数据库访问 ORM 工具，提供对象映射、丰富的类型处理、动态 SQL、存储过程、 内置分页方言 20+、 支持嵌套事务、多数据源、条件构造器、INSERT 策略、多语句 / 多结果。并兼容 Spring 及 MyBatis 用法。 它不依赖任何其它框架，因此可以很方便的和任意一个框架整合在一起使用。
依赖
<dependency>
<groupId>net.hasor</groupId>
<artifactId>dbvisitor</artifactId>
<version>5.4.1</version>
</dependency>
- 修复：DataSourceUtils 在动态 DataSource 情况下的内存泄漏问题
- 修复：OracleDialect 拼写 tableName 时 catalog/schema 的处理问题
功能特性
-
熟悉的方式
- JdbcTemplate 接口方式（高度兼容 Spring JDBC）
- Mapper 文件方式（高度兼容 MyBatis）
- LambdaTemplate （高度接近 MyBatis Plus、jOOQ 和 BeetlSQL）
- @Insert、@Update、@Delete、@Query、@Callable 注解（类似 JPA）
-
事务支持
- 支持 5 个事务隔离级别、7 个事务传播行为（与 Spring tx 相同）
- 提供 TransactionTemplate、TransactionManager 接口方式声明式事务控制能力（用法与 Spring 相同）
-
特色优势
- 支持 分页查询 并且提供多种数据库方言（20+）
- 支持 INSERT 策略（INTO、UPDATE、IGNORE）
- 更加丰富的 TypeHandler（MyBatis 40+，dbVisitor 60+）
- Mapper XML 支持多语句、多结果
- 提供独特的
@{xxx, expr , xxxxx } 规则扩展机制，让动态 SQL 更加简单
- 支持 存储过程
- 支持 JDBC 4.2 和 Java8 中时间类型
- 支持多数据源
执行 SQL
使用 SQL 的方式读取数据，PrintUtils 和 DsUtils.java 两个工具类可以在 例子工程 中找到
// 创建数据源
DataSource dataSource = DsUtils.dsMySql();
// 创建 JdbcTemplate 对象
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
// 加载测试数据脚本
jdbcTemplate.loadSQL("CreateDB.sql");
// 查询数据并 Map 形式返回
List<Map<String, Object>> mapList = jdbcTemplate.queryForList("select * from test_user");
// 打印测试数据
PrintUtils.printMapList(mapList);
控制台可以得到如下结果
/--------------------------------------------\
| id | name | age | create_time |
|--------------------------------------------|
| 1 | mali | 26 | 2021-11-12 19:14:06.0 |
| 2 | dative | 32 | 2021-11-12 19:14:06.0 |
| 3 | jon wes | 41 | 2021-11-12 19:14:06.0 |
| 4 | mary | 66 | 2021-11-12 19:14:06.0 |
| 5 | matt | 25 | 2021-11-12 19:14:06.0 |
\--------------------------------------------/
如果想使用 DTO 对象接收数据，则需要创建一个 DTO 对象。
// 因此可以简单的通过 @Table 注解声明一下
// - `test_user` 通过驼峰转换后可以得到类名 `TestUser`
@Table(mapUnderscoreToCamelCase = true)
public class TestUser {
private Integer id;
private String name;
private Integer age;
private Date createTime;
// getters and setters omitted
}
然后通过 queryForList 方法直接查询
List<TestUser> dtoList = jdbcTemplate.queryForList("select * from test_user", TestUser.class);
单表 CRUD
对于单表 CRUD 操作可以使用 JdbcTemplate 的子类 LambdaTemplate
// 创建数据源
DataSource dataSource = DsUtils.dsMySql();
// 创建 LambdaTemplate 对象和创建 JdbcTemplate 一样
LambdaTemplate lambdaTemplate = new LambdaTemplate(dataSource);
// 查询，所有数据
List<TestUser> dtoList = lambdaTemplate.lambdaQuery(TestUser.class)
.queryForList();
// 插入新数据
TestUser newUser = new TestUser();
newUser.setName("new User");
newUser.setAge(33);
newUser.setCreateTime(new Date());
int result = lambdaTemplate.lambdaInsert(TestUser.class)
.applyEntity(newUser)
.executeSumResult();
// 更新，将name 从 mali 更新为 mala
TestUser sample = new TestUser();
sample.setName("mala");
int result = lambdaTemplate.lambdaUpdate(TestUser.class)
.eq(TestUser::getId, 1)
.updateBySample(sample)
.doUpdate();
// 删除，ID 为 2 的数据
int result = lambdaTemplate.lambdaUpdate(TestUser.class)
.eq(TestUser::getId, 2)
.doDelete();
通用 Mapper
通用 Mapper 接口来完成一些基本操作，仍然以单表 CRUD 为例。
// 创建数据源
DataSource dataSource = DsUtils.dsMySql();
// 创建通用 DAO
DalSession session = new DalSession(dataSource);
BaseMapper<TestUser> baseMapper = session.createBaseMapper(TestUser.class);
// 初始化一些数据
baseMapper.template().loadSQL("CreateDB.sql");
// 查询数据
List<TestUser> dtoList = baseMapper.query().queryForList();
PrintUtils.printObjectList(dtoList);
// 插入新数据
TestUser newUser = new TestUser();
newUser.setName("new User");
newUser.setAge(33);
newUser.setCreateTime(new Date());
int result = baseMapper.insert(newUser);
// 更新，将name 从 mali 更新为 mala
TestUser sample = baseMapper.queryById(1);
sample.setName("mala");
int result = baseMapper.updateById(sample);
// 删除，ID 为 2 的数据
int result = baseMapper.deleteById(2);
注解化 Mapper
作为 Mapper 可以定义自己的方法，并通过注解具体执行的 SQL 语句。
// BaseMapper 是可选的，继承它相当于多了一组单表 CURD 的扩展功能。
@SimpleMapper
public interface TestUserDAO extends BaseMapper<TestUser> {
@Insert("insert into `test_user` (name,age,create_time) values (#{name}, #{age}, now())")
int insertUser(@Param("name") String name,
@Param("age") int age);
@Update("update `test_user` set age = #{age} where id = #{id}")
int updateAge(@Param("id") int userId,
@Param("age") int newAge);
@Delete("delete from `test_user` where age > #{age}")
int deleteByAge(@Param("age") int age);
@Query(value = "select * from `test_user` where #{beginAge} < age and age < #{endAge}",
resultType = TestUser.class)
List<TestUser> queryByAge(@Param("beginAge") int beginAge,
@Param("endAge") int endAge);
}
//创建 Session
DalSession session = new DalSession(dataSource);
// 创建 Mapper 接口
TestUserMapper userDAO = session.createMapper(TestUserMapper.class);
使用 XML 管理 SQL
统一管理 SQL 的最佳场所仍然是 Mapper 文件，而且 dbVisitor 的 Mapper 文件高度兼容 MyBatis 学习成本极低。
// 利用 @RefMapper 注解将 Mapper 文件和 接口类联系起来（继承 BaseMapper 是可选的）
@RefMapper("/mapper/quick_dao3/TestUserMapper.xml")
public interface TestUserDAO extends BaseMapper<TestUser> {
int insertUser(@Param("name") String name,
@Param("age") int age);
int updateAge(@Param("id") int userId,
@Param("age") int newAge);
int deleteByAge(@Param("age") int age);
List<TestUser> queryByAge(@Param("beginAge") int beginAge,
@Param("endAge") int endAge);
}
为了更好了解和使用 dbVisitor 的 Mapper 文件建议增加 DTD加以验证。另外 dbVisitor 兼容 MyBatis3 的 DTD 对于绝大部分 MyBatis 工程都可以正常兼容。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//dbvisitor.net//DTD Mapper 1.0//EN"
"https://www.dbvisitor.net/schema/dbvisitor-mapper.dtd">
<mapper namespace="com.example.demo.quick.dao3.TestUserDAO">
<resultMap id="testuser_resultMap" type="com.example.demo.quick.dao3.TestUser">
<result column="id" property="id"/>
<result column="name" property="name"/>
<result column="age" property="age"/>
<result column="create_time" property="createTime"/>
</resultMap>
<sql id="testuser_columns">
name,age,create_time
</sql>
<insert id="insertUser">
insert into `test_user` (
<include refid="testuser_columns"/>
) values (
#{name}, #{age}, now()
)
</insert>
<update id="updateAge">
update `test_user` set age = #{age} where id = #{id}
</update>
<delete id="deleteByAge"><![CDATA[
delete from `test_user` where age > #{age}
]]></delete>
<select id="queryByAge" resultMap="testuser_resultMap">
select id,<include refid="testuser_columns"/>
from `test_user`
where #{beginAge} < age and age < #{endAge}
</select>
<select id="queryAll" resultMap="testuser_resultMap">
select id,<include refid="testuser_columns"/>
from `test_user`
</select>
</mapper>
利用规则简化 XML 配置
规则是将一组语句操作封装成为一个规则函数，通过引用规则而减少 SQL 配置。
使用 and 规则
<select id="queryUser">
select * from `test_user`
@{and, age = :age}
@{and, id in (:list)}
</select>
原始的 mybatis 方式处理
<select id="queryUser">
select * from `test_user`
where 1 = 1
<if test="age != null">
and age = #{age}
</if>
and id in <foreach item="item" index="index" collection="list"
open="(" separator="," close=")">
#{item}
</foreach>
#{item}
</select>
分页查询
LambdaTemplate 单表分页查询
// 构造 LambdaTemplate 和初始化一些数据
DataSource dataSource = DsUtils.dsMySql();
LambdaTemplate lambdaTemplate = new LambdaTemplate(dataSource);
lambdaTemplate.loadSQL("CreateDB.sql");
// 构建分页对象，每页 3 条数据(默认第一页的页码为 0)
Page pageInfo = new PageObject();
pageInfo.setPageSize(3);
// 分页查询数据
List<TestUser> pageData1 = lambdaTemplate.lambdaQuery(TestUser.class)
.usePage(pageInfo)
.queryForList();
// 分页查询下一页数据
pageInfo.nextPage();
List<TestUser> pageData2 = lambdaTemplate.lambdaQuery(TestUser.class)
.usePage(pageInfo)
.queryForList();
Mapper 文件分页查询
@RefMapper("/mapper/quick_page3/TestUserMapper.xml")
public interface TestUserDAO extends BaseMapper<TestUser> {
// 可以直接返回分页之后的数据结果
List<TestUser> queryByAge(@Param("beginAge") int beginAge,
@Param("endAge") int endAge,
Page pageInfo);
// 也可以返回包含分页信息的分页结果
List<TestUser> queryByAge(@Param("beginAge") int beginAge,
@Param("endAge") int endAge,
Page pageInfo);
}
// 构建分页条件
Page pageInfo = new PageObject();
pageInfo.setPageSize(3);
// 分页方式查询 mapper 中的查询
List<TestUser> data1 = userDAO.queryByAge(25, 100, pageInfo);
PageResult<TestUser> page1 = userDAO.queryByAge2(25, 100, pageInfo);
// 分页方式查询 mapper 中的查询
pageInfo.nextPage();
List<TestUser> data2 = userDAO.queryByAge(25, 100, pageInfo);
PageResult<TestUser> page2 = userDAO.queryByAge2(25, 100, pageInfo);
相关链接
官方网站：https://www.dbvisitor.net/
源码地址：https://gitee.com/zycgit/dbvisitor
Spring Boot 整合手册，https://www.dbvisitor.net/docs/integration/with-springboot
快速上手：https://www.dbvisitor.net/docs/guides/quickstart
