SpringBoot整合Mybatis(配置版 + 注解版 + 混合版)

最新推荐文章于 2024-09-10 17:11:23 发布
最新推荐文章于 2024-09-10 17:11:23 发布
阅读量655 收藏 1
点赞数
分类专栏： # SpringBoot 文章标签： spring boot mybatis 配置版 注解版 配置注解混合版
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yy8623977/article/details/127932175
版权

目录

1. 创建Mysql表和添加测试数据

创建Mysql表，如下所示：

mysql> create table user (
    ->     id bigint(20) auto_increment not null comment '主键ID',
    ->     name varchar(30) null default null comment '姓名',
    ->     age int(11) null default null comment '年龄',
    ->     email varchar(50) null default null comment '邮箱',
    ->     primary key (id)
    -> );
Query OK, 0 rows affected, 2 warnings (0.01 sec)

mysql>

添加测试数据，如下所示：

mysql> insert into user (id, name, age, email) values
    -> (1, 'Jone', 18, 'test1@mybatis.com'),
    -> (2, 'Jack', 20, 'test2@mybatis.com'),
    -> (3, 'Tom', 28, 'test3@mybatis.com'),
    -> (4, 'Sandy', 21, 'test4@mybatis.com'),
    -> (5, 'Billie', 24, 'test5@mybatis.com');
Query OK, 5 rows affected (0.02 sec)
Records: 5  Duplicates: 0  Warnings: 0

mysql>

2. 添加pom.xml依赖

添加Mybatis提供的starter

        <!-- 支持spring 2.6.3 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>

可以看到mybatis-spring-boot-starter的依赖了spring-boot-starter-jdbc、mybatis、mybatis-spring
Mybatis-spring-boot-starter

3. 自动配置分析

查看mybatis-spring-boot-autoconfigure-2.2.2.jar的META-INF\spring.factories，可以看到给我们自动配置了MybatisLanguageDriverAutoConfiguration和MybatisAutoConfiguration

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

现在我们重点来看MybatisAutoConfiguration类，可以看到：

  • 当IOC容器中只有一个DataSource才生效
  • 绑定了MybatisProperties配置类
  • 向IOC容器添加了SqlSessionFactory，并且SqlSessionFactory设置了dataSource
  • 向IOC容器添加了SqlSessionTemplate，里面就有SqlSession，就可以对数据库进行crud操作
  • 向IOC容器添加了AutoConfiguredMapperScannerRegistrar，会扫描配置文件指定的位置，将标注了@Mapper的接口添加到IOC容器，这些接口是操作Mybatis的接口
package org.mybatis.spring.boot.autoconfigure;
......省略部分......
@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties({MybatisProperties.class})
@AutoConfigureAfter({DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class})
public class MybatisAutoConfiguration implements InitializingBean {
......省略部分......
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
        factory.setDataSource(dataSource);
......省略部分......
    }
......省略部分......
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        ExecutorType executorType = this.properties.getExecutorType();
        return executorType != null ? new SqlSessionTemplate(sqlSessionFactory, executorType) : new SqlSessionTemplate(sqlSessionFactory);
    }
......省略部分......
    @Configuration
    @Import({AutoConfiguredMapperScannerRegistrar.class})
    @ConditionalOnMissingBean({MapperFactoryBean.class, MapperScannerConfigurer.class})
    public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {
        public MapperScannerRegistrarNotFoundConfiguration() {
        }

        public void afterPropertiesSet() {
            MybatisAutoConfiguration.logger.debug("Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
        }
    }

    public static class AutoConfiguredMapperScannerRegistrar implements BeanFactoryAware, EnvironmentAware, ImportBeanDefinitionRegistrar {
        private BeanFactory beanFactory;
        private Environment environment;

        public AutoConfiguredMapperScannerRegistrar() {
        }

        public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
            if (!AutoConfigurationPackages.has(this.beanFactory)) {
                MybatisAutoConfiguration.logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.");
            } else {
                MybatisAutoConfiguration.logger.debug("Searching for mappers annotated with @Mapper");
                ......省略部分......
            }
            ......省略部分......
        }
        ......省略部分......
    }
