SpringBoot整合Mybatis(附源码，内含手写mapper和逆向工程两种方案)

上上签i
302 阅读3分钟

SpringBoot整合Mybatis(附源码)

本文已参与「新人创作礼」活动，一起开启掘金创作之路。

本篇是关于SpringBoot整合Mybatis，本篇主要是一个小demo，由两种方案实现，先是采用手动配置的Mapper，后面也试一下逆向工程生成的Mapper。

官方API

Mybatis官方文档 mybatis.org/spring-boot…

可以在官网发现，这里有很多版本对应问题，为了避免出现问题，我们全用最新版~

image-20201006185646003

二话不说，直接整，sql别找我要了吧，改成自己有的sql就行啦

整合测试

创建新的SpringBoot项目，在创建时可以勾选mybatis模块

image-20201006190343143

或者我们手动在pom里导入依赖，一样，没啥区别

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

编写配置文件

applicaiton.properties

spring.datasource.username=root
spring.datasource.password=*******
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#整合mybatis
mybatis.type-aliases-package=com.feng.pojo
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

在SpringBoot中先测试一下是否能连接成功，我们再往下走，否则当程序编写到一定程度，我们很难定位bug。

image-20201006190734901

可以看到这里我们已经拿到数据源信息，是SpringBoot默认的数据源class com.zaxxer.hikari.HikariDataSource没问题，如果想要配置Druid的，导包+配置就ok了

下面开始编写实体类

User.java

package com.feng.pojo;

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

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int id;
    private String name;
    private String pwd;
}

如果对lombok不了解的可以看一下我这篇博客下关于lombok的介绍

blog.csdn.net/weixin_4387…

UserMapper的接口

UserMapper.java

package com.feng.mapper;

import com.feng.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;

//这个注解表示了这是一个mybatis的mapper类
@Mapper
@Repository
public interface UserMapper {

    List<User> queryUserList();

    User queryUserById(int id);

    int addUser(User user);

    int updateUser(User user);

    int deleteUser(int id);
}

注意这里面我们用了新的@Mapper标签，他表示当前类是mybatis的Mapper类

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--namespace=绑定一个对应的Dao/Mapper接口-->
<mapper namespace="com.feng.mapper.UserMapper">

    <select id="queryUserList" resultType="User">
        select * from user
    </select>

    <select id="queryUserById" resultType="User">
        select * from user where id = #{id}
    </select>

    <insert id="addUser" parameterType="User">
        insert into user (id,name,pwd) values (#{id},#{name},#{pwd})
    </insert>

    <update id="updateUser" parameterType="User">
        update user set name=#{name},pwd=#{pwd} where id = #{id}
    </update>

    <delete id="deleteUser" parameterType="int">
        delete from user where id = #{id}
    </delete>


</mapper>

maven资源过滤问题

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
        </includes>
        <filtering>true</filtering>
    </resource>
    <resource>
        <directory>src/main/java</directory>
        <includes>
            <include>**/*.properties</include>
            <include>**/*.xml</include>
        </includes>
        <filtering>true</filtering>
    </resource>
</resources>

顺手咱就配上，避免出现意想不到的问题

下一步编写controller层

UserController.java

package com.feng.controller;

import com.feng.mapper.UserMapper;
import com.feng.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/queryUserList")
    public List<User> queryUserList() {
        List<User> userList = userMapper.queryUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        return userList;
    }

    //添加一个用户
    @GetMapping("/addUser")
    public String addUser() {
        userMapper.addUser(new User(10, "马化腾", "556699"));
        return "ok";
    }

    //修改一个用户
    @GetMapping("/updateUser")
    public String updateUser() {
        userMapper.updateUser(new User(10, "麻花藤", "669977"));
        return "ok";
    }

    //根据id删除一个用户
    @GetMapping("/deleteUser")
    public String deleteUser() {
        userMapper.deleteUser(10);
        return "ok";
    }

}

测试效果

在这里插入图片描述

