使用MyBatis小记

2024-02-11 19:01:04

MyBatis

简介

什么是mybatis

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

持久层

数据持久化

持久化就是将程序的数据在持久化状态和瞬时状态转化的过程

为什么需要mybatis

帮助程序员将数据存入到数据库中
传统的jdbc代码太复杂
简化、框架、自动化

特点

简单易学：本身就很小且简单。没有任何第三方依赖，最简单安装只要两个jar文件+配置几个sql映射文件易于学习，易于使用，通过文档和源代码，可以比较完全的掌握它的设计思路和实现。
灵活：mybatis不会对应用程序或者数据库的现有设计强加任何影响。 sql写在xml里，便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。
解除sql与程序代码的耦合：通过提供DAO层，将业务逻辑和数据访问逻辑分离，使系统的设计更清晰，更易维护，更易单元测试。sql和代码的分离，提高了可维护性。
提供映射标签，支持对象与数据库的orm字段关系映射
提供对象关系映射标签，支持对象关系组建维护
提供xml标签，支持编写动态sql

使用mybatis

1、在resources目录下创建mybatis-config.xml文件

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

<?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>
    <!--environment 元素体中包含了事务管理和连接池的配置，可以配置多个-->
    <environments default="test">
        <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>
        <environment id="test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" 
                value="jdbc:mysql://localhost:3306/game?useSSL=false&amp; characterEncoding=utf-8&amp; autoReconnect=true"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--mappers 元素则包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL 代码和映射定义信息-->
    <mappers>
        <mapper resource="com/kai/dao/UserMapper.xml"/>
    </mappers>
</configuration>

2、构建SqlSessionFactory

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

public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

    //获取SqlSessionFactory对象
    static {
        try {
            String resource = "mybatis-config.xml";
            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(){
        SqlSession sqlSession = sqlSessionFactory.openSession();
        return sqlSession;
    }
}

3、编写实体类

package com.kai.pojo;

public class User {
    private int id;
    private String username;
    private String password;
    private String power;

    public User() {
    }

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

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

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

    public String getPower() {
        return power;
    }

    public void setPower(String power) {
        this.power = power;
    }

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

}

4、编写mapper接口类

package com.kai.dao;

import com.kai.pojo.User;

import java.util.List;

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

5、编写接口的映射文件

<?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指定一个mapper接口-->
<mapper namespace="com.kai.dao.UserDao">
    <select id="getUserList" resultType="com.kai.pojo.User">
        select * from user
    </select>
</mapper>

6、编写测试类

package com.kai.dao;

import com.kai.pojo.User;
import com.kai.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;

import java.util.List;

public class UserDaoTest {

    @Test
    public void test(){

        //获得sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //执行sql
        UserDao userdao = sqlSession.getMapper(UserDao.class);
        List<User> userList = userdao.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        sqlSession.close();

    }
}

遇到的问题

1 字节的 UTF-8 序列的字节 1 无效

解决：xml编码问题，设置idea的默认编码和项目编码即可

命名空间

在之前版本的 MyBatis 中，命名空间（Namespaces）的作用并不大，是可选的。但现在，随着命名空间越发重要，你必须指定命名空间。

命名空间的作用有两个，一个是利用更长的全限定名来将不同的语句隔离开来，同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。长远来看，只要将命名空间置于合适的 Java 包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。

命名解析：为了减少输入量，MyBatis 对所有具有名称的配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。

全限定名（比如 “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。
短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和 “com.bar.selectAllThings”），那么使用时就会产生“短名称不唯一”的错误，这种情况下就必须使用全限定名。

作用域和生命周期

理解我们之前讨论过的不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。

提示 对象生命周期和依赖注入框架

依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。如果对如何通过依赖注入框架使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring 或 MyBatis-Guice 两个子项目。

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()) {
  // 你的应用逻辑代码
}

在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。因此，最好将映射器放在方法作用域内。就像下面的例子一样：

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

CRUD

Xml文件中的namespace包名要和mapper接口的包名一致
增删改要提交事务

使用步骤

1、编写mapper接口

//查询全部用户
List<User> getUserList();

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

//insert一个用户
int addUser(User user);

//update
int updateUser(User user);

//delete
int deleteUser(int id);

2、编写sql映射文件

