Mybatis入门-01-第一个程序

MyBatis

一、入门

1.前言

https://mybatis.org/mybatis-3/zh/index.html

mybatis3有比较丰富的中文官方文档，一切应该以文档为主。

参考视频：狂神说Java-Mybatis

作为一款优秀的持久层框架，MyBatis几乎免除了所有的JDBC代码，十分方便。

但是由于文档某些时候阅读起来确实有一定的门槛，因此对其做一定的笔记也是必要的。

前置内容：

  • Java
  • maven
  • MySQL
  • JDBC
  • JavaWeb中持久化层的一些知识，如POJO

环境：

  • Java11
  • IDEA 2019.3.3
  • MySQL8
  • mybatis3

2.入门

2.1 路径

本文使用Maven创建Mybais项目，项目路径如下。

image-20200909112756798

在IDEA创建Maven项目后，将其src删去，同时在该项目下创建Module即可，这时IDLE会自动在两个pom.xml中写入两者的关系，即在父pom.xml中写入：

<modules>
    <module>mybatis-01</module>
</modules>

在子pom.xml中写入：

<parent>
    <artifactId>MyBaitsLearn</artifactId>
    <groupId>com.duzhuan</groupId>
    <version>1.0-SNAPSHOT</version>
</parent>

这是一种使用习惯，父pom.xml的配置子pom.xml可以继承。

如果不明文标出，一般认为下面对于pom.xml的操作都是对父pom.xml的操作。

2.2 依赖

        <!--jdbc-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>

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

        <!--JUnit-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>

image-20200909114449114

确认这个子项目里有依赖。

2.3 创建数据库

create database if not exists `mybatis`;

use `mybatis`;

create table if not exists `User`(
    `id` INT(20) not null primary key,
    `name` VARCHAR(20) default null,
    `pwd` varchar(20) default null
)ENGINE=INNODB default CHARSET = UTF8;

insert into `User`(`id`,`name`,`pwd`)
values (1,'admin','123456'),
       (2,'Jax','123456'),
       (3,'Jinx','123455'),
       (4,'Query','123456'),
       (5,'biubiu','123456');

2.4 POJO

路径

image-20200909144041324

代码

package com.duzhuan.pojo;

/**
 * @Autord: HuangDekai
 * @Date: 2020/9/9 14:11
 * @Version: 1.0
 * @since: jdk11
 */
public class User {
    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 + '\'' +
                '}';
    }
}

2.5 简配配置文件

路径

image-20200909144317775

简单解析

<?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="${driver}"/>
                <property name="url" value="${url}"/>
                <property name="username" value="${username}"/>
                <property name="password" value="${password}"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

xml文件头不提。

所有的配置都应该在<configuration>标签内。这是一个可以暂且用来展示功能的配置文件，很显然的是现在没有任何功能。而且与官网复制下来的相比，缺少了mappers及其子标签。

先一行一行看，<environments>标签，显然，可以配置多套环境，default表示的是默认是使用哪套环境。通过观看<enviroments>可以看到有id属性，显然，<envireonments default="environment的id"。

transactionManager,事务管理器，具体可查看官网文档-配置-事务管理器,这里只需要让transactionManager的值为JDBC。

dataSource，数据源。大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。有三种内建的数据源类型（也就是 type="[UNPOOLED|POOLED|JNDI]"）。之后深入了解可以通过查询文档，这里使用POOLED,即使用连接池，其默认设置链接数量是10，暂不深入了解。

关于properties：

  • driver – 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。
  • url – 这是数据库的 JDBC URL 地址。
  • username – 登录数据库的用户名。
  • password – 登录数据库的密码。

因此，若是要简单地使用配置文件，可以先如下设置：

<?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?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="qq123456"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

其中&amp;是在xml中&的转义字符。

2.6 UserMapper

路径

image-20200909200023491

相当于JavaWeb里的UserDao接口，在MyBatis中称其为Mapper。

UserMapper代码为：

package com.duzhuan.dao;

import com.duzhuan.pojo.User;

import java.util.List;

/**
 * @Autord: HuangDekai
 * @Date: 2020/9/9 19:42
 * @Version: 1.0
 * @since: jdk11
 */
public interface UserMapper {
    List<User> getUserList();
}

2.7 UserMapper.xml

路径

image-20200909202752831

代码

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

L1-L4为xml文件头

mapper是根标签，只允许有一个。namespace，命名空间。其值等于要绑定的接口的全限定名，显然一个Mapper.xml只会绑定一个接口。

