spring boot中mybatis使用

最新推荐文章于 2024-05-23 18:09:42 发布

panda-star

最新推荐文章于 2024-05-23 18:09:42 发布

阅读量151

点赞数

分类专栏： spring boot使用

本文链接：https://blog.csdn.net/chinabestchina/article/details/108312003

版权

spring boot使用专栏收录该内容

7 篇文章 0 订阅

订阅专栏

spring boot中mybatis使用

文章目录

spring boot中mybatis使用

一、简介

这里介绍在spring boot中数据持久化mybatis使用，包含使用插件mybatis generator自动生成映射等相关文件。

二、开发步骤

2.1 mybatis generator使用

这里介绍使用mybatis generator的maven插件生成对应的entity、mapper接口及mapper的xml映射文件。

2.1.1 mybatis generator源码地址

mybatis generator源码地址：https://github.com/mybatis/generator，可以根据需要调整源码地址，这块后续再介绍。

2.1.2 定义generatorConfig.xml配置文件

generatorConfig.xml配置文件定义了生成映射文件的相关属性，哪些表需要生成对应映射文件。可在idea中定义为模板文件，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>
    <!-- targetRuntime：指定生成文件匹配的mybatis版本 -->
    <context id="default" targetRuntime="MyBatis3">
        <!-- bug修复插件，用于避免mapper xml文件内元素重复生成-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin"></plugin>
        <!-- 自带的分页插件-->
        <plugin type="org.mybatis.generator.plugins.RowBoundsPlugin"></plugin>

        <!--创建class时，对注释进行控制-->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!--是否去除自动生成的注释，true:是 false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--jdbc的数据库连接信息-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/school?useUnicode=true&amp;characeterEncoding=utf-8&amp;serverTimezone=UTC"
                        userId="root"
                        password="root"></jdbcConnection>

        <!-- 类型处理器，在数据库类型和java类型之间的转换控制-->
        <javaTypeResolver>
            <!-- 是否强制数据库中的decimal、numeric类型，转换为java中的BigDecimal类，默认是false，通常不需要修改-->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--targetPackage:生成实体类所在的包  targetProject:生成实体类所在的文件位置 -->
        <javaModelGenerator targetPackage="com.dragon.study.spring_boot_mybatis.entity"
                            targetProject="src/main/java">
            <!-- 是否允许子包 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否清理从数据库中查询出的字符串左右两边的空白字符 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!--targetPackage:生成mapper的xml文件所在的包  targetProject:生成mapper的xml文件位置 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <!-- 针对数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!--targetPackage:生成mapper接口所在的包  targetProject:生成mapper接口的文件位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.dragon.study.spring_boot_mybatis.dao" targetProject="src/main/java">
            <!-- 针对 oracle 数据库的一个配置，是否把 schema 作为字包名 -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!--指定需要生成的数据库表和java中对应的实体bean名，另外还有其它属性可配置，在此略过-->
        <table tableName="stu" domainObjectName="Stu"></table>
    </context>
</generatorConfiguration>

2.1.3 添加mybatis-generator-maven-plugin插件

在maven的pom.xml文件中添加mybatis-generator-maven-plugin插件，如下：

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <!-- 在控制台打印执行日志 -->
        <verbose>true</verbose>
        <!-- 重复生成时会覆盖之前的文件-->
        <overwrite>true</overwrite>
        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
    </configuration>
    <!-- 数据库连接选择8.0以上的，因为用的mysql8.0-->
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.4.0</version>
        </dependency>
    </dependencies>
</plugin>

2.1.4 生成映射文件

执行mybatis-generator插件即可生成相应映射文件，如在idea中双击项目对应的maven Plugins下的mybatis-generator即可。

2.2 mybatis使用

2.2.1 application.yaml添加配置

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql://localhost:3306/school?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
    driverClassName: com.mysql.jdbc.Driver
mybatis:
  type-aliases-package: com.dragon.study.spring_boot_mybatis.entity
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true
logging:
  level:
    com.dragon.study.spring_boot_mybatis.dao: debug

