Mybatis入门学习

悠悠 2022-12-19 14:27 98阅读 0赞

# Mybatis入门学习 #

## 1.Mybatis概述 ##

> mybatis 是一个优秀的基于 java 的持久层框架，它内部封装了 jdbc，使开发者只需要关注 sql 语句本身，而不需要花费精力去处理加载驱动、创建连接、创建 statement 等繁杂的过程。
> 
> mybatis 通过 xml 或注解的方式将要执行的各种 statement 配置起来，并通过 java 对象和 statement 中sql 的动态参数进行映射生成最终执行的 sql 语句，最后由 mybatis 框架执行 sql 并将结果映射为 java 对象并返回。
> 
> 采用 ORM 思想解决了实体和数据库映射的问题，对 jdbc 进行了封装，屏蔽了 jdbc api 底层访问细节，使我们不用与 jdbc api 打交道，就可以完成对数据库的持久化操作。

## 2.搭建Mybatis开发环境 ##

### 2.1创建maven工程 ###

打开idea工具，在maven工程下创建一个普通的Java项目。

**第一步** 新建项目，选择Maven，选择自己目录下的JDK版本，选择quickstart，然后下一步

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center]

**第二步：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 1][]

\*\*第三步：\*\*注意Maven主目录最好选择自己安装的maven目录，不要选择idea工具下的maven目录

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 2][]

\*\*第四步：\*\*配置pom.xml文件

需要导入依赖：`mysql,mybatis,junit`

<?xml version="1.0" encoding="UTF-8"?>
    
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
    
      <groupId>com.mybatis</groupId>
      <artifactId>MybatisStudy01</artifactId>
      <version>1.0-SNAPSHOT</version>
    
      <name>MybatisStudy01</name>
      
      <url>http://www.example.com</url>
    
      <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
      </properties>
    
      
      <dependencies>
        
        <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <version>5.1.49</version>
        </dependency>
        
        <dependency>
          <groupId>org.mybatis</groupId>
          <artifactId>mybatis</artifactId>
          <version>3.4.5</version>
        </dependency>
        
        <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>4.12</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
    
    
    </project>

#### 2.2创建Mybatis子工程 ####

删掉刚刚创建好的工程下的`src`文件夹，在根目录处右键新建新模块，选择Maven下的quickstart

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 3][]

选择下一步，命名为mybatisTest，选择下一步

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 4][]

最后一步选择完成！

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 5][]

### 2.3创建mysql数据库 ###

