[Java知识库] MyBatis--搭建

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> Java知识库 -> MyBatis--搭建 -> 正文阅读

[Java知识库]MyBatis--搭建

1、开发环境

IDE：idea 2021.3.2

构建工具：maven 3.8.1

MySQL版本：MySQL 5.5.28

MyBatis版本：MyBatis 3.5.7

可以在idea中安装MyBatisX插件，方便Mybatis中mapper和xml的映射，提高开发效率

2、创建maven工程

a>打包方式：jar

b>引入依赖

pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.mybatis</groupId>
    <artifactId>MyBatis_demo1</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <dependencies>
        <!-- Mybatis核心 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.7</version>
        </dependency>
        <!-- junit测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <!-- MySQL驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.3</version>
        </dependency>
    </dependencies>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

</project>

若数据库是mysql8版本，则mysql驱动的版本要改为8.0.16！

3、创建MyBatis的核心配置文件

习惯上命名为mybatis-config.xml，这个文件名仅仅只是建议，并非强制要求。将来整合Spring 之后，这个配置文件可以省略，所以大家操作时可以直接复制、粘贴。

核心配置文件主要用于配置连接数据库的环境以及MyBatis的全局配置信息

核心配置文件路径在src/main/resources/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.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>
    <!--引入映射文件-->
    <mappers>
        <mapper resource="mappers/UserMapper.xml"/>
    </mappers>
</configuration>

此处数据库名为mybatis，映射文件后续引入

若数据库是mysql8版本，则driver中写com.mysql.cj.jdbc.Driver

4、创建mapper接口

MyBatis中的mapper接口相当于以前的dao。但是区别在于，mapper仅仅是接口，我们不需要提供实现类。

a>创表

在这里插入图片描述

b>创建POJO类

路径在src/main/java/com/mybatis/pojo/User.java

package com.mybatis.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import lombok.experimental.Accessors;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@ToString
public class User {
    // 指定字段名和属性值一致（反射）
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private String sex;
    private String email;
}

此处使用Lombok的注解，避免代码过长；使用前提，在pom.xml中添加Lombok依赖，同时需要在IDEA中安装Lombok插件

其中@Data就是帮助生成get/set方法，@AllArgsConstructor和@NoArgsConstructor是全参构造和无参构造，@ToString是覆盖默认toString方法，@Accessors(chain = true)是在调用类的方法时可以链式调用。

lombok的依赖如下：
<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.18.22</version>
</dependency>

c> mapper接口

路径在src/main/java/com/mybatis/mapper/UserMapper.java

package com.mybatis.mapper;

import com.mybatis.pojo.User;

public interface UserMapper {
    /**
     * 添加用户信息
     * @param user
     * @return
     */
    int insertUser();
}

5、创建MyBatis的映射文件

相关概念：ORM（Object Relationship Mapping）对象关系映射。

对象：Java的实体类对象
关系：关系型数据库
映射：二者之间的对应关系

Java概念	数据库慨念
类	表
属性	字段/列
对象	记录/行

1、映射文件的命名规则：

表所对应的实体类的类名+Mapper.xml，和接口名一致

例如：表t_user，映射的实体类为User，所对应的映射文件为UserMapper.xml

因此一个映射文件对应一个实体类，对应一张表的操作

MyBatis映射文件用于编写SQL，访问以及操作表中的数据

MyBatis映射文件存放的位置是src/main/resources/mappers目录下

2、MyBatis中可以面向接口操作数据，要保证两个一致：

a>mapper接口的全类名和映射文件的命名空间（namespace）保持一致

b>mapper接口中方法的方法名和映射文件中编写SQL的标签的id属性保持一致

路径在src/main/resources/mappers/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">
<!--namespace值必须和UserMapper接口的全类名保持一致-->
<mapper namespace="com.mybatis.mapper.UserMapper">
    <!--id是SQL语句的唯一标识，值要和UserMapper接口中的方法名保持一致-->
    <insert id="insertUser">
        -- id在数据库中自增
        insert into t_user values(null,'张三','123',23,'女','123@qq.com')
    </insert>
</mapper>

6、通过junit测试功能

路径在src/test/java/com/mybatis/test/MyBatisTest.java

package com.mybatis.test;

