Mybatis入门之基本操作

前言

• 作为一个资深后端码农天天都要和数据库打交道&＃xff0c;最早使用的是 Hiberate&＃xff0c;一个封装性极强的持久性框架。自从接触到 Mybatis 就被它的灵活性所折服了&＃xff0c;可以自己写 SQL&＃xff0c;虽然轻量级&＃xff0c;但是麻雀虽小&＃xff0c;五脏俱全。这篇文章就来讲讲什么是 Mybatis&＃xff0c;如何简单的使用 Mybatis。

什么是 Mybatis

• MyBatis 是一款优秀的持久层框架&＃xff0c;它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO&＃xff08;Plain Old Java Objects&＃xff0c;普通老式 Java 对象&＃xff09;为数据库中的记录。

环境搭建

• 本篇文章使用的环境是SpringBoot&＃43;Mybatis&＃43;Mysql

Maven 依赖

• MySQL 驱动依赖和 Druid 连接池的依赖

        mysqlmysql-connector-java5.1.40runtimecom.alibabadruid-spring-boot-starter1.1.9


• Mybatis 启动包依赖&＃xff0c;此处导入的是 SpringBoot 和 Mybatis 整合启动器的依赖&＃xff0c;点击去可以看到&＃xff0c;这个启动包依赖了mybatis和mybatis-spring&＃xff08;Mybatis 和 Spring 整合的 Jar 包&＃xff09;&＃xff0c;因此使用 SpringBoot 之后只需要导入这个启动器的依赖即可。

        org.mybatis.spring.bootmybatis-spring-boot-starter2.0.0


• 以上两个依赖添加成功后&＃xff0c;Maven 环境就已经配置完了。

数据库连接池配置&＃xff08;Druid&＃xff09;

• 这个不是本文的重点&＃xff0c;而且网上很多教程&＃xff0c;我就简单的配置一下&＃xff0c;在 SpringBoot 的application.properties中配置即可。

##单一数据源
spring.datasource.url&＃61;jdbc\:mysql\://127.0.0.1\:3306/vivachekcloud_pzhdermyy?useUnicode\&＃61;true&characterEncoding\&＃61;UTF-8&zeroDateTimeBehavior\&＃61;convertToNull&useSSL\&＃61;false
spring.datasource.username&＃61;root
spring.datasource.password&＃61;123456
spring.datasource.type&＃61;com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name&＃61;com.mysql.jdbc.Driver
#初始化连接大小
spring.datasource.druid.initial-size&＃61;0
#连接池最大使用连接数量
spring.datasource.druid.max-active&＃61;20
#连接池最小空闲
spring.datasource.druid.min-idle&＃61;0
#获取连接最大等待时间
spring.datasource.druid.max-wait&＃61;6000
spring.datasource.druid.validation-query&＃61;SELECT 1
#spring.datasource.druid.validation-query-timeout&＃61;6000
spring.datasource.druid.test-on-borrow&＃61;false
spring.datasource.druid.test-on-return&＃61;false
spring.datasource.druid.test-while-idle&＃61;true
#配置间隔多久才进行一次检测&＃xff0c;检测需要关闭的空闲连接&＃xff0c;单位是毫秒
spring.datasource.druid.time-between-eviction-runs-millis&＃61;60000
#置一个连接在池中最小生存的时间&＃xff0c;单位是毫秒
spring.datasource.druid.min-evictable-idle-time-millis&＃61;25200000
#spring.datasource.druid.max-evictable-idle-time-millis&＃61;
#打开removeAbandoned功能,多少时间内必须关闭连接
spring.datasource.druid.removeAbandoned&＃61;true
#1800秒&＃xff0c;也就是30分钟
spring.datasource.druid.remove-abandoned-timeout&＃61;1800
#
spring.datasource.druid.log-abandoned&＃61;true
spring.datasource.druid.filters&＃61;mergeStat
#spring.datasource.druid.verifyServerCertificate
#spring.datasource.filters&＃61;stat,wall,log4j
# 通过connectProperties属性来打开mergeSql功能&＃xff1b;慢SQL记录
spring.datasource.connectionProperties&＃61;druid.stat.mergeSql&＃61;true;druid.stat.slowSqlMillis&＃61;5000


基础概念

• dao层&＃xff1a;用于存放和数据库交互的文件&＃xff0c;Mybatis 的interface都放在此层

• service层&＃xff1a;用于存放业务逻辑的文件。

配置 xml 文件存放的位置

