MyBatis 入门教程

MyBatis 入门

创建项目

通过idea工具创建一个maven工程：File -> New -> Project 创建一个项目

引入依赖包和驱动包

在项目中在pom.xml中引入以下依赖包

<dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
    	   <!-- 更加项目实际情况选择对应的版本 --> 
            <version>x.x.x</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
    	   <!-- 根据mysql数据库的版本来选择版本号 --> 
            <version>x.x.x</version>
        </dependency>
</dependencies>

创建mybatis配置文件

在项目resource 目录下创建一个mybatis-config.xml文件，该配置文件头内容直接从MyBatis官网中copy过来。

配置文件内容如下：

<?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>

</configuration>

配置dataSorce连接

driver：com.mysql.jdbc.Driver (MySQL 5.x) 或者 com.mysql.cj.jdbc.Driver （MySQL 6.x 及以上）

url ： jdbc:mysql://{数据库IP}:{port}/{databaseName}?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false （注意：MySQL 6.x 之后需要指定时区serverTimezone, 如果 “&” 无法使用，则这使用 & 代替）

username ： 数据库用户名

password ： 数据库用户密码

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

创建entity类

/**
 * @description TODO
 * @atuor Administrator
 * @data 2022-07-30
 */
public class PaymentEntity {
    private Long id;
    private String orderNo;

    public Long getId() {
        return id;
    }

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

    public String getOrderNo() {
        return orderNo;
    }

    public void setOrderNo(String orderNo) {
        this.orderNo = orderNo;
    }

    @Override
    public String toString() {
        return "PaymentEntity{" +
                "id=" + id +
                ", orderNo='" + orderNo + '\'' +
                '}';
    }
}

创建mapper接口

/**
 * @description TODO
 * @atuor Administrator
 * @data 2022-07-30
 */
public interface PaymentMapper {

    PaymentEntity getPaymentById(@Param("id") Long id);

    void createPayment(PaymentEntity entity);
}

创建mapper映射文件

在resource文件夹下创建创建mapper映射文件：/mapper/PaymentMapper.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.example.mybatis.mapper.PaymentMapper">
	<!-- 根据ID查询 -->
    <select id="getPaymentById" parameterType="long" resultType="com.example.mybatis.entity.PaymentEntity">
        select id,order_no as orderNo from payment where id =#{id}
    </select>
	<!-- 保存数据 -->
    <insert id="createPayment" parameterType="com.example.mybatis.entity.PaymentEntity">
        insert into payment(order_no) values (#{orderNo})
    </insert>
</mapper>

配置映射文件

在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">
<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/payment?serverTimezone=UTC&amp;useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=false"/>
                <property name="username" value="root"/>
                <property name="password" value="rootroot"/>
            </dataSource>
        </environment>
    </environments>
    <!-- 配置mapper映射文件路径 -->
    <mappers>
        <mapper resource="mapper/PaymentMapper.xml"/>
    </mappers>
</configuration>

目录结构如下：

测试mybatis

创建一个测试类：MyBatisTest.java

public class MybatisTest {

    public static void main(String[] args) throws IOException {
        // 1. 读取mybatis配置文件
        String config = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(config);

        // 2. 创建SqlSessionFactoryBuilder 对象
        SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();

        // 3. 创建 SqlSessionFactory 对象
        SqlSessionFactory sqlSessionFactory = builder.build(inputStream);

        // 4. 创建 sqlSession 对象
        SqlSession sqlSession = sqlSessionFactory.openSession();

        // 5. 通过 sqlSession 对象获取指定的mapper映射，生成对应的mapper代理对象
        PaymentMapper mapper = sqlSession.getMapper(PaymentMapper.class);
        
        // 6. 通过mapper代理对象执行查询
        PaymentEntity paymentById = mapper.getPaymentById(1L);

        System.out.println(paymentById);
    }
}

查看MySQL数据库记录：

代码执行结果：