第一个Mybatis程序（Mybatis简介、Mybatis工作原理、Mybatis核心组件、CRUD增删改查）

2022-04-16 08:45:11

环境:

jdk1.8
MySQL5.7
maven 3.6.1
IDEA

1.简介

1.1、什么是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/search?q=mybatis

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

Github：https://github.com/mybatis/mybatis-3
mybatis官方文档：https://mybatis.org/mybatis-3/zh/index.html

1.2、持久化

数据持久化

持久化就是将程序的数据在持久状态和瞬时状态转化的过程。
内存：断电即失
数据持久化的方式：数据库（jdbc）、io文件持久化。
生活中的例子：罐头放冰箱里冷藏

为什么需要持久化？

有一些对象，不能让他丢掉
内存太贵了

1.3、持久层

Dao层，Service层,Controller层……

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

1.4、为什么需要Mybatis？

帮助程序员将数据存入到数据库中
方便
传统的JDBC代码太复杂了。人都比较喜欢偷懒，所以出有了了框架，能自动帮我们干很多事。
不用Mybatis也可以，但Mybatis更容易上手。技术没有高低之分。

优点：

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

缺点：

SQL语句编写工作量大，对开发人员有一定要求
数据库移植性差。

2.第一个MyBatis程序

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

2.1、MyBatis环境搭建

搭建数据库

/*创建数据库和表*/
DROP DATABASE IF EXISTS `mybatis`;
CREATE DATABASE `mybatis`;
USE `mybatis`;
CREATE TABLE `user`(
	`id` INT(20) NOT NULL PRIMARY KEY,
	`name` VARCHAR(30) DEFAULT NULL,
	`pwd` VARCHAR(30) DEFAULT NULL
)ENGINE=InnoDB DEFAULT CHARSET=utf8;

/*插入数据*/
INSERT INTO `user`(`id`,`name`,`pwd`) VALUES
(1,'曹操','123456'),
(2,'张飞','123455'),
(3,'孙权','123423')

新建项目

新建一个普通的maven项目
删除src目录，把这个项目当做一个父工程。
导入依赖

<dependencies>
    	<!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</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、创建一个模块（在项目上右键，新建一个module）

编写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>
    <!--起别名-->
    <typeAliases>
        <typeAlias type="cn.xh.pojo.User" alias="User"></typeAlias>
    </typeAliases>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        	<property name="driver" value="com.mysql.jdbc.Driver"/>
            <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
            <property name="username" value="root"/>
            <property name="password" value="root"/>
      </dataSource>
    </environment>
  </environments>
</configuration>

我们描述一下 MyBatis 的基础配置文件：

元素定义了一个别名 user，它代表着 com.mybatis.po.User 这个类。这样定义后，在 MyBatis 上下文中就可以使用别名去代替全限定名了。
元素的定义，这里描述的是数据库。它里面的元素是配置事务管理器，这里采用的是 MyBatis 的 JDBC 管理器方式。
元素配置数据库，其中属性 type=“POOLED” 代表采用 MyBatis 内部提供的连接池方式，最后定义一些关于 JDBC 的属性信息。
元素代表引入的那些映射器，在谈到映射器时会详细讨论它。

编写mybatis工具类

//sqlSessionFactory --> sqlSession
public class MybatisUtil {
    public 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(){
        return sqlSessionFactory.openSession();
    }
}

2.3、编写代码

实体类

public class User {
    private int id;
    private String name;
    private String pwd;

    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }
    public User(){

    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + 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;
    }
}

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">
<mapper namespace="cn.xh.dao.UserDao">
    <!--select查询语句-->
    <select id="getUserList" resultType="User">
        select * from mybatis.user
    </select>
</mapper>

2.4、测试

注意点：org.apache.ibatis.binding.BindingException: Type interface cn.xh.dao.UserDao is not known to the MapperRegistry.

什么是MapperRegistry？核心配置文件中注册mappers

<!--每一个Mapper.xml都需要在Mybatis核心配置文件里注册-->
<mappers>
        <mapper resource="cn/cgz/dao/UserMapper.xml"></mapper>
</mappers>

junit测试

public class UserDaoTest {
    //第一步:获得SqlSession
    SqlSession sqlSession = MybatisUtil.getSqlSession();
    //第二步:getMapper
    UserDao userDao = sqlSession.getMapper(UserDao.class);
    User user = new User();
    @Test
    public void getUserListTest(){
        List<User> userList = userDao.getUserList();
        for (User user: userList) {
            System.out.println(user);
        }
        //关闭SqlSession
        sqlSession.close();
    }
}

可能会遇到的问题：

配置文件没有注册
绑定接口错误
方法名不对
返回类型不对
Maven导出资源问题

<!--在父工程的pom.xml添加这段代码,如果不生效就在子项目的pom.xml也添加-->
<build>
        <!--将mapper文件打包进去-->
        <resources>
            <resource>
                <!--指定根目录 到源文件夹 一般如下-->
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
</build>

3.MyBatis工作原理

读取 MyBatis 配置文件：mybatis-config.xml 为 MyBatis 的全局配置文件，配置了 MyBatis 的运行环境等信息，例如数据库连接信息。

