SSM 之 MyBatis（上）-阿里云开发者社区

一、MyBatis

1、MyBatis简介

1.1、Mybatis历史

MyBatis最初是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation迁移到了Google Code。随着开发团队转投Google Code旗下， iBatis3.x正式更名为MyBatis。代码于 2013年11月迁移到Github。 iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。 iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。

1.2、MyBatis特性

MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架

MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集

MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录

MyBatis 是一个半自动的ORM（Object Relation Mapping）框架

1.3 MyBatis下载

MyBatis下载地址：https://github.com/mybatis/mybatis-3

1.4、和其他持久化层技术对比

JDBC

SQL 夹杂在Java代码中耦合度高，导致硬编码内伤

维护不易且实际开发需求中 SQL 有变化，频繁修改的情况多见

代码冗长，开发效率低

Hibernate 和 JPA

操作简便，开发效率高

程序中的长难复杂 SQL 需要绕过框架

内部自动生产的 SQL，不容易做特殊优化

基于全映射的全自动框架，大量字段的 POJO 进行部分映射时比较困难。

反射操作太多，导致数据库性能下降

MyBatis

轻量级，性能出色

SQL 和 Java 编码分开，功能边界清晰。Java代码专注业务、SQL语句专注数据

开发效率稍逊于HIbernate，但是完全能够接受

2、搭建MyBatis

2.1、开发环境

IDE：idea 2022.2

构建工具：maven 3.8.4

MySQL版本：MySQL 8.0.28

MyBatis版本：MyBatis 3.5.10

MySQL不同版本的注意事项

1、驱动类driver-class-name MySQL 5版本使用jdbc5驱动，驱动类使用：com.mysql.jdbc.Driver

MySQL 8版本使用jdbc8驱动，驱动类使用：com.mysql.cj.jdbc.Driver

2、连接地址url

MySQL 5版本的url： jdbc:mysql://localhost:3306/ssm

MySQL 8版本的url： jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC

否则运行测试用例报告如下错误： java.sql.SQLException: The server time zone value ‘ÖÐ¹ú±ê×¼Ê±¼ä’ is unrecognized or represents more

2.2、创建maven工程

2.2.1、打包方式：jar

2.2.2、引入依赖

<dependencies>
    <!-- Mybatis核心 -->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.10</version>
    </dependency>
    <!-- junit测试 -->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
    </dependency>
    <!-- MySQL驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
</dependencies>

2.3、创建MyBatis的核心配置文件

习惯上命名为mybatis-config.xml，这个文件名仅仅只是建议，并非强制要求。将来整合Spring 之后，这个配置文件可以省略。

核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息

核心配置文件存放的位置是src/main/resources目录下

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <!-- 配置连接数据库的环境 -->
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC"/>
        <property name="username" value="root"/>
        <property name="password" value="jc951753"/>
      </dataSource>
    </environment>
  </environments>
  <!-- 引入mybatis的映射文件 -->
  <mappers>
    <mapper resource="mappers/UserMapper.xml"/>
  </mappers>
</configuration>

2.4、创建mapper接口

MyBatis中的mapper接口相当于以前的dao。但是区别在于，mapper仅仅是接口，我们不需要提供实现类。

public interface UserMapper {
    /**
     * 添加用户信息
     * @return
     */
    int insertUser();
}

2.5、创建MyBatis的映射文件

相关概念：ORM（Object Relationship Mapping）对象关系映射。

对象：Java的实体类对象

关系：关系型数据库

映射：二者之间的对应关系

Java概念	数据库概念
类	表
属性	字段/列
对象	记录/行

1、映射文件的命名规则：

表所对应的实体类的类名+Mapper.xml

例如：表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml

因此一个映射文件对应一个实体类，对应一张表的操作

MyBatis映射文件用于编写SQL，访问以及操作表中的数据

MyBatis映射文件存放的位置是src/main/resources/mappers目录下

2、 MyBatis中可以面向接口操作数据，要保证两个一致：

mapper接口的全类名和映射文件的命名空间（namespace）保持一致

mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

<?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.jingchao.mybatis.mapper.UserMapper">
  <!--
    mapper接口和映射文件保持两个一致：
      1、mapper接口的全类名和映射文件的namespace一致
      2、mapper接口中的方法名要和映射文件中的sql的id保持一致
   -->
  <!-- int insertUser() -->
  <insert id="insertUser">
    insert into t_user values(null,'admin','123456',18,'男','jc.jingchao@qq.com')
  </insert>
</mapper>

2.6、通过Junit测试功能

@Test
public void testInsert() throws IOException {
    // 获取核心配置文件的输入流
    InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
    // 获取SqlSessionFactoryBuilder对象
    SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
    // 获取SqlSessionFactory对象
    SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
    // 获取Sql的会话对象SqlSession，是MyBatis提供的操作数据库的对象
    SqlSession sqlSession = sqlSessionFactory.openSession();
    // 获取UserMapper的代理实现类对象
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    // 调用mapper接口中的方法啊，实现添加用户信息的功能
    int result = mapper.insertUser();
    System.out.println("result = " + result);
    // 提交事务
    sqlSession.commit();
    // 关闭SqlSession
    sqlSession.close();
}

SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的会话）

SqlSessionFactory：是“生产”SqlSession的“工厂”。

工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。

2.7、添加log4j日志功能

2.7.1、引入依赖

<!-- log4j日志 -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

2.7.2、添加log4j的配置文件

