MyBatis入门

最新推荐文章于 2024-07-27 11:53:57 发布

y_Engineer

最新推荐文章于 2024-07-27 11:53:57 发布

阅读量312

点赞数

分类专栏：分享 Java基础 MyBatis 文章标签： MyBatis入门

本文链接：https://blog.csdn.net/y_Engineer/article/details/101783351

版权

分享同时被 3 个专栏收录

56 篇文章 0 订阅

订阅专栏

Java基础

55 篇文章 0 订阅

订阅专栏

MyBatis

2 篇文章 0 订阅

订阅专栏

MyBatis入门

一、概述

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

二、官方文档及下载

**官方文档：**https://mybatis.org/mybatis-3/index.html
下载地址：https://github.com/mybatis/mybatis-3/releases
maven依赖：

<!--mybatis-->
<dependency>
     <groupId>org.mybatis</groupId>
     <artifactId>mybatis</artifactId>
     <version>3.5.2</version>
</dependency>

三、MyBatis入门程序

3.1、搭建环境

3.1.1、创建数据库表

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,'李四','123456')

3.1.2、创建maven项目

项目结构

在这里插入图片描述

pom.xml配置

添加必要的maven依赖

<!--数据库驱动-->
<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>
<!--测试-->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
</dependency>

防止资源导出失败的问题

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

3.2、MyBatis配置文件

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">
<configuratio
    <properties resource="db.properties"/>
    
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/study/dao/UserMapper.xml"/>
    </mappers>
</configuration>

db.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
username=root
password=123456

3.3、编写代码

3.3.1、MyBatisUtils工具类

//功能：获取SqlSessionFactory 对象
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            String resources = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resources);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

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

3.3.2、User实体类

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 + '\'' +
                '}';
    }
}

3.3.3、UserMapper持久层接口

public interface UserMapper {
    //根据id获取获取用户
    User getUserById(int id);
    //添加用户
    int addUser(User user);
    //根据id删除用户
    int deleteUserById(int id);
    //修改用户
    int updateUesr(User user);
}

3.3.4、UserMapper.xml

<?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.study.dao.UserMapper">
    
    <!--根据id查询用户-->
    <select id="getUserById" resultType="User">
        select * from mybatis.user where id=#{id}
    </select>
    <!--添加用户-->
    <insert id="addUser" parameterType="User">
        insert into mybatis.user values(#{id},#{name},#{pwd})
    </insert>
    <!--删除用户-->
    <delete id="deleteUserById">
        delete from mybatis.user where id=#{id}
    </delete>
    <!--修改用户信息-->
    <update id="updateUesr" parameterType="User">
        update mybatis.user set name=#{name},pwd=#{pwd} where id=#{id}
    </update>
</mapper>

namespace：绑定一个对应接口
id：就是对应的namespace中的方法名
resultType：sql语句返回值类型
parameterType：参数类型
在 mybatis-config.xml 中注册

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

3.3.5、UserMapperTest测试类

public class UserMapperTest {

    @Test
    public void getUserByIdTest(){
        //获取getUserList对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.getUserById(1);
        System.out.println(user);
        //关闭SqlSession
        sqlSession.close();
    }
    
    @Test
    public void addUserTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int num = mapper.addUser(new User(3,"王五","121212"));
        if (num>0) {
            System.out.println("添加成功！");
        }
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void delectTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int num = mapper.deleteUserById(0);
        if (num>0) {
            System.out.println("删除成功！");
        }
        sqlSession.commit();
        sqlSession.close();
    }

    @Test
    public void updateTest(){
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int num = mapper.updateUesr(new User(1,"哈哈","111111"));
        if (num>0) {
            System.out.println("修改成功！");
        }
        sqlSession.commit();
        sqlSession.close();
    }
}

getUserById测试结果：

User{id=2, name='李四', pwd='123456'}

Process finished with exit code 0

**注意：**增删改操作必须提交事务sqlSession.commit();

四、作用域（Scope）和生命周期

SqlSessionFactoryBuilder

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

SqlSessionFactory

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

SqlSession

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

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

五、MyBatis的XML配置

1、properties（属性）

这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，也可通过 properties 元素的子元素来传递。 这些属性可以在整个配置文件中被用来替换需要动态配置的属性值。

<properties resource="db.properties">
     <property name="username" value="root"/>
     <property name="password" value="123456"/>
</properties>

<dataSource type="POOLED">
    <property name="driver" value="${driver}"/>
    <property name="url" value="${url}"/>
    <property name="username" value="${username}"/>
    <property name="password" value="${password}"/>
</dataSource>

注意：配置文件中的配置优先级大于在property标签中的配置，即会优先选择配置文件中的配置。

2、typeAliases（类型别名）

给实体类起别名

<typeAliases>
    <typeAlias type="com.study.pojo.User" alias="User"/>
</typeAliases>

指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean

<typeAliases>
     <package name="com.study.pojo"/>
</typeAliases>

每一个在包 com.study.pojo 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。若有注解，则别名为其注解值。

@Alias("_user")		//使用注解自定义别名为 _user
public class User {...}

六、结果集映射（resultMap ）

修改上面实体类字段：pwd–>password

public class User {
    private int id;
    private String name;
    private String password;
    ...
}

由于实体类字段与数据库字段不一致（数据库字段依然为pwd），导致查出的 password=null
解决办法：使用结果集映射

<resultMap id="UserMap" type="User">
        <result column="pwd" property="password"/>
    </resultMap>
    
    <!--根据id查询用户-->
    <select id="getUserById" resultMap="UserMap">
        select id,name,pwd from mybatis.user where id=#{id}
    </select>