Mybatis快速入门

2023-09-27 20:50:34

Mybatis快速入门

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

Mybatis入门编写步骤

1.配置环境

使用数据库工具（本人使用SQLyog）创建mybatis数据库以及对应的user表。对应的sql语句如下所示：

CREATE DATABASE mybatis

CREATE TABLE USER(
	id INT PRIMARY KEY,
	`name` VARCHAR(20),
	pwd VARCHAR(20)
)

INSERT INTO USER
VALUES
(1,"张三","111"),
(2,"李四","222"),
(3,"王五","333")

本次博客使用 Maven 来构建项目，因此需要将下面的依赖代码置于 pom.xml 文件中：

<!--    导入mybatis依赖-->
    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.27</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.22</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter</artifactId>
            <version>RELEASE</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

里面包括mybatis，mysql，lombok(一款插件，能够用@Data简化实体类的编写,具体可参考后序的实体类)以及junit测试。具体的介绍就不过多赘述。
这里需要注意的是，由于我们的UserMapper.xml资源文件写在java文件的目录下，所以会造成导出失败，解决方案如下：

需要在pom.xml加入一行代码，具体代码如下:

<build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

这样做的目的就是为了使java目录下的.xml和。properties文件能够顺利导出。

2.编写实体类

本次实体类以User类为例，包括id，name，pwd等属性。同时需要注意，代码中的包名需要根据自身的代码结构来自行修改。

package com.xing.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private int id;//id
    private String name;//姓名
    private String pwd;//密码
}

3.导入Mybatis核心配置文件

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

简而言之，通过核心配置文件就是为了让SqlSessionFactoryBuilder来构建出SqlSessionFactory 实例的。
具体的mybatis.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">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

<!--    映射器，告诉编译器去哪里找sql语句-->
    <mappers>
        <mapper class="com.xing.dao.UserMapper"/>
    </mappers>
</configuration>

需要注意的是，上述的username和passowrd需要根据自己的连接数据库的情况而修改，配置文件中的是地址映射，目的是告诉编译器去哪里找sql语句，这里后序会介绍。

4.编写接口

在这里创建一个UserMapper接口。具体的接口如下图所示。

package com.xing.dao;

import com.xing.pojo.User;

import java.util.List;

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

该接口里面仅有一个selectUser方法，返回值是一个List集合。

5.编写编写接口对应的Mapper.xml文件

接口编写完毕后，需要根据接口来撰写对应的Mapper.xml文件。具体的UserMapper.xml文件呢如下。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xing.dao.UserMapper">
    <select id="selectUser" resultType="com.xing.pojo.User">
        select * from mybatis.user;
    </select>
</mapper>

namespace后面书写对应的接口全限定名，id后面是对应的方法名，因为sql语句为查询语句，所以用select标签。resultType对应的是返回值类型，同样要使用全限定名，当然也可以在配置文件里面设置别名，这里设置别名省略。

6.测试

测试直接在test文件中创建MyTest类，具体的名称可以指定设置。具体对应的MyTest.java文件如下所示。

import com.xing.dao.UserMapper;
import com.xing.pojo.User;
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 org.junit.jupiter.api.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

public class MyTest {
    @Test
    public void selectUser() throws IOException {
        String resources="mybatis.xml";
        InputStream inputStream = Resources.getResourceAsStream(resources);
        //创建SqlSessionFactory实例
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        //获得sqlSession实例，参数为true设置自动提交事务
        SqlSession sqlSession = sqlSessionFactory.openSession(true);
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = mapper.selectUser();
        for (User user : users) {
            System.out.println(user);
        }
        //关闭sqlSession
        sqlSession.close();
    }
}

在此代码中，可以将sqlSession的获取过程定义为一个工具类，这样更加方便。

在文章的最后，展示一下文章的代码结构，方便读者的快速入门。

码农公寓

Mybatis快速入门

Mybatis入门编写步骤

1.配置环境

2.编写实体类

3.导入Mybatis核心配置文件

4.编写接口

5.编写编写接口对应的Mapper.xml文件

6.测试

相关文章