......省略部分......
}

查看MybatisProperties配置类，Mybatis的配置由mybatis开头的配置进行配置的

......省略部分......
@ConfigurationProperties(
    prefix = "mybatis"
)
public class MybatisProperties {
......省略部分......
}

4. 代码实现

4.1 User类实现

  • 类名不用和表名对应
  • 字段需要一一对应
package com.hh.springboottest.myController;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@NoArgsConstructor
@AllArgsConstructor
@Data
public class User {
    
    private Long id;
    private String name;
    private Integer age;
    private String email;

}

4.2 application.properties配置

指定mybatis配置文件的路径，和mapper.xml文件的位置

mybatis.config-location=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*

4.3 mybatis-config.xml配置文件

说明：

  • 设置mapUnderscoreToCamelCase为true，意思是让数据库表的字段user-name，和类的属性是UserName对应起来
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <settings>
        <!-- 让数据库表的字段user-name，和类的属性是UserName对应起来 -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
</configuration>

configuration中的配置，都可以在application.properties中实现，但是在application.properties中指定了mybatis.configuration，就不要mybatis-config.xml文件了，就需要将application.properties的mybatis.config-location配置删除。如下所示：

mybatis.configuration.map-underscore-to-camel-case=true

4.4 Mapper接口和Mapper.xml实现

Mapper接口说明如下：

  • Mapper接口需要用@Mapper注解标识。也可以在SpringBoot的启动类中，用注解@MapperScan(“com.hh.springboottest.mapper”)声明Mapper接口的扫描路径
  • 同时声明操作数据的方法getUser，等会在Mapper.xml中实现
package com.hh.springboottest.mapper;

import com.hh.springboottest.myController.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;


@Mapper
public interface UserMapper {
    public User getUser(@Param("id") Long id);
}

Mapper.xml文件说明如下：

  • namespace指定对应的Mapper接口
  • 查询数据就用select标签，id和Mapper接口的方法名对应，resultType和Mapper接口的方法的返回值对应
  • select查询语句的常量值从Mapper接口的方法参数获取
  • 也可以返回map。则resultType=“map”，返回的对象是Map<String, Object>，key是字段名，value是字段值
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hh.springboottest.mapper.UserMapper">
    <!-- public User getUser(Long id); -->
    <select id="getUser" resultType="com.hh.springboottest.myController.User">
        select * from user where id = #{id}
    </select>
</mapper>

4.5 Service实现

UserService接口实现如下：

package com.hh.springboottest.service;

import com.hh.springboottest.myController.User;

public interface UserService {
    public User getUser(Long id);
}

UserServiceImpl实现类如下：

package com.hh.springboottest.service.impl;

import com.hh.springboottest.mapper.UserMapper;
import com.hh.springboottest.myController.User;
import com.hh.springboottest.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    UserMapper userMapper;

    public User getUser(Long id) {
        return userMapper.getUser(id);
    }
}

4.6 UserMapper测试

package com.hh.springboottest;

import com.hh.springboottest.myController.User;
import com.hh.springboottest.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@Slf4j
@SpringBootTest
public class MyApplicationTest {

    @Autowired
    UserService userService;

    @Test
    public void queryDataTest() {
    
        User user = userService.getUser(1L);
        log.info("获取到的用户信息: {}", user);

    }
}

运行程序，结果如下：

......省略部分......
2022-11-21 06:56:51.768  INFO 7824 --- [           main] com.hh.springboottest.MyApplicationTest  : 获取到的用户信息: User(id=1, name=Jone, age=18, email=test1@mybatis.com)
......省略部分......

5. 注解版开发

可以不在application.properties指定mybatis.mapper-locations配置参数，不用Mapper.xml文件，直接使用注解进行开发。如下所示：

package com.hh.springboottest.mapper;

import com.hh.springboottest.myController.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {

    @Select("select * from user where id = #{id}")
    public User getUser(Long id);
}

6. 混合版(配置 + 注解)

既可以在Mapper.xml中使用配置文件的方式，也可以在Mapper接口使用注解

UserMapper接口实现如下：

package com.hh.springboottest.mapper;

