Java：SpringBoot系列——第七章 整合tkMapper

已于 2023-01-13 13:18:14 修改
阅读量485 收藏 1
点赞数
文章标签： java spring boot mybatis
于 2023-01-13 13:13:09 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/chenyouchang/article/details/128672542
版权

SpringBoot系列——第七章 整合tkMapper

文章目录

前言

基于mybatis提供了很多第三方插件，这些插件通常可以帮助我们完成数据操作方法的封装、数据库逆向工程工作的工作

一、在项目开发中DAO的实现问题

为什么需要用到tkMapper

1. 实体类与数据表的关系

实现类与数据表直接存在对应关系，并且是有规律的，因此我们只要指定数据表的结构，就能生成实体类

在这里插入图片描述

2. DAO接口中方法的规律

所有DAO接口中定义的方法也是有一定规律的，不同点就是实体类型的不同

  • UserDAO
public interface UserDAO {
   
    public int insertUser(User user);
    public User queryUserByName(String userName);
}
  • BookDAO
public interface BookDAO {
   
    public int insertBook(Book book);
    public Book queryBookByName(String bookName);
}

把它们相同的部分抽取出来，定义一个通用接口，再它们继承这个接口

public interface GeneralDAO<T> {

    public int insert(T t);
    public T queryByName(String name);
}
  • UserDAo
public interface UserDAO extends GeneralDAO<User>{
}
  • BookDAO
public interface BookDAO extends GeneralDAO<Book>{
}

3. Mapper映射文件的规律

GeneralDAO接口中定义的数据库操作方法使用了泛型，因此无需映射文件；对应UserDAO和BookDAO需要映射文件，所有DAO的相同操作的映射文件也是有规律可循的

  • UserMapper