2.2.2 在启动类添加注解@MapperScan

在在启动类添加指定包位置的注解@MapperScan，如：

@MapperScan(basePackages = "com.dragon.study.spring_boot_mybatis.dao")

2.2.3 mapper映射文件

根据前面mybatis-generator方法生成对应映射文件，也可使用@Select、@MapKey等注解生成自定义mapper接口方法。

三、示例

3.1 添加maven依赖

<?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.3.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.dragon.study</groupId>
    <artifactId>spring_boot_mybatis</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring_boot_mybatis</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.10</version>
        </dependency>
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.4.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.4.0</version>
                <configuration>
                    <!-- 在控制台打印执行日志 -->
                    <verbose>true</verbose>
                    <!-- 重复生成时会覆盖之前的文件-->
                    <overwrite>true</overwrite>
                    <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                </configuration>
                <!-- 数据库连接选择8.0以上的，因为用的mysql8.0-->
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>8.0.21</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.4.0</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>

</project>

3.2 添加application.yaml配置

server:
  port: 11001
spring:
  application:
    name: spring-boot-mybatis
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql://localhost:3306/school?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
    driverClassName: com.mysql.jdbc.Driver
mybatis:
  type-aliases-package: com.dragon.study.spring_boot_mybatis.entity
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true
logging:
  level:
    com.dragon.study.spring_boot_mybatis.dao: debug

3.3 启动类添加@MapperScan注解配置

package com.dragon.study.spring_boot_mybatis;

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

@SpringBootApplication
//指定mapper包
@MapperScan(basePackages = "com.dragon.study.spring_boot_mybatis.dao")
public class SpringBootMybatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootMybatisApplication.class, args);
    }
}

3.4 添加自定义mapper

根据mybatis-generator插件即可生成相应映射文件，在此略。自定义mapper如下：

package com.dragon.study.spring_boot_mybatis.dao;

import com.dragon.study.spring_boot_mybatis.entity.Stu;
import org.apache.ibatis.annotations.MapKey;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import java.util.Map;
public interface CustomStuMapper {
    @MapKey("id")
    @Select("select * from stu where id>#{id}")
    Map<Integer, Stu> selectStuMapGreaterId(@Param("id") int id);
}

3.5 测试

package com.dragon.study.spring_boot_mybatis;

import com.dragon.study.spring_boot_mybatis.dao.CustomStuMapper;
import com.dragon.study.spring_boot_mybatis.dao.StuMapper;
import com.dragon.study.spring_boot_mybatis.entity.Stu;
import com.dragon.study.spring_boot_mybatis.entity.StuExample;
import org.apache.ibatis.session.RowBounds;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import javax.annotation.Resource;
import java.util.List;
import java.util.Map;

@SpringBootTest
class SpringBootMybatisApplicationTests {

    @Resource
    private StuMapper stuMapper;
    @Resource
    private CustomStuMapper customStuMapper;

    @Test
    void contextLoads() {
        //根据主键查询
        Stu stu = stuMapper.selectByPrimaryKey(1);
        System.out.println(stu);
        
        //分页查询
        List<Stu> stuList = stuMapper.selectByExampleWithRowbounds(new StuExample(), new RowBounds(10, 5));
        System.out.println(stuList);

        //调用自定义mapper
        Map<Integer, Stu> m = customStuMapper.selectStuMapGreaterId(90);
        System.out.println(m);
    }
}

panda-star

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
spring boot中mybatis使用

spring boot中mybatis使用文章目录spring boot中mybatis使用一、简介二、开发步骤2.1 mybatis generator使用2.1.1 mybatis generator源码地址2.1.2 定义generatorConfig.xml配置文件2.1.3 添加mybatis-generator-maven-plugin插件2.1.4 生成映射文件2.2 mybatis使用2.2.1 application.yaml添加配置2.2.2 在启动类添加注解@MapperScan2.
复制链接

扫一扫