<mapper namespace="com.kai.dao.UserMapper">
    <select id="getUserList" resultType="com.kai.pojo.User">
        select * from user
    </select>

    <select id="getUserByID" parameterType="int" resultType="com.kai.pojo.User">
        select * from user where id = #{id}
    </select>

    <insert id="addUser" parameterType="com.kai.pojo.User">
        insert into user (id,username,password,power) value (#{id},#{username},#{password},#{power})
    </insert>

    <update id="updateUser" parameterType="com.kai.pojo.User">
        update user set username=#{username},password=#{password},power=#{power} where id=#{id}
    </update>

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

3、测试

@Test
public void test(){
    //获得sqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    //执行sql
    UserMapper userdao = sqlSession.getMapper(UserMapper.class);
    List<User> userList = userdao.getUserList();
    for (User user : userList) {
        System.out.println(user);
    }
    sqlSession.close();
}

@Test
public void TestgetUserByID(){
    //获得sqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    //执行sql
    UserMapper usermapper = sqlSession.getMapper(UserMapper.class);
    User userByID = usermapper.getUserByID(1);
    System.out.println(userByID);
    sqlSession.close();
}

//增删改需要提交事务
@Test
public void TestaddUser(){
    //获得sqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    //执行sql
    UserMapper usermapper = sqlSession.getMapper(UserMapper.class);
    int i = usermapper.addUser(new User(13, "name", "123456", "user"));
    System.out.println(i);
    sqlSession.commit();
    sqlSession.close();
}

@Test
public void TestUpdate(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    mapper.updateUser(new User(13,"newName","123456","user"));
    sqlSession.commit();
    sqlSession.close();
}

@Test
public void TestDeleteUser(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    mapper.deleteUser(13);
    sqlSession.commit();
    sqlSession.close();
}

使用Map

1、编写mapper接口

int MapAddUser(Map<String,Object> map);

2、编写sql映射文件

<insert id="MapAddUser" parameterType="map">
    insert into user (id,username,password,power) 
    value (#{userId},#{name},#{userPassword},#{power})
</insert>

3、测试

@Test
public void TestMapAddUser(){
    //获得sqlSession对象
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    //执行sql
    UserMapper usermapper = sqlSession.getMapper(UserMapper.class);
    HashMap<String, Object> stringObjectHashMap = 
        new HashMap<String, Object>();
    stringObjectHashMap.put("name","MapName");
    stringObjectHashMap.put("userPassword","123456");
    usermapper.MapAddUser(stringObjectHashMap);
    sqlSession.commit();
    sqlSession.close();
}

使用模糊查询

1、编写mapper接口

List<User> getUser(String value);

2、编写sql映射文件

<select id="getUser" resultType="com.kai.pojo.User">
    select * from user where username like #{value}
</select>

或者写死

<select id="getUser" resultType="com.kai.pojo.User">
    select * from user where username like "%"#{value}"%"
</select>

3、测试

@Test
public void TestgetUser(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<User> userList = mapper.getUser("vi%");
    for (User user : userList) {
        System.out.println(user);
    }
    sqlSession.close();
}

4、结果

User{id=3, username='vida', password='123456', power='user'}
User{id=4, username='vivida', password='123456', power='user'}

配置

配置文档的顶层结构如下（需要按照顺序进行配置书写）：

configuration（配置）
- properties（属性）
- settings（设置）
- typeAliases（类型别名）
- typeHandlers（类型处理器）
- objectFactory（对象工厂）
- plugins（插件）
- environments（环境配置）
  - environment（环境变量）
    
    transactionManager（事务管理器）
    
    dataSource（数据源）
- databaseIdProvider（数据库厂商标识）
- mappers（映射器）

属性（properties）

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。

1、编写一个配置文件db.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/game?useSSL=false&characterEncoding=utf-8&autoReconnect=true
username=root
password=123456

2、在mybatis配置文件中映射

放在<configuration>里面的最前面

<properties resource="db.properties"></properties>

如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

首先读取在 properties 元素体内指定的属性。
然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性。
最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。

类型别名（typeAliases）

类型别名可为 Java 类型设置一个缩写名字
它仅用于 XML 配置，意在降低冗余的全限定类名书写

1、单独设置别名

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

2、扫描包下的全部类自动设置别名

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

3、也可以在类上设置注解

@Alias("DBUser")
public class User {...}

参考内容

mybatis – MyBatis 3 | 入门

狂神mybatis

码农公寓

MyBatis

简介

什么是mybatis

持久层

为什么需要mybatis

特点

使用mybatis

命名空间

作用域和生命周期

SqlSessionFactoryBuilder

SqlSessionFactory

SqlSession

映射器实例

CRUD

使用步骤

使用Map

使用模糊查询

配置

属性（properties）

类型别名（typeAliases）

参考内容

相关文章