加载映射文件。映射文件即 SQL 映射文件，该文件中配置了操作数据库的 SQL 语句，需要在 MyBatis 配置文件 mybatis-config.xml 中加载。mybatis-config.xml 文件可以加载多个映射文件，每个文件对应数据库中的一张表。

构造会话工厂：通过 MyBatis 的环境等配置信息构建会话工厂 SqlSessionFactory。

创建会话对象：由会话工厂创建 SqlSession 对象，该对象中包含了执行 SQL 语句的所有方法。

Executor 执行器：MyBatis 底层定义了一个 Executor 接口来操作数据库，它将根据 SqlSession 传递的参数动态地生成需要执行的 SQL 语句，同时负责查询缓存的维护。

MappedStatement 对象：在 Executor 接口的执行方法中有一个 MappedStatement 类型的参数，该参数是对映射信息的封装，用于存储要映射的 SQL 语句的 id、参数等信息。

输入参数映射：输入参数类型可以是 Map、List 等集合类型，也可以是基本数据类型和 POJO 类型。输入参数映射过程类似于 JDBC 对 preparedStatement 对象设置参数的过程。

输出结果映射：输出结果类型可以是 Map、 List 等集合类型，也可以是基本数据类型和 POJO 类型。输出结果映射过程类似于 JDBC 对结果集的解析过程。

4、Mybatis核心组件

SqlSessionFactoryBuilder（构造器）：它会根据配置或者代码来生成 SqlSessionFactory，采用的是分步构建的 Builder 模式。
SqlSessionFactory（工厂接口）：依靠它来生成 SqlSession，使用的是工厂模式。
SqlSession（会话）：一个既可以发送 SQL 执行返回结果，也可以获取 Mapper 的接口。在现有的技术中，一般我们会让其在业务逻辑代码中“消失”，而使用的是 MyBatis 提供的 SQL Mapper 接口编程技术，它能提高代码的可读性和可维护性。
SQL Mapper（映射器）:MyBatis 新设计存在的组件，它由一个 Java 接口和 XML 文件（或注解）构成，需要给出对应的 SQL 和映射规则。它负责发送 SQL 去执行，并返回结果。

用一张图来展示Mybatis核心组件的关系。

5、CRUD

5.1、namespace

namespace中的包名要和Dao/mapper接口的包名一致！

5.2、Select

选择，查询语句

id：就是对于的namespace中的方法名
resultType：Sql语句执行的返回值！
parameterType：参数类型！

编写接口

//根据id查询用户
User getUserById(int id);

编写对于的mapper中的sql语句

<select id="getUserById" parameterType="int" resultType="User">
        select * from mybatis.user where id = #{id}
</select>

测试

@Test
public void getUserById(){
   user = userDao.getUserById(1);
   System.out.println(user);
   sqlSession.close();
}

5.3、Insert

//添加用户
int addUser(User user);

<insert id="addUser" parameterType="User">
        insert into user (id,name,pwd) values (#{id},#{name},#{pwd})
</insert>

//增删改需要提交事务
@Test
public void addUser(){
    int res = userDao.addUser(new User(5,"哈哈哈","1212323"));
    sqlSession.commit();
    sqlSession.close();
}

5.4、Update

//修改用户int updateUser(User user);

<update id="updateUser" parameterType="User">
     update user set name=#{name},pwd=#{pwd} where id = #{id}
</update>

@Test
public void updateUser(){
   userDao.updateUser(new User(4,"呵呵","12132"));
   sqlSession.commit();
   sqlSession.close();
}

5.5、Delete

//删除用户
int deleteUser(int id);

<delete id="deleteUser" parameterType="int">
       delete from user where id=#{id}
 </delete>

@Test
public void deleteUser(){
   userDao.deleteUser(5);
   sqlSession.commit();
   sqlSession.close();
}

注意点：增删改需要提交事务！

5.6、分析错误

标签不要匹配错，增加的标签里必须是增加的sql语句
resource绑定mapper,需要使用路径
程序配置文件必须符合规范，多个.都不行
NullPointerException，没有注册到资源
输出的xml文件中存在乱码问题！
maven资源没有导出问题

5.7、Map传参

假设,我们的实体类，或者数据库中的表，字段或参数过多，我们应当考虑使用Map！

//万能的map
int addUser2(Map<String,Object> map);

<!--对象中的属性，可以直接取出来
        传递map的key
    -->
<insert id="addUser2" parameterType="map">
     insert into user (id,name,pwd) values (#{userid},#{username},#{userPwd})
</insert>

@Test
public void addUser2(){
    Map<String,Object> map = new HashMap<String, Object>();
    map.put("userid",6);
    map.put("username","hello");
    map.put("userPwd","43523");
    userDao.addUser2(map);
    sqlSession.commit();
    sqlSession.close();
}

Map传递参数，直接在sql中取出Key即可！【parameterType=“map”】

对象传递参数，直接在sql中取对象属性即可！【 parameterType=“User”】

只有一个基本类型参数的情况下，可以直接在sql中取到！

多个参数用Map，或者注解！

5.8、模糊查询

Java代码执行的时候，传递通配符% %

List<User> userList = userDao.getUserLike("%曹%");

在sql拼接中使用通配符

select * from user WHERE name like "%"#{value}"%";

码农公寓

环境: