Mybatis详细教程入门

举报
李子捌 发表于 2021/11/24 20:11:06 2021/11/24
【摘要】 Mybaits1、简介1.1 什么是MybatisMyBatis 是一款优秀的持久层框架;它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的...

Mybaits


1、简介


1.1 什么是Mybatis



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


1.2 持久化


数据持久化


  • 持久化就是将程序的数据在持久状态和瞬时状态转化的过程
  • 内存：断电即失
  • 数据库（Jdbc）,io文件持久化。


为什么要持久化？


  • 有一些对象，不能让他丢掉
  • 内存太贵


1.3 持久层


Dao层、Service层、Controller层


  • 完成持久化工作的代码块
  • 层界限十分明显


1.4 为什么需要MyBatis


  • 帮助程序员将数据存入到数据库中
  • 方便
  • 传统的JDBC代码太复杂了，简化，框架，自动化
  • 不用MyBatis也可以，技术没有高低之分
  • 优点：
    • 简单易学
    • 灵活
    • sql和代码的分离，提高了可维护性。
    • 提供映射标签，支持对象与数据库的orm字段关系映射
    • 提供对象关系映射标签，支持对象关系组建维护
    • 提供xml标签，支持编写动态sql


2、第一个Mybatis程序


思路：搭建环境 --> 导入MyBatis --> 编写代码 --> 测试


新建项目


  1. 创建一个普通的maven项目
  1. 删除src目录 （就可以把此工程当做父工程了，然后创建子工程）
  1. 导入maven依赖


  <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.22</version>
        </dependency>
        <!--mybatis依赖-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.6</version>
        </dependency>
        <!--Junit依赖-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <!--lombok依赖-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
        </dependency>
        <!--log4j依赖-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>


4.创建一个Module


2.2 创建一个模块


  • 编写mybatis的核心配置文件 
<?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/mybatis?userSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

</configuration>
  • 编写mybatis工具类 
package com.liziba.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.InputStream;

/**
 * @auther LiZiBa
 * @date 2021/1/17 17:01
 * @description: mybatis工具类
 **/
public class MybatisUtil {

    /** SqlSessionFactory对象 */
    static SqlSessionFactory sqlSessionFactory;

    static {
        try{
            // 第一步：通过SqlSessionFactoryBuilder获取SqlSessionFactory
            String resource = "mybatis-config.xml";
            InputStream is = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        }catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取SqlSession （SqlSession提供执行数据库语句方法）
     * @return  SqlSession对象
     */
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}


2.3 编写代码


  • 实体类 
package com.liziba.mybatis.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.ibatis.type.Alias;

/**
 * @auther LiZiBa
 * @date 2021/1/17 17:07
 * @description:
 **/

@Data
@AllArgsConstructor
@NoArgsConstructor
// 别名自定义默认使用实体首字母小写  User-->Alias-->user
@Alias("user")
public class User {

    private Integer id;
    private String name;
    private String password;

}
  • Dao/Mapper接口 
public interface UserMapper {    
	/**
     * 查询所有User
     * @return
     */
    List<User> getUserList();
}
  • 接口实现类 （由原来的UserMapperImpl转变为一个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="com.liziba.mybatis.mapper.UserMapper">
    
    <!--查询所有User-->
    <select id="getUserList" resultType="com.liziba.mybatis.pojo.User">
        select id,name,pwd as password from user
    </select>

</mapper>
  • 测试
    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fgbp0vH1-1622730704315)(C:\Users\Leon Plious\AppData\Roaming\Typora\typora-user-images\1610891512594.png)] 
package com.liziba.mybatis.mapper;

import com.liziba.mybatis.pojo.User;
import com.liziba.mybatis.utils.MybatisUtil;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.session.SqlSession;
import org.apache.log4j.Logger;
import org.junit.Test;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @auther LiZiBa
 * @date 2021/1/17 17:28
 * @description:
 **/
public class UserMapperTest {

    /**
     * 测试获取全部user
     */
    @Test
    public void getUserListTest() {
        // 开启一个SqlSession
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        // 通过SqlSession获取UserMapper
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userMapper.getUserList();
        // 循环输出userList
        userList.forEach(user -> {
            System.out.println(user.toString());
        });
        // 关闭SqlSession
        sqlSession.close();
    }
    
}


可能会遇到的问题：


  1. 配置文件没有注册
  1. 绑定接口错误
  1. 方法名不对
  1. 返回类型不对
  1. Maven导出资源问题


