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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
mybatis的整体架构

mybatis的整体架构

mybatis的整体架构分为三层： 1.基础支持层 该层包括：数据源模块、事务管理模块、缓存模块、Binding模块、反射模块、类型转换模块、日志模块、资源加载模块、解析器模块 2.核心处理层 该层包括：配置解析、参数映射、SQL解析、SQL执行、结果集映射、插件 3.接口层 该层包括：SqlSession 基础支持层 该层保护mybatis的基础模块，它们为核心处理层提供了良好的支撑。
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2