CREATE DATABASE `mybatis`;
    
    USE `mybatis`;
    
    DROP TABLE IF EXISTS `user`;
    
    CREATE TABLE `user` (
    `id` int(20) NOT NULL,
    `name` varchar(30) DEFAULT NULL,
    `pwd` varchar(30) DEFAULT NULL,
    PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
    
    insert  into `user`(`id`,`name`,`pwd`) values (1,'狂神','123456'),(2,'张三','abcdef'),(3,'李四','987654');
    SELECT * FROM user;

### 2.4编写mybatis-config.xml文件 ###

该XML 配置文件中包含了对 MyBatis 系统的核心设置，包括获取数据库连接实例的数据源（DataSource）以及决定事务作用域和控制方式的事务管理器（TransactionManager）。**文件名可以随便取**

首先要在src——main目录下创建`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.jdbc.Driver"/>
                    
                    <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                    
                    <property name="username" value="root"/>
                    
                    <property name="password" value="1234"/>
                </dataSource>
            </environment>
        </environments>
        
        <mappers>
            <mapper resource="com/kuang/dao/UserMapper.xml"/>
        </mappers>
    </configuration>

### 2.5编写Mybatis工具类 ###

> 每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。而SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

该工具类放在包com.mybatis.utils下.

// MybatisUtils.java
    // 工具类
    // SqlSessionFactory
    public class MybatisUtils { 
        private static SqlSessionFactory sqlSessionFactory;
        static{ 
            String resource = "mybatis-config.xml";
            try { 
                InputStream inputStream = Resources.getResourceAsStream(resource);
                sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            } catch (IOException e) { 
                e.printStackTrace();
            }
    
        }
        // sqlsession包含了面向数据库执行sql命令的所有方法
        public static SqlSession getSqlSession(){ 
            return sqlSessionFactory.openSession();
        }
    
    
    }

### 2.6编写User实体类 ###

实体类放在包com.mybatis.pojo下

// User.java
    package com.mybatis.pojo;
    
    public class User { 
        private int id;
        private String name;
        private String pwd;
    
        public User() { 
        }
    
        public User(int id, String name, String pwd) { 
            this.id = id;
            this.name = name;
            this.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;
        }
    
        @Override
        public String toString() { 
            return "User{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", pwd='" + pwd + '\'' +
                    '}';
        }
    }

**注意：实体类属性必须和数据库中字段名保持一致**

### 2.7编写持久层接口UserDao ###

接口Userdao.java放在包com.mybatis.dao下

// Userdao.java
    package com.mybatis.dao;
    
    import com.mybatis.pojo.User;
    
    import java.util.List;
    
    public interface Userdao { 
        // 查询所有用户
        List<User> getUserList();
    }

### 2.8编写持久层接口的配置文件UserMapper.xml ###

\*\*注意：\*\*创建位置必须和持久层接口在相同的包中

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 6][]

<?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.mybatis.dao.Userdao" >
        <select id="getUserList" resultType="com.mybatis.pojo.User">
            select * from user
        </select>
    </mapper>

*  命名空间**namespace**：用来映射接口Userdao，命名空间用全限定名来绑定不同的接口。
 *  **id**:用来映射接口中的方法
 *  **resultType**:返回值类型，方法getUserList返回类型为\`List，但是要写集合内存储的数据类型User，不是List,所以resultType应该是User类的全限定名。
    
     *  如果返回值为`int,String等类型,则要填写`int,String\`

放法getUserList是一个查询方法，标签表示查询，在标签内写sql查询语句。

注意：配置这么写好后还不能使用，因为Mybatis还不知道映射配置的位置

在上面编写的mybatis-config.xml中，还需要加上一句配置

<mappers>
            <mapper resource="com/mybatis/dao/UserMapper.xml"/>
    </mappers>

### 2.9编写测试类 ###

在目录test下编写测试类,Junit包测试类

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 7][]

public class MybatisTest { 
        @Test
        public void Test01(){ 
            // 第一步 获取sqlsession对象
            SqlSession sqlSession = MybatisUtils.getSqlSession();
            try { 
                // 第二步 通过getMapper获取Userdao的实现类
                Userdao userdao = sqlSession.getMapper(Userdao.class);
                List<User> userList = userdao.getUserList();
                for(User user:userList){ 
                    System.out.println(user);
                }
            } catch (Exception e){ 
                e.printStackTrace();
            } finally { 
                // 第三步 关闭SqlSession
                sqlSession.close();
            }
        }
    }

### 2.10测试Mybatis ###

配置JUnit

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 8][]

点击绿色三角运行

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 9][]

### 3.可能会遇到的问题 ###

如果UserMapper.xml文件不放在目录resources下，而是跟UserDao接口放在一个目录下，会报一个找不到UserMapper.xml错误

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 10][]

这是由于**Maven静态资源过滤问题**导致的。

>  *  静态资源，包含HTMl,图片,CSS,JS等不需要与数据库交互的一类文件
>  *  动态资源：需要与数据库交互，可以根据需要显示不同的数据，不需要修改页面

需要在父工程下的pom.xml下填入以下配置

<build>
        <resources>
          <resource>
            <directory>src/main/java</directory>
            <includes>
              <include>**/*.properties</include>
              <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
          </resource>
          <resource>
            <directory>src/main/resources</directory>
            <includes>
              <include>**/*.properties</include>
              <include>**/*.xml</include>
            </includes>
            <filtering>false</filtering>
          </resource>
        </resources>
      </build>

否则需要自己手动设置，即将UserMapper.xml放在resources下，并且目录和Userdao接口目录相同。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/b0b2442720af4582bff545aaa42b39a0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/20201108154937689.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/2020110815494843.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201108155002171.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201108155012846.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 5]: https://img-blog.csdnimg.cn/20201108155023717.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 6]: https://img-blog.csdnimg.cn/2020110815504886.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 7]: https://img-blog.csdnimg.cn/20201108155104131.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 8]: https://img-blog.csdnimg.cn/2020110815511545.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 9]: https://img-blog.csdnimg.cn/20201108155125641.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3_size_16_color_FFFFFF_t_70_pic_center 10]: https://img-blog.csdnimg.cn/20201108155143274.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxODIyNjQ3,size_16,color_FFFFFF,t_70#pic_center