3、CURD


3.1 namespace


namespace中的包名要和Dao/Mapper接口的包名一致


3.2 select


选择，查询语句；


  • id：就是对应的namespace对于的mapper中的方法名；
  • resultType : Sql语句执行的返回值；
  • parameterType : 参数类型；
    1. 编写接口 
/**
  * 通过id获取用户
  * @param id
  * @return
 */
User getUserById(Integer id);
    1. 编写对应的mapper中的sql语句 
<!--通过id查询用户-->
<select id="getUserById" resultType="com.liziba.mybatis.pojo.User">
    select * from user where id = #{id}
</select>
    1. 测试 
/**
 * 通过id获取用户
 */
@Test
public void getUserByIdTest() {

    logger.info("通过id获取用户");

    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = userMapper.getUserById(1);
    System.out.println(user.toString());
    sqlSession.close();
}


**insert/update/delete 语句需要提交事务sqlSession.commit();


3.3 Insert


  1. 编写接口 
/**
 * 插入User
 * @param user
 */
void addUser(User user);
  1. 编写对应的mapper中的sql语句 
<!--添加User-->
<insert id="addUser" parameterType="user">
    insert into user (id, name, pwd) values (#{id}, #{name}, #{pwd})
</insert>
  1. 测试 
/**
 * 测试插入user
*/
@Test
public void addUserTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = new User(5, "liangqinshi", "123456");
    userMapper.addUser(user);
    // 增加、删除、修改一定要提交事务
    sqlSession.commit();
    sqlSession.close();
}


3.4 update


  1. 编写接口 
/**
 * 通过id修改User
 * @param user
*/
void updateUserById(User user);
  1. 编写对应的mapper中的sql语句 
<!--通过id修改用户-->
<update id="updateUserById" parameterType="user">
    update user set name = #{name} ,pwd = #{pwd} where id = #{id}
</update>
  1. 测试 
 /**
  * 通过id修改用户
 */
@Test
public void updateUserByIdTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = new User(1, "liziba01", "654321");
    userMapper.updateUserById(user);

    sqlSession.commit();
    sqlSession.close();
}


3.5 Delete


  1. 编写接口 
/**
     * 通过id删除用户
     * @param id
     */
void deleteUserById(Integer id);
  1. 编写对应的mapper中的sql语句 
<!--通过id删除用户-->
<delete id="deleteUserById" parameterType="int">
    delete from user where id = #{id}
</delete>
  1. 测试 
/**
     * 通过id删除用户
     */
@Test
public void deleteUserByIdTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    userMapper.deleteUserById(5);
    sqlSession.commit();
    sqlSession.close();
}


3.6 万能Map


假设，我们的实体类，或者数据库中的表，字段或者参数过多，我们应该考虑使用Map!


  1. UserMapper接口


/**
     * 通过Map对象插入User
     * @param map
     */
void addUserByMap(Map<String, Object> map);


  1. UserMapper.xml


<!--通过map添加User-->
<insert id="addUserByMap" parameterType="map">
    insert into user (id, name, pwd) values (#{id}, #{name}, #{password})
</insert>


  1. 测试


/**
  * 通过map新增User
 */
@Test
public void addUserByMapTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    // 构建map，传入参数
    Map<String, Object> userMap = new HashMap<>();
    userMap.put("id", 4);
    userMap.put("name", "xieli");
    userMap.put("password", "123456");
    userMapper.addUserByMap(userMap);

    sqlSession.commit();
    sqlSession.close();
}


Map传递参数，直接在sql中取出key即可！ 【parameter=“map”】


对象传递参数，直接在sql中取出对象的属性即可！ 【parameter=“Object”】


只有一个基本类型参数的情况下，可以直接在sql中取到


多个参数用Map , 或者注解！


3.7 模糊查询


**建议Java代码执行的时候，传递通配符% %


  1. UserMapper接口


/**
     * 通过名字模糊查询User
     * @param nameLike   %nameLike%
     * @return
     */
List<User> getUserLikeByName(String nameLike);


  1. UserMapper.xml


<!--通过名字模糊查询-->
<select id="getUserLikeByName" resultMap="UserMap">
    select * from user where name like #{nameLike}
</select>


  1. 测试


/**
 * 通过名字模糊查询
 */
@Test
public void getUserLikeByNameTest() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

    String nameLike = "%li%";
    List<User> users = userMapper.getUserLikeByName(nameLike);
    users.forEach(user -> {
        System.out.println(user.toString());
    });

    sqlSession.close();
}