• Mybatis 中xml的文件默认是要和interface放在一个包下的&＃xff0c;并且文件的名称要一样。

• 在和 SpringBoot 整合后有两种配置方式&＃xff0c;下面详细介绍。

application.properties 中设置

• 既然是和 SpringBoot 整合&＃xff0c;那么万变不离xxxAutoConfiguration这个配置类了&＃xff0c;Mybatis 的配置类就是MybatisAutoConfiguration&＃xff0c;如下&＃xff1a;

&＃64;org.springframework.context.annotation.Configuration
&＃64;ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
&＃64;ConditionalOnSingleCandidate(DataSource.class)
&＃64;EnableConfigurationProperties(MybatisProperties.class)
&＃64;AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration implements InitializingBean {}


• 可以看到&＃64;EnableConfigurationProperties(MybatisProperties.class)这行代码&＃xff0c;就是将 properties 中的属性映射到 MybatisProperties 这个成员属性中&＃xff0c;因此设置的方式就要看其中的属性。

public class MybatisProperties {//前缀public static final String MYBATIS_PREFIX &＃61; "mybatis";/*** Mybatis配置文件的位置*/private String configLocation;/*** Mybatis的Mapper的xml文件的位置*/private String[] mapperLocations;


• 因此设置的方式很简单&＃xff0c;如下&＃xff1a;

## xml文件放置在/src/main/resource/mapper/文件夹下
mybatis.mapper-locations&＃61;classpath*:/mapper/**/*.xml


配置类中设置

• 不是本章重点&＃xff0c;后面在讲 Mybatis 和 SpringBoot 整合的文章会涉及到该内容。

配置扫描 Mybatis 的 interface

• 在和 SpringBoot 整合后&＃xff0c;扫描 Mybatis 的接口&＃xff0c;生成代理对象是一件很简单的事&＃xff0c;只需要一个注解即可。

&＃64;Mapper

• 该注解标注在 Mybatis 的interface类上&＃xff0c;SpringBoot 启动之后会扫描后会自动生成代理对象。实例如下&＃xff1a;

&＃64;Mapper
public interface UserInfoMapper {int insert(UserInfo record);int insertSelective(UserInfo record);}


• 缺点&＃xff1a;每个interface都要标注一个&＃xff0c;很鸡肋&＃xff0c;一个项目中的 interface 少说也有上百个吧。

&＃64;MapperScan

• &＃64;Mapper注解的升级版&＃xff0c;标注在配置类上&＃xff0c;用于一键扫描 Mybatis 的interface。

• 使用也是很简单的&＃xff0c;直接指定接口所在的包即可&＃xff0c;如下&＃xff1a;

&＃64;MapperScan({"com.xxx.dao"})
public class ApiApplication {}


• &＃64;MapperScan和&＃64;Mapper这两个注解千万不要重复使用。

• 优点&＃xff1a;一键扫描&＃xff0c;不用每个 interface 配置。

基本的 crud

• 既然和数据库交互&＃xff0c;避免不了 crud 操作&＃xff0c;就安心做一个妥妥的crud boy吧。

• 针对 Mybatis 其实有两套方法映射&＃xff0c;一个是 XML 文件的方式&＃xff0c;一个是注解的方式。但是今天只讲 XML 文件的方式&＃xff0c;原因很简单&＃xff0c;注解的方式企业不用&＃xff0c;谁用谁倒霉&＃xff0c;哈哈。

查询

• 查询语句是 MyBatis 中最常用的元素之一——光能把数据存到数据库中价值并不大&＃xff0c;还要能重新取出来才有用&＃xff0c;多数应用也都是查询比修改要频繁。MyBatis 的基本原则之一是&＃xff1a;在每个插入、更新或删除操作之间&＃xff0c;通常会执行多个查询操作。因此&＃xff0c;MyBatis 在查询和结果映射做了相当多的改进。一个简单查询的 select 元素是非常简单的。

SELECT name,age,id FROM PERSON WHERE ID &＃61; #{id}



• 对应的interface的方法如下&＃xff1a;

Person selectPersonById(int id);


• 这个标签有很多属性&＃xff0c;比较常用的属性如下&＃xff1a;

  • id&＃xff08;必填&＃xff09;&＃xff1a;在命名空间中唯一的标识符&＃xff0c;可以被用来引用这条语句。和interface中的方法名要一致。

