SpringBoot整合MyBatis三步就够了

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,高可用系列 2核4GB
简介: 如果你还没有数据库,那么你需要先安装一个数据库无论是本地还是虚拟机或者服务器上都需要先要有数据库作为基础。

前言:

如果你还没有数据库,那么你需要先安装一个数据库无论是本地还是虚拟机或者服务器上都需要先要有数据库作为基础。提供一篇linux下安装mysql数据库女朋友看了都会的详细教程: linux环境安装mysql数据库,且这里默认是已经建立了一个SpringBoot的项目了,如果不太清楚怎么快速建立一个SpringBoot的项目,可以看下这篇: 快速建立Jsp+SpringBoot的项目


一.整合过程



SpringBoot集成MyBatis主要有以下几个步骤,导入相关依赖、配置application.properties文件、创建service接口及其实现类、创建dao接口、根据dao接口中的方法内容创建mapper文件,下面根据这个流程对各个步骤进行详细说明。


1.导入相关依赖


这里需要导入的依赖有MyBatis的依赖包、mysql数据库的驱动包、数据源连接池的依赖包这三种,如下:

版本介绍:

SpringBoot:2.4.4

mybatis-spring-boot-starter:2.1.2

mysql-connector-java:5.1.38

druid:1.1.19

  <!--引入mybatis的依赖-->
  <dependency>
     <groupId>org.mybatis.spring.boot</groupId>
     <artifactId>mybatis-spring-boot-starter</artifactId>
     <version>2.1.2</version>
  </dependency>
  <!--引入连接mysql的驱动-->
  <dependency>
     <groupId>mysql</groupId>
     <artifactId>mysql-connector-java</artifactId>
     <version>5.1.38</version>
  </dependency>
  <!--引入数据源连接池依赖-->
  <dependency>
     <groupId>com.alibaba</groupId>
     <artifactId>druid</artifactId>
     <version>1.1.19</version>
  </dependency>


2.配置文件application.properties


这里需要配置的参数有数据库与mybatis两类,具体如下,注意其他数据库的配置参数我们可以不提供,SpringBoot会有一个默认的配置。

# 数据库相关配置
#连接池
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
#驱动类
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#数据库地址
spring.datasource.url=jdbc:mysql://192.168.150.130:3306/shiro?characterEncoding=UTF-8&useSSL=false
#数据库用户名与密码
spring.datasource.username=root
spring.datasource.password=super
# mybatis 别名配置,配置该参数mapper中才认识自定义类型
mybatis.type-aliases-package=com.example.demo5.entry
# 包扫描,配置了该参数MyBatis才能找到我们写mapper文件
mybatis.mapper-locations=classpath:com/example/demo5/mapper/*.xml


3.创建service接口及其实现类、创建dao接口


这个没有什么好说的,就是普通的接口创建然后类实现然后调用dao的接口,代码如下:


1.servic接口

public interface ShiroUserService {
    void insertUser(ShiroUser shiroUser);
    ShiroUser queryUser(String username);
}


2.service接口实现类

@Service
@Transactional
public class ShiroUserServiceImpl implements ShiroUserService {
   @Resource
   private ShiroUserDao shiroUserDao;
   @Override
   public void insertUser(ShiroUser shiroUser) {
       //使用MD5+盐+hash散列进行对密码加密
       String salt = SaltUttil.getSalt(10);
       Md5Hash md5Hash = new Md5Hash(shiroUser.getPassword(),salt ,2048);
       shiroUser.setPassword(md5Hash.toString());
       shiroUser.setSalt(salt);
       shiroUserDao.insertUser(shiroUser);
   }
   @Override
   public ShiroUser queryUser(String username) {
       ShiroUser shiroUser = shiroUserDao.queryUser(username);
       return shiroUser;
   }
}


3.dao接口创建

public interface ShiroUserDao {
    void insertUser(ShiroUser shiroUser);
    ShiroUser queryUser(String username);
}


需要说明的是这里可以使用mapper注解,也可以在启动类上加入mapperScan注解,这两个注解都可以将dao与mapper文件映射到一起,建议在启动类上加MapperScan注解传入需要扫描的包路径即可,如下:


@MapperScan(value = "com.example.demo5.dao")
@SpringBootApplication
public class Demo5Application {
    public static void main(String[] args) {
        SpringApplication.run(Demo5Application.class, args);
    }
}


4.根据dao创建mapper文件


首先需要在resource文件夹下创建一个文件夹用来存储mapper.xml文件,该文件夹的路径就是我们在appliction.properties配置的路径,事实上应该先创建再去配置,这里这么写是想把配置写到一起


4.创建mapper文件夹

没啥要求,路径无需与dao或者谁保持一致,值得注意的是创建多级文件目录必须使用斜杠,不能用点,点创建出来的是单层目录结构,本人曾因这个踩过坑,印象深刻。

2021032717202777.png


5.创建mapper.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">
<mapper namespace="com.example.demo5.dao.ShiroUserDao">
    <sql id="shiro_user_fields">
      oid,username,password,salt
    </sql>
    <insert id="insertUser" parameterType="ShiroUser" useGeneratedKeys="true" keyProperty="oid">
        insert into shiro_user values (#{oid},#{username},#{password},#{salt})
    </insert>
    <select id="queryUser" parameterType="java.lang.String" resultType="ShiroUser">
        select
        <include refid="shiro_user_fields"/>
        from shiro_user where 1=1
        <if test="username != null and username != ''">
          and username = #{username}
        </if>
    </select>
</mapper>


这也是一个标准mapper文件,可以当做模板使用,具体的mapper文件中的各个语句的含义就不一一解释了,该文旨在总结过程。


5.完成整合


其实到现在SpringBoot+MyBatis整合就完成了。对于创建实体类,创建controller接口这些非主要过程,就没写出来。本来就不是多复杂的东西,不过这也不是唯一的整合方法,只不过这种整合方式更为快速,快速的根本在于使用了SpringBoot提供的Mybatis的启动器,省去了很多的xml配置。但是无论多简单的事情,都有可能碰到各种问题。下面列出多种在整合过程可能出现的问题,并给予解答,自己做个总结,希望也能帮到路过的读者。


二.问题总结



这个过程难免会碰到很多问题,对于接触这个架构久了的人可能一眼就看出,对于刚接触的人可能还需要各种bd。下面对几个常见的问题进行一一列举。


1.dao上使用Mapper注解?


上面的整合流程中并没有在dao上加任何注解,不过其实我们可以为每一个dao文件加一个Mapper注解,该注解可以将dao与mapper.xml文件关联起来,自动为dao生成一个实现类并注入到spring容器中。不过在启动类上加MapperScan注解与该注解效果等同。


2.报错SSL connection without server’s identity verification is not recommended


image.png


这个是因为不能验证数据库所在的服务器是否安全导致的,我们可以让Spring不去检查该值,将数据库路径配置加上useSSL=false即可

spring.datasource.url=jdbc:mysql://192.168.150.130:3306/shiro?characterEncoding=UTF-8&useSSL=false


这样就解决了。


3.BindingException绑定异常


这是因为IDEA默认是不编译xml文件的,需要我们在pom文件的build层级下加入以下内容,告诉在编译项目时将我们的xml文件一起编译:

    <resources>
            <resource>
                <directory>src/main/Java</directory>
                <excludes>
                    <exclude>**/*.java</exclude>
                </excludes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.* </include>
                </includes>
            </resource>
        </resources>