4、配置解析


4.1 核心配置文件


  • mybatis-config.xml
  • Mybatis的配置文件包含了会深深影响MyBatis行为的设置和属性信息。 
configuration（配置）
    properties（属性）
    settings（设置）
    typeAliases（类型别名）
    typeHandlers（类型处理器）
    objectFactory（对象工厂）
    plugins（插件）
    environments（环境配置）
    	environment（环境变量）
    		transactionManager（事务管理器）
    		dataSource（数据源）
    databaseIdProvider（数据库厂商标识）
    mappers（映射器）


4.2 环境配置 environments


MyBatis 可以配置成适应多种环境


不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境


学会使用配置多套运行环境！


MyBatis默认的事务管理器就是JDBC ，连接池：POOLED


4.3 属性 properties


我们可以通过properties属性来实现引用配置文件


这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。【db.poperties】


  1. 编写一个配置文件
    db.properties 
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?userSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
username=root
password=123456
  1. 在核心配置文件中引入 
<!--属性配置-->
<!--数据库连接配置，如果属性properties存在与外部配置文件相同的key则以外部文件为标准-->
<properties resource="db.properties" />
    • 可以直接引入外部文件
    • 可以在其中增加一些属性配置
    • 如果两个文件有同一个字段，优先使用外部配置文件的


4.4 类型别名 typeAliases


  • 类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置.
  • 意在降低冗余的全限定类名书写。
    也可以指定一个包，每一个在包 com.liziba.mybatis.pojo 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 com.liziba.mybatis.pojo.User 的别名为 user,；若有注解，则别名为其注解值。见下面的例子： 
 <!--别名配置-->
<!--
     在实体类比较少的时候，使用第一种方式。
     如果实体类十分多，建议用第二种扫描包的方式。
     第一种可以自定义别名，第二种需要在实体上增加注解才能自定义别名。
 -->
<typeAliases>
    <!--第一种-->
    <typeAlias type="com.liziba.mybatis.pojo.User" alias="user"></typeAlias> 
</typeAliases>
<typeAliases>
    <!--第二种-->
    <package name="com.liziba.mybatis.pojo"/>
</typeAliases>

在实体类比较少的时候，使用第一种方式。


如果实体类十分多，建议用第二种扫描包的方式。


第一种可以自定义别名，第二种不行，如果非要改，需要在实体上增加注解。

@Alias("user")
public class User {
    ...
}


4.5 设置 Settings


这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。


https://mybatis.org/mybatis-3/zh/configuration.html#settings


<settings>
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="multipleResultSetsEnabled" value="true"/>
  <setting name="useColumnLabel" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>


4.6 其他配置


  • plugins 插件
    • mybatis-generator-core
    • mybatis-plus
    • 通用mapper


4.7. 映射器 mappers


MapperRegistry：注册绑定我们的Mapper文件；


方式一：【推荐使用】


<!--每一个Mapper.xml都需要在MyBatis核心配置文件中注册-->
 <mappers>
     <mapper resource="com/liziba/mybatis/mapper/UserMapper.xml"/>
</mappers>


方式二：使用class文件绑定注册


<!--每一个Mapper.xml都需要在MyBatis核心配置文件中注册-->
<mappers>
    <mapper class="com.liziba.mybatis.mapper.UserMapper"/>
</mappers>


注意点：


  • 接口和他的Mapper配置文件必须同名
  • 接口和他的Mapper配置文件必须在同一个包下


方式三：使用包扫描进行注入


<mappers>
    <package name="com.liziba.mybatis.mapper"/>
</mappers>


4.8 作用域和生命周期



  • 理解我们之前讨论过的不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。
    提示 对象生命周期和依赖注入框架
    依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。 如果对如何通过依赖注入框架使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。
    这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。
    SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。
    每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：
    在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

作用域（Scope）和生命周期

SqlSessionFactoryBuilder

SqlSessionFactory

SqlSession

try (SqlSession session = sqlSessionFactory.openSession()) {
  // 你的应用逻辑代码
}


5、解决属性名和数据库字段名不一致的问题


5.1 问题


[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-68p7rpJs-1622730704319)(C:\Users\Leon Plious\AppData\Roaming\Typora\typora-user-images\1610893482795.png)]


[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Pw33fS2L-1622730704323)(C:\Users\Leon Plious\AppData\Roaming\Typora\typora-user-images\1610893508460.png)]


