Spring Boot 集成 tk.mybatis

2024-04-23 09:04
文章标签 java spring boot 集成 mybatis tk

本文主要是介绍Spring Boot 集成 tk.mybatis，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一 Spring Boot 集成 tk.mybatis

tk.mybatis 是 MyBatis 的一个插件，用于简化 MyBatis 的开发。

1.添加依赖

Spring Boot 项目中的 pom.xml 文件中添加 MyBatis、TkMyBatis 和 MySQL的依赖。

<dependency><groupId>tk.mybatis</groupId><artifactId>mapper-spring-boot-starter</artifactId><version>2.1.5</version> <!-- 请根据实际情况选择版本 -->
</dependency>
<dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>2.2.0</version> <!-- 请根据实际情况选择版本 -->
</dependency>
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.26</version> <!-- 请根据实际情况选择版本 -->
</dependency>

2.配置数据源

在 application.properties 或 application.yml 文件中配置数据源

spring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://localhost:3306/mydatabaseusername: your_usernamepassword: your_password

或者

spring.datasource.url=jdbc:mysql://localhost:3306/your_database
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

3.创建实体类

创建对应数据库表的实体类，并确保属性与表字段一一对应。

@Table 注解指定对应的数据库表

import javax.persistence.*;
import lombok.Data;@Data
@Table(name = "your_table")
public class YourEntity {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private String id;private String name;
}

4.创建 Mapper接口

创建Mapper接口继承自 Mapper<T>，其中 T 是实体类的类型。

import tk.mybatis.mapper.common.Mapper;public interface YourMapper extends Mapper<YourEntity> {// 这里可以添加自定义的查询方法
}

5.启动类上添加注解

在 Spring Boot 的启动类上添加 @MapperScan 注解，指定 Mapper接口的包路径。

@MapperScan：tk.mybatis.spring.annotation.MapperScan

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import tk.mybatis.spring.annotation.MapperScan;@MapperScan(basePackages = "com.example.yourapp.mapper")
@SpringBootApplication
public class SpringbootMainApplication {public static void main(String[] args) {SpringApplication.run(SpringbootMainApplication.class, args);}}

6.使用 Mapper

在 Service 类中注入 Mapper并使用它。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;@Service
public class YourService {@Autowiredprivate YourMapper yourMapper;public List<YourEntity> getAllEntities() {return yourMapper.selectAll();}// Add other methods as needed
}

二 对象和数据库记录映射

如果实体类的实例字段中包含对象，需要考虑如何对象和数据库记录如何相互映射。

通常情况下，使用 MyBatis 的 TypeHandler来处理对象字段的映射。

1.实体类(包含对象字段)

@ColumnType 注解作用：指定 OtherObjectTypeHandler.class 作为类型处理器

import lombok.Data;
import tk.mybatis.mapper.annotation.ColumnType;
import javax.persistence.*;@Data
@Table(name = "your_table")
public class YourEntity {@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private String id;private String name;// 对象字段@Column(name = "other_object")@ColumnType(typeHandler = OtherObjectTypeHandler.class)private OtherObject otherObject;
}

2.映射(TypeHandler)