4.如果报了数据库连接的错


这个错,笔者碰到过但是没有还原出来,数据库的的配置参数都是正常的。数据库也是正常的。但是就是连接不上,这时候加入了数据库的其他连接参数就正常了。但是并没有还原出来,作为参考好了。

spring.datasource.max-idle=10
spring.datasource.max-wait=10000
spring.datasource.min-idle=5
spring.datasource.initial-size=5


5.若是报了主键问题

20210327182254120.png

报了该错,要么mapper文件中在insert语句未配置这俩参数,使用自动生成主键,第二个是数据库主键的名称,如果这俩都配了,再检查下数据库中的表是否配置了支持主键自增。

useGeneratedKeys="true" keyProperty="oid"

20210327182254120.png


6.数据存入乱码问题


在application.properties配置数据库地址时加入characherEncoding=UTF-8,如下:

spring.datasource.url=jdbc:mysql://192.168.150.130:3306/shiro?characterEncoding=UTF-8&useSSL=false


此外,检查数据库是否是UTF-8创建的。

20210327182533669.png


如果这些都正常,那么可能是前后端交互时就有乱码了,注意前端文件的编码是否正常,比如jsp,html等的编码是否有误。


7.使用Autowired注解注入dao时,IDEA提示找不到可用的Bean


上面的整合过程如果使用autowired就会提示这个问题,如下:


20210327182837117.png


IDEA提示我们,没有可注入的bean,为什么IDEA这么提示我们呢,因为我们并没有为dao接口提供实现类,IDEA自然检测不到,但是我们可以不理他,编译运行时不会有影响的,因为Mybatis会为我们实现一个实现类并注入到Spring容器中,这样运行时就不会有问题了,但是如果看着这个提示碍眼,我们可以换成Resource即可,就不会有问题了。


8.运行程序一直出现typeException


这个大部分都是因为mapper.xml中的问题导致,认认真真检查下mapper文件,看看参数的类型,个数,#的使用等是否有问题。


以上便是整合过程中可能碰到的一些问题,整理出来自然是为了下次碰到可以快速的定位问题,如果还能帮到路过的你,那就更好了。


三.总结