log4j的配置文件命名为logj.xml，存放在src/main/resources目录下

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
  <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
    <param name="Encoding" value="UTF-8" />
    <layout class="org.apache.log4j.PatternLayout">
      <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m (%F:%L) \n" />
    </layout>
  </appender>
  <logger name="java.sql">
    <level value="debug" />
  </logger>
  <logger name="org.apache.ibatis">
    <level value="info" />
  </logger>
  <root>
    <level value="debug" />
    <appender-ref ref="STDOUT" />
  </root>
</log4j:configuration>

日志的级别

FATAL(致命) > ERROR(错误) > WARN(警告) > INFO(信息) > DEBUG(调试)

从左到右打印的内容越来越详细

3、核心配置文件详解

3.1、核心配置文件顺序

MyBatis核心配置文件中标签需要按照指定顺序配置：

properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?

3.2、配置标签详解

下面通过scss的代码样式来说明各个标签的作用和属性等

.configuration{
    .properties{
        作用：引入properties文件 ,此后可以在当前文件中通过 ${key} 的方式访问value
    }
    .typeAliases{
        作用：设置别名，即为某个具体的类型设置一个别名，在MyBatis的范围中，就可以使用别名来表示一个具体的类型
        .typeAlias{
            .属性{
                type：设置需要起别名的类型
                alias：设置某个类型的别名
            }
            .其他{
                1：如果不设置alias，当前类型的默认别名为类名，且不区分大小写
            }
        }
        .package{
            说明：通过包设置类型别名，指定包下所有的类型的默认别名为类名，且不区分大小写
        }
    }
    .environments{
        作用：配置多个连接数据库的环境
        .属性{
            default：设置默认使用的环境的id
        }
        .environment{
            作用：配置某个具体的环境
            .属性{
                id：表示连接数据库的环境的唯一标识，不能重复
            }
            .transactionManager{
                作用：设置事务管理方式
                .属性{
                    .type{
                        JDBC：表示使用JDBC中原生的事务管理方式（当前环境执行SQL时，使用的事务提交或回滚需要手动处理）
                        MANAGED：被管理，例如Spring
                    }
                }
            }
            .dataSource{
                作用：配置数据源
                .属性{
                    .type{
                        作用：设置数据源类型
                        POOLED：表示使用数据库连接池缓存数据库连接
                        UNPOOLED：表示不使用数据库连接池
                        JNDI：表示使用上下文中的数据源
                    }
                }
            }
        }
    }
    .mappers{
        作用：引入mybatis的映射文件
        .mapper{
        }
        .package{
            说明：以包的形式引入映射文件
            .要求：{
              1：mapper接口和映射文件所在的包名必须一致
                2：mapper接口的名字和映射文件的名字必须一致
            }
        }
    }
}

3.3、配置文件详情

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <!--
      MyBatis核心配置文件中标签需要按照指定顺序配置：
      properties?,settings?,typeAliases?,typeHandlers?,
      objectFactory?,objectWrapperFactory?,reflectorFactory?,
      plugins?,environments?,databaseIdProvider?,mappers?
   -->
  <!-- 引入properties文件 ,此后可以在当前文件中通过 ${key} 的方式访问value-->
  <properties resource="jdbc.properties"/>
  <!--
      typeAliases：设置别名，即为某个具体的类型设置一个别名
      在MyBatis的范围中，就可以使用别名来表示一个具体的类型
   -->
  <typeAliases>
    <!--
        type：设置需要起别名的类型
        alias：设置某个类型的别名
     -->
    <!-- <typeAlias type="com.jingchao.mybatis.pojo.User" alias="abc"></typeAlias> -->
    <!-- 如果不设置alias，当前类型的默认别名为类名，且不区分大小写 -->
    <!-- <typeAlias type="com.jingchao.mybatis.pojo.User"></typeAlias> -->
    <!-- 通过包设置类型别名，指定包下所有的类型的默认别名为类名，且不区分大小写 -->
    <package name="com.jingchao.mybatis.pojo"/>
  </typeAliases>
  <!--
      environments：配置连接数据库的环境
      属性：
          default：设置默认使用的环境的id
   -->
  <environments default="development">
    <!--
        environment：设置一个具体的连接数据库的环境
        属性：
            id：设置环境的唯一标识，不能重复
     -->
    <environment id="development">
      <!--
          transactionManager：设置事务管理器
          属性：
              type：设置事务管理的方式
              type：JDBC、MANAGED
                  JDBC：表示使用JDBC中原生的事务管理方式
                  MANAGED：被管理，例如Spring
       -->
      <transactionManager type="JDBC"/>
      <!--
          dataSource：设置数据源
          属性：
              type：设置数据源类型
              type：POOLED、UNPOOLED、JNDI
                  POOLED：表示使用数据库连接池
                  UNPOOLED：表示不使用数据库连接池
                  JNDI：表示使用上下文中的数据库
       -->
      <dataSource type="POOLED">
        <property name="driver" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
      </dataSource>
    </environment>
    <environment id="test">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC"/>
        <property name="username" value="root"/>
        <property name="password" value="jc951753"/>
      </dataSource>
    </environment>
  </environments>
  <!-- 引入mybatis的映射文件 -->
  <mappers>
    <!-- <mapper resource="mappers/UserMapper.xml"/> -->
    <!--
        以包的形式引入映射文件，但是必须满足下面俩个条件
        1、mapper接口和映射文件所在的包名必须一致
        2、mapper接口的名字和映射文件的名字必须一致
     -->
    <package name="com.jingchao.mybatis.mapper"/>
  </mappers>