import com.hh.springboottest.myController.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {

    @Select("select * from user where id = #{id}")
    public User getUser(Long id);

    public void insertUser(User user);
}

UserMapper.xml文件如下。说明：

  • 向数据库插入数据使用insert标签
  • 可以直接获取User类的属性值
  • 如果没有传入User.id, useGeneratedKeys会将数据库生成的自增id返回，重新赋值给User
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.hh.springboottest.mapper.UserMapper">
    <!-- public User getUser(Long id); -->
    <select id="getUser-noUse" resultType="com.hh.springboottest.myController.User">
        select * from user where id = #{id}
    </select>

    <!-- public void insertUser(User user); -->
    <!-- 如果没有传入User.id, useGeneratedKeys会将数据库生成的自增id返回，重新赋值给User -->
    <insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
        insert into user(id, name, age, email) values(#{id}, #{name}, #{age}, #{email})
    </insert>
</mapper>

insertUser如果使用注解开发，如下所示：

    @Insert("insert into user(id, name, age, email) values(#{id}, #{name}, #{age}, #{email})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    public void insertUser(User user);

UserService接口如下：

package com.hh.springboottest.service;

import com.hh.springboottest.myController.User;

public interface UserService {
    public User getUser(Long id);

    public void insertUser(User user);
}

UserServiceImpl实现类如下：

package com.hh.springboottest.service.impl;

import com.hh.springboottest.mapper.UserMapper;
import com.hh.springboottest.myController.User;
import com.hh.springboottest.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    UserMapper userMapper;

    public User getUser(Long id) {
        return userMapper.getUser(id);
    }

    @Override
    public void insertUser(User user) {
        userMapper.insertUser(user);
    }
}

Mapper测试如下：

package com.hh.springboottest;

import com.hh.springboottest.myController.User;
import com.hh.springboottest.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;

@Slf4j
@SpringBootTest
public class MyApplicationTest {

    @Autowired
    UserService userService;

    @Test
    public void queryDataTest() {

        User user = userService.getUser(1L);
        log.info("获取到的用户信息: {}", user);

        User insertUser = new User(6L, "Lily", 24, "test6@mybatis.com");
        userService.insertUser(insertUser);
    }
}
Bulut0907
关注
专栏目录
Spring Boot教程 - Spring Boot集成Mybatis（XML方式）
Ricky
11-18 6263
项目开发中不可避免需要跟数据库打交道，作者开发的项目的中广泛使用Mybatis作为ORM框架。 本文主要讲解在Spring Boot项目中 如何整合Mybatis。开发环境 JDK 1.8 Spring Boot 1.5.8.RELEASE Mybatis 3.4.4
SpringBoot整合Mybatis完整详细版含注册、登录、拦截器配置
09-28
SpringBoot整合Mybatis完整详细版含注册、登录、拦截器配置功能
【Spring Boot整合MyBatis教程】
qq_43884946的博客
06-11 7183
Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置，从而使开发人员不再需要定义样板化的配置。通过这种方式，Spring Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者。MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。
Springboot中mybatis的使用
最新发布
2301_80224944的博客
09-10 1090
springboot，mybatis
mybatis-spring-boot-starter配置mybatis的插件(Interceptor)
m0_67390788的博客
03-22 1025
记录一下mybatis-spring-boot-starter配置mybatis插件. 以前使用mybatis的自定义插件的时候都是使用xml的配置形式来配置，现在使用starter的时候突然一下不知道怎么配置了，这里记录一下怎么配置mybatis的插件。 参考链接 spring boot 中如何设置mybatis的插件 使用starter 现在使用springboot项目引入组件基本都是使用starter的形式来引用了。 <dependency> <grou.
SpringBoot+Mybatis多模块（module）项目搭建教程
Java笔记虾
06-05 2264
作者：枫本非凡 cnblogs.com/orzlin/p/9717399.html 推荐阅读 1.SpringBoot 整合篇 2.手写一套迷你版HTTP服务器 3.记住：永远不要在MySQL中使用UTF-8 4.Springboot启动原理解析 一、前言 最近公司项目准备开始重构，框架选定为SpringBoot+Mybatis，本篇主要记录了在IDEA中搭建Sprin...
springboot整合mybatis配置
热门推荐
acq的博客
01-03 4万+
springboot整合mybatis配置 本文只说明在springboot中配置mybatis，不涉及springboot的创建。 首先pom依赖 &lt;dependency&gt; &lt;groupId&gt;mysql&lt;/groupId&gt; &lt;artifactId&gt;mysql-connector-java&lt;/artifactId&gt; &lt;scop...
SpringBoot中配置mybatis
weixin_53870975的博客
03-23 4488
①pom.xml中引入 <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.2.2</version> </dependency> ②resources下创建以下文件 mybatis-co
基于Springboot+Mybatis+SpringMvc+springsecrity+Redis完整网站后台管理系统.zip
12-23
MyBatis可以使用简单的XML或注解进行配置和原始映射，将接口和Java的POJOs(Plain Old Java Objects，普通的Java对象)映射成数据库中的记录。在本系统中，MyBatis负责数据库操作，提供灵活的数据访问层。 Spring MVC...
SpringBoot+Mybatis+Druid+PageHelper实现多数据源并分页方法
08-26
总结来说，SpringBoot整合Mybatis、Druid和PageHelper可以创建一个高性能、易维护的后端系统。通过Druid，我们能够监控数据库性能，优化连接池配置；使用PageHelper可以简化分页查询的实现；而多数据源的支持则增强...
idea+springboot+mybatis+jsp+bootstrap实现从mysql查询出数据并显示(源码)
01-25
MyBatis通过Mapper接口和XML或注解配置文件，实现了SQL的动态执行和结果映射。 4. MySQL： MySQL是一款开源的关系型数据库管理系统，广泛应用于Web应用中。它的性能高、稳定性好，且易于使用，是许多小型到大型...
springboot配置文件和整合mybatis配置文件
01-20
springboot配置文件模板:包括多环境开发布置,端口号配置,全局jackson配置,mysql数据库配置,oracle数据库配置,连接池配置,redis配置,redis链接池的配置,设置上传文件大小限制配置,全局格式化时间配置,https证书配置示例
springboot集成mybatis注解版与配置版
07-05
springboot与mybatis集成，注解版与配置版，下载可运行。集成过程可参考博客https://blog.csdn.net/m0_37984249/article/details/80923212
springboot+mybatis+mysql+layUI+thymeleaf实现增删改查
04-04
总的来说，这个项目展示了如何将SpringBoot、MyBatis、MySQL、LayUI和Thymeleaf整合在一起，创建一个功能完善的Web应用，实现对数据的CRUD操作。这种技术栈组合具有较高的开发效率和良好的可维护性，是当前Web开发中...
springboot+mybatis+layui+shiro 权限注解-后台的完整的项目整合
04-23
《SpringBoot + MyBatis + Layui + Shiro 权限注解：后台完整项目整合指南》 在当今的Web开发领域，SpringBoot以其简洁、快速的特性深受开发者喜爱。结合MyBatis作为持久层框架，Layui作为前端UI库，以及Shiro进行...
Spring整合配置Mybatis
04-16 555
使用Spring 整合 mybatis 配置
Spring 整合Mybatis配置
qq_43573066的博客
12-07 192
Spring 整合Mybatis配置 一、配置数据库 配置数据源，加载驱动。 <!-- 将properties文件加载进spring容器中 --> <context:property-placeholder location="dbConfig.properties"/> <!-- 配置数据源，加载驱动 --> <bean id="dataSource...
Spring 整合mybatis配置
漂浮
03-10 1万+
Spring整合mybatis配置 Mybatis是ibatis的升级版，是一个基于java的持久层框架。Mybatis是支持普通SQL查询，存储过程和高级映射的优秀的持久层框架，Mybatis 消除了几乎所有JDBC代码和参数的手工设置以及结果集的检索。MyBatis 使用简单的 XML或注解用于配置和原始映射，将接口和 Java 的POJOs（Plain Old Java Objects，普
spring整合mybatis配置
weixin_44701385的博客
06-13 311
spring整合mybatis
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值