到这里CRUD一气呵成，基本没什么问题

逆向工程整合

在application.properties中没有区别

编写配置文件

applicaiton.properties

spring.datasource.username=root
spring.datasource.password=*******
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#整合mybatis
mybatis.type-aliases-package=com.feng.pojo
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

mybatis-generator插件

测试连接后，我们在pom.xml加入mybatis-generator插件

<!--Mybatis逆向工程-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <!--配置文件的位置-->
                    <configurationFile>GeneratorMapper.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>

image-20201006193836719

右边maven栏里出现该插件表示添加成功

image-20201006193900199

此时我们在项目根目录创建

GeneratorMapper.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>
    <!-- 指定连接数据库的 JDBC 驱动包所在位置，指定到你本机的完整路径 -->
    <classPathEntry location="F:\Java\Environment\apache-maven-3.6.1\Maven-repo\mysql\mysql-connector-java\8.0.21\mysql-connector-java-8.0.21.jar"/>
    <!-- 配置 table 表信息内容体，targetRuntime 指定采用 MyBatis3 的版本 -->
    <context id="tables" targetRuntime="MyBatis3">
        <!-- 抑制生成注释，由于生成的注释都是英文的，可以不让它生成 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!-- 配置数据库连接信息 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&amp;characterEncoding=utf-8"
                        userId="root"
                        password="****">
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
        <!-- 生成 model 类，targetPackage 指定 model 类的包名， targetProject 指定
       生成的 model 放在 idea的哪个工程下面-->
        <javaModelGenerator targetPackage="com.feng.springboot05mybatistest.dao"
                            targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="false"/>
        </javaModelGenerator>
        <!-- 生成 MyBatis 的 Mapper.xml 文件，targetPackage 指定 mapper.xml 文件的
       包名， targetProject 指定生成的 mapper.xml 放在 idea的哪个工程下面 -->
        <sqlMapGenerator targetPackage="com.feng.springboot05mybatistest.mapper"
                         targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- 生成 MyBatis 的 Mapper 接口类文件,targetPackage 指定 Mapper 接口类的包
       名， targetProject 指定生成的 Mapper 接口放在 idea的哪个工程下面 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.feng.springoot.mapper"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        <!-- 数据库表名及对应的 Java 模型类名 -->
        <table tableName="User" domainObjectName="User"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false"/>
    </context>
</generatorConfiguration>

先别急着CV，每个人的配置不一样

以下细说

JDBC 驱动包所在位置

配置自己电脑里的绝对路径哦

image-20201006194041742

配置数据库连接信息

image-20201006194142592

dao和mapper和mapper接口生成的位置

image-20201006194528341

最后是实体类

image-20201006194654489

全部配置妥后双击plugins

运行

image-20201006194837466

完成逆向工程

可以看到该弄的都帮忙弄好了

image-20201006194958919

在测试类里小测一下

别忘了在UserMapper的接口类上加上@Mapper和@Repository注入哈

package com.feng.springboot05mybatistest;

import com.feng.springboot05mybatistest.dao.User;
import com.feng.springboot05mybatistest.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Springboot05MybatisTestApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        User user = userMapper.selectByPrimaryKey(1);
        System.out.println(user.getId()+" "+user.getName()+" "+user.getPwd());
    }

}

可以发现一点问题没得

image-20201006195600028

附

1、如果用逆向工程时报

XML Parser Error on line 2: 不允许有匹配 "[xX][mM][lL]" 的处理指令目标。

错误时，表示GeneratorMapper.xml文件前<?xml version="1.0" encoding="UTF-8"?> 必须是XML文件的第一个元素且前面不能空格。

2、使用逆向工程时mysql的jar包和mysql版本需要一致，否则会有意想不到的错误

3、mapper.xml和mapper接口内的内容要一致，两边有差异同样会报错

4、逆向工程生成完了记得在Mapper接口上加@Mapper注解！

avatar
文章
阅读
粉丝