pwd 与 password不一致查询结果password=null


[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xiP33sRx-1622730704324)(C:\Users\Leon Plious\AppData\Roaming\Typora\typora-user-images\1610893687340.png)]


解决办法（不推荐）


  • 起别名 
<!--查询所有User-->
<!--取别名解决实体字段与数据库字段不一致问题（不推荐）-->
<select id="getUserList" resultType="user">
 	select id,name,pwd as password from user
</select>


5.2 resultMap


结果集映射


id name pwd


id name password


<!--结果集映射-->
<resultMap id="UserMap" type="user">
    <!--column为数据库字段，property为实体字段名-->
    <result column="id" property="id"></result>
    <result column="name" property="name"></result>
    <result column="pwd" property="password"></result>
</resultMap>


 <!--通过id查询用户-->
<!--通过结果集映射解决实体字段与数据库字段不一致问题（推荐）-->
<select id="getUserById" resultMap="UserMap">
    select * from user where id = #{id}
</select>


  • resultMap 元素是 MyBatis 中最重要最强大的元素。它可以让你从 90% 的 JDBC ResultSets 数据提取代码中解放出来，并在一些情形下允许你进行一些 JDBC 不支持的操作。实际上，在为一些比如连接的复杂语句编写映射代码的时候，一份 resultMap 能够代替实现同等功能的数千行代码。ResultMap 的设计思想是，对简单的语句做到零配置，对于复杂一点的语句，只需要描述语句之间的关系就行了。


6、日志


6.1 日志工厂


如果一个数据库操作，出现了异常，我们需要排错，日志就是最好的助手！


曾经：sout、debug


现在：日志工厂


[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-o93Thrgo-1622730704325)(C:\Users\Leon Plious\AppData\Roaming\Typora\typora-user-images\1610893988341.png)]


  • SLF4J
  • LOG4J 【掌握】
  • LOG4J2
  • JDK_LOGGING
  • COMMONS_LOGGING
  • STDOUT_LOGGING 【掌握】
  • NO_LOGGING


在MyBatis中具体使用哪一个日志实现，在设置中设定


STDOUT_LOGGING


<settings>
    <setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>


6.2 Log4j


什么是Log4j？


  • Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件；
  • 我们也可以控制每一条日志的输出格式；
  • 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程；
  • 最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。


  1. 先导入log4j的包 
<!--log4j依赖-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
  1. log4j.properties 
# 将等级为DEBUG级别的日志输出到console和file两个目的地
log4j.rootLogger=DEBUG,console,file

# 控制台输出配置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

# 文件输出配置
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/rzp.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

# 日志输出级别配置
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sq1.PreparedStatement=DEBUG
  1. 配置settings为log4j实现
  1. 测试运行


Log4j简单使用


  1. 在要使用Log4j的类中，导入包 import org.apache.log4j.Logger;
  1. 日志对象，参数为当前类的class对象 
   static Logger logger = Logger.getLogger(UserMapperTest.class);
  1. 日志级别 
/**
     * 通过id获取用户
     */
@Test
public void getUserByIdTest() {

    logger.info("通过id获取用户");

    SqlSession sqlSession = MybatisUtil.getSqlSession();
    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    User user = userMapper.getUserById(1);
    System.out.println(user.toString());
    sqlSession.close();
}
    1. info
    2. debug
    1. error


7、分页


思考：为什么分页？


  • 减少数据的处理量


7.1 使用Limit分页


SELECT * from user limit startIndex,pageSize


使用MyBatis实现分页，核心SQL


  1. 接口 
/**
  * Limit分页查询用户
  * @param map
  * @return
 */
List<User> getUserByLimit(Map<String, Integer> map);
  1. Mapper.xml 
<!--limit分页查询-->
<select id="getUserByLimit" resultMap="UserMap">
    select * from user limit #{startIndex}, #{pageSize}
</select>
  1. 测试 
/**
     * limit分页查询
     */
@Test
public void getUserByLimit() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();

    UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
    Map<String, Integer> paramMap = new HashMap<>();
    paramMap.put("startIndex", 0);
    paramMap.put("pageSize", 2);
    List<User> users = userMapper.getUserByLimit(paramMap);

    users.forEach(user -> {
        System.out.println(user.toString());
    });

    sqlSession.close();
}


7.2 RowBounds分页


不再使用SQL实现分页


  1. 接口 
/**
 * RowBounds分页查询
 * @return
*/
List<User> getUserByRowBounds();
  1. mapper.xml 
