MyBatis简介&工厂类&xml核心配置文件

喜欢木木

已于 2023-02-21 21:11:02 修改

阅读量253

点赞数 2

分类专栏： MyBatis 文章标签： mybatis java maven

于 2023-02-20 17:25:54 首次发布

本文链接：https://blog.csdn.net/fj123321666/article/details/129128170

版权

MyBatis 专栏收录该内容

7 篇文章 0 订阅

订阅专栏

1.什么是MyBatis

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

2.如何使用MyBatis

如果使用 Maven 来构建项目，则需将下面的依赖代码置于 pom.xml 文件中：

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

在使用maven时需要注意的是,为了防止我们在运行的时候出现资源加载不成功的问题,我们可以在使用maven时加入build工具

<!--    在build中配置resources,来防止我们资源导出失败的问题-->
    <build>
        <resources>
            <resource>
                <directory>
                    src/main/resources
                </directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>
                    src/main/java
                </directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

3.从 XML 中构建 SqlSessionFactory

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

从 XML 文件中构建 SqlSessionFactory 的实例非常简单，建议使用类路径下的资源文件进行配置。但也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

我们需要编写我们的工具类

实例(以后可以直接拿来用):

package com.sangyu.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;

/**
 * @author sangYu
 * @date 2023/2/16
 * sqlSessionFactory --> sqlSession
 */

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    static {
        //使用mybatis获取sqlSessionFactory对象
        String resource = "mybatis-config.xml";
        try {
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
    //SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。

    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

我们要使用MyBatis首先要配置mybatis的核心配置文件

主要包含:核心配置,环境,事务管理

实例:

我们需要在此连接我们的数据库

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://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"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mysqllearn?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="sangyu"/>
                <property name="password" value="?"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/sangyu/dao/UserMapper.xml"/>
    </mappers>
</configuration>

配置完核心配置之后,我们就可以去编写我们的实体类代码了

4.创建用来写SQL代码的xml文件,一般使用mapper命名

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.sangyu.dao.UserDao">
    <select id="getUserList" resultType="com.sangyu.bean.User">
        select * from mysqllearn.user
    </select>
</mapper>

我们可以在我们的dao层编写mapper,这个mapper正好照应了我们核心配置文件中的

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

注意事项:

如果我们的核心配置文件中没有写mapper,就会出现以下报错:

org.apache.ibatis.binding.BindingException: Type interface com.sangyu.dao.UserDao is not known to the MapperRegistry.我们需要记住这个错误是因为核心配置文件中没有mapper造成的

核心配置文件中mapper的resource="com/sangyu/dao/UserMapper.xml"就是我们编写的mapper的路径
namespace="com.sangyu.dao.UserDao"指的就是我们用来实现操作接口的路径
resultType="com.sangyu.bean.User"指的就是我们的类型,一般是实体类
select id="getUserList"指的就是我们方法的名字

当这些都完成之后,我们就可以开始写我们的SQL语句啦

实例:第一个mybatis

数据准备

create table user(
id int(10) not null PRIMARY KEY,
name VARCHAR(20) DEFAULT null,
password VARCHAR(20) DEFAULT NULL
);
insert into user(id,name,password) VALUES(1,'桑榆',1111),(2,'桑榆2',2222),(3,'桑榆3',3333);

首先我们来配置我们的maven

<!--    导入依赖-->
    <dependencies>
        <!--        MySQL驱动-->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>8.0.31</version>
        </dependency>
        <!--        mybatis-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.6</version>
        </dependency>
        <!--        Junit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
    </dependencies>

<!--    在build中配置resources,来防止我们资源导出失败的问题-->
    <build>
        <resources>
            <resource>
                <directory>
                    src/main/resources
                </directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>
                    src/main/java
                </directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

编写mybatis的工厂工具类

package com.sangyu.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;

/**
 * @author sangYu
 * @date 2023/2/16
 * sqlSessionFactory --> sqlSession
 */

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    static {
        //使用mybatis获取sqlSessionFactory对象
        String resource = "mybatis-config.xml";
        try {
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
    //SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。

    public static SqlSession getSqlSession(){
        return sqlSessionFactory.openSession();
    }
}

编写核心配置xml文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://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"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mysqllearn?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="sangyu"/>
                <property name="password" value="sangyu"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/sangyu/dao/UserMapper.xml"/>
    </mappers>
</configuration>

编写实体类

package com.sangyu.bean;

/**
 * @author sangYu
 * @date 2023/2/16
 */
public class User {
    /**
     * 用户ID
     */
    private int id;
    /**
     * 用户名
     */
    private String name;
    /**
     * 用户密码
     */
    private String password;

    public User() {
    }

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

    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 getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

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

编写我们的mapper接口(dao)

package com.sangyu.dao;

import com.sangyu.bean.User;

import java.util.List;

/**
 * @author sangYu
 * @date 2023/2/16
 */
public interface UserDao {
    List<User> getUserList();
}

编写mapper.xml文件(相当于以前的实现类)

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.sangyu.dao.UserDao">
    <select id="getUserList" resultType="com.sangyu.bean.User">
        select * from mysqllearn.user
    </select>
</mapper>

进行测试

package com.sangyu.dao;

import com.sangyu.bean.User;
import com.sangyu.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

/**
 * @author sangYu
 * @date 2023/2/16
 */
public class UserDaoTest {
    @Test
    public void test(){
        //第一步:获取SqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        //方式一:getMapper
        //推荐使用方式一
        UserDao mapper = sqlSession.getMapper(UserDao.class);
        List<User> userList = mapper.getUserList();

//        //方式二:
//        List<User> userList = sqlSession.selectList("com.sangyu.dao.UserDao.getUserList");

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

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

测试结果

在这里插入图片描述

喜欢木木

关注

2
点赞
踩
2

收藏

觉得还不错? 一键收藏
打赏
0
评论
MyBatis简介&工厂类&xml核心配置文件

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

扫一扫