  • parameterType&＃xff08;可选&＃xff09;&＃xff1a;将会传入这条语句的参数的类全限定名或别名。这个属性是可选的&＃xff0c;因为 MyBatis 可以通过类型处理器&＃xff08;TypeHandler&＃xff09;推断出具体传入语句的参数&＃xff0c;默认值为未设置&＃xff08;unset&＃xff09;。

  • resultType&＃xff1a;期望从这条语句中返回结果的类全限定名或别名。注意&＃xff0c;如果返回的是集合&＃xff0c;那应该设置为集合包含的类型&＃xff0c;而不是集合本身的类型。resultType 和 resultMap 之间只能同时使用一个。

  • resultMap&＃xff1a;对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性&＃xff0c;如果你对其理解透彻&＃xff0c;许多复杂的映射问题都能迎刃而解。resultType 和 resultMap 之间只能同时使用一个。

  
  

  变更

  
  

  • 数据变更语句 insert&＃xff0c;update 和 delete 的实现非常接近。

  • 下面是 insert&＃xff0c;update 和 delete 语句的示例&＃xff1a;

  insert into Author (id,username,password,email,bio)values (#{id},#{username},#{password},#{email},#{bio})
update Author setusername &＃61; #{username},password &＃61; #{password},email &＃61; #{email},bio &＃61; #{bio}where id &＃61; #{id}
delete from Author where id &＃61; #{id}


  

  #{}和${}的区别

  
  

  • 上面的例子中我们可以看到使用的都是#{}&＃xff0c;关于#{}和${}的区别也是在很多初级工程师的面试最常被问到的&＃xff0c;现在只需要记住区别就是#{}使用了 JDBC 的预编译&＃xff0c;可以防止 SQL 注入&＃xff0c;提高了安全性&＃xff0c;${}并没有预编译&＃xff0c;安全性不够。在后面 Mybatis 的源码讲解中将会涉及到为什么一个用了预编译&＃xff0c;一个没用。

  
  

  自增 ID 的返回

  
  

  • 关于 Mysql 的文章中有提到&＃xff0c;设计一个表最好要有一个自增 ID&＃xff0c;无论这个 ID 你是否用到&＃xff0c;具体原因不在解释&＃xff0c;可以翻看之前的文章。

  • 有了自增 ID&＃xff0c;插入之后并不能自动返回&＃xff0c;但是我们又需要这个 ID 值&＃xff0c;那么如何返回呢&＃xff1f;

  • 标签提供了两个属性用来解决这个问题&＃xff0c;如下&＃xff1a;

    • useGeneratedKeys&＃xff1a;设置为 true&＃xff0c;表示使用自增主键返回

    • keyProperty&＃xff1a;指定返回的自增主键映射到parameterType的哪个属性中。

  • 假设插入Person&＃xff0c;并且 person 表中的自增主键 id 需要返回&＃xff0c;XML 文件如下&＃xff1a;

  

insert into person(name,age)values(#{name},#{age});


  

  SQL 代码片段

  
  

  • 这个元素可以用来定义可重用的 SQL 代码片段&＃xff0c;以便在其它语句中使用。参数可以静态地&＃xff08;在加载的时候&＃xff09;确定下来&＃xff0c;并且可以在不同的 include 元素中定义不同的参数值。比如&＃xff1a;

   ${alias}.id,${alias}.username,${alias}.password 

  

  • 这个 SQL 片段可以在其它语句中使用&＃xff0c;例如&＃xff1a;

  select,from some_table t1cross join some_table t2


  

  

  开启驼峰映射

  
  

  • DBA 在设计数据库的时候&＃xff0c;往往使用的是下划线(_)的方式&＃xff0c;比如user_id。但是 Java 是不规范的&＃xff0c;我们通常将它转换为userId&＃xff0c;这就是驼峰命名方法。

  • 但是在使用 Mybatis 查询的时候&＃xff0c;比如&＃xff1a;

  select user_id from user_info


  

  • 上面的user_id和User中的userId根本不对应&＃xff0c;也就映射不进去&＃xff0c;此时查询的结果就是 userId 是 null&＃xff0c;当然我们可以使用别名的方式&＃xff0c;SQL 可以改写为select user_id as userId from user_info

  • 另外一种方式是不用别名&＃xff0c;直接开启 Mybatis 的驼峰映射规则&＃xff0c;会自动映射&＃xff0c;开启的方式很简单&＃xff0c;就是在application.properties文件配置一下&＃xff0c;如下&＃xff1a;

  mybatis.configuration.map-underscore-to-camel-case&＃61;true