继承BaseTypeHandler抽象类，创建一个 TypeHandler类来处理 Object对象字段的映射(对象与数据库字段的转换)。

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;public class OtherObjectTypeHandler extends BaseTypeHandler<OtherObject> {private final ObjectMapper objectMapper = new ObjectMapper();@Overridepublic void setNonNullParameter(PreparedStatement ps, int i, OtherObject parameter, JdbcType jdbcType) throws SQLException {// 设置 PreparedStatement 中的参数，将 OtherObject 对象转换为需要的类型try {ps.setObject(i, objectMapper.writeValueAsString(parameter));} catch (JsonProcessingException e) {throw new RuntimeException(e);}}@Overridepublic OtherObject getNullableResult(ResultSet rs, String columnName) throws SQLException {// 从 ResultSet 中获取数据并转换为 OtherObject 对象try {return objectMapper.readValue(rs.getString(columnName), OtherObject.class);} catch (JsonProcessingException e) {throw new RuntimeException(e);}}@Overridepublic OtherObject getNullableResult(ResultSet rs, int columnIndex) throws SQLException {// 从 ResultSet 中获取数据并转换为 OtherObject 对象try {return objectMapper.readValue(rs.getString(columnIndex), OtherObject.class);} catch (JsonProcessingException e) {throw new RuntimeException(e);}}@Overridepublic OtherObject getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {// 从 CallableStatement 中获取数据并转换为 OtherObject 对象try {return objectMapper.readValue(cs.getString(columnIndex), OtherObject.class);} catch (JsonProcessingException e) {throw new RuntimeException(e);}}
}

三 Example的应用

在 tk.mybatis 中，Example 类提供了一种便捷的方式来构建动态的 SQL 查询条件。
通过使用 Example 类，可以在不同的场景下动态地构建查询条件，而不需要手动编写复杂的 SQL 语句。

import org.lbb.mapper.YourMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import tk.mybatis.mapper.entity.Example;import java.util.List;@Service
public class YourService {@Autowiredprivate YourMapper yourMapper;/*** 根据 id 获取实体*/public YourEntity getEntity(String id) {// 1.创建 Example 对象Example example = new Example(YourEntity.class);// 2.创建 Criteria 对象，用于设置查询条件Example.Criteria criteria = example.createCriteria();// 3.设置查询条件criteria.andEqualTo("id", id);return yourMapper.selectOneByExample(example);}/*** 根据 name 获取实体*/public List<YourEntity> getEnties(String name) {// 1.创建 Example 对象Example example = new Example(YourEntity.class);// 2.创建 Criteria 对象，用于设置查询条件Example.Criteria criteria = example.createCriteria();// 3.设置查询条件criteria.andEqualTo("name", name);return yourMapper.selectByExample(example);}
}

Criteria 对象中可以添加不同的条件，比如 andEqualTo、andLike、andGreaterThan 等等，来实现更加灵活的查询。

四 分页

1.PageHelper

依赖

<dependency><groupId>com.github.pagehelper</groupId><artifactId>pagehelper-spring-boot-starter</artifactId><version>{pagehelper-version}</version>
</dependency>

public List<YourEntity> pagingByPageHelper(int pageNum, int pageSize) {// 设置分页参数PageHelper.startPage(pageNum, pageSize);// 执行查询List<YourEntity> entities = yourMapper.selectAll();// 获取分页信息PageInfo<YourEntity> pageInfo = new PageInfo<>(entities);log.info("{}", pageInfo.getPageNum());// 返回分页结果return pageInfo.getList();
}

pageNum 和 pageSize，分别表示要查询的页码和每页显示的记录数。

通过 PageHelper.startPage 方法设置分页参数。

查询结果会被自动分页，存储在 PageInfo 对象中，可以从中获取分页信息和当前页的数据列表。

2.RowBounds

RowBounds 是 MyBatis 提供的一种简单的分页实现方式，它通过在查询时指定起始行和返回的最大行数来实现分页。

在 tk.mybatis 中，selectByRowBounds 方法可以直接在 Mapper 接口中使用，它接受两个参数：

  1. 查询条件（实体属性）
  2. RowBounds 对象
public List<YourEntity> pagingByRowBounds(int pageNum, int pageSize) {// 创建 PageRowBounds 对象，表示分页的起始行和每页显示的行数PageRowBounds pageRowBounds = new PageRowBounds((pageNum - 1) * pageSize, pageSize);// 执行分页查询，传入查询条件（实体属性）和 PageRowBounds 对象List<YourEntity> entities = yourMapper.selectByRowBounds(null, pageRowBounds);return entities;
}

创建 PageRowBounds 对象，设置起始行和每页显示的行数。

调用 yourMapper.selectByRowBounds 方法执行分页查询，传入了查询条件为 null（表示查询所有记录）和 PageRowBounds 对象。

在使用 selectByRowBounds 方法时，需要手动计算分页的起始行，并创建对应的 PageRowBounds 对象。

这种方式相对比较底层，需要更多的手动操作，但在某些情况下可能更加灵活。

这篇关于Spring Boot 集成 tk.mybatis的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/928353。

相关文章

Springboot @Autowired和@Resource的区别解析

Springboot @Autowired和@Resource的区别解析

《Springboot@Autowired和@Resource的区别解析》@Resource是JDK提供的注解,只是Spring在实现上提供了这个注解的功能支持,本文给大家介绍Springboot@... 目录【一】定义【1】@Autowired【2】@Resource【二】区别【1】包含的属性不同【2】@
阅读更多...
springboot循环依赖问题案例代码及解决办法

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖（即BeanA依赖BeanB,而BeanB又依赖BeanA）,会导致Spring的... 目录1. 什么是循环依赖？2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1：使用 @La
阅读更多...
Java枚举类实现Key-Value映射的多种实现方式

Java枚举类实现Key-Value映射的多种实现方式

《Java枚举类实现Key-Value映射的多种实现方式》在Java开发中,枚举(Enum)是一种特殊的类,本文将详细介绍Java枚举类实现key-value映射的多种方式,有需要的小伙伴可以根据需要... 目录前言一、基础实现方式1.1 为枚举添加属性和构造方法二、http://www.cppcns.co
阅读更多...
Elasticsearch 在 Java 中的使用教程

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J
阅读更多...
Java中的String.valueOf()和toString()方法区别小结

Java中的String.valueOf()和toString()方法区别小结

《Java中的String.valueOf()和toString()方法区别小结》字符串操作是开发者日常编程任务中不可或缺的一部分,转换为字符串是一种常见需求,其中最常见的就是String.value... 目录String.valueOf()方法方法定义方法实现使用示例使用场景toString()方法方法
阅读更多...
Java中List的contains()方法的使用小结

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论：List 的 contain
阅读更多...
Java实现文件图片的预览和下载功能

Java实现文件图片的预览和下载功能

《Java实现文件图片的预览和下载功能》这篇文章主要为大家详细介绍了如何使用Java实现文件图片的预览和下载功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... Java实现文件（图片）的预览和下载 @ApiOperation("访问文件") @GetMapping("
阅读更多...
Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

Spring Boot + MyBatis Plus 高效开发实战从入门到进阶优化(推荐)

《SpringBoot+MyBatisPlus高效开发实战从入门到进阶优化(推荐)》本文将详细介绍SpringBoot+MyBatisPlus的完整开发流程,并深入剖析分页查询、批量操作、动... 目录Spring Boot + MyBATis Plus 高效开发实战：从入门到进阶优化1. MyBatis
阅读更多...
SpringCloud动态配置注解@RefreshScope与@Component的深度解析

SpringCloud动态配置注解@RefreshScope与@Component的深度解析

《SpringCloud动态配置注解@RefreshScope与@Component的深度解析》在现代微服务架构中,动态配置管理是一个关键需求,本文将为大家介绍SpringCloud中相关的注解@Re... 目录引言1. @RefreshScope 的作用与原理1.1 什么是 @RefreshScope1.
阅读更多...
Java并发编程必备之Synchronized关键字深入解析

Java并发编程必备之Synchronized关键字深入解析

《Java并发编程必备之Synchronized关键字深入解析》本文我们深入探索了Java中的Synchronized关键字,包括其互斥性和可重入性的特性,文章详细介绍了Synchronized的三种... 目录一、前言二、Synchronized关键字2.1 Synchronized的特性1. 互斥2.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2