<!--RowBound分页查询-->
<select id="getUserByRowBounds" resultMap="UserMap">
    select * from user
</select>
  1. 测试 
/**
     * RowBounds分页查询
     */
@Test
public void getUserByRowBounds() {
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    RowBounds rowBounds = new RowBounds(0, 2);
    List<User> users = sqlSession.selectList("com.liziba.mybatis.mapper.UserMapper.getUserByRowBounds", null, rowBounds);
    users.forEach(user -> {
        System.out.println(user.toString());
    });

    sqlSession.close();
}


7.3 分页插件


pagehelper


8、使用注解开发


8.1 面向接口开发


  • 面向对象：考虑问题以对象为单位，考虑对象的属性和方法
  • 面向过程：考虑问题以一个具体的流程（事务过程）为单位，考虑他的实现
  • 接口开发：针对复用性而言，体现在系统整体的架构和设计


8.2 使用注解开发


  • 注解在接口上 
	/**
     * 查询所有用户
     * @return
     */
    @Select("select * from user")
    List<User> getUsers();

    /**
     * 通过ID查询用户
     * @param id
     * @return
     */
    @Select("select * from user where id = #{id}")
    User getUserById(@Param("id")Integer id);

    /**
     * 更新用户信息
     * @param user
     */
    @Update("update user set name=#{name}, password=#{password} where id = #{id}")
    void setUserById(User user);

    /**
     * 新增用户
     * @param user
     */
    @Insert("insert into user (id, name, password) values (6, #{name}, #{password})")
    void addUser(User user);

    /**
     * 通过ID删除用户
     * @param id
     */
    @Delete("delete from user where id = #{id}")
    void deleteUserById(@Param("id")Integer id);
  • 工具类回顾 
/**
 * @auther LiZiBa
 * @date 2021/1/17 17:01
 * @description: mybatis工具类
 **/
public class MybatisUtil {

    /** SqlSessionFactory对象 */
    static SqlSessionFactory sqlSessionFactory;

    static {
        try{
            // 第一步：通过SqlSessionFactoryBuilder获取SqlSessionFactory
            String resource = "mybatis-config.xml";
            InputStream is = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(is);
        }catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * 获取SqlSession （SqlSession提供执行数据库语句方法）
     * @return  SqlSession对象
     */
    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}
  • 添加mapper接口文件映射 -- 查看最后mappers 
<?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>
    <!--属性配置-->
    <properties resource="db.properties" />

    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>


    <!--环境配置，可以配置多套环境，但是只能指定一个环境使用-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
       <mapper class="com.liziba.mybatis.mapper.UserMapper" />
    </mappers>
</configuration>
  • 测试
    关于@Param( )注解 
    /**
     * 获取用户集合
     */
    @Test
    public void getUsersTest() {

        SqlSession sqlSession = MybatisUtil.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = userMapper.getUsers();
        users.forEach(user -> {
            System.out.println(user.toString());
        });
        // 关闭会话
        sqlSession.close();
    }


    /**
     * 通过用户ID查询用户信息
     */
    @Test
    public void getUserByIdTest() {

        SqlSession sqlSession = MybatisUtil.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = userMapper.getUserById(1);
        System.out.println(user.toString());
        // 关闭会话
        sqlSession.close();
    }


    /**
     * 根据ID更新User
     */
    @Test
    public void setUserByIdTest() {

        SqlSession sqlSession = MybatisUtil.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = new User(1, "谢礼加油！", "123456");
        userMapper.setUserById(user);
        // 提交事务
        sqlSession.commit();
        // 关闭会话
        sqlSession.close();
    }


    /**
     * 新增用户
     */
    @Test
    public void addUserTest() {

        SqlSession sqlSession = MybatisUtil.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = new User(6, "tabao", "350000");
        userMapper.addUser(user);
        // 提交事务
        sqlSession.commit();
        // 关闭会话
        sqlSession.close();
    }