import com.mybatis.mapper.UserMapper;
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 MyBatisTest {
    @Test
    public void testMyBatis() throws IOException {
        //加载MyBatis的核心配置文件
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        //获取SqlSessionFactoryBuilder对象
        SqlSessionFactoryBuilder sf = new SqlSessionFactoryBuilder();
        //通过核心配置文件所对应的字节输入流创建工厂类SqlSessionFactory，生产SqlSession对象
        SqlSessionFactory factory = sf.build(is);
        //创建SqlSession对象，此时通过SqlSession对象所操作的sql都必须手动提交或回滚事务
        //SqlSession sqlSession = factory.openSession();
        //创建SqlSession对象，此时通过SqlSession对象所操作的sql都会自动提交
        SqlSession sqlSession = factory.openSession(true);
        //通过代理模式创建UserMapper接口的代理实现类对象
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int result = userMapper.insertUser();
        //若factory.openSession()无参数或参数值为false，则必须添加下面这句：提交事务
        //sqlSession.commit();
        System.out.println("结果："+result);
    }
}

在idea中，方法的()里按快捷键ctrl+p，会显示该方法所有重载参数

SqlSession：代表Java程序和数据库之间的会话。（HttpSession是Java程序和浏览器之间的会话）

SqlSessionFactory：是“生产”SqlSession的“工厂”。

工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。

运行结果：

控制台
在这里插入图片描述
数据库

7、加入log4j日志功能

a>引入依赖

在pom.xml中加入

<!-- log4j日志 -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

b>加入log4j的配置文件

log4j的配置文件名为log4j.xml，存放的路径在src/main/resources/log4j.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
    <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
        <param name="Encoding" value="UTF-8" />
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS}
%m (%F:%L) \n" />
        </layout>
    </appender>
    <logger name="java.sql">
        <level value="debug" />
    </logger>
    <logger name="org.apache.ibatis">
        <level value="info" />
    </logger>
    <root>
        <level value="debug" />
        <appender-ref ref="STDOUT" />
    </root>
</log4j:configuration>

再次运行测试
在这里插入图片描述

日志的级别：FATAL(致命)>ERROR(错误)>WARN(警告)>INFO(信息)>DEBUG(调试) 从左到右打印的内容越来越详细

8、测试删、改、查

修改

a>添加接口方法

在UserMapper.java接口中添加如下

	/**
     * 修改用户信息
     * @return
     */
    int updateUser();

b>添加mapper映射

在UserMapper.xml中添加如下

    <update id="updateUser">
        update t_user set username='柳灵' where id=3
    </update>

c>编写测试方法

在MyBatisTest.java中添加如下

    @Test
    public void testUpdate() throws IOException {
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sf = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = sf.build(is);
        SqlSession sqlSession = factory.openSession(true);
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int result = userMapper.updateUser();
        System.out.println("结果："+result);
    }

d>运行

控制台
在这里插入图片描述
数据库

删除

a>添加接口方法

在UserMapper.java接口中添加如下

    /**
     * 删除用户信息
     * @return
     */
    int deleteUser();

b>添加mapper映射

在UserMapper.xml中添加如下

    <delete id="deleteUser">
        delete from t_user where id=3
    </delete>

c>编写测试方法

在MyBatisTest.java中添加如下

    @Test
    public void testDelete() throws IOException {
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sf = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = sf.build(is);
        SqlSession sqlSession = factory.openSession(true);
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        int result = userMapper.deleteUser();
        System.out.println("结果："+result);
    }

d>运行

控制台
在这里插入图片描述

数据库中已删除id=3的记录

查询

查询单条记录

a>添加接口方法

在UserMapper.java接口中添加如下

    /**
     * 根据id查询用户
     * @return
     */
    User getUserById();

b>添加mapper映射

在UserMapper.xml中添加如下

    <select id="getUserById" resultType="com.mybatis.pojo.User">
        select * from t_user where id=1
    </select>

查询功能的标签必须设置resultType或resultMap

resultType：设置默认的映射关系

resultMap：设置自定义的映射关系

c>编写测试方法

在MyBatisTest.java中添加如下

    @Test
    public void testSelect() throws IOException {
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sf = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = sf.build(is);
        SqlSession sqlSession = factory.openSession(true);
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        User user = userMapper.getUserById();
        System.out.println("结果：" + user);
    }

d>运行

控制台
在这里插入图片描述

查询所有记录

a>添加接口方法

在UserMapper.java接口中添加如下

    /**
     * 查询所有用户信息
     * @return
     */
    List<User> getAllUser();

b>添加mapper映射

在UserMapper.xml中添加如下

    <select id="getAllUser" resultType="com.mybatis.pojo.User">
        select * from t_user
    </select>

c>编写测试方法

在MyBatisTest.java中的testSelect()修改如下

    @Test
    public void testSelect() throws IOException {
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        SqlSessionFactoryBuilder sf = new SqlSessionFactoryBuilder();
        SqlSessionFactory factory = sf.build(is);
        SqlSession sqlSession = factory.openSession(true);
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
        List<User> users = userMapper.getAllUser();
        // lambda表达式
        //users.forEach(user -> System.out.println(user));
        // lambda替换为方法引用
        users.forEach(System.out::println);
    }