</configuration>

3.4、其他

3.4.1、SQLSessionUtil工具类的封装

package com.jingchao.mybatis.utils;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
public class SqlSessionUtil {
    public static SqlSession getSqlSession(){
        SqlSession sqlSession = null;
        try {
            // 获取核心配置文件的输入流
            InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
            // 获取SqlSessionFactoryBuilder
            SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
            // 获取SqlSessionFactory
            SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
            // 获取SqlSession对象
            sqlSession = sqlSessionFactory.openSession(true);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return sqlSession;
    }
}

3.4.2、IDEA创建mybatis的模板

① 配置mybatis-congfig模板

idea路径：Settings —> Editor —> File and Code Templates

示例

模板内容

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <!--
      MyBatis核心配置文件中标签需要按照指定顺序配置：
      properties?,settings?,typeAliases?,typeHandlers?,
      objectFactory?,objectWrapperFactory?,reflectorFactory?,
      plugins?,environments?,databaseIdProvider?,mappers?
   -->
  <properties resource="jdbc.properties"/>
  <typeAliases>
    <package name=""/>
  </typeAliases>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <package name=""/>
  </mappers>
</configuration>

② 配置mybatis-mapper模板

配置方法同上

模板内容

<?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="">
</mapper>

4、MyBatis的增删改查

4.1、新增

4.1.1、实现流程

备注：实现流程仅以新增为例演示，后续的操作流程相似。

1.mapper接口中定义抽象方法

public interface UserMapper {
    /**
     * 添加用户信息
     * @return
     */
    int insertUser();
}

2.mapper.xml中写入操作的sql语句

<mapper namespace="com.jingchao.mybatis.mapper.UserMapper">
  <!-- int insertUser() -->
  <insert id="insertUser">
    insert into t_user values(null,'admin','123456',18,'男','jc.jingchao@qq.com')
  </insert>
</mapper>

3.测试方法

public class MyBatisTest{
    @Test
    public void testInsert(){
      // 其中的SqlSessionUtil为自己封装好的工具类    
        SqlSession sqlSession = SqlSessionUtil.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        mapper.insertUser();
        sqlSession.close();
    }
}

4.2、删除

<!-- void deleteUser() -->
<delete id="deleteUser">
    delete from t_user where id = 3
</delete>

4.3、修改

<!-- void updateUser() -->
<update id="updateUser">
    update t_user set username='root',password='1234' where id = 3
</update>

4.4、查询一个实体类对象

<!-- User getUserById() -->
<select id="getUserById" resultType="com.jingchao.mybatis.pojo.User">
    select * from t_user where id = 4
</select>

4.5、查询list集合

<!-- List<User> getAllUser() -->
<select id="getAllUser" resultType="User">
    select * from t_user
</select>

注意：

1、查询的标签select必须设置属性resultType或resultMap，用于设置实体类和数据库表的映射关系

resultType：自动映射，用于属性名和表中字段名一致的情况，即查询的数据转换为Java对象

resultMap：自定义映射，用于处理一对多或多对一或字段名和属性名不一致的情况

5、MyBatis获取参数值的两种方式

MyBatis获取参数值的两种方式：${} 和 #{}

${} 的本质就是字符串拼接

#{}的本质就是占位符赋值

${} 使用字符串拼接的方式拼接sql，若为字符串类型或日期类型的字段进行赋值时，需要手动加单引号；但是#{}使用占位符赋值的方式拼接sql，此时为字符串类型或日期类型的字段进行赋值时，可以自动添加单引号

5.1、单个字面向量类型的参数

说明

若mapper接口中的方法参数为单个的字面量类型

此时可以使用 KaTeX parse error: Expected 'EOF', got '#' at position 6: {} 和 #̲{} 以任意的名称获取参数的值…{}需要手动加单引号

${} 示例

<!-- User getUserByUsername(String username) -->
<select id="getUserByUsername" resultType="User">
    select * from t_user where username = '${username}'
</select>

#{} 示例

<!-- User getUserByUsername(String username) -->
<select id="getUserByUsername" resultType="User">
    select * from t_user where username = #{username}
</select>

5.2、多个字面量类型的参数

说明

若mapper接口中的方法参数为多个时

此时MyBatis会自动将这些参数放在一个map集合中，以arg0,arg1…为键，以参数为值；以 param1,param2…为键，以参数为值；因此只需要通过KaTeX parse error: Expected 'EOF', got '#' at position 4: {}和#̲{}访问map集合的键就可以获…{}需要手动加单引号

${} 示例

<!-- User checkLogin(String username, String password) -->
<select id="checkLogin" resultType="User">
    select * from t_user where username = '${arg0}' and password = '${arg1}'
</select>
<select id="checkLogin" resultType="User">
    select * from t_user where username = '${param1}' and password = '${param2}'
</select>

#{} 示例

<!-- User checkLogin(String username, String password) -->
<select id="checkLogin" resultType="User">
    select * from t_user where username = #{arg0} and password = #{arg1}
</select>
<select id="checkLogin" resultType="User">
    select * from t_user where username = #{param1} and password = #{param2}
</select>

5.3、map集合类型的参数

说明

若mapper接口中的方法需要的参数为多个时

此时可以手动创建map集合，将这些数据放在 map中，只需要通过KaTeX parse error: Expected 'EOF', got '#' at position 4: {}和#̲{}访问map集合的键就可以获…{}需要手动加单引号

手动创建map

HashMap<String, Object> map = new HashMap<>();
map.put("username","admin");
map.put("password","123456");
User user = mapper.checkLoginByMap(map);

${} 示例

<!-- User checkLoginByMap(Map<String, Object> map) -->
<select id="checkLoginByMap" resultType="User">
    select * from t_user where username = '${username}' and password = '${password}'
</select>

#{} 示例

<!-- User checkLoginByMap(Map<String, Object> map) -->
<select id="checkLoginByMap" resultType="User">
    select * from t_user where username = #{username} and password = #{password}
</select>

5.4、实体类类型的参数

说明

若mapper接口中的方法参数为实体类对象时

此时可以使用KaTeX parse error: Expected 'EOF', got '#' at position 4: {}和#̲{}，通过访问实体类对象中的属…{}需要手动加单引号

${} 示例

<!-- void insertUser(User user) -->
<insert id="insertUser">
    insert into t_user values(null,'${username}','${password}','${age}','${gender}','${email}')
</insert>

#{} 示例

<!-- void insertUser(User user) -->
<insert id="insertUser">
    insert into t_user values(null,#{username},#{password},#{age},#{gender},#{email})
</insert>

5.5、使用@Param标识参数（Im）

说明

可以通过@Param注解标识mapper接口中的方法参数

此时，会将这些参数放在map集合中，以@Param注解的value属性值为键，以参数为值；以 param1,param2…为键，以参数为值；只需要通过KaTeX parse error: Expected 'EOF', got '#' at position 4: {}和#̲{}访问map集合的键就可以获…{}需要手动加单引号

${} 示例

<!-- User checkLoginByParam(@Param("username") String username, @Param("password") String password) -->
<select id="checkLoginByParam" resultType="User">
    select * from t_user where username = '${username}' and password = '${password}'
</select>

#{} 示例

<!-- User checkLoginByParam(@Param("username") String username, @Param("password") String password) -->
<select id="checkLoginByParam" resultType="User">
    select * from t_user where username = #{username} and password = #{password}
</select>

6、MyBatis的各种查询功能

6.1、查询一个实体类对象

/**
 * 根据id查询用户信息
 * @param id
 * @return
 */
User getUserById(@Param("id") Integer id);

<!-- User getUserById(@Param("id") Integer id); -->
<select id="getUserById" resultType="User">
    select * from t_user where id = #{id}
</select>

6.2、查询一个list集合

/**
 * 查询所有用户信息
 * @return
 */
List<User> getAllUser();

<!-- List<User> getAllUser(); -->
<select id="getAllUser" resultType="User">
    select * from t_user
</select>

当查询的数据为多条时，不能使用实体类作为返回值，否则会抛出异常

TooManyResultsException；但是若查询的数据只有一条，可以使用实体类或集合作为返回值

6.3、查询单个数据

/**
 * 查询用户的总数量
 * @return
 */
Integer getCount();

<!-- Integer getCount(); -->
<select id="getCount" resultType="_int">
    select count(*) from t_user
</select>

在MyBatis中，对于Java中常用的类型都设置了类型别名

例如： java.lang.Integer–>int / integer

例如： int–>_int / _integer

例如： Map–>map, List–>list

6.4、查询一条数据为map集合

/**
 * 根据id查询用户信息为map集合
 * @param id
 * @return
 */
Map<String, Object> getUserByIdToMap(@Param("id") Integer id)

<!-- Map<String, Object> getUserByIdToMap(@Param("id") Integer id);-->
<!-- 结果：{password=123456, gender=男, id=7, age=18, email=jc.jingchao@qq.com, username=admin} -->
<select id="getUserByIdToMap" resultType="map">
    select * from t_user where id = #{id}
</select>

6.5、查询多条数据为map集合

6.5.1、方式一

将表中的数据以map集合的方式查询，一条数据对应一个map

若有多条数据，会产生多个map集合，此时可以将这些map放在一个list集合中获取

/**
 * 查询所有用户信息为map集合
 * @return
 */
List<Map<String, Object>> getAllUserToMap();

<!-- List<Map<String, Object>> getAllUserToMap(); -->
<select id="getAllUserToMap" resultType="map">
    select * from t_user
</select>

6.5.2、方式二

将表中的数据以map集合的方式查询，一条数据对应一个map

若有多条数据，会产生多个map集合，并且最终会以一个map的方式返回数据（将得到的多个map放在一个大的map中），此时需要通过@Mapkey注解设置map集合的键，值是每条数据对应的map集合

/**
 * 查询所有用户信息为map集合
 * @return
 */
@MapKey("id")
Map<String, Object> getAllUserToMap();

<!-- Map<String, Object> getAllUserToMap(); -->
<!-- 结果：
  {
    4={password=123456, gender=男, id=4, age=18, email=jc.jingchao@qq.com, username=admin}, 
    5={password=123456, gender=男, id=5, age=18, email=jc.jingchao@qq.com, username=admin}, 
    6={password=123456, gender=男, id=6, age=18, email=jc.jingchao@qq.com, username=景超}
  }
-->
<select id="getAllUserToMap" resultType="map">
    select * from t_user
</select>

7、特殊SQL的执行

7.1、模糊查询

/**
 * 通过用户名模糊查询用户信息
 * @param mohu
 * @return
 */
List<User> getUserByLike(@Param("mohu") String mohu);

<!-- List<User> getUserByLike(@Param("mohu") String mohu); -->
<select id="getUserByLike" resultType="User">
    <!-- select * from t_user where username like '%${mohu}%' -->
    <!-- select * from t_user where username like concat('%',#{mohu},'%') -->
  select * from t_user where username like "%"#{mohu}"%"
</select>

7.2、批量删除

/**
 * 批量删除
 * @param ids
 */
void deleteMoreUser(@Param("ids") String ids);

<!-- void deleteMoreUser(@Param("ids") String ids); -->
<delete id="deleteMoreUser">
    delete from t_user where id in (${ids})
</delete>

7.3、动态设置表名

/**
 * 动态设置表名，查询用户信息
 * @param tableName
 * @return
 */
List<User> getUserList(@Param("tableName") String tableName);

<!-- List<User> getUserList(@Param("tableName") String tableName); -->
<select id="getUserList" resultType="User">
    select * from ${tableName}
</select>

7.4、添加功能获取自增的主键

场景模拟：添加班级时为班级分配学生

t_clazz(clazz_id, clazz_name)

t_student(student_id, student_name, clazz_id)

1、添加班级信息

2、获取新添加的班级的id

3、为班级分配学生，即将某学生的班级id修改为新添加的班级的id

/**
 * 添加用户信息，获取自增的主键
 * @param user
 */
void insertUser(User user);

<!-- void insertuser(User user); -->
<insert id="insertUser" useGeneratedKeys="true" keyProperty="id">
    insert into t_user values (null,#{username},#{password},#{age},#{gender},#{email})
</insert>

备注：

useGeneratedKeys：设置使用自增的主键

keyProperty：因为增删改有统一的返回值是受影响的行数，因此只能将获取的自增的主键放在传输的参数user对象的某个属性中

8、自定义映射resultMap

8.1、resultMap处理字段和属性的映射关系

若字段名和实体类中的属性名不一致，但是字段名符合数据库的规则（使用 _），实体类中的属性符合Java的规则（驼峰），可以通过下面两种方式实现字段名与实体类中的属性的映射：

通过给字段起别名的方式，保证与实体类中的属性名保持一致

<!-- Emp getEmpByEmpId(@Param("empId") Integer empId); -->
<select id="getEmpByEmpId" resultType="Emp">
    select emp_id empId, emp_name empName, age, gender from t_emp where emp_id = #{empId}
</select>

在mybatis的核心配置文件中设置全局配置信息，在查询表中的信息时，自动将 _ 类型的字段装换为驼峰形式

<!-- 可将下面的内容配置到mybatis-config模板中的properties标签的下方 -->
<settings>
    <!-- 将下划线映射为驼峰 -->
    <setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

<!-- Emp getEmpByEmpId(@Param("empId") Integer empId); -->
<select id="getEmpByEmpId" resultType="Emp">
    select * from t_emp where emp_id = #{empId}
</select>

若字段名和实体类中的属性名不一致，则可以通过resultMap设置自定义映射

<!--
  resultMap：设置自定义映射
  属性：
    id：表示自定义映射的唯一标识
    type：查询的数据要映射的实体类的类型
  子标签：
    id：设置主键的映射关系
    result：设置普通字段的映射关系
    association：设置多对一的映射关系
    collection：设置一对多的映射关系
  属性：
    column：设置映射关系中表中的字段名  
    property：设置映射关系中实体类中的属性名
-->
<resultMap id="empResultMap" type="Emp">
    <id column="emp_id" property="empId"></id>
    <result column="emp_name" property="empName"></result>
    <result column="age" property="age"></result>
    <result column="gender" property="gender"></result>
</resultMap>
<!-- Emp getEmpByEmpId(@Param("empId") Integer empId); -->
<select id="getEmpByEmpId" resultMap="empResultMap">
    select * from t_emp where emp_id = #{empId}
</select>

8.2、多对一映射处理

场景：查询员工信息以及员工所对应的部门信息

8.2.1、级联方式处理映射关系

<resultMap id="empAndDeptResultMap" type="Emp">
    <id column="emp_id" property="empId"></id>
    <result column="emp_name" property="empName"></result>
    <result column="age" property="age"></result>
    <result column="gender" property="gender"></result>
    <result column="dept_id" property="dept.deptId"></result>
    <result column="dept_name" property="dept.deptName"></result>
</resultMap>
<!-- Emp getEmpAndDept(@Param("empId") Integer empId); -->
<select id="getEmpAndDept" resultMap="empAndDeptResultMap">
    select * from t_emp left join t_dept
    on t_emp.dept_id = t_dept.dept_id
    where t_emp.emp_id = #{empId}
</select>

8.2.2、使用association处理映射关系

<resultMap id="empAndDeptResultMap" type="Emp">
    <id column="emp_id" property="empId"></id>
    <result column="emp_name" property="empName"></result>
    <result column="age" property="age"></result>
    <result column="gender" property="gender"></result>
    <association property="dept" javaType="Dept">
        <id column="dept_id" property="deptId"></id>
        <result column="dept_name" property="deptName"></result>
    </association>
</resultMap>
<!-- Emp getEmpAndDept(@Param("empId") Integer empId); -->
<select id="getEmpAndDept" resultMap="empAndDeptResultMap">
    select * from t_emp left join t_dept
    on t_emp.dept_id = t_dept.dept_id
    where t_emp.emp_id = #{empId}
</select>

备注：

association：处理多对一的映射关系（处理实体类类型的属性）

property：设置需要处理映射关系的属性的属性名

javaType：设置要处理的属性的类型

8.2.2、分步查询

1.查询员工信息

/**
 * 通过分布查询查询员工以及对应的部门信息的第一步
 * @param empId
 * @return
 */
Emp getEmpAndDeptByStepOne(@Param("empId") Integer empId);

<resultMap id="empAndDeptByStepResultMap" type="Emp">
    <id column="emp_id" property="empId"></id>
    <result column="emp_name" property="empName"></result>
    <result column="age" property="age"></result>
    <result column="gender" property="gender"></result>
    <association 
                 property="dept" 
                 select="com.jingchao.mybatis.mapper.DeptMapper.getEmpAndDeptByStepTwo"
                 column="dept_id"
                 ></association>
</resultMap>
<!-- Emp getEmpAndDeptByStepOne(@Param("empId") Integer empId); -->
<select id="getEmpAndDeptByStepOne" resultMap="empAndDeptByStepResultMap">
    select * from t_emp where emp_id = #{empId}
</select>

2.根据员工所对应的部门id查询部门信息

/**
 * 通过分布查询查询员工以及对应的部门信息的第二步
 * @param deptId
 * @return
 */
Dept getEmpAndDeptByStepTwo(@Param("deptId") Integer deptId);

<!-- Dept getEmpAndDeptByStepTwo(@Param("deptId") Integer deptId); -->
<select id="getEmpAndDeptByStepTwo" resultType="Dept">
    select * from t_dept where dept_id = #{deptId}
</select>

备注：association标签的属性

property：设置需要处理映射关系的属性的属性名

select：设置分步查询的sql的唯一标识

column：将查询出的某个字段作为分步查询的sql的条件

注：分步查询优点

分步查询的优点：可以实现延迟加载

实现：

1、核心配置文件中设置全局配置信息

lazyLoadingEnabled：延迟加载的全局开关。当开启时，所有关联对象都会延迟加载

aggressiveLazyLoading：当开启时，任何方法的调用都会加载该对象的所有属性。否则，每个属性会按需加载

2、通过association和 collection中的fetchType属性设置当前的分步查询是否使用延迟加载， fetchType=“lazy(延迟加载) eager(立即加载)”

<!-- 全局配置 -->
<settings>
    <!-- 开启延迟加载 -->
    <setting name="lazyLoadingEnabled" value="true"/>
    <!-- 按需加载， 默认为false，课省略不配置 -->
    <setting name="aggressiveLazyLoading" value="false"/>
</settings>

<associatio fetchType="lazy"></association>

8.3、一对多映射处理

8.3.1、collection

/**
 * 查询部门以及部门中的员工信息
 * @param deptId
 * @return
 */
Dept getDeptAndEmpByDeptId(@Param("deptId") Integer deptId);

<resultMap id="deptAndEmpResultMap" type="Dept">
    <id column="dept_id" property="deptId"></id>
    <result column="dept_name" property="deptName"></result>
    <collection property="emps" ofType="Emp">
        <id column="emp_id" property="empId"></id>
        <result column="emp_name" property="empName"></result>
        <result column="age" property="age"></result>
        <result column="gender" property="gender"></result>
    </collection>
</resultMap>
<!-- Dept getDeptAndEmpByDeptId(@Param("deptId") Integer deptId); -->
<select id="getDeptAndEmpByDeptId" resultMap="deptAndEmpResultMap">
    select * from t_dept left join t_emp
    on t_dept.dept_id = t_emp.dept_id
    where t_dept.dept_id = #{deptId}
</select>

备注：association标签的属性

ofType：设置集合类型的属性中存储的数据的类型

8.3.2、分步查询

查询部门信息

/**
 * 通过分步查询查询部门以及部门中的员工信息的第一步
 * @param deptId
 * @return
 */
Dept getDeptAndEmpByStepOne(@Param("deptId") Integer deptId);

<resultMap id="deptAndEmpResultMapByStep" type="Dept">
    <id column="dept_id" property="deptId"></id>
    <result column="dept_name" property="deptName"></result>
    <collection property="emps"
                select="com.jingchao.mybatis.mapper.EmpMapper.getDeptAndEmpByStepTwo"
                column="dept_id"
                ></collection>
</resultMap>
<!-- Dept getDeptAndEmpByStepOne(@Param("deptId") Integer deptId); -->
<select id="getDeptAndEmpByStepOne" resultMap="deptAndEmpResultMapByStep">
    select * from t_dept where dept_id = #{deptId}
</select>

根据部门的id查询部门中所有的员工

/**
 * 通过分布查询查询部门以及部门中的员工信息的第二步
 * @param deptId
 * @return
 */
List<Emp> getDeptAndEmpByStepTwo(@Param("deptId") Integer deptId);

<!-- List<Emp> getDeptAndEmpByStepTwo(@Param("deptId") Integer deptId);-->
<select id="getDeptAndEmpByStepTwo" resultType="Emp">
    select * from t_emp where dept_id = #{deptId}
</select>

9、动态SQL

Mybatis框架的动态SQL技术是一种根据特定条件动态拼装SQL语句的功能，它存在的意义是为了解决拼接SQL语句字符串的痛点问题

9.1、if

说明

if 标签可以通过test属性的表达式进行判断，若表达式结果为true，则标签中的内容会被执行；反之标签中的内容不会被执行

示例

<!-- List<Emp> getEmpByCondition(Emp emp); -->
<select id="getEmpByCondition" resultType="Emp">
    select * from t_emp where 1=1
    <if test="empName != null and empName != ''">
        emp_name = #{empName}
    </if>
    <if test="age != null and age != ''">
        and age = #{age}
    </if>
    <if test="gender != null and gender != ''">
        and gender = #{gender}
    </if>
</select>

9.2、where

说明

where 和 if 一般结合使用：

1、若where标签中的if条件都不满足，则where标签没有任何功能，即不会添加where关键字

2、若where标签中的if条件满足，则where标签会自动添加where关键字

3、where标签会将最前方多余的and删除，内容后多余的and不会被删除

示例

<!-- List<Emp> getEmpByCondition(Emp emp); -->
<select id="getEmpByCondition" resultType="Emp">
    select * from t_emp
    <where>
        <if test="empName != null and empName != ''">
            emp_name = #{empName}
        </if>
        <if test="age != null and age != ''">
            and age = #{age}
        </if>
        <if test="gender != null and gender != ''">
            and gender = #{gender}
        </if>
    </where>
</select>

9.3、trim

说明

trim 用于去掉或添加标签中的内容

常用属性：

prefix：在标签中的内容的前面添加指定内容

prefixOverrides：在标签中的内容的前面去掉指定内容

suffix：在trim标签中的内容的后面添加指定内容

suffixOverrides：在trim标签中的内容的后面去掉指定内容

示例

<!-- List<Emp> getEmpByCondition(Emp emp); -->
<select id="getEmpByCondition" resultType="Emp">
    select * from t_emp
    <trim prefix="where" suffixOverrides="and">
        <if test="empName != null and empName != ''">
            emp_name = #{empName} and
        </if>
        <if test="age != null and age != ''">
            age = #{age} and
        </if>
        <if test="gender != null and gender != ''">
            gender = #{gender}
        </if>
    </trim>
</select>

9.4、choose、when、otherwise

说明

choose、when、otherwise相当于java中的 if…else if…else

其中when至少设置一个，otherwise至多设置一个

示例

<!-- List<Emp> getEmpByChoose(Emp emp); -->
<select id="getEmpByChoose" resultType="Emp">
    select * from t_emp
    <where>
        <choose>
            <when test="empName != null and empName != ''">
                emp_name = #{empName}
            </when>
            <when test="age != null and age != ''">
                age = #{age}
            </when>
            <when test="gender != null and gender != ''">
                gender = #{gender}
            </when>
        </choose>
    </where>
</select>

9.5、foreach

说明

属性：

collection：要循环的数组或者集合

item：用一个字符串来表示数组或集合中的每一个元素

separator：设置每次循环的数据之间的分隔符

open：循环的所有内容以什么开始

close：循环的所有内容以什么结束

示例一（批量添加）

<!-- void insertMoreEmp(@Param("emps") List<Emp> emps); -->
<insert id="insertMoreEmp">
    insert into t_emp values
    <foreach collection="emps" item="emp" separator=",">
        (null,#{emp.empName},#{emp.age},#{emp.gender},null)
    </foreach>
</insert>

示例二（批量删除）

<!-- void deleteMoreEmp(@Param("empIds") Integer[] empIds); -->
<delete id="deleteMoreEmp">
    delete from t_emp where emp_id in
    (
    <foreach collection="empIds" item="empId" separator=",">
        #{empId}
    </foreach>
    )
</delete>
<delete id="deleteMoreEmp">
    delete from t_emp where emp_id in
    <foreach collection="empIds" item="empId" separator="," open="(" close=")">
        #{empId}
    </foreach>
</delete>
<delete id="deleteMoreEmp">
    delete from t_emp where
    <foreach collection="empIds" item="empId" separator="or">
        emp_id = #{empId}
    </foreach>
</delete>

9.6、SQL片段

说明

可以记录一段sql，在需要使用的地方通过include标签进行引入

示例

<sql id="empColumns">
    emp_id,emp_name,age,gender,dept_id
</sql>
<!-- 引用sql片段 -->
<!-- List<Emp> getEmpByCondition(Emp emp); -->
<select id="getEmpByConditionOne" resultType="Emp">
    select <include refid="empColumns"></include> from t_emp where
    <if test="empName != null and empName != ''">
        emp_name = #{empName}
    </if>
    <if test="age != null and age != ''">
        and age = #{age}
    </if>
    <if test="gender != null and gender != ''">
        and gender = #{gender}
    </if>
</select>

10、MyBatis的缓存

10.1、MyBatis的一级缓存

一级缓存是SqlSession级别的，通过同一个SqlSession查询的数据会被缓存，下次查询相同的数据，就会从缓存中直接获取，不会从数据库重新访问

使一级缓存失效的四种情况：

不同的SqlSession对应不同的一级缓存

同一个SqlSession但是查询条件不同

同一个SqlSession两次查询期间执行了任何一次增删改操作

同一个SqlSession两次查询期间手动清空了缓存

备注：一级缓存默认开启

10.2、MyBatis的二级缓存

二级缓存是SqlSessionFactory级别，通过同一个SqlSessionFactory创建的SqlSession查询的结果会被缓存；此后若再次执行相同的查询语句，结果就会从缓存中获取

二级缓存开启的条件：

在核心配置文件中，设置全局配置属性cacheEnabled=“true”，默认为true，不需要设置

在映射文件中设置标签

二级缓存必须在SqlSession关闭或提交之后有效

查询的数据所转换的实体类类型必须实现序列化的接口

使二级缓存失效的情况：

两次查询之间执行了任意的增删改，会使一级和二级缓存同时失效

10.3、二级缓存的相关配置

在mapper配置文件中添加的cache标签可以设置一些属性：

eviction属性：缓存回收策略，默认的是 LRU。

LRU（Least Recently Used） – 最近最少使用的：移除最长时间不被使用的对象。

FIFO（First in First out） – 先进先出：按对象进入缓存的顺序来移除它们。

SOFT – 软引用：移除基于垃圾回收器状态和软引用规则的对象。

WEAK – 弱引用：更积极地移除基于垃圾收集器状态和弱引用规则的对象。

flushInterval属性：刷新间隔，单位毫秒

默认情况是不设置，也就是没有刷新间隔，缓存仅仅调用语句时刷新

size属性：引用数目，正整数

代表缓存最多可以存储多少个对象，太大容易导致内存溢出

readOnly属性：只读， true/false

true：只读缓存；会给所有调用者返回缓存对象的相同实例。因此这些对象不能被修改。这提供了很重要的性能优势。

false：读写缓存；会返回缓存对象的拷贝（通过序列化）。这会慢一些，但是安全，因此默认是 false。

10.4、MyBatis缓存查询的顺序

先查询二级缓存，因为二级缓存中可能会有其他程序已经查出来的数据，可以拿来直接使用。

如果二级缓存没有命中，再查询一级缓存

如果一级缓存也没有命中，则查询数据库

SqlSession关闭之后，一级缓存中的数据会写入二级缓存

10.5、整合第三方缓存EHCache

10.5.1、添加依赖

<!-- MyBatis EHCache 整合包 -->
<dependency>
    <groupId>org.mybatis.caches</groupId>
    <artifactId>mybatis-ehcache</artifactId>
    <version>1.2.2</version>
</dependency>
<!-- slf4j日志门面的一个具体实现 -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.11</version>
</dependency>

10.5.2、各jar包功能

jar包名称	作用
mybatis-ehcache	MyBatis和EHCache的整合包
ehcache	EHCache核心包
slf4j-api	SLF4J日志门面包
logback-classic	支持SLF4J门面接口的一个具体实现

10.5.3、创建EHCache的配置文件ehcache.xml

<?xml version="1.0" encoding="utf-8" ?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="../config/ehcache.xsd">
  <!-- 磁盘保存路径 -->
  <diskStore path="D:\jingchao\ehcache"/>
  <defaultCache
      maxElementsInMemory="1000"
      maxElementsOnDisk="10000000"
      eternal="false"
      overflowToDisk="true"
      timeToIdleSeconds="120"
      timeToLiveSeconds="120"
      diskExpiryThreadIntervalSeconds="120"
      memoryStoreEvictionPolicy="LRU">
  </defaultCache>
</ehcache>

10.5.4、设置二级缓存的类型

<cache type="org.mybatis.caches.ehcache.EhcacheCache"/>

10.5.5、加入logback日志

存在SLF4J时，作为简易日志的log4j将失效，此时我们需要借助SLF4J的具体实现logback来打印日志。创建logback的配置文件logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
  <!-- 指定日志输出的位置 -->
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <!-- 日志输出的格式 -->
      <!-- 按照顺序分别是： 时间、日志级别、线程名称、打印日志的类、日志主体内容、换行
      -->
      <pattern>[%d{HH:mm:ss.SSS}] [%-5level] [%thread] [%logger]
        [%msg]%n</pattern>
    </encoder>
  </appender>
  <!-- 设置全局日志级别。日志级别按顺序分别是： DEBUG、INFO、WARN、ERROR -->
  <!-- 指定任何一个日志级别都只打印当前级别和后面级别的日志。 -->
  <root level="DEBUG">
    <!-- 指定打印日志的appender，这里通过“STDOUT”引用了前面配置的appender -->
    <appender-ref ref="STDOUT" />
  </root>
  <!-- 根据特殊需求指定局部日志级别 -->
  <logger name="com.jingchao.mybatis.mapper" level="DEBUG"/>
</configuration>

10.5.6、EHCache配置文件说明

属性名	是否必须	作用
maxelementslnMelory	是	在内存中缓存的element的最大数目
maxElementsOnDisk	是	在磁盘上缓存的element的最大数目，若是0表示无穷大
etemal	是	设定缓存的element是否永远不过期。如果为true，则缓存的数据始终有效，如果false那么还要根据timeToldleSeconds、timeToliveSeconds判断
overflowToDisk	是	设定当内存缓存溢出的时候是否将过期的element缓存到磁盘上
timeToldleSeconds	否	当缓存在EhCache中的数据前后两次的访问时间超过timeToldleSeconds的属性取值时，这些数据便会删除，默认值是0，也就是可闲置时间无穷大
timeToLIveSeconds	否	缓存element的有效生命期，默认是0，也就是element的存活时间无穷大
diskSpoolBufferSizeMB	否	DiskStore（硬盘缓存）的缓存区大小。默认是30MB。每个Cache都应该有自己的缓冲区。
diskPersistent	否	在VM重启的时候是否启用磁盘保存EhCache中的数据，默认是false
diskExpiryThreadntervalSeconds	否	磁盘缓存的清理线程运行间隔，默认是120s。每个120s，相应的线程都会进行一次EhCache中数据的清理工作
memoryStoreEvictionPolicy	否	当内存缓存达到最大，有新的element加入的时候，移除缓存中element的策略。默认是LUR（最近最少使用），可选有LFU（最不常使用）和FIFO（先进先出）

SSM 之 MyBatis（上）

热门文章

最新文章

相关课程

相关电子书