MyBatis学习要点记录

未完待续。。。

目录

1、简介

  • MyBatis 是一款优秀的持久层框架,它支持自定义 SQL存储过程以及高级映射
  • 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
  • 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的普通的 Java对象映射成数据库中的记录。

2、MyBatis小练习

2.1 环境搭建
  1. 创建数据库数据 - (MySQL 5.7)
CREATE TABLE `student` (
  `id` INT(10) NOT NULL PRIMARY KEY,
  `name` VARCHAR(30) NOT NULL,
  `age` VARCHAR(5)
) ENGINE=INNODB DEFAULT CHARSET=utf8
INSERT INTO `student` (`id`, `name`,`age`) VALUES ('1', '李白', '33'); 
INSERT INTO `student` (`id`, `name`,`age`) VALUES ('2', '赵云','23'); 
INSERT INTO `student` (`id`, `name`,`age`) VALUES ('3', '诸葛亮','43'); 
INSERT INTO `student` (`id`, `name`,`age`) VALUES ('4', '后裔','54'); 
INSERT INTO `student` (`id`, `name`,`age`) VALUES ('5', '小鲁班','18');
  1. 新建项目
  • 新建一个 Maven 项目,删除 src 并创建父子工程项目结构
    MyBatis学习要点记录

  • 导入 Maven 依赖

<!-- 导入依赖 -->
    <dependencies>
        <!-- mysql驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.49</version>
        </dependency>
        <!-- MyBatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!-- junit -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>
2.2 创建一个模块

作用:
MyBatis学习要点记录

  1. 编写 MyBatis 核心配置文件
    MyBatis学习要点记录
  2. 编写 MyBatis 工具类
public class MyBatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    //初始加载一次就好了
    static {
        //使用MyBatis第一步:获取 SqlSessionFactory 对象
        try {
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
        //既然有了 SqlSessionFactory,顾名思义,我们可以从中获得 SqlSession 的实例。
        // 通过 SqlSession 实例来直接执行已映射的 SQL 语句。
        public static SqlSession getSqlSession(){
            return sqlSessionFactory.openSession();
        }
}
  1. 编写代码
  • 实体类
package com.tang.pojo;

/**
 * @author THX
 * @Date 2021/3/28
 */
public class Student {

    private int id;
    private String name;
    private String age;
	...
}
  • Dao接口
public interface StudentMapper {
    List<Student> getStutent();
}

  • 接口实现类(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">
<!-- 命名空间:绑定一个 dao/mapper接口 -->
<mapper namespace="com.tang.dao.StudentMapper">
    <select id="getStutent" resultType="com.tang.pojo.Student">
    select * from student where id = #{id}
  </select>
</mapper>
2.3 测试

过程:编写方法接口 ——> 编写对应 mapper 中的SQL语句 ——> 测试

@Test
    private void test(){
        //获得 SqlSession 对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();
        
        StudentMapper mapper = sqlSession.getMapper(StudentMapper.class);
        List<Student> stutents = mapper.getStutent();
        
        //关闭资源
        sqlSession.close();
    }

注意:

  • 每个 mapper.xml 都需要在 MyBatis 核心配置文件中注册
  • 增删操作需要提交事务:sqlSession.commit();
<!-- 单个 mapper 注册 -->
<mappers>
        <mapper resource="com/tang/dao/Mapper/StudentMapper.xml"/>
</mappers>
<!-- 批量注册 -->
<mappers>
        <package name="com.tang.Mapper"/>
</mappers>
  • 在父工程的pom.xml中,Build里配置resource,防止资源导出失败问题
<build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

3、配置解析

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

MyBatis可以配置多套环境,其中JDBCPOOLED为默认的事务数据源
MyBatis学习要点记录

3.3 属性(properties)

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

数据库配置文件:db.properties

driver = com.mysql.jdbc.Driver
url = jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
username = root
password = root

在核心配置文件中引入

 <!-- 引入外部配置文件 -->
    <properties resource="db.properties"/>
3.4 别名(typeAliases)

MyBatis-config.xml中配置,注意配置顺序

  • 单个 JavaBean
<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
</typeAliases>
  • 同包下的 JavaBean 一起设置,mapper 中默认别名为 小写开头
<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

如需设置其他别名,可以在 JavaBean 上注解,如

@Alias("blog")
public class Blog{
    ...
}
3.5 设置(settings)

MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为:

设置名 描述 有效值 默认值
cacheEnabled 开启缓存 true /false true
lazyLoadingEnabled 懒加载相关 true /false false
mapUnderscoreToCamelCase 将数据库列A_B映射到Java属性名aB true /false false
logImpl 指定 MyBatis 所用日志的具体实现 SLF4J /LOG4J / LOG4J2 / JDK_LOGGING / COMMONS_LOGGING / STDOUT_LOGGING / NO_LOGGING/ 无
3.6 映射器(mappers)

告诉 MyBatis 到哪里去找到 SQL 语句

  • 方式一:使用类路径
<!-- 使用相对于类路径的资源引用 -->
<mappers>
  <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
</mappers>
  • 方式二:通过 class 全限定名
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
</mappers>

注意点:接口和 mapper 文件需要同名,且在同包下

  • 方式三:扫描包
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

注意点:接口和 mapper 文件需要同名,且在同包下

3.7 生命周期和作用域

不同作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。

MyBatis学习要点记录
  • SqlSessionFactoryBuilder
    用来获得SqlSessionFactory,只需获得一次,因此最佳作用域为:方法作用域(也就是局部方法变量)

  • SqlSessionFactory
    一旦被创建就应该在应用的运行期间一直存在,类似连接池,最佳作用域是应用作用域,使用单例模式实现

  • SqlSession
    每个线程都应该有它自己的 SqlSession 实例,非线程安全,无法共享,作用域是请求或方法作用域

4、属性名和字段名不一致

4.1 ResultMap

当对象属性名和数据库字段名不一致时,可以将其一一对应,进行结果集映射

mapper.xml 文件中:

<!-- user对象属性和数据库字段 -->
<!-- property为对象属性名,column为数据库字段 -->
<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="user_name"/>
  <result property="password" column="hashed_password"/>
</resultMap>
<!-- 查询语句 -->
<select id="selectUsers" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

其中:查询语句返回结果类型,为 resultMap 结果集的id,#{}中的id为传参

5、日志

Mybatis 通过使用内置的日志工厂提供日志功能。
常用:STDOUT_LOGGING(标准)、LOG4J(主要)

LOG4J:可以控制每一条日志的输出格式;通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是,这些可以通过一个配置文件来灵活地进行配置,而不需要修改应用的代码。

使用步骤:

  • 导包
<!-- log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>
  • resources 下,建个log4j.properties配置文件

### 设置###
log4j.rootLogger = debug,stdout,D,E
 
### 输出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
 
### 输出DEBUG 级别以上的日志到=E://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E://logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG 
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
 
### 输出ERROR 级别以上的日志到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =E://logs/error.log 
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR 
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
上一篇:springmvc + spring + mybatis ssm 配置文件


下一篇:用程序都需要日志记录逻辑