MyBatis——第一个Mybatis程序

MyBatis

若出问题，切换版本：

• jdk:1.8
• mysql:5.1.47
• maven 3.6.1
• IDEA

简介

什么是MyBatis

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

如何获得mybatis

maven仓库：https://mvnrepository.com/artifact/org.mybatis/mybatis/3.5.7

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

github地址：https://github.com/mybatis/mybatis-3/releases

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

持久化

数据持久化

• 持久就是将程序的数据在持久状态和瞬时状态转化的过程
  • 持久：数据库(jdbc)，io文件持久化
  • 瞬时：内存：断电即失

持久层

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

为什么需要MyBatis?

• 帮助程序员将数据存入到数据库中

• 传统的jdbc代码太复杂了->简化->框架

• 优点：

  • 简单易学
  • 灵活
  • sql和代码分离，提高可维护性
  • 提供映射标签，支持对象与数据库的orm字段关系映射
  • 提供对象关系映射标签，支持对象关系组建维护
  • 提供xml标签，支持编写动态sql

• 用的人多!

---

---

---

第一个MyBatis程序

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

1.搭建数据库

#mybatis
CREATE DATABASE mybatis;

USE mybatis;

CREATE TABLE USER(
    sid INT(20) NOT NULL PRIMARY KEY,
    sname VARCHAR(30) DEFAULT NULL,
    pwd VARCHAR(30) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=utf8;

INSERT INTO USER(sid,sname,pwd) VALUES
(1,"feliks","123456"),
(2,"zhangsan","123456"),
(3,"lisi","123456")

---

2.新建项目

新建一个普通的maven项目

删除src目录作为父工程

导入maven依赖

<!--父工程-->
    <groupId>net.cqwu</groupId>
    <artifactId>Mybatis-Study</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--导入依赖-->
    <dependencies>
    <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>

---

3.创建一个模块

• 编写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核心配置文件-->
<configuration>
    <!--环境-->
    <environments default="development">
        <environment id="development">
            <!--事物管理-->
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                                                                                    <!--xml中 & 不能用，用 &amp; 代替-->
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
<!--每一个Mapper.xml都需要在Mybatis核心配置文件中注册-->
    <mappers>
        <mapper resource="net/cqwu/dao/UserMapper.xml"/>
    </mappers>
</configuration>

• 编写mybatis工具类

package net.cqwu.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.IOException;
import java.io.InputStream;

//sqlSessionFactory -->构建sqlSession
public class MybatisUtils {

    //提升作用域
    private static SqlSessionFactory sqlSessionFactory;

    static {

        try {
            //使用Mybatis第一步：获取sqlSessionFactory对象
            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(){
//        SqlSession sqlSession = sqlSessionFactory.openSession();
//        return sqlSession;
        return sqlSessionFactory.openSession();
    }
}

---

4.编写代码

• 实体类

public class User {
    private int sid;
    private String sname;
    private String pwd;

    public User() {
    }

    public User(int sid, String sname, String pwd) {
        this.sid = sid;
        this.sname = sname;
        this.pwd = pwd;
    }
    //省略getter setter toString.

• Dao接口

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

• 接口实现类

  由原来的UserDaoImpl转变为一个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接口-->
<mapper namespace="net.cqwu.dao.UserDao">
          <!--方法名-->           <!--返回全限定名-->
    <select id="getUserList" resultType="net.cqwu.pojo.User">
        select * from mybatis.user
    </select>

</mapper>

---

4.测试

• junit

public class UserDaoTest {
    @Test
    public void test(){

        //第一步：获得SqlSession
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //第二步：执行SQL-->方式一：getMapper
        UserDao mapper = sqlSession.getMapper(UserDao.class);
        List<User> userList = mapper.getUserList();
        
        //方式二：老的，不推荐使用
//        List<User> userList = sqlSession.selectList("net.cqwu.dao.UserDao.getUserList");

        
        for (User user : userList) {
            System.out.println(user);
        }

        //关闭SqlSession
        sqlSession.close();
    }
}

可能会遇到问题：

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

---

总结：

七步：

---

---

Mybatis三个核心接口

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，
就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的
最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 
来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，
以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，
没有任何理由丢弃它或重新创建另一个实例。 
使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，
多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。
因此 SqlSessionFactory 的最佳作用域是应用作用域。 
有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。
SqlSession 的实例不是线程安全的，因此是不能被共享的，
所以它的最佳的作用域是请求或方法作用域。 
绝对不能将 SqlSession 实例的引用放在一个类的静态域，
甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型
的托管作用域中，比如 Servlet 框架中的 HttpSession。
 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个
 和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，
 就可以打开一个 SqlSession，返回一个响应后，就关闭它。 
 这个关闭操作很重要，为了确保每次都能执行关闭操作，
 你应该把这个关闭操作放到 finally 块中

确保 SqlSession 关闭的标准模式：

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

---

---

---

遇到的报错：

测试报错

java.lang.ExceptionInInitializerError
	at net.cqwu.dao.UserDaoTest.test(UserDaoTest.java:15)

解决：

• 方式一：将UserMapper.xml复制一份到target\test-classes里面的同一路径下
• 方式二：在pom.xml中加上如下配置
• 若还是报错，将true中的true改为false.

maven由于约定大于配置，可能会遇到写的配置文件，无法被导出或者生效的问题，解决方案：

<!--在build中配置resourse，来防止我们资源导出失败的问题-->
<build>
    <resources>
        <resource>
            <directory>src/main/resource</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>

IDEA链接数据库报错

java.lang.RuntimeException: com.mysql.cj.exceptions.InvalidConnectionAttribute

原因： 未指明serverTimezone

解决方法：

URL中填如下字段：

jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC

thanks for kuang😄