MyBatis 学习笔记

MyBatis 学习笔记

@Author: YiHua Lee @Address: Guangdong province, China

MyBatis 框架概述

mybatis 是一个优秀的基于 java 的持久层框架,它内部封装了 jdbc,使开发者只需要关注 sql 语句本身,而不需要花费精力去处理加载驱动、创建连接、创建 statement 等繁杂的过程。

mybatis 通过 xml 或注解的方式将要执行的各种 statement 配置起来,并通过 java 对象和 statement 中sql 的动态参数进行映射生成最终执行的 sql 语句,最后由 mybatis 框架执行 sql 并将结果映射为 java 对象并返回。

采用 ORM 思想解决了实体和数据库映射的问题,对 jdbc 进行了封装,屏蔽了 jdbc api 底层访问细节,使我们不用与 jdbc api 打交道,就可以完成对数据库的持久化操作。

Mybatis 框架快速入门

有如下一个数据库表:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
CREATE TABLE UserMyBatis(
id INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
username VARCHAR(32) NOT NULL COMMENT '用户名称',
birthday DATETIME DEFAULT NULL COMMENT '生日',
sex CHAR(1) DEFAULT NULL COMMENT '性别',
address VARCHAR(256) DEFAULT NULL COMMENT '地址'
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

insert into UserMyBatis(id, username, birthday, sex, address)
values (41, '唐老鸭', '2018-02-27 17:47:08', '女', '北京'),
(42, '米老鼠', '2018-03-02 15:09:37', '男', '上海'),
(43, '小叮当', '2018-03-04 11:34:34', '男', '广州'),
(45, '野比大雄', '2018-03-04 12:04:06', '男', '深圳'),
(46, '静香', '2018-03-07 17:37:26', '女', '成都'),
(48, '小马宝莉', '2018-03-08 11:44:00', '女', '重庆');
  1. 创建 maven 工程

    20200715095422
  1. 添加 Mybatis3.4.5 的坐标

    在 pom.xml 文件中添加 Mybatis3.4.5 的坐标,如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    <dependencies>
    <dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.5</version>
    </dependency>
    <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.10</version>
    <scope>test</scope>
    </dependency>
    <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.25</version>
    <scope>runtime</scope>
    </dependency>
    <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.12</version>
    </dependency>
    </dependencies>
  1. 编写 User 实体类

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    public class User {
    private Integer id;
    private String username;
    private Date birthday;
    private String sex;
    private String address;

    public Integer getId() { return id; }

    public void setId(Integer id) { this.id = id; }

    public String getUsername() { return username; }

    public void setUsername(String username) { this.username = username; }

    public Date getBirthday() { return birthday; }

    public void setBirthday(Date birthday) { this.birthday = birthday; }

    public String getSex() { return sex; }

    public void setSex(String sex) { this.sex = sex; }

    public String getAddress() { return address; }

    public void setAddress(String address) { this.address = address; }

    @Override
    public String toString() {
    return "User [id=" + id +
    ", username=" + username +
    ", birthday=" + birthday +
    ", sex=" + sex +
    ", address=" + address + "]";
    }
    }
  1. 编写持久层接口 UserDaoImpl

    UserDaoImpl 接口就是我们的持久层接口(也可以写成 UserDao 或者 UserMapper)

    1
    2
    3
    4
    5
    6
    7
    public interface UserDaoImpl {
    /**
    * 查询所有用户
    * @return 所有用户的信息
    */
    List<User> findAll();
    }
  1. MyBatis 系统的核心设置 SqlMapConfig.xml

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    <?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 的环境 -->
    <environments default="mysql">
    <!-- 配置 mysql 的环境 -->
    <environment id="mysql">
    <!-- 配置事务的类型 -->
    <transactionManager type="JDBC"></transactionManager>
    <!-- 配置连接数据库的信息:用的是数据源(连接池) -->
    <dataSource type="POOLED">
    <!-- 配置连接数据库的基本信息 -->
    <property name="driver" value="com.mysql.jdbc.Driver"/> <!-- 数据库连接池 -->
    <property name="url" value="jdbc:mysql://localhost:3306/Study"/> <!-- 连接链接 -->
    <property name="username" value="root"/> <!-- mysql用户名 -->
    <property name="password" value="123456"/> <!-- mysql密码 -->
    </dataSource>
    </environment>
    </environments>
    <!-- 告知 mybatis 映射配置的位置 -->
    <mappers>
    <mapper resource="my/stringbug/dao/UserDaoImpl.xml"/>
    </mappers>
    </configuration>
  1. 编写持久层接口的映射文件 UserDaoImpl.xml

    1
    2
    3
    4
    5
    6
    7
    8
    <?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.itheima.dao.IUserDao">
    <!-- 配置查询所有操作 -->
    <select id="findAll" resultType="my.stringbug.domain.User">SELECT * FROM user;</select>
    </mapper>
  1. 测试

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    public class MyBatisTest {
    @Test
    public void FindAllUserInfoTest() throws IOException {
    // 读取配置文件
    InputStream inputStream = Resources.getResourceAsStream("SqlMapConfig.xml");
    // 创建 SqlSessionFactory 工厂
    SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
    SqlSessionFactory factory = builder.build(inputStream);
    // 使用工厂生产 SqlSession 对象
    SqlSession sqlSession = factory.openSession();
    // 使用 SqlSession 创建 Dao 接口的代理对象
    UserDaoImpl userDao = sqlSession.getMapper(UserDaoImpl.class);
    // 使用代理对象执行方法
    List<User> userList = userDao.findAll();
    for (User user : userList) {
    System.out.println(user);
    }
    // 释放资源
    sqlSession.close();
    inputStream.close();
    }
    }
  1. 此外,还可以在持久层借口中添加注解来定义SQL语句

    1
    2
    3
    4
    5
    6
    7
    8
    public interface UserDaoImpl {
    /**
    * 查询所有用户
    * @return 所有用户的信息
    */
    @Select("SELECT * FROM UserMyBatis")
    List<User> findAll();
    }

    这样就可以不用编写持久层接口的映射文件了。

  1. 运行 MyBatisTest ,查询结果如下:

    1
    2
    3
    4
    5
    6
    User [id=41, username=唐老鸭, birthday=Tue Feb 27 17:47:08 CST 2018, sex=女, address=北京]
    User [id=42, username=米老鼠, birthday=Fri Mar 02 15:09:37 CST 2018, sex=男, address=上海]
    User [id=43, username=小叮当, birthday=Sun Mar 04 11:34:34 CST 2018, sex=男, address=广州]
    User [id=45, username=野比大雄, birthday=Sun Mar 04 12:04:06 CST 2018, sex=男, address=深圳]
    User [id=46, username=静香, birthday=Wed Mar 07 17:37:26 CST 2018, sex=女, address=成都]
    User [id=48, username=小马宝莉, birthday=Thu Mar 08 11:44:00 CST 2018, sex=女, address=重庆]
  1. 入门案例目录结构

    20200722101047
评论