这篇文章整理了整合SpringBoot与MyBatis的过程以及可能碰到的问题,整合过程挑了主要的写,有一些并没有写出来,问题,都是常见的问题。其实无论是SpringBoot整合什么都是这些步骤而已,第一步都是导入依赖,第二部都是修改配置文件。然后开始编码。都是这一个主流程,整理的目的是为了自己犯重复的错,也希望帮到路过的你。

相关实践学习
如何在云端创建MySQL数据库
开始实验后,系统会自动创建一台自建MySQL的 源数据库 ECS 实例和一台 目标数据库 RDS。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
1月前
|
Java 数据库连接 Maven
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和MyBatis Generator,使用逆向工程来自动生成Java代码,包括实体类、Mapper文件和Example文件,以提高开发效率。
105 2
mybatis使用一:springboot整合mybatis、mybatis generator,使用逆向工程生成java代码。
|
1月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
52 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
1月前
|
前端开发 Java Apache
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
本文详细讲解了如何整合Apache Shiro与Spring Boot项目,包括数据库准备、项目配置、实体类、Mapper、Service、Controller的创建和配置,以及Shiro的配置和使用。
288 1
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
|
2月前
|
Java 数据库连接 数据库
spring复习05,spring整合mybatis,声明式事务
这篇文章详细介绍了如何在Spring框架中整合MyBatis以及如何配置声明式事务。主要内容包括:在Maven项目中添加依赖、创建实体类和Mapper接口、配置MyBatis核心配置文件和映射文件、配置数据源、创建sqlSessionFactory和sqlSessionTemplate、实现Mapper接口、配置声明式事务以及测试使用。此外,还解释了声明式事务的传播行为、隔离级别、只读提示和事务超时期间等概念。
spring复习05,spring整合mybatis,声明式事务
|
2月前
|
Java 数据库连接 数据库
SpringBoot 整合jdbc和mybatis
本文详细介绍了如何在SpringBoot项目中整合JDBC与MyBatis,并提供了具体的配置步骤和示例代码。首先,通过创建用户实体类和数据库表来准备基础环境;接着,配置Maven依赖、数据库连接及属性;最后,分别展示了JDBC与MyBatis的集成方法及其基本操作,包括增删查改等功能的实现。适合初学者快速入门。
SpringBoot 整合jdbc和mybatis
|
1月前
|
Java 关系型数据库 MySQL
springboot学习五:springboot整合Mybatis 连接 mysql数据库
这篇文章是关于如何使用Spring Boot整合MyBatis来连接MySQL数据库,并进行基本的增删改查操作的教程。
64 0
springboot学习五:springboot整合Mybatis 连接 mysql数据库
|
1月前
|
SQL Java 数据库连接
mybatis使用二:springboot 整合 mybatis,创建开发环境
这篇文章介绍了如何在SpringBoot项目中整合Mybatis和MybatisGenerator,包括添加依赖、配置数据源、修改启动主类、编写Java代码,以及使用Postman进行接口测试。
16 0
mybatis使用二:springboot 整合 mybatis,创建开发环境
|
1月前
|
Java 数据库连接 API
springBoot:后端解决跨域&Mybatis-Plus&SwaggerUI&代码生成器 (四)
本文介绍了后端解决跨域问题的方法及Mybatis-Plus的配置与使用。首先通过创建`CorsConfig`类并设置相关参数来实现跨域请求处理。接着,详细描述了如何引入Mybatis-Plus插件,包括配置`MybatisPlusConfig`类、定义Mapper接口以及Service层。此外,还展示了如何配置分页查询功能,并引入SwaggerUI进行API文档生成。最后,提供了代码生成器的配置示例,帮助快速生成项目所需的基础代码。
|
1月前
|
前端开发 Java 数据库连接
表白墙/留言墙 —— 中级SpringBoot项目,MyBatis技术栈MySQL数据库开发,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
本文是一份全面的表白墙/留言墙项目教程,使用SpringBoot + MyBatis技术栈和MySQL数据库开发,涵盖了项目前后端开发、数据库配置、代码实现和运行的详细步骤。
42 0
表白墙/留言墙 —— 中级SpringBoot项目,MyBatis技术栈MySQL数据库开发,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
|
1月前
|
Java 数据库连接 mybatis
Springboot整合Mybatis,MybatisPlus源码分析,自动装配实现包扫描源码
该文档详细介绍了如何在Springboot Web项目中整合Mybatis,包括添加依赖、使用`@MapperScan`注解配置包扫描路径等步骤。若未使用`@MapperScan`,系统会自动扫描加了`@Mapper`注解的接口;若使用了`@MapperScan`,则按指定路径扫描。文档还深入分析了相关源码,解释了不同情况下的扫描逻辑与优先级,帮助理解Mybatis在Springboot项目中的自动配置机制。
125 0
Springboot整合Mybatis,MybatisPlus源码分析,自动装配实现包扫描源码