Mybatis-Plus极大简化了我们的开发,作为mybatis的增强版,Mybatis-Plus确实帮我们减少了很多SQL语句的编写,通过其提供的API,可以方便地完成增删查改操作。但是,其实除了Mybatis-Plus以外,还有一个技术tk-mybatis可以达到同样的效果,只不过随着MP的兴起,tk-mybatis已经被渐渐淡忘,就像曾经的JSP+Servlet。
因此,为了证明tk-mybatis曾经存在过,这篇文章就详细介绍一下tk-mybatis的使用方法。
目录
第一步:准备数据库
第二步:创建一个springboot项目
第三步:添加tk-mybatis的依赖
第四步:修改配置文件
第五步:创建数据库表对应的实体类
第六步:持久层接口继承自Mapper接口
第七步:使用tk-mybatis的API完成crud
扩展:使用tk-mybatis整合PageHelper实现分页查询
1、添加PageHelper依赖
2、设置分页拦截器
3、在所有代码之前开启分页
第一步:准备数据库
创建数据库tkmybatis,然后执行项目resources目录下的tkmybatis.sql脚本文件。
第二步:创建一个springboot项目
本篇文章将创建一个名为tkmybatis的springboot项目用于演示tkmybatis的使用。
第三步:添加tk-mybatis的依赖
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>1.1.5</version>
</dependency>
项目完整的依赖如下
<?xml version="1.0" encoding="UTF-8"?>
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.9</version>
<relativePath/>
</parent>
<groupId>com.example</groupId>
<artifactId>tkmybatis</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<java.version>1.8</java.version>
<mysql.version>8.0.28</mysql.version>
<druid.version>1.1.21</druid.version>
<lombok.version>1.18.22</lombok.version>
<mybatis.version>2.2.2</mybatis.version>
<tkmybatis.version>1.1.5</tkmybatis.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>${mysql.version}</version>
</dependency>
<!--数据库连接池-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>${druid.version}</version>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>${mybatis.version}</version>
</dependency>
<!--tk.mybatis-->
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>${tkmybatis.version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
第四步:修改配置文件
在application.yml中配置数据源和日志的显示级别
spring:
datasource:
username: root
password: root
url: jdbc:mysql://localhost:3306/tkmybatis
driver-class-name: com.mysql.cj.jdbc.Driver
type: com.alibaba.druid.pool.DruidDataSource
logging:
level:
springfox: error
com.example.tkmybatis: debug
第五步:创建数据库表对应的实体类
package com.example.tkmybatis.entity;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import javax.persistence.Id;
import java.io.Serializable;
import java.time.LocalDateTime;
/**
* 歌曲
* @author heyunlin
* @version 1.0
*/
@Data
public class Song implements Serializable {
private static final long serialVersionUID = 18L;
@Id
private String id;
/**
* 歌曲名
*/
private String name;
/**
* 歌手
*/
private String singer;
/**
* 描述信息
*/
private String note;
/**
* 最后一次修改时间
*/
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private LocalDateTime lastUpdateTime;
}
第六步:持久层接口继承自Mapper接口
package com.example.tkmybatis.mapper;
import com.example.tkmybatis.entity.Song;
import org.springframework.stereotype.Repository;
import tk.mybatis.mapper.common.Mapper;
/**
* @author heyunlin
* @version 1.0
*/
@Repository
public interface SongMapper extends Mapper<Song> {
}
在这点上,其实和mybatis-plus很像,mybatis-plus里是继承BaseMapper<T>接口,然后使用BaseMapper<T>接口中预定义实现的简单crud方法。
但是,tk-mybatis的各个API在继承关系上又和mybatis-plus完全不同,tk-mybatis中,一个接口中只定义一个方法(把接口隔离原则体现的淋漓尽致ovo)。
package tk.mybatis.mapper.common;
public interface Mapper<T> extends
BaseMapper<T>,
ExampleMapper<T>,
RowBoundsMapper<T>,
Marker {
}
可以发现,Mapper接口继承了很多个接口BaseMapper、ExampleMapper和RowBoundsMapper,而BaseMapper又继承了基本的增删查改的Mapper接口BaseSelectMapper、BaseInsertMapper、BaseUpdateMapper和BaseDeleteMapper。
这几个接口又继承了相应的插入、删除、更新或查询的接口,每个接口中只定义一个方法。
BaseMapper.java
package tk.mybatis.mapper.common;
import tk.mybatis.mapper.common.base.BaseDeleteMapper;
import tk.mybatis.mapper.common.base.BaseInsertMapper;
import tk.mybatis.mapper.common.base.BaseSelectMapper;
import tk.mybatis.mapper.common.base.BaseUpdateMapper;
public interface BaseMapper<T> extends
BaseSelectMapper<T>,
BaseInsertMapper<T>,
BaseUpdateMapper<T>,
BaseDeleteMapper<T> {
}
BaseSelectMapper.java
package tk.mybatis.mapper.common.base;
import tk.mybatis.mapper.common.base.select.*;
public interface BaseSelectMapper<T> extends
SelectOneMapper<T>,
SelectMapper<T>,
SelectAllMapper<T>,
SelectCountMapper<T>,
SelectByPrimaryKeyMapper<T>,
ExistsWithPrimaryKeyMapper<T> {
}
第七步:使用tk-mybatis的API完成crud
tk-mybatis中两个重要的API相关说明:
- tk.mybatis.mapper.entity.Example
- tk.mybatis.mapper.entity.Example.Criteria
1、创建Example对象
2、通过Example的静态方法createCriteria()获取Criteria对象
接下来通过测试类测试tkmybatis的API方法
package com.example.tkmybatis;
import com.example.tkmybatis.entity.Song;
import com.example.tkmybatis.mapper.SongMapper;
import com.example.tkmybatis.util.StringUtils;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import tk.mybatis.mapper.entity.Example;
import java.util.List;
@SpringBootTest
class TkMybatisTests {
@Autowired
private SongMapper songMapper;
@Test
void testInsert() {
Song song = new Song();
song.setId(StringUtils.uuid());
song.setName("稻香");
song.setSinger("周杰伦");
// 添加
songMapper.insert(song);
// 选择性添加
// 拼接sql语句时会在每个字段设置前添加null判断,只有不为null才设置到set子句
songMapper.insertSelective(song);
}
@Test
void testUpdate() {
Song song = new Song();
song.setId(StringUtils.uuid());
song.setName("稻香");
song.setSinger("周杰伦");
// 通过主键修改
songMapper.updateByPrimaryKey(song);
// 通过主键选择性修改
songMapper.updateByPrimaryKeySelective(song);
}
@Test
void testUpdateByExample() {
Song song = new Song();
song.setId(StringUtils.uuid());
song.setName("稻香");
song.setSinger("周杰伦");
Example example = new Example(Song.class);
Example.Criteria criteria = example.createCriteria();
criteria.andCondition("name = ", song.getName());
// 通过Example中设置的条件修改
songMapper.updateByExample(song, example);
// 通过Example中设置的条件选择性地修改
songMapper.updateByExampleSelective(song, example);
}
@Test
void testSelect() {
Song song = new Song();
song.setName("稻香");
song.setSinger("周杰伦");
// 根据song中设置字段作为条件查询条件
List<Song> select = songMapper.select(song);
// 根据主键查询(也就是@Id注解标注的字段)
Song selectByPrimaryKey = songMapper.selectByPrimaryKey("123");
// 查询全部
List<Song> selectAll = songMapper.selectAll();
// 同select()方法,当能够确定查询结果中最多只有一条记录时可以使用此方法
Song selectOne = songMapper.selectOne(song);
// 根据song中设置字段作为条件查询条件,返回符合条件的记录数
int selectCount = songMapper.selectCount(song);
}
@Test
void testSelectByExample() {
Example example = new Example(Song.class);
Example.Criteria criteria = example.createCriteria();
example.setOrderByClause("last_update_time");
criteria.andCondition("name = ", "稻香");
criteria.andCondition("singer = ", "周杰伦");
List<Song> list = songMapper.selectByExample(example);
int count = songMapper.selectCountByExample(example);
}
}
扩展:使用tk-mybatis整合PageHelper实现分页查询
和mybatis-plus不同,tk-mybatis并没有帮我们实现分页功能,需要整合PageHelper来实现分页查询。
1、添加PageHelper依赖
<!-- 分页插件 -->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper</artifactId>
<version>5.1.4</version>
</dependency>
2、设置分页拦截器
package com.example.tkmybatis.config;
import com.alibaba.druid.pool.DruidDataSource;
import com.github.pagehelper.PageInterceptor;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import javax.sql.DataSource;
import java.util.Properties;
/**
* Mybatis配置类
* @author heyunlin
* @version 1.0
*/
@Configuration
@MapperScan("com.example.tkmybatis.mapper")
public class MybatisConfig {
@Bean
@Primary
@ConfigurationProperties(prefix = "spring.datasource")
public DataSource getDataSource() {
return DataSourceBuilder.create().type(DruidDataSource.class).build();
}
/**
* 定义创建Session工厂Bean的方法
* @return SqlSessionFactoryBean
*/
@Bean
public SqlSessionFactoryBean sqlSessionFactoryBean() {
// 定义MyBatis的Session工厂对象,用于产生MyBatis全局的会话工厂
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
// 设置数据源
sqlSessionFactoryBean.setDataSource(getDataSource());
Properties properties = new Properties();
properties.setProperty("reasonable", "true");
properties.setProperty("pageSizeZero", "true");
properties.setProperty("supportMethodsArguments", "true");
// 创建分页拦截器
PageInterceptor interceptor = new PageInterceptor();
interceptor.setProperties(properties);
// 添加分页拦截器
sqlSessionFactoryBean.setPlugins(interceptor);
return sqlSessionFactoryBean;
}
}
3、在所有代码之前开启分页
在所有代码之前添加PageHelper.startPage(int page, int size)方法开启分页。例如:
package com.example.tkmybatis;
import com.example.tkmybatis.dto.SongPagerDTO;
import com.example.tkmybatis.entity.Song;
import com.example.tkmybatis.mapper.SongMapper;
import com.example.tkmybatis.util.StringUtils;
import com.github.pagehelper.PageHelper;
import org.apache.ibatis.session.RowBounds;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import tk.mybatis.mapper.entity.Example;
import java.util.List;
@SpringBootTest
class TkMybatisTests {
@Autowired
private SongMapper songMapper;
@Test
void testSelectByPage() {
// 模拟后台传的参数
SongPagerDTO pagerDTO = new SongPagerDTO();
pagerDTO.setName("爱");
PageHelper.startPage(pagerDTO.getPage(), pagerDTO.getRows());
Example example = new Example(Song.class);
Example.Criteria criteria = example.createCriteria();
if (StringUtils.isNotEmpty(pagerDTO.getName())) {
criteria.andLike("name", "%".concat(pagerDTO.getName()).concat("%"));
}
List<Song> list = songMapper.selectByExample(example);
int count = songMapper.selectCountByExample(example);
// 封装查询结果返回
}
}
整个项目的结构如下
好了,文章就分享到这里了,文章设计代码已经上传到git仓库,按需获取文章来源:https://www.toymoban.com/news/detail-655315.html
tkmybatis使用详解案例项目https://gitee.com/he-yunlin/tkmybatis.git文章来源地址https://www.toymoban.com/news/detail-655315.html
到了这里,关于tk-mybatis使用介绍,springboot整合tk-mybatis、PageHelper实现分页查询的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!