select显然是一个用于执行SQL查询语句的标签，其中id等于的是namespace中 绑定的接口中的方法的名字。

image-20200909203935623`

resultType为结果的类型的全限定名。select * from mybatis.user是执行的SQL。

image-20200909204308421

值得一提的是，类似于返回值为List<User>这种列表的，resultType也是填写具体的实体类。

在数据库中执行select * from mybatis.user时返回的是：

image-20200909213207806

到此仍未使用MyBatis去获取数据库里的数据，并且上面某些配置存在一些比较显然的问题，但先按下不表，继续。

2.8 MybatisUtils

这个类用于封装一些固定步骤。

路径

image-20200909215207618

代码

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

/**
 * @Autord: HuangDekai
 * @Date: 2020/9/9 21:38
 * @Version: 1.0
 * @since: jdk11
 */
public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;

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

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

可以参照官方文档中从SqlSessionFactory中获取SqlSession：

从 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);

2.9 创建测试样例

路径

image-20200909215632690

UserMapperTest代码

package com.duzhuan.dao;

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

import java.util.List;

/**
 * @Autord: HuangDekai
 * @Date: 2020/9/9 21:56
 * @Version: 1.0
 * @since: jdk11
 */
public class UserMapperTest {
    @Test
    public void getUserListTest(){
        SqlSession sqlSession= MybatisUtils.getSqlSession();

        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = userMapper.getUserList();
        for (User user : userList) {
            System.out.println(user);
        }

        sqlSession.close();
    }
}

2.10 可能遇到的错误

2.10.1 Error:java: 错误: 不支持发行版本 5

image-20200909220447380

image-20200909220517460

image-20200909220547244

image-20200909220636539

image-20200909220732867

image-20200909221007847

最好将上述位置的Java版本设为一致。

2.10.2 经典错误 porg.apache.ibatis.binding.BindingException: Type interface com.duzhuan.dao.UserMapper is not known to the MapperRegistry.

类似于Servlet需要在web.xml中注册一样，Mapper也需要在mybatis-config.xml中注册。

在mybatis-config.xml的根标签里添加：

    <mappers>
        <mapper class="com.duzhuan.dao.UserMapper"></mapper>
    </mappers>

image-20200909222040965

建立关系的方式多种多样，这里仅用class="Mapper全限定名"用来举例。同时，比如这种用法要求：

image-20200909224943732

  • Mapper与Mapper.xml同名
  • Mapper与Mapper.xml同目录

2.10.3 经典错误 org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.duzhuan.dao.UserMapper.getUserList

一般情况下，是因为Maven生成的target文件夹中没有Mapper对应的Mapper.xml。

image-20200909231751001

只要把UserMapper.xml文件复制粘贴过去一般就能解决。

但是这是Maven造成的问题，maven默认只复制java代码文件，对xml、properties等不复制。而且，每次都要复制粘贴过去也很麻烦，因此解决问题的正道应该是修改maven的配置。

在父pom.xml主标签里加入：

    <build>
        <resources>
            <resource>
                <directory>src/main/resource/</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>

2.11 输出结果及修正

image-20200909233536164

在我们的数据库中，密码这一字段的字段名为pwd:

image-20200909233955300

在POJO中，很显然地，其属性名为password:

image-20200909234147656

从SQL上说，在此处select * from mybatis.user可以类似看为：

select `id`,`name`,`password` from mybatis.user

当然，在SQL这样是不能执行的，只是Mybatis将其处理成全都是null的字段，具体操作有待研究。

这时修改pojo的属性及其 getter and setter方法名为pwd无疑是简单的。但是MyBatis也有许多解决办法。

修改 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.duzhuan.dao.UserMapper">
    
    <resultMap id="UserMap" type="com.duzhuan.pojo.User">
        <result column="pwd" property="password"/>
    </resultMap>
    
    <select id="getUserList" resultMap="UserMap">
        select * from mybatis.user
    </select>
</mapper>

增加了resultMap标签及其子标签。其中id是resultMap的id，在11行中resultMap的值就是需要的resultMap的id。

type中是要映射的实体类的全限定名或别名。

column的值是数据库的字段名，property的值要映射的实体类中的属性的名称。

这样，就相当于有如下SQL：

select `id`,`name`,`pwd`as`password` from mybatis.user

当然，MyBatis做的要多得多，比如省略了人工编写JDBC代码，将从数据库拿到的数据放入POJO中的操作。

结果：

image-20200910000820712

posted @ 2020-09-10 00:31  杜撰丶  阅读(293)  评论(0)  编辑  收藏  举报