Mybatis

Mybatis

Mybatis概念

• MyBatis 是一款优秀的持久层框架，用于简化 JDBC 开发

• MyBatis 本是 Apache 的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github

• 官网：https://mybatis.org/mybatis-3/zh/index.html

持久层：

• 负责将数据到保存到数据库的那一层代码。Mybatis就是对jdbc代码进行了封装。
• JavaEE三层架构：表现层、业务层、持久层

JDBC的缺点

• 硬编码

  • 注册驱动、获取连接

  代码有很多字符串，而这些是连接数据库的四个基本信息，以后如果要将Mysql数据库换成其他的关系型数据库的话，这四个地方都需要修改，如果放在此处就意味着要修改我们的源代码。

  • SQL语句
    如果表结构发生变化，SQL语句就要进行更改。这也不方便后期的维护。

• 操作繁琐

  • 手动设置参数

  • 手动封装结果集

Mybatis 优化

• 硬编码可以配置到配置文件
• 操作繁琐的地方mybatis都==自动完成

Mybatis快速入门

1、创建模块，导入坐标

<dependencies>
    <!--mybatis 依赖-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.5</version>
    </dependency>

    <!--mysql 驱动-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.46</version>
    </dependency>

    <!--junit 单元测试-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13</version>
        <scope>test</scope>
    </dependency>

    <!-- 添加slf4j日志api -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.20</version>
    </dependency>
    <!-- 添加logback-classic依赖 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.3</version>
    </dependency>
    <!-- 添加logback-core依赖 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-core</artifactId>
        <version>1.2.3</version>
    </dependency>
</dependencies>

注意：需要在项目的 resources 目录下创建logback的配置文件

2、编写 MyBatis 核心配置文件 – > 替换连接信息 解决硬编码问题

在模块下的 resources 目录下创建mybatis的配置文件 mybatis-config.xml，内容如下：

<?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：配置数据库连接环境信息。可以配置多个environment，通过default属性切换不同的environment
    -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--数据库连接信息-->
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql:///mybatis?useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="1234"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
       <!--加载sql映射文件-->
       <mapper resource="UserMapper.xml"/>
    </mappers>
</configuration>

3、编写 SQL 映射文件 --> 统一管理sql语句，解决硬编码问题

在模块的 resources 目录下创建映射配置文件 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">
<mapper namespace="test">
    <select id="selectAll" resultType="com.itheima.pojo.User">
        select * from tb_user;
    </select>
</mapper>

4、编码
4.1创建与数据库表对应的实体类

public class User {
    private int id;
    private String username;
    private String password;
    private String gender;
    private String addr;
    
    //省略了 setter 和 getter
}

4.2编写 MybatisDemo 测试类

public class MyBatisDemo {

    public static void main(String[] args) throws IOException {
        //1. 加载mybatis的核心配置文件，获取 SqlSessionFactory
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

        //2. 获取SqlSession对象，用它来执行sql
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //3. 执行sql
        List<User> users = sqlSession.selectList("test.selectAll"); //参数是一个字符串，该字符串必须是映射配置文件的namespace.id
        System.out.println(users);
        //4. 释放资源
        sqlSession.close();
    }
}

Mybatis Mapper 代理开发

Mybatis基本使用存在硬编码问题。
Mapper 代理方式的目的：

• 解决原生方式中的硬编码
• 简化后期执行SQL

使用要求

使用Mapper代理方式，必须满足以下要求：

• 定义与SQL映射文件同名的Mapper接口，并且将Mapper接口和SQL映射文件放置在同一目录下。
• 设置SQL映射文件的namespace属性为Mapper接口全限定名
• 在 Mapper 接口中定义方法，方法名就是SQL映射文件中sql语句的id，并保持参数类型和返回值类型一致

使用

1、创建mapper 包，创建 BrandMapper接口，代码如下：

public interface BrandMapper {

    /**
     * 查询所有
     */
    List<Brand> selectAll();
}

2、在 resources 下创建 对应的mapper 目录，并在该目录下创建BrandrMapper.xml 映射配置文件

<!--
    namespace:名称空间。必须是对应接口的全限定名
-->
<mapper namespace="solo.iu.mapper.UserMapper">
    <select id="selectAll" resultType="solo.iu.pojo.Brand">
        select *
        from tb_brand;
    </select>
</mapper>

3、测试
测试改方法时,我们发现数据封装成功了，而有些数据并没有封装成功。
原因

实体类中属性名与表中字段名不一致

解决方案

1. sql片段+起别名

• 给两个字段起别名 将需要复用的SQL片段抽取到 sql 标签中

