MyBatis（一）：第一个MyBatis程序

本文是按照狂神说的教学视频学习的笔记，强力推荐，教学深入浅出1便就懂！b站搜索狂神说即可

https://space.bilibili.com/95256449?spm_id_from=333.788.b_765f7570696e666f.2

本文使用IDEA和maven项目搭建，数据库使用MySQL 8。

定义:MyBatis

• MyBatis 是一款优秀的持久层框架

• 它支持自定义 SQL、存储过程以及高级映射

• MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作

• MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

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

• 以上内容摘自官网和百度百科

获得MyBatis

• maven仓库

          <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
          <dependency>
              <groupId>org.mybatis</groupId>
              <artifactId>mybatis</artifactId>
              <version>3.5.4</version>
          </dependency>
  ​

• GITHUB：https://github.com/mybatis/mybatis-3/releases

• 中文文档：https://mybatis.org/mybatis-3/zh/index.html

数据库准备

1. 导入基本依赖

使用Maven项目导入基本依赖

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.4</version>
        </dependency>
            
            <!--这个是用于分步发布程序-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.11</version>
            <scope>test</scope>
        </dependency>
​

2. 配置mybatis-configxml文件

　　在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"><!--这里的配置根据数据库有所不同，请按照自己的配置-->
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3308/mybatis?useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=true&amp;serverTimezone=GMT%2B8"/>
                <property name="username" value="root"/>
                <property name="password" value="mysql"/>
            </dataSource>
        </environment>
    </environments>
​
    <!--     每一个Mapper.xml都需要Mybatis核心配置文件中注册    -->
    <mappers>
        <mapper resource="com/rzp/dao/UserMapper.xml"/>
    </mappers>
</configuration>

3.创建sqlSessionFactory工具类及其对象

　　创建MybatisUtils类，出于开发习惯按以下结构配置。

//创建sqlSessionFactory工具类
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;
    static{
        InputStream inputStream = null;
        try {
​
            //使用Mybatis，就是利用该工具类获取sqlSessionFacitory对象
            String resource = "mybatis-config.xml";
            inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    
    //创建对象
    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}
​

4.编写代码

示例

• 注意事项：要把IDEA的编译方式改成UTF-8，否则编译出来的xml文件中文是乱码，导致程序执行会报错：1字节的UTF-8序列的字节1无效

• 总览

• 实体类User

package com.rzp.pojo;
​
public class User {
    private int id;
    private String name;
    private String pwd;
​
    public int getId() {
        return id;
    }
​
    public void setId(int id) {
        this.id = id;
    }
​
    public String getName() {
        return name;
    }
​
    public void setName(String name) {
        this.name = name;
    }
​
    public String getPwd() {
        return pwd;
    }
​
    public void setPwd(String pwd) {
        this.pwd = pwd;
    }
​
    public User() {
    }
​
    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }
}

• Mapper接口(UserMapper)

public interface UserMapper {
    List<User> getUserList();
}

• Mapper对应xml文件(UserMapper.xml)文件

  • 　　注意这个文件名字和路径必须和我们第一个xml配置文件：mybatis-config.xml中最后一项配置的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">
​
<!--namespace=绑定一个对应的Dao/Mapper接口-->
<!--namespace名字要与Mapper接口对应-->
<mapper namespace="com.rzp.dao.UserMapper">
    <!--
    id就是Mapper接口中方法的名字

    resultType就是返回的类型，严格来说现在返回的是list，这种情况下是返回的泛式
    -->
    <select id="getUserList" resultType="com.rzp.pojo.User">
    select * from mybatis.user
    </select>
​
​
</mapper>

• 测试方法

  • 　　其实不必要用try catch来包围，但是官方推荐使用，主要是为了finally关闭资源

    @Test
    public void test(){
        //获得sqlSession对象
​
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        try{
            //执行SQL
            //方式一：getMapper
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            List<User> userList = userMapper.getUserList();
​
            for (User user : userList) {
                System.out.println(user);
            }
        }catch (Exception e){
            e.printStackTrace();
        }finally {
            //关闭sqlSession
            sqlSession.close();
​
        }
​

测试结果

拓展1

• java 7开始支持try-with-resource方法，写法是：

try(在这里放入要new的对象){
    
}catch(){
    
}
try catch执行完以后会自动关闭对象的资源，用于IO或者sqlSession都可以，其实就相当于省略了finally的关闭资源

• 就可以改成这样

​
        try(SqlSession sqlSession = MybatisUtils.getSqlSession()){
            //执行SQL
            //方式一：getMapper
            UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
            List<User> userList = userMapper.getUserList();
​
            for (User user : userList) {
                System.out.println(user);
            }
        }catch (Exception e){
            e.printStackTrace();
        }
​
​

• 但是如果是maven项目，pom文件要制定jdk版本，否则会发生编译错误：Try-with-resources are not supported at language level '5’

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

拓展2

除了使用getMapper方法外，还可以使用以下方式调用：

//获得sqlSession对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
try{
    //方式二:
    List<User> usersList = sqlSession.selectList("com.rzp.dao.UserMapper.getUserList");
    for (User user : usersList) {
        System.out.println(user);
    }
}catch (Exception e){
    e.printStackTrace();
}finally {
    //关闭sqlSession
    sqlSession.close();
​
}

• 这是旧版本的方法。

• 显然，这个方法在编写的时候必须选择合适的方法，而且调用的UserMapper的方法时也没有那么方便。这个方法官方不推荐使用。

这是我的GitHub地址

https://github.com/renzhongpei?tab=repositories