mybatis入门第一天

mybatis入门第一天

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

1. mybatis环境搭建

• 创建maven项目，并在pom.xml文件中配置资源过滤问题

<!-- Maven由于它的约定大于配置, 我们可能遇到我们写的配置文件, 无法被导出或者生效的问题, 这时候我们就要配置资源过滤, 如下: -->
    <!--  在 build 中配置 resource, 来防止我们资源导出失败  -->
    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

• 在pom.xml文件中导入mybatis项目所依赖的jar包

<!--  导入依赖  -->
    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.21</version>
        </dependency>

    </dependencies>

• 在resources目录下，创建db.properties文件，配置mysql数据库连接所需要的属性信息，这是为了配置mybatis核心配置文件所准备的，当然你也可以不创建，直接在mybatis核心配置文件中写入，看个人喜好

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUniCode=true&characterEncoding=UTF-8
username=root
password=123456

• 在resources目录下，配置mybatis的XML核心配置文件，从 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>

    <!-- 加载类路径下的数据库的属性配置文件 -->
    <properties resource="db.properties"></properties>

    <!--  多套环境，默认选中development环境  -->
    <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>

2. mybatis简单demo

• 在mysql中创建一个mybatis数据库，并创建一张user表

/*
 Navicat Premium Data Transfer

 Source Server         : MySql
 Source Server Type    : MySQL
 Source Server Version : 80017
 Source Host           : localhost:3306
 Source Schema         : mybatis

 Target Server Type    : MySQL
 Target Server Version : 80017
 File Encoding         : 65001

 Date: 31/05/2021 16:43:14
*/

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` int(255) UNSIGNED NOT NULL AUTO_INCREMENT,
  `name` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  `password` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL,
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 7 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (2, '小何', '男');
INSERT INTO `user` VALUES (5, 'hello', '123987');

SET FOREIGN_KEY_CHECKS = 1;

• 在pojo包下创建一个user实体类，其中使用到了lombok插件，通过注解自动生成getter，setter，toString，无参构造方法，全参构造方法等

package pojo;

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

import java.io.Serializable;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {
    private Integer id;

    private String name;

    private String password;

    private static final long serialVersionUID = 1L;
}

• 在dao包下，创建一个接口UserDao

package dao;

import pojo.User;

import java.util.List;

public interface UserDao {
    int deleteUserById(int id);
    List<User> selectAllUsers();
}

• 编写该接口的mapper（映射）文件，相当于实现类（后面也可以直接用注解实现，而不需要编写mapper文件），这时候需要去 mybatis官网 处找到mapper文件的约束

<?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文件唯一对应的接口 -->
<mapper namespace="dao.UserDao">
	<!-- id对应接口下的方法名，parameterType表示参数类型，其中#{id}为取出参数列表中名为id的值, 返回被删除的记录条数 -->
  <delete id="deleteUserById" parameterType="int">
    delete from user where id = #{id}
  </delete>
    <!-- id对应接口下的方法名，resultType表示返回类型，mybatis会通过反射帮我们自动封装好 -->
  <select id="selectAllUsers" resultType="pojo.User">
    select * from user
  </select>
</mapper>

• 编写完mapper文件后，我们还需要去mybatis核心配置文件中，注册此mapper文件，注意以下说的路径一致是指包路径一致，因为无论是java文件夹下的文件，还是resources文件夹下的文件，最后都会被编译进相同的编译路径下，也就是说resources文件夹下的dao包和java文件夹的dao包在编译后，都会合并成一个dao文件夹

<!--   注册 Mapper.xml 配置文件  -->
    <mappers>
    <!--这两种方式，接口名与mapper文件名和路径（包路径）必须一致，因为他们都是通过反射获取类名然后寻找mapper文件-->
    <!--<mapper class="dao.UserDao"/>-->
    <package name="dao"/>

        <!--这种两种方式类名与mapper文件名可以不一致，因为是通过mapper文件中的namespace来确定接口在哪的-->
        <!--<mapper resource="dao/UserDao.xml"/>-->
        <!--这种方式采用的是绝对路径，不推荐使用-->
        <!--<mapper url="file:///E:\Users\HGS\IdeaProjects\SSM_Study\mybatis_study\demo_01\src\main\resources\dao\UserDao.xml"/>-->
    </mappers>

• 最后在test文件夹下创建测试类，按我个人的编程习惯，测试类与被测试类的包路径最好一致

package dao;

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.Test;

import java.io.IOException;
import java.io.InputStream;

public class UserDaoTest {
    static private UserDao userDao;
    static private SqlSession sqlSession;
    static {
        //  获取 mybatis 核心配置文件的输入流
        try(InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml")) {
            //  获取创建 SqlSessionFactory 对象的建造者（运用了建造者模式）
            SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
            //  通过 SqlSessionFactoryBuilder 通过 mybatis 核心配置文件来建造 SqlSessionFactory 对象
            SqlSessionFactory factory = builder.build(inputStream);
            /**
             * SqlSessionFactory 顾名思义，就是用来生产 SqlSession 实例的工厂
             * SqlSession 提供了在数据库执行 SQL 命令所需的所有方法
             * 注意：SqlSession 实例在进行增删改时，需要手动提交事务；若不想手动，则在 openSession 方法中输入 true，自动提交事务
             */
            sqlSession = factory.openSession();
//          // 使用和指定语句的参数和返回值相匹配的接口
            userDao = sqlSession.getMapper(UserDao.class);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    @Test
    public void deleteUserById(){
        System.out.println(userDao.deleteUserById(2));
        // 手动提交事务
        sqlSession.commit();
    }

    @Test
    public void selectAllUsers(){
        System.out.println(userDao.selectAllUsers());
    }

}