<sql id="brand_column">
	id, brand_name as brandName, company_name as companyName, ordered, description, status
</sql>

id属性值是唯一标识，引用时也是通过该值进行引用。

• 在原sql语句中进行引用

使用 include 标签引用上述的 SQL 片段，而 refid 指定上述 SQL 片段的id值。

<select id="selectAll" resultType="brand">
    select
    <include refid="brand_column" />
    from tb_brand;
</select>

2. resultMap
   起别名 + sql片段的方式可以解决上述问题，但是它也存在问题。如果还有功能只需要查询部分字段，而不是查询所有字段，那么我们就需要再定义一个 SQL 片段，这就显得不是那么灵活。

那么我们也可以使用resultMap来定义字段和属性的映射关系的方式解决上述问题。

• 在映射配置文件中使用resultMap定义 字段 和 属性 的映射关系

  <resultMap id="brandResultMap" type="solo.iu.pojo.Brand">
        <!--
              id：完成主键字段的映射
                  column：表的列名
                  property：实体类的属性名
              result：完成一般字段的映射
                  column：表的列名
                  property：实体类的属性名
          -->
        <result column="brand_name" property="brandName"/>
        <result column="company_name" property="companyName"/>
    </resultMap>

注意：在上面只需要定义 字段名 和 属性名 不一样的映射，而一样的则不需要专门定义出来。

*SQL语句正常编写

<select id="selectAll" resultMap="brandResultMap">
    select *
    from tb_brand;
</select>

参数占位符

mybatis提供了两种参数占位符

• ${} ：拼接SQL。底层使用的是 Statement，会存在SQL注入问题
• #{} ：执行SQL时，会将 #{} 占位符替换为？，将来自动设置参数值。从上述例子可以看出使用#{} 底层使用的是 PreparedStatement
  注意：开发我们使用 #{} 参数占位符

SQL语句中特殊字段处理

以后肯定会在SQL语句中写一下特殊字符，比如某一个字段大于某个值，如下图

可以看出报错了，因为映射配置文件是xml类型的问题，而 > < 等这些字符在xml中有特殊含义，所以此时我们需要将这些符号进行转义，可以使用以下两种方式进行转义

• 转义字符

  下图的 < 就是 < 的转义字符。
  

• <![CDATA[内容]]>

多条件查询

1. 编写接口方法
   在 BrandMapper 接口中定义多条件查询的方法。

而该功能有三个参数，我们就需要考虑定义接口时，参数应该如何定义。Mybatis针对多参数有多种实现

• 使用 @Param("参数名称") 标记每一个参数，在映射配置文件中就需要使用 #{参数名称} 进行占位

  List<Brand> selectByCondition(@Param("status") int status, @Param("companyName") String companyName,@Param("brandName") String brandName);
  

• 将多个参数封装成一个 实体对象 ，将该实体对象作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容} 时，里面的内容必须和实体类属性名保持一致。

  List<Brand> selectByCondition(Brand brand);
  

• 将多个参数封装到map集合中，将map集合作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容} 时，里面的内容必须和map集合中键的名称一致。

  List<Brand> selectByCondition(Map map);
  

2. 编写SQL语句

<select id="selectByCondition" resultMap="brandResultMap">
    select *
    from tb_brand
    where status = #{status}
    and company_name like #{companyName}
    and brand_name like #{brandName}
</select>

3. 动态SQL
   上面的功能实现是有一定的问题的，一般情况下用户在输入条件时，肯定不会所有的条件都填写。所以我们使用动态sql进行sql语句的编写
   Mybatis对动态SQL有很强大的支撑：

• if

• choose (when, otherwise)

• trim (where, set)

• foreach

1. if 标签：条件判断

2. test 属性：逻辑表达式

3. where 标签

4. 作用：

   • 替换where关键字
   • 会动态的去掉第一个条件前的 and
   • 如果所有的参数没有值则不加where关键字

<select id="selectByCondition" resultMap="brandResultMap">
    select *
    from tb_brand
    <where>
        <if test="status != null">
            and status = #{status}
        </if>
        <if test="companyName != null and companyName != '' ">
            and company_name like #{companyName}
        </if>
        <if test="brandName != null and brandName != '' ">
            and brand_name like #{brandName}
        </if>
    </where>
</select>

注意：需要给每个条件前都加上 and 关键字。

单个条件（动态SQL）

1. 编写接口方法

在 BrandMapper 接口中定义单条件查询的方法。

/**
 1. 单条件动态查询
 2. @param brand
 3. @return
  */
List<Brand> selectByConditionSingle(Brand brand);

4. 编写SQL语句