    /**
     * 通过ID删除用户
     */
    @Test
    public void deleteUserByIdTest() {

        SqlSession sqlSession = MybatisUtil.getSqlSession();
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        userMapper.deleteUserById(6);
        // 提交事务
        sqlSession.commit();
        // 关闭会话
        sqlSession.close();
    }
    • 基本类型的参数或者String类型，需要加上
    • 引用类型不需要加
    • 如果只有一个基本类型的话，可以忽略，但是建议大家都加上
    • 我们在SQL中引用的就是我们这里的@Param()中设定的属性名

8.3 MyBatis 中#{}和${}区别

#{} 是预编译处理，像传进来的数据会加个" "（#将传入的数据都当成一个字符串，会对自动传入的数据加一个双引号）

${} 就是字符串替换。直接替换掉占位符。$方式一般用于传入数据库对象，例如传入表名.

使用 ${} 的话会导致 sql 注入。

所以为了防止 SQL 注入，能用 #{} 的不要去用 ${}


9、多对一


多个学生对应一个老师


创建表对象
-- 老师表
CREATE TABLE `teacher` (
  `id` int(11) NOT NULL,
  `name` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

-- 学生表
CREATE TABLE `student` (
  `id` int(11) NOT NULL,
  `name` varchar(255) DEFAULT NULL,
  `tid` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`),
  KEY `fk_tid` (`tid`),
  CONSTRAINT `fk_tid` FOREIGN KEY (`tid`) REFERENCES `teacher` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
环境搭建
    1. 导入lombok
    2. 新建实体类Teacher,Student
    1. 建立Mapper接口
    2. 建立Mapper.xml文件
    1. 在核心配置文件中绑定注册我们的Mapper接口或者文件
    2. 测试查询是否能够成功 
<!--如果mapper.xml文件没有放在resource下需要添加如下配置-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>
  • 按照查询嵌套处理 
   <select id="getStudents" resultMap="studentToTeacher">
        select * from student
    </select>

    <resultMap id="studentToTeacher" type="Student">
        <result property="id" column="id"></result>
        <result property="name" column="name"></result>
        <!--复杂属性对象使用association-->
        <association property="teacher" column="tid" javaType="teacher" select="getTeachers"></association>
    </resultMap>

    <!--对应select="getTeachers"  根据查询出来的tid查询teacher-->
    <select id="getTeachers" resultType="teacher">
        select * from teacher where id = #{tid}
    </select>
/**
     * 测试查询嵌套
     */
    @Test
    public void getStudentsTest() {
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
        List<Student> students = mapper.getStudents();
        students.forEach(student -> {
            System.out.println(student.toString());
        });
        sqlSession.close();
    }



  • 按照结果嵌套处理 
  <select id="getStudents2" resultMap="studentToTeacher2">
         select  s.id sid,s.name sname,t.name tname, t.id tid
         from student s,teacher t
         where s.tid = t.id
    </select>
    <!--结果封装，将查询出来的列封装到对象属性中-->
    <resultMap id="studentToTeacher2" type="student">
        <result property="id" column="sid" />
        <result property="name" column="sname" />
        <association property="teacher" javaType="teacher">
            <result property="id" column="tid" />
            <result property="name" column="tname" />
        </association>
    </resultMap>
 /**
     * 测试结果嵌套
     */
    @Test
    public void getStudents2Test() {
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
        List<Student> students = studentMapper.getStudents2();
        students.forEach(student -> {
            System.out.println(student.toString());
        });
        sqlSession.close();
    }



10、一对多


一个老师对应多个学生


  • 查询嵌套


    <!--查询嵌套-->
    <select id="getTeachers2" resultMap="teacherToStudent2" parameterType="int">
        select * from teacher where id = #{tid}
    </select>
    <resultMap id="teacherToStudent2" type="teacher">
        <result property="id" column="id" />
        <result property="name" column="name" />
        <collection property="students"  column="id" ofType="student" select="getStudents" />
    </resultMap>
    <select id="getStudents" resultType="student">
        select * from student where tid = #{id}
    </select>


/**
     * 查询嵌套
     */
    @Test
    public void getTeacher2() {
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        TeacherMapper mapper = sqlSession.getMapper(TeacherMapper.class);
        List<Teacher> teachers = mapper.getTeachers2(1);
        teachers.forEach(teacher -> {
            System.out.println(teacher.toString());
        });
        sqlSession.close();
    }



  • 结果嵌套


    <!--结果嵌套-->
    <select id="getTeachers" resultMap="teacherToStudent" parameterType="int">
        select t.id tid, t.name tname, s.id sid, s.name sname
        from teacher t,student s
        where t.id = s.tid and tid = #{tid}
    </select>
    <resultMap id="teacherToStudent" type="teacher">
        <result property="id" column="tid" />
        <result property="name" column="tname" />
        <!--ofType用来指定映射到List或者集合中的pojo类型，泛型中的约束类型-->
        <collection property="students" ofType="student">
            <result property="id" column="sid" />
            <result property="name" column="sname" />
            <result property="tid" column="tid" />
        </collection>
    </resultMap>


/**
     * 结果嵌套
     */
    @Test
    public void getTeacher() {
        SqlSession sqlSession = MybatisUtil.getSqlSession();
        TeacherMapper mapper = sqlSession.getMapper(TeacherMapper.class);
        List<Teacher> teachers = mapper.getTeachers(1);
        teachers.forEach(teacher -> {
            System.out.println(teacher.toString());
        });
        sqlSession.close();
    }



11、总结


  1. 关联 - association 【多对一】
  1. 集合 - collection 【一对多】
  1. javaType & ofType
    1. JavaType用来指定实体类中的类型
    2. ofType用来指定映射到List或者集合中的pojo类型，泛型中的约束类型


注意点：


  • 保证SQL的可读性，尽量保证通俗易懂
  • 注意一对多和多对一，属性名和字段的问题
  • 如果问题不好排查错误，可以使用日志，建议使用Log4j


12、动态SQL


12.1 动态 SQL


MyBatis 的强大特性之一便是它的动态 SQL。如果你有使用 JDBC 或其他类似框架的经验，你就能体会到根据不同条件拼接 SQL 语句有多么痛苦。拼接的时候要确保不能忘了必要的空格，还要注意省掉列名列表最后的逗号。利用动态 SQL 这一特性可以彻底摆脱这种痛苦。


通常使用动态 SQL 不可能是独立的一部分,MyBatis 当然使用一种强大的动态 SQL 语言来改进这种情形,这种语言可以被用在任意的 SQL 映射语句中。


12.2 环境搭建


项目结构



建表语句


CREATE TABLE `blog` (
  `id` int(10) NOT NULL AUTO_INCREMENT COMMENT '博客id',
  `title` varchar(30) NOT NULL COMMENT '博客标题',
  `author` varchar(30) NOT NULL COMMENT '博客作者',
  `create_time` datetime NOT NULL COMMENT '创建时间',
  `views` int(30) NOT NULL COMMENT '浏览量',
  `state` int(2) DEFAULT NULL COMMENT '状态',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;


实体类


@Data
@NoArgsConstructor
@AllArgsConstructor
public class Blog {

    private Integer id;
    private String title;
    private String author;
    private Date createTime;
    private int views;
    private int active;

}


MybatisUtil工具类


public class MybatisUtil {

    static SqlSessionFactory sqlSessionFactory;

    static{
        try{
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        }catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }
}


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>
    <!--属性配置-->
    <properties resource="db.properties" />

    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>
    
    <typeAliases>
        <package name="com.liziba.mybatis.pojo"/>
    </typeAliases>

    <!--环境配置，可以配置多套环境，但是只能指定一个环境使用-->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>


    <mappers>
        <mapper resource="com/liziba/mybatis/mapper/BlogMapper.xml" />
    </mappers>
</configuration>


db.properties数据库配置文件


driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?userSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
username=xxxx
password=xxxx


log4j.properties日志配置文件


# 将等级为DEBUG级别的日志输出到console和file两个目的地
log4j.rootLogger=DEBUG,console,file

# 控制台输出配置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

# 文件输出配置
log4j.appender.file=org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/rzp.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

# 日志输出级别配置
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sq1.PreparedStatement=DEBUG


12.3 if


这条语句提供了一个可选的文本查找类型的功能。如果没有传入"title"，那么所有active = 1的BLOG都会返回；反之若传入了"title"，那么就会把模糊查找"title"内容的BLOG结果返回


 <!--通过名字名字模糊查询状态为活跃状态为1的博客-->
<select id="findActiveBlogsWithTitleLike" parameterType="string" resultType="blog">
    select * from blog
    where active = 1
    <if test="title != null">
        and title like #{title}
    </if>
</select>


如果想可选地通过"title"和"author"两个条件搜索


<select id="selectBlogsUseIf" parameterType="map" resultType="blog">
    select * from blog
    where active = 1
    <if test="title != null">
        and title = #{title}
    </if>
    <if test="author != null">
        and author = #{author}
    </if>
</select>


12.4 choose (when, otherwise)


有些时候，我们不想用到所有的条件语句，而只想从中择其一二


<select id="findActiveBlogsOrViewsWithLike" parameterType="map" resultType="blog">
    select * from blog
    where active = 1
    <choose>
        <when test="title != null">
            and title like #{title}
        </when>
        <when test="author != null">
            and author like #{author}
        </when>
        <otherwise>
            and views > 1000
        </otherwise>
    </choose>
</select>


12.5 trim (where, set)


12.5.1 where


现在考虑回到"if"示例，这次我们将active = 1也设置成动态的条件，通过参数传入，看看会发生什么。


<select id="findActiveBlogsWithTitleLike" parameterType="map" resultType="blog">
    select * from blog
    where 
    <if test="active != null">
    	active = #{active}
    </if> 
    <if test="title != null">
        and title like #{title}
    </if>
</select>


如果这些条件没有一个能匹配上将会怎样？最终这条 SQL 会变成这样


select * from blog 
where


这会导致查询失败。如果仅仅第二个条件匹配又会怎样？这条 SQL 最终会是这样


select * from blog 
where 
and title like 'xxxx'


这个查询也会失败


如何解决呢？我们通过where来解决，where 元素知道只有在一个以上的if条件有值的情况下才去插入"WHERE"子句。而且，若最后的内容是"AND"或"OR"开头的，where 元素也知道如何将他们去除。


<select id="findActiveBlogsWithTitleLike" parameterType="map" resultType="blog">
    select * from blog
    <where >
      <if test="active != null">
    	active = #{active}
    </if> 
    <if test="title != null">
        and title like #{title}
    </if>
    </where>
</select>


12.5.2set


类似的用于动态更新语句的解决方案叫做 set。set 元素可以被用于动态包含需要更新的列，而舍去其他的


这里需要注意的是每个值后面的   ,


<!--更新blog-->
<update id="updateBlogIfNecessary" parameterType="blog">
    update blog 
    <set>
        <if test="title != null">
            title = #{title},
        </if>
        <if test="author != null">
            author = #{author},
        </if>
        <if test="views != null">
            views = #{views},
        </if>
        <if test="active != null">
            active = #{active},
        </if>
    </set>
    where id = #{id}
</update>


12.6 foreach


动态 SQL 的另外一个常用的必要操作是需要对一个集合进行遍历，通常是在构建 IN 条件语句的时候


<!--通过ID集合查询博客集合-->
<select id="selectBlogsByIds" parameterType="list" resultType="blog">
    select * from blog
    where id in
    <foreach collection="list" item="id" index="index" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>


foreach 元素的功能是非常强大的，它允许你指定一个集合，声明可以用在元素体内的集合项和索引变量。它也允许你指定开闭匹配的字符串以及在迭代中间放置分隔符。这个元素是很智能的，因此它不会偶然地附加多余的分隔符。


注意 你可以将一个 List 实例或者数组作为参数对象传给 MyBatis，当你这么做的时候，MyBatis 会自动将它包装在一个 Map 中并以名称为键。List 实例将会以"list"作为键，而数组实例的键将是"array"。


12.7 SQL 片段


有的时候，我们可能会将一些功能的部分抽取出来，方便使用！


  • 使用SQL标签抽取公共部分 
<sql id="if-title-author">
    <if test="title!=null">
        title = #{title}
    </if>
    <if test="author!=null">
        and author = #{author}
    </if>
</sql>
  • 在需要使用的地方使用Include标签引用即可 
<select id="getBlogs" parameterType="map" resultType="blog">
    select * from blog
    <where>
        <include refid="if-title-author"></include>
    </where>
</select>


12.8 自定义标签


where等价于


<trim prefix="WHERE" prefixOverrides="AND |OR ">
  ... 
</trim>


set等价于


<trim prefix="SET" suffixOverrides=",">
  ...
</trim>
【版权声明】本文为华为云社区用户原创内容，转载时必须标注文章的来源（华为云社区）、文章链接、文章作者等基本信息， 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容，欢迎发送邮件进行举报，并提供相关证据，一经查实，本社区将立刻删除涉嫌侵权内容，举报邮箱： cloudbbs@huaweicloud.com
MyBatis SQL
  • 点赞
  • 收藏
  • 关注作者

评论（0）

0/1000
抱歉，系统识别当前为高风险访问，暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称，即可参与社区互动！

*长度不超过10个汉字或20个英文字符，设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符，设置后3个月内不可修改。

确认 取消

加入云驻计划，成为创作者

  • 华为云周边好礼
  • 免费体验产品
  • 特殊身份标识
  • 线下官方门票
  • 内部专家零距离
  • 与10000+优质创作者共同成长
立即加入