MyBatis 第一个MyBatis程序 学习笔记

MyBatis官方文档

一、建表

• 在MySQL上新建数据库、新建自己需要的表。

DROP DATABASE IF EXISTS mybatis;  -- 如果存在就先删除
CREATE DATABASE mybatis;  -- 新建数据库

USE mybatis;  -- 不能漏掉
CREATE TABLE `user`(
        id 		INT 		PRIMARY KEY AUTO_INCREMENT,
        `name` 	VARCHAR(20)	NOT NULL,
        address VARCHAR(20)	DEFAULT NULL
) ENGINE=INNODB ;

INSERT INTO `user`(`name`, address)   -- 插入多条数据
VALUES 
('张三','中国'),
('李四','中国'),
('王五','中国');

二、IDEA新建工程

• 详见Maven构建工程
• 目录结构
  

三、根据数据库，编写Java Bean

• 保存在pojo文件夹

public class User {
  private Integer id;
  private String name;
  private String address;

  public User() {
  }

  public User(Integer id, String name, String address) {
    this.id = id;
    this.name = name;
    this.address = address;
  }

  public Integer getId() {
    return id;
  }

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

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getAddress() {
    return address;
  }

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

  @Override
  public String toString() {
    return "User{" +
            "id=" + id +
            ", name='" + name + '\'' +
            ", address='" + address + '\'' +
            '}';
  }
}

四、导入MyBatis依赖

• 在pox.xml文件的dependencies中加入MyBatis、mysql-connector

<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.22</version>
</dependency>

• Maven仓库

五、从 XML 中构建 SqlSessionFactory

• 每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。
• 在xml文件中配置MyBatis系统的核心设置，文件保存在resources文件夹，叫做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 default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--                sql驱动，需要根据实际情况修改-->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <!--               sql的url-->
                <property name="url"
                          value="jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <!--                用户名及密码-->
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!--    设置需要被扫描的mapper，路径通过`/`分隔！-->
    <mappers>
        <mapper resource="com/du/mybatis/dao/UserMapper.xml"/>
    </mappers>
</configuration>

• 编写一个工具类，用来获取SqlSession，类名就叫Utils
• SqlSession 的实例不是线程安全的，因此是不能被共享的
• SqlSession 每次使用完成后需要正确关闭，这个关闭操作是必须的

public class Utils {
  private static SqlSessionFactory sqlSessionFactory;
  static String resource = "mybatis-config.xml";  // mybatis的配置xml文件

  static {
    try {
      InputStream inputStream = Resources.getResourceAsStream(resource);  // 获取文件输入流
      sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 获取SqlSession的工厂
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

  public static SqlSession getSqlSession() {
    return sqlSessionFactory.openSession();  // 返回一个SqlSession
  }
}

六、DAO层编写

• 编写一个DAO的接口

public interface UserMapper {
  List<User> getUserList();  // 获取数据库中所有User
}

• 通过xml文件，保存sql语句；并调用上方接口，保存查询结果。xml文件叫做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="com.du.mybatis.dao.UserMapper">
    <!--    id为接口中的方法名-->
    <!--  resultType 为查询的bean，记得是全路径！  -->
    <select id="getUserList" resultType="com.du.mybatis.pojo.User">
        select id, `name`, address
        from user;
    </select>
</mapper>

七、Mapper使用

• 测试之前写的DAO层

public class UserMapperTest {
  @Test
  public void test() {
         // 通过try-with-resource打开资源，使用完自动close
    try (SqlSession sqlSession = Utils.getSqlSession()) {   // 调用之前在工具类中写的获取SqlSession方法
      UserMapper mapper = sqlSession.getMapper(UserMapper.class);   // 输入指定Mapper的Class，获取底层实现的对象
      List<User> userList = mapper.getUserList();  // 调用接口的方法即可查询结果
      for (User user : userList) {   // 遍历查询结果
        System.out.println(user);
      }
    }
  }
}

至此，完成了MyBatis的第一个程序。