<select id="selectByConditionSingle" resultMap="brandResultMap">
    select *
    from tb_brand
    <where>
        <choose><!--相当于switch-->
            <when test="status != null"><!--相当于case-->
                status = #{status}
            </when>
            <when test="companyName != null and companyName != '' "><!--相当于case-->
                company_name like #{companyName}
            </when>
            <when test="brandName != null and brandName != ''"><!--相当于case-->
                brand_name like #{brandName}
            </when>
        </choose>
    </where>
</select>

添加数据

1. 编写mapper接口

在这里插入代码片 /**
   * 添加
   */
void add(Brand brand);

2. 编写sql

<insert id="add" useGeneratedKeys="true" keyProperty="id">
    insert into tb_brand (brand_name, company_name, ordered, description, status)
    values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>

注意：在 insert 标签上添加如下属性：

• useGeneratedKeys：是够获取自动增长的主键值。true表示获取
• keyProperty ：指定将获取到的主键值封装到哪儿个属性里

修改

1. 编写mapper接口

 /**
   * 修改
   */
void update(Brand brand);

2. 编写sql

<update id="update">
    update tb_brand
    <set>
        <if test="brandName != null and brandName != ''">
            brand_name = #{brandName},
        </if>
        <if test="companyName != null and companyName != ''">
            company_name = #{companyName},
        </if>
        <if test="ordered != null">
            ordered = #{ordered},
        </if>
        <if test="description != null and description != ''">
            description = #{description},
        </if>
        <if test="status != null">
            status = #{status}
        </if>
    </set>
    where id = #{id};
</update>

注意： set 标签可以用于动态包含需要更新的列，忽略其它不更新的列

删除

1. 编写mapper接口

/**
  * 根据id删除
  */
void deleteById(int id);
/**
  * 批量删除
  */
void deleteByIds(int[] ids);

注意: 批量删除的参数是一个数组，数组中存储的是多条数据的id

2. 编写sql

```java
<delete id="deleteById">
    delete from tb_brand where id = #{id};
</delete>

<delete id="deleteByIds">
    delete from tb_brand where id
    in
    <foreach collection="array" item="id" separator="," open="(" close=")">
        #{id}
    </foreach>
    ;
</delete>

foreach 标签

用来迭代任何可迭代的对象（如数组，集合）。

• collection 属性：
  • mybatis会将数组参数，封装为一个Map集合。
    • 默认：array = 数组
    • 使用@Param注解改变map集合的默认key的名称
• item 属性：本次迭代获取到的元素。
• separator 属性：集合项迭代之间的分隔符。foreach 标签不会错误地添加多余的分隔符。也就是最后一次迭代不会加分隔符。
• open 属性：该属性值是在拼接SQL语句之前拼接的语句，只会拼接一次
• close 属性：该属性值是在拼接SQL语句拼接后拼接的语句，只会拼接一次

mybatis 传参

多参

接收多个参数需要使用 @Param 注解

User select(@Param("username") String username,@Param("password") String password);

注意： 以后接口参数是多个时，在每个参数上都使用 @Param 注解。这样代码的可读性更高

单参

• POJO 类型

  直接使用。要求 属性名 和 参数占位符名称 一致

• Map 集合类型

  直接使用。要求 map集合的键名 和 参数占位符名称 一致

• Collection 集合类型

  Mybatis 会将集合封装到 map 集合中，如下：

  map.put(“arg0”，collection集合);

  map.put(“collection”，collection集合;

  可以使用 @Param 注解替换map集合中默认的 arg 键名。

• List 集合类型

  Mybatis 会将集合封装到 map 集合中，如下：

  map.put(“arg0”，list集合);

  map.put(“collection”，list集合);

  map.put(“list”，list集合);

  可以使用 @Param 注解替换map集合中默认的 arg 键名。

• Array 类型

  Mybatis 会将集合封装到 map 集合中，如下：

  map.put(“arg0”，数组);

  map.put(“array”，数组);

  可以使用 @Param 注解替换map集合中默认的 arg 键名。

• 其他类型

  比如int类型，参数占位符名称 叫什么都可以。尽量做到见名知意

注解实现CRUD

Mybatis 针对 CURD 操作都提供了对应的注解，已经做到见名知意。如下：

• 查询 ：@Select
• 添加 ：@Insert
• 修改 ：@Update
• 删除 ：@Delete

使用注解开发会比配置文件开发更加方便。如下就是使用注解进行开发

@Select(value = "select * from tb_user where id = #{id}")
public User select(int id);

注意：

• 注解是用来替换映射配置文件方式配置的，所以使用了注解，就不需要再映射配置文件中书写对应的 statement