<insert id="insert">
    insert into users(user_id,username)
    values (#{userId},#{username})
</insert>

@Table
public class User {
	@Id
	@Column("user_id")
	private int userId;
	@Column("username")
	private String username;
}
  • BookMapper
<insert id="insert">
    insert into books(book_id,book_name)
    values (#{bookId},#{bookName})
</insert>

@Table
public class Book {
	@Id
	@Column("book_id")
	private int bookId;
	@Column("book_name")
	private String BookName;
}

二、tkMapper的概述

基于mybatis提供了很多第三方插件，这些插件通常可以帮助我们完成数据操作方法的封装、数据库逆向工程工作的工作

数据库逆向工程：根据数据表生成实体类、映射文件。

常用的第三方插件：

  • MyBatis-plus
  • tkMapper

1. tkMapper的介绍

tkMapper是一个Mybatis插件，是在Mybatis的基础上提供了许多工具，可以帮助我们完成对应数据库的相关操作，提高开发效率。

2. tkMapper的作用

  • 提供了针对表通用的数据库操作方法
  • 逆向工程–根据数据表生成实体类、dao接口、映射文件

三、tkMapper集成部署

1. 基于SpringBoot完成MyBatis的集成

1.1 创建SpringBoot项目
  1. File–New–Project–Spring Initializr
  2. 填写项目信息
  • 远程服务器
  • 项目名
  • 本地JDK与远程服务器下载的应用JDK要保持一致

在这里插入图片描述

  1. 下载应用的配置
  • 下载的SpringBoot版本
  • 添加的依赖

在这里插入图片描述

1.2 配置MyBatis

在SpringBoot配置文件配置mybatis

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db6?serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=123456


mybatis.mapper-locations=classpath:mappers/*Mapper.xml
mybatis.type-aliases-package=com.xiaoqing.springboottkmapperdemo.beans
1.3 在启动类指定DAO类的路径
@SpringBootApplication
@MapperScan("com.xiaoqing.springboottkmapperdemo.dao")//指定DAO类的路径
public class SpringbootTkmapperDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootTkmapperDemoApplication.class, args);
    }

}

2. SpringBoot集成tkMapper

2.1 添加依赖

在pom.xml中添加依赖

<!-- https://mvnrepository.com/artifact/tk.mybatis/mapper-spring-boot-starter -->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.5</version>
</dependency>
2.2 修改启动类@MapperScan的包

修改tk.mybatis的包为tk.mybatis.spring.annotation.MapperScan，不修改会报错

在这里插入图片描述
在这里插入图片描述

package com.xiaoqing.springboottkmapperdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import tk.mybatis.spring.annotation.MapperScan;

@SpringBootApplication
//@MapperScan("com.xiaoqing.springboottkmapperdemo.dao")
@MapperScan("com.xiaoqing.springboottkmapperdemo.dao")
public class SpringbootTkmapperDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootTkmapperDemoApplication.class, args);
    }
}

至此，tkMapper部署完成

四、tkMapper的使用

1. 创建数据表

创建数据表

  • users
DROP TABLE IF EXISTS `users`;
CREATE TABLE `users` (
  `user_id` int(11) NOT NULL AUTO_INCREMENT,
  `user_name` varchar(20) NOT NULL,
  `user_pwd` varchar(20) NOT NULL,
  `user_realname` varchar(20) NOT NULL,
  `user_img` varchar(100) DEFAULT NULL,
  PRIMARY KEY (`user_id`)
) ENGINE=InnoDB AUTO_INCREMENT=17 DEFAULT CHARSET=utf8;

2. 创建实体类

tkMapper，在映射的时候，实体类名要与数据库表名保持一致（实体类名为表名首字母大写、带有下划线‘_’的名字，省去下划线，下划线后的第一个首字母大写）

如果表名和实体类名不对应会报错，一共有两种解决方式：

  • 修改实体类名，与表名对应
  • 使用@Table（）注解指定表名
@Data
@NoArgsConstructor
@AllArgsConstructor
@Table(name = "users") //指定数据库中的表名
public class User {
    private int userId;
    private String userName;
    private String userPwd;
    private String userRealname;
    private String userImg;
}

3. 创建DAO接口

tkMapper已经完成了对单表的通用操作的封装，主要封装在Mapper接口和MysqlMapper接口中，因此我们如果要完成对单表的操作，只需要自定义dao接口继承这两个接口即可 。

在测试类的时候userdao会报错，提示“找不到userdao”，这里可以忽略(因为是可以获取到的)，可以在接口中使用@Repository注解就不会提示错误

  • UserDAO
@Repository
public interface UserDAO extends Mapper<User>, MySqlMapper<User> {
}

4. 创建测试类

4.1 添加依赖
  • junit
  • Spring-test
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <scope>4.13.2</scope>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
</dependency>
4.2 测试类

@RunWith 声明单元测试的驱动

@SpringBootTest 声明启动类的路径

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = SpringbootTkmapperDemoApplication.class)
public class UserDAOTest {
    @Autowired
    private UserDAO userDAO;
    @Test
    public void insert(){
        User user = new User();
        user.setUserName("hong");
        user.setUserPwd("123456");
        user.setUserRealname("小红");
        user.setUserImg("12.png");
        int insert = userDAO.insert(user);
        System.out.println(insert);
    }
}
4.3 测试结果

在这里插入图片描述

五、tkMapper的常用方法

1. 添加操作

添加操作的常用方法有两个：

  • insert() 添加一个对象

  • insertUseGeneratedKeys() 添加一个对象并进行主键回填

    在进行主键回填的时候，实体类中id必须要用@Id指定，并且主键的数据类型改为Integer（通过反射）

1.1 添加一个对象
@Test
public void insert(){

    User user = new User();
    user.setUserName("ming");
    user.setUserPwd("123456");
    user.setUserRealname("小明");
    user.setUserImg("13.png");

    int i = userDAO.insert(user);
    assertEquals(1,i);

}

测试结果：

在这里插入图片描述

1.2 主键回填的添加

在进行主键回填的时候,实体类中id必须要用@Id指定，并且主键的数据类型改为Integer，不然获取不到回填的主键，因为tkMapper底层是通过反射实现的

@Test
public void insertUseGeneratedKeys(){
    User user = new User();
    user.setUserName("xiao");
    user.setUserPwd("888888");
    user.setUserRealname("笑笑");
    user.setUserImg("16.png");

    int i = userDAO.insertUseGeneratedKeys(user);
    assertEquals(1,i);
    System.out.println("回填的主键：" + user.getUserId());
}

在这里插入图片描述

测试结果

在这里插入图片描述

2. 修改操作

修改操作的常用方法：

  • updateByPrimaryKey() 根据主键修改记录
  • updateByExample() 根据条件删除记录
2.1 根据主键修改记录
@Test
public void update(){

    User user = new User();
    user.setUserId(17);
    user.setUserName("pipi");
    user.setUserPwd("666666");
    user.setUserRealname("pipi");
    user.setUserImg("18.png");

    int i = userDAO.updateByPrimaryKey(user);
    assertEquals(1,i);
}
  • 修改前

在这里插入图片描述

  • 修改后

在这里插入图片描述

3. 删除操作

删除操作常用方法：

  • deleteByPrimaryKey() 根据主键删除记录
  • deleteByExample() 根据条件删除记录
3.1 根据主键删除记录
@Test
public void delete(){

    int i = userDAO.deleteByPrimaryKey(17);
    assertEquals(1,i);
}

4. 查询操作

查询操作常用方法：

  • selectAll() 查询所有记录
  • selectByPrimaryKey() 根据主键查询
  • selectByExample() 根据条件查询
  • selectByRowBounds() 分页查询
  • selectCount() 查询总记录数
  • selectByExampleAndRowBounds() 带条件的分页查询
  • selectCountByExample()查询满足条件的总记录数
4.1 查询所有记录
@Test
public void select(){
    List<User> users = userDAO.selectAll();
    for (User user:
         users) {
        System.out.println(user);
    }
}

测试结果：

在这里插入图片描述

4.2 根据主键查询记录
@Test
public void select(){

    User user = userDAO.selectByPrimaryKey(18);
    System.out.println(user);
}

测试结果：

在这里插入图片描述

4.3 根据条件查询

1.查询用户名为xiao和hong的记录

@Test
public void select(){

    //根据条件查询
    //创建一个EXample对象用于封装User的查询条件
    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();

    //封装条件：userName为xiao或者hong
    criteria.andEqualTo("userName","xiao");
    criteria.orEqualTo("userName","hong");

    List<User> users = userDAO.selectByExample(example);
    for (User user:users) {
    	System.out.println(user);
    }
}

测试结果:

在这里插入图片描述

2.查询用户名带“x”的记录

    @Test
    public void select(){
        //根据条件查询
        //创建一个EXample对象用于封装User的查询条件
        Example example = new Example(User.class);
        Example.Criteria criteria = example.createCriteria();
        //查询用户名带“x”的记录
        criteria.andLike("userName","%x%");

        List<User> users = userDAO.selectByExample(example);
        for (User user:
             users) {
            System.out.println(user);
        }
    }

测试结果：

在这里插入图片描述

4.4 分页查询

查询第二页，每页五条记录,总记录数

@Test
public void select(){
    //分页查询
    int pageNum = 2;
    int pageSize = 5;
    int start = (pageNum - 1) * pageSize;

    RowBounds rowBounds = new RowBounds(start,pageSize);
    List<User> users = userDAO.selectByRowBounds(new User(), rowBounds);
    for (User user:
         users) {
        System.out.println(user);
    }
    //查询总记录数
    int count = userDAO.selectCount(new User());
    System.out.println(count);
}

查询结果

在这里插入图片描述

4.5 带条件的分页查询

查询密码为123456的第二页，每页五条记录，满足条件的总记录数

@Test
public void select2(){
    //条件
    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();
    criteria.andEqualTo("userPwd","123456");

    //分页查询
    int pageNum = 2;//第几页
    int pageSize = 5;//每页的条数
    int start = (pageNum - 1) * pageSize;
    RowBounds rowBounds = new RowBounds(start,pageSize);

    List<User> users = userDAO.selectByExampleAndRowBounds(example, rowBounds);
    for (User user:
            users) {
        System.out.println(user);
    }
    //查询满足条件的总记录数
    int count = userDAO.selectCountByExample(example);
    System.out.println(count);
}

查询结果：

在这里插入图片描述

六、tkMapper的关联查询

关联查询有两种策略：

  • 进行多次单表查询
  • 自定义查询

1. 多次单表查询

查询用户同时查询订单

①在User实体类private List orderList属性

②根据用户名查询出用户记录

③获取到用户记录的userId

④再根据userId去订单表查询符合条件订单记录

⑤最后将订单列表设置到用户orderList属性

@Test
public void select3(){
    //查询用户的同时查询订单

    //根据用户名查询用户
    Example example = new Example(User.class);
    Example.Criteria criteria = example.createCriteria();
    criteria.andEqualTo("userName","zhangsan");

    List<User> users = userDAO.selectByExample(example);
    User user = users.get(0);

    //根据用户id查询订单
    Example example1 = new Example(Order.class);
    Example.Criteria criteria1 = example1.createCriteria();
    criteria1.andEqualTo("userId",user.getUserId());
    List<Order> orders = orderDAO.selectByExample(example1);

    //将顶顶设置到user中
    user.setOrderList(orders);
    System.out.println(user);
}

查询结果：

在这里插入图片描述

2. 自定义查询

自定义查询是UserMapper.xml文件查询。

七、基于tkMapper的逆向工程

逆向工程，就是根据创建好的数据表，生成实体类、dao、映射文件

1. 添加逆向工程依赖

此依赖是一个mybatis的maven插件,在build标签里添加

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.5</version>

    <!--插件需要的依赖-->
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.1.5</version>
        </dependency>
    </dependencies>
</plugin>

2. 逆向工程配置

在com/xiaoqing/general目录下创建GeneralDao接口

注意：‘GeneralDao’,不能在dao包里

package general;

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

public interface GeneralDao<T> extends Mapper<T>, MySqlMapper<T> {
}

在resources目录下创建generatorConfig.xml，在里面定义了需要生成的表，以及生成文件的路径等信息

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!-- 引入数据库连接配置 -->
    <!--    <properties resource="jdbc.properties"/>-->

    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!-- 配置 GeneralDAO -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="com.xiaoqing.general.GeneralDao"/>
        </plugin>

        <!-- 配置数据库连接 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/fmmail"
                        userId="root" password="123456">
        </jdbcConnection>

        <!-- 配置实体类存放路径 -->
        <javaModelGenerator targetPackage="com.xiaoqing.springboottkmapperdemo.beans" targetProject="src/main/java"/>

        <!-- 配置 XML 存放路径 -->
        <sqlMapGenerator targetPackage="/" targetProject="src/main/resources/mappers"/>

        <!-- 配置 DAO 存放路径 -->
        <javaClientGenerator targetPackage="com.xiaoqing.springboottkmapperdemo.dao" targetProject="src/main/java" type="XMLMAPPER"/>

        <!-- 配置需要指定生成的数据库和表，% 代表所有表 -->
        <table tableName="%"></table>
    </context>
</generatorConfiguration>

3. 将配置文件设置到maven插件中

pom.xml

在这里插入图片描述

<configuration>
    <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
</configuration>

4. 执行逆向生成

双击mybatis:generator:generate

在这里插入图片描述

出现BUILD SUCCESS则逆向成功

在这里插入图片描述

通过逆向生成的实体类、DAO和mapper

在这里插入图片描述

在这里插入图片描述

Julissa.
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
spring-boot+tk.mybatis通用mapper
08-25
spring-boot+tk.mybatis通用mapper
SpringBoot:SpringBoot系列demo
05-14
弹簧靴 Spring Boot系列演示
Springboot整合TKMapper
龙山大佛爷的博客
09-28 442
Springboot整合TKMapper 使用TKMapper无需再创建mapper.xml文件 首先基于springboot完成对MyBatis的整合，然后再对TKMapper进行整合 1 创建springboot项目 勾选必要的依赖 整合mybatis 引入了mybatis的依赖，就需要配置数据库，创建 application.yml文件 spring: datasource: url: jdbc:mysql://192.168.1.2:3306/learn_tkmapper?serve
Springboot整合tkMapper
weixin_48319193的博客
12-15 899
<dependency> <groupId>tk.mybatis</groupId> <artifactId>mapper-spring-boot-starter</artifactId> <version>2.1.5</version> </dependency> package com.ycz.ent...
springboot集成tkmapper及基本使用
打怪升级
08-06 779
springboot集成tkmapper基本使用
SpringBoot 整合TKMapper
mekave的博客
02-26 1122
TKMapper入门说明优势添加依赖添加插件application.yml 配置MapperScan开始使用源码地址 说明 TKMapper（通用mapper，以下简称tk）。 由于TKMapper有以下特性，值得研究是否有必要引入作公司内部框架，提高开发效率 优势 1、 不再需要用户手写单表的CRUD 2、 相比于公司的工具，不再需要生成单表的Example相关的类，精简了代码 3、 提供MBG...
springboot-project:springboot系列demo
05-18
springboot系列demo，在前一个的工程上集成新的功能 01.spring-boot-mybatis-demo spring boot 集成mybatis，mybatis-generator 02.spring-boot-redis-demo 在01的基础上集成redis，logback 03.spring-boot-dynamic...
springboot2:springboot2整合中间件
03-16
SpringBoot2是一个基于Java的轻量级框架，它极大地简化了Spring应用的初始搭建以及开发过程。这个项目主题是“SpringBoot2整合中间件”，意味着我们将探讨如何在SpringBoot2项目中集成各种常用的中间件技术，以提升...
springboot-mybatis-oracle-demo:springboot+mybatis+oracle整合
05-16
《SpringBoot、MyBatis与Oracle数据库整合的深度解析》 在现代的Java开发中，SpringBoot因其便捷的配置和快速的应用开发能力，已经成为企业级应用的首选框架。而MyBatis作为轻量级的持久层框架，以其灵活的SQL映射...
SpringBoot：SpringBoot整合类别框架和应用
02-04
SpringBoot整合类别框架和应用所有代码都通过测试，并且真实有效简介本仓库整合了一些工作中经常用到的一些技术。总体深度较浅，但会持续更新，并且会慢慢加深。文件数据库相关中间件相关定时任务相关API文档相关 .....
springboot-tkmapper:springboot集成mybatis,pageHelper,tkmapper
05-13
springboot-tkmapper springboot集成mybatis，pageHelper，tkmapper
SpringBoot+tk.Mybatis整合+yml配置+logback配置
09-11
微服务框架SpringBoot+通用Mapper（tk.Mybatis）整个项目架构，直接上手开用，yml和logback配置都已经配置完好
spring-boot 集成 tk mybatis
07-19
spring-boot 集成 tk mybatis ， 适用于oracle、mysql
Spring Boot整合tk.Mapper/通用Mapper
做兴趣使然的Hero
08-04 349
1 简介 通用Mapper都可以极大的方便开发人员。可以随意的按照自己的需要选择通用方法，还可以很方便的开发自己的通用方法。 极其方便的使用MyBatis单表的增删改查。 支持单表操作，不支持通用的多表联合查询。 通用 Mapper 支持 Mybatis-3.2.4 及以上版本。 简介: 在早期项目文档中有过类似主题的内容，但是最近我自己看文档的时候发现一个问题，文档虽然很详细，但是并不适合初次接触的人。为了方便第一次听说，第一次尝试的开发人员了解通用 Mapper，补充此文档。 Gitee地址：http
Spring Boot 中使用 tkMapper
最新发布
m0_73311735的博客
11-10 1295
tkMapper 就是一个 MyBatis 插件，基于 MyBatis 提供很多工具，提高开发效率，主要有以下两个功能。提供针对单表通用的数据库操作方法逆向工程（根据数据表自动生成实体类、Dao 接口、Mapper 映射文件）
springboot集成tk.mapper
KnifeBlade的博客
11-08 625
引入依赖： &lt;dependency&gt; &lt;groupId&gt;tk.mybatis&lt;/groupId&gt; &lt;artifactId&gt;mapper-spring-boot-starter&lt;/artifactId&gt; &lt;version&gt;1.2.3&lt;/version&gt; &lt;/dependency
SpringBoot集成TkMapper
刘信晨
10-15 7869
springboot集成TkMapper 简化持久层法人代码熟悉，提高开发效率； 先给大家截个图看一下效果 这就是效果！！ 是不是感觉很爽。（TkMapper对单表的操作很方便的） 下来我们进入正题， 第一步：Pom 文件中加载 jar 文件 &lt;dependency&gt; &lt;groupId&gt;tk.mybatis&lt;/groupId&gt; &lt;ar...
springboot搭建后台框架 （一）整合tkMapper
醉鱼的博客
06-02 1409
springboot整合tkMapper 想着每次搭建新项目时框架都要从新搭建，基本常用的也就哪几种，现在就来搭建一种常用的springboot后台框架，以后新开小项目可以直接拿来使用 项目整体结构图 2.新建springboot空白项目，选中web依赖（略） 3.pom文件依赖项展示 <?xml version="1.0" encoding="UTF-8"?> <proj...
springboot集成tkMapper进行增删改查，使用mybatis-generator-maven-plugin进行mysql数据库的逆向工程
专注微信小程序
09-27 785
tkMapper：超简单，只需要引入依赖，就可以轻松解决单表的增删改查，再也不用写SQL。 逆向工程：也是很简单的，一个配置文件就可以按照数据库生成实体类、DAO接口，Mapper文件
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值