Mybatis入门

1. 什么是Mybatis

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Ordinary Java Object,普通的 Java对象)映射成数据库中的记录。(摘自百度百科)

2. 第一个Mybatis程序

2.1 创建一个示例数据库

create database `mybatis`;

use `mybatis`;

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', '李四', '123456'),('3', '王五', '123456');

2.2 新建项目

mybatis文档

1. 新建一个普通的maven项目

new project --> maven --> next --> 修改名称 --> finish

2. 导入依赖（porm.xml）

<dependencies>
    
    <dependency>
        <groupId>mysqlgroupId>
        <artifactId>mysql-connector-javaartifactId>
        <version>5.1.47version>
    dependency>

    
    <dependency>
        <groupId>org.mybatisgroupId>
        <artifactId>mybatisartifactId>
        <version>3.5.2version>
    dependency>

    
    <dependency>
        <groupId>junitgroupId>
        <artifactId>junitartifactId>
        <version>4.12version>
    dependency>

dependencies>

3. 新建一个模块

项目名处右键 --> new --> module --> maven --> next --> 修改名称 --> finish

这样可以在一个大工程中编写独立的模块，而不用重复导入依赖

<groupId>cn.sjcupgroupId>
<artifactId>Mybatis-StudyartifactId>
<packaging>pompackaging>
<version>1.0-SNAPSHOTversion>

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

2.3 添加配置文件

在resources目录下新建一个文件，名为mybatis-config.xml

<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>
    <mappers>
        <mapper resource="org/mybatis/example/BlogMapper.xml"/>
    mappers>
configuration>

• driver，驱动，这个是固定的，com.mysql.jdbc.Driver
• url，使用idea连接数据库时，就可以看到一个url，但还需要设置一些内容，“jdbc:mysql://localhost:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=UTF-8”（附：使用IDER连接MySQL数据库）

• username和password就是自己登录数据库的用户名和密码

然后还需要注意的是，每一个mapper.xml都需要在mybatis核心配置文件中注册

<mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
mappers>

2.4 编写mybatis工具类

这个工具类的作用是：1. 加载配置文件；2. 获取SqlSession，SqlSession 提供了在数据库执行 SQL 命令所需的所有方法

添加一个工具类，命名为MybatisUtils

//SqlSessionFactory --> SqlSession
public class MybatisUtils {
    private static SqlSessionFactory sqlSessionFactory;
    //为了启动就会加载数据流，因此使用了静态代码块
    static {
        try {
            //使用mybatis获取SqlSessionFactory对象
            String resource = "mybatis-config.xml";
            InputStream inputStream = Resources.getResourceAsStream(resource);
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

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

2.5 实体类

对应数据库的user表，添加User实体类

public class User {
    private int id;
    private String name;
    private String pwd;

    //以下内容可以使用lombok代替
    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.6 Mapper

Mapper相当于JDBC中的Dao层

要获取所有成员信息，首先创建一个接口

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

按照以往JDBC的流程，下一步应该建立一个实现类去实现这个接口，获取连接Connection，使用prepareStatement执行sql命令，在数据库中获取所需的数据。但是在mybatis中，已经帮我们省去了这些操作，只需要定义sql语句即可，这个语句既可以通过 XML 定义，也可以通过注解定义。

下面使用xml定义，新建UserMapper.xml

<mapper namespace="cn.sjcup.Mapper.UserMapper">
    <select id="getUserList" resultType="cn.sjcup.pojo.User">
        select * from mybatis.user
    select>
mapper>

这里注意resultType（返回结果类型）要使用全称

2.7 测试

测试使用juint测试

public class UserMapperTest {

    @Test
    public void Test(){

        //1.获取sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();
        //2.执行sql
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> userList = mapper.getUserList();

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

        //3.关闭sqlsession
        sqlSession.close();


    }
}

如果按照我的程序放置路径，直接运行Test()会报错，错误为无法找到UserMapper.xml

可是它确实存在

这里就涉及到了maven的一个特性，它无法获取java目录下的配置文件，因此有两种解决方案：1.将UserMapper.xml放置到resources目录下；2.增加配置（porm.xml）

<build>
    <resources>
        <resource>
            <directory>src/main/resourcesdirectory>
            <includes>
                <include>**/*.propertiesinclude>
                <include>**/*.xmlinclude>
            includes>
            <filtering>truefiltering>
        resource>
        <resource>
            <directory>src/main/javadirectory>
            <includes>
                <include>**/*.propertiesinclude>
                <include>**/*.xmlinclude>
            includes>
            <filtering>truefiltering>
        resource>
    resources>
build>

输出结果：

>User{id=1, name='张三', pwd='123456'}
>User{id=2, name='李四', pwd='123456'}
>User{id=3, name='王五', pwd='123456'}

参考

遇见狂神说

mybatis文档