MyBatis学习笔记(二) —— 搭建MyBatis项目

2、搭建MyBatis

2.1、开发环境

IDE：idea 2019.2

构建工具：maven 3.5.4

MySQL版本：MySQL 8

MyBatis版本：MyBatis 3.5.7

MySQL不同版本的注意事项

1、驱动类 driver-class-name

MySQL 5版本使用jdbc5驱动，驱动类使用：com.mysql.jdbc.Driver

MySQL 8版本使用jdbc8驱动，驱动类使用：com.mysql.cj.jdbc.Driver

2、链接地址url

MySQL 5版本的url :

jdbc:mysql://localhost:3306/ssm

MySQL 8版本的url :

jdbc:mysql://localhost:3306/ssm?serverTimezone=UTC

否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘xxxx’ is unrecoginized or represents more

如果连接的数据库没有设置编码的，需要加上参数characterEncoding=utf-8。

mysql8版本中不需要设置编码的参数，因为mysql8编码中默认支持中文的。需要加入serverTimezone的参数。

2.2、创建maven工程

Name: 入门案例

GroupId：maven的坐标，比如：com.fan.mybatis

ArtifactId：工程名

Version：版本号

① 打包方式：jar

<?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.fan.mybatis</groupId><artifactId>mybatis_helloworld</artifactId><version>1.0-SNAPSHOT</version><!-- 设置打包方式为jar包 --><packaging>jar</packaging><properties><maven.compiler.source>8</maven.compiler.source><maven.compiler.target>8</maven.compiler.target></properties>
</project>

② 引入依赖

  	<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>8.0.18</version></dependency></dependencies>

main目录：存放的是主程序

test目录：存放的是测试程序

main/java目录：放的是java类

main/resources目录：放的是配置文件

test/java目录：放的是测试的java类

2.3、数据库

表和实体类是有映射关系的。

mysql创建数据库 ssm

创建t_user

2.4、创建实体类

package com.fan.mybatis.pojo;/*** @Date: 2023/02/19* @Author: fan* @Description:*/
public class User {private Integer id;private String username;private String password;private Integer age;private String gender;private String email;public User() {}public User(Integer id, String username, String password, Integer age, String gender, String email) {this.id = id;this.username = username;this.password = password;this.age = age;this.gender = gender;this.email = email;}public Integer getId() {return id;}public void setId(Integer id) {this.id = id;}public String getUsername() {return username;}public void setUsername(String username) {this.username = username;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}public Integer getAge() {return age;}public void setAge(Integer age) {this.age = age;}public String getGender() {return gender;}public void setGender(String gender) {this.gender = gender;}public String getEmail() {return email;}public void setEmail(String email) {this.email = email;@Overridepublic String toString() {return "User{" +"id=" + id +", username='" + username + '\'' +", password='" + password + '\'' +", age=" + age +", gender='" + gender + '\'' +", email='" + email + '\'' +'}';}
}

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

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

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

核心配置文件存放的位置是 src/main/resources目录下

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configurationPUBLIC "-//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/ssm?serverTimezone=UTC"/><property name="username" value="root"/><property name="password" value="root"/></dataSource></environment></environments><!-- 引入mybatis的映射文件 --><mappers><mapper resource="mappers/UserMapper.xml"/></mappers>
</configuration>

建议把时区设置在mysql里设置，这样就不用重复设置了

environments 开发环境（测试、生产、开发） dataSource 数据库 mappers 业务SQL

2.6、创建mapper接口

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

package com.fan.mybatis.mapper;public interface UserMapper {}

2.7、创建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属性保持一致

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.fan.mybatis.mapper.UserMapper"><!--mapper接口和映射文件要保持一致:1、mapper接口的全类名和映射文件的namespace一致2、mapper接口中的方法的方法名要和映射文件中的sql的id保持一致--></mapper>

2.8、通过junit测试功能

打开数据库，截断

清空是把表中的数据都删除掉。

截断是把表删掉，创建一个一模一样的表。表中的id会重新开始。

刷新数据表

MyBatisTest.java

package com.fan.mybatis.test;import com.atguigu.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;/*** @Date: 2023/02/21* @Author: fan* @Description:*/
public class MyBatisTest {@Testpublic void testInsert() throws IOException {//获取核心配置文件的输入流InputStream is = Resources.getResourceAsStream("mybatis-config.xml");//获取SqlSessionFactoryBuilder对象SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();//获取sql的会话对象SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);//获取sql的会话对象SqlSession(不会自动提交事务)，是MyBatis提供的操作数据库的对象//SqlSession sqlSession = sqlSessionFactory.openSession();//获取sql的会话对象SqlSession(会自动提交事务)，是MyBatis提供的操作数据库的对象SqlSession sqlSession = sqlSessionFactory.openSession(true);//获取UserMapper的代理实现类对象UserMapper userMapper = sqlSession.getMapper(UserMapper.class);//调用mapper接口中的方法，实现添加用户的信息的功能int result = userMapper.insertUser();//提供sql以及的唯一标识找到sql并执行，唯一标识是namespace.sqlId//int result = sqlSession.insert("com.atguigu.mybatis.mapper.UserMapper.insertUser");System.out.println("结果：" + result);//提交事务//sqlSession.commit();//关闭SqlSessionsqlSession.close();}
}

• SqlSession：代表Java程序和数据库之间的会话。(HttpSession 是Java程序和浏览器之间的会话）
• SqlSessionFactory：是“生产”SqlSession的“工厂”。
• 工厂模式：如果创建某一个对象，使用的过程基本固定，那么我们就可以把创建这个对象的相关代码封装到一个“工厂类”中，以后都使用这个工厂类来“生产”我们需要的对象。

2.9、加入log4j日志功能

① 加入依赖

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

② 加入log4j的配置文件

log4j的配置文件名为log4.xml，存放的位置是src/main/resources目录下

<?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(调试)

从左到右打印的内容越来越详细

运行后控制台打印信息如下：

2.10、创建工具类 SqlSessionUtils

SqlSessionUtils.java

package com.fan.mybatis.utils;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 java.io.IOException;
import java.io.InputStream;/*** @Date: 2023/02/22* @Author: fan* @Description:*/
public class SqlSessionUtils {public static SqlSession getSqlSession(){SqlSession sqlSession = null;try {//获取核心配置文件的输入流InputStream is = Resources.getResourceAsStream("mybatis-config.xml");//获取SqlSessionFactoryBuilderSqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();//获取SqlSessionFactorySqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);//获取SqlSession对象sqlSession = sqlSessionFactory.openSession(true);} catch (IOException e) {e.printStackTrace();}return sqlSession;}
}

2.11、测试新增用户

在实现mybatis的增删改查的过程中，比较麻烦，特别是获取SqlSession的过程。可以直接创建一个工具类 SqlSessionUtil。

UserMapper.java

package com.fan.mybatis.mapper;import com.fan.mybatis.pojo.User;public interface UserMapper {/*** 添加用户信息* @return*/int insertUser();
}

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.fan.mybatis.mapper.UserMapper"><!-- int insertUser() --><insert id="insertUser">insert into t_user values(null,'admin','123456',23,'男','[e-mail]')</insert>
</mapper>

运行测试类，控制台打印输出：

结果：1

数据库中可以看到新增一条数据

2.11、测试修改用户

在实现mybatis的增删改查的过程中，比较麻烦，特别是获取SqlSession的过程。可以直接创建一个工具类 SqlSessionUtil。

UserMapper.java

package com.fan.mybatis.mapper;/*** @Date: 2023/02/20* @Author: fan* @Description:*/
public interface UserMapper {/*** 修改用户信息*/void updateUser();
}

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.fan.mybatis.mapper.UserMapper"><!-- void updateUser() --><update id="updateUser">update t_user set username = 'root',password='123' where id = 3</update>
</mapper>

Junit测试修改

@Testpublic void testUpdate(){//获取SqlSession对象SqlSession sqlSession = SqlSessionUtils.getSqlSession();//获取当前mapper接口的代理实现类对象UserMapper mapper = sqlSession.getMapper(UserMapper.class);//执行mapper接口的修改方法mapper.updateUser();//关闭SqlSessionsqlSession.close();
}

控制台输出：

DEBUG 02-22 10:58:20,396==> Preparing: update t_user set username = ‘root’,password=‘123’ where id = 3 (BaseJdbcLogger.java:137)
DEBUG 02-22 10:58:20,412==> Parameters: (BaseJdbcLogger.java:137)
DEBUG 02-22 10:58:20,417<== Updates: 1 (BaseJdbcLogger.java:137)

数据库

2.12、测试删除用户

UserMapper.java

package com.fan.mybatis.mapper;/*** @Date: 2023/02/20* @Author: fan* @Description:*/
public interface UserMapper {/*** 删除用户信息*/void deleteUser();
}

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.fan.mybatis.mapper.UserMapper"><!--mapper接口和映射文件要保持一致:1、mapper接口的全类名和映射文件的namespace一致2、mapper接口中的方法的方法名要和映射文件中的sql的id保持一致--><!-- int insertUser() --><insert id="insertUser">insert into t_user values(null,'admin','123456',23,'男','[e-mail]')</insert><!-- void updateUser() --><update id="updateUser">update t_user set username = 'root',password='123' where id = 3</update><!-- void deleteUser() --><delete id="deleteUser">delete from t_user where id = 3</delete>
</mapper>

Junit测试删除用户

MyBatisTest.java

//删除用户
@Testpublic void testDelete(){//获取SqlSession对象SqlSession sqlSession = SqlSessionUtils.getSqlSession();//获取当前mapper接口的代理实现类对象UserMapper mapper = sqlSession.getMapper(UserMapper.class);//执行mapper接口的删除方法mapper.deleteUser();//关闭SqlSessionsqlSession.close();
}

控制台打印输出

DEBUG 02-22 11:09:20,078==> Preparing: delete from t_user where id = 3 (BaseJdbcLogger.java:137)

DEBUG 02-22 11:09:20,095==> Parameters: (BaseJdbcLogger.java:137)

DEBUG 02-22 11:09:20,101<== Updates: 1 (BaseJdbcLogger.java:137)

数据表中可以看到id为3的用户删除了

2.13、测试查询用户

UserMapper接口

package com.fan.mybatis.mapper;import com.fan.mybatis.pojo.User;/*** @Date: 2023/02/20* @Author: fan* @Description:*/
public interface UserMapper {/*** 根据id查询用户信息* @return*/User getUserById();
}

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.fan.mybatis.mapper.UserMapper"><!-- User getUserById() --><!--resultType: 设置结果类型，即查询的数据要转换的java类型resultMap: 自定义映射，处理多对一或一对多的映射关系--><select id="getUserById" resultType="com.fan.mybatis.pojo.User">select * from t_user where id = 1</select>
</mapper>

MyBatisTest.java

    //根据id查询用户@Testpublic void testGetUserById(){SqlSession sqlSession = SqlSessionUtils.getSqlSession();UserMapper mapper = sqlSession.getMapper(UserMapper.class);User user = mapper.getUserById();System.out.println(user);}

控制台打印输出：

DEBUG 02-22 12:25:03,700==> Preparing: select * from t_user where id = 1 (BaseJdbcLogger.java:137)

DEBUG 02-22 12:25:03,715==> Parameters: (BaseJdbcLogger.java:137)

DEBUG 02-22 12:25:03,728<== Total: 1 (BaseJdbcLogger.java:137)

User{id=1, username=‘admin’, password=‘123456’, age=23, gender=‘男’, email=‘[e-mail]’}

2.14、测试查询所有的用户

UserMapper接口

package com.fan.mybatis.mapper;import com.fan.mybatis.pojo.User;import java.util.List;/*** @Date: 2023/02/20* @Author: fan* @Description:*/
public interface UserMapper {/*** 查询所有的用户信息* @return*/List<User> getAllUser();
}

UserMapper.xml映射文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.fan.mybatis.mapper.UserMapper"><!-- List<User> getAllUser() --><select id="getAllUser" resultType="com.fan.mybatis.pojo.User">select * from t_user</select>
</mapper>

Junit测试查询所有的用户

MyBatisTest.java

    @Testpublic void testGetAllUser(){SqlSession sqlSession = SqlSessionUtils.getSqlSession();UserMapper mapper = sqlSession.getMapper(UserMapper.class);List<User> list = mapper.getAllUser();//循环输出list集合中的数据list.forEach(System.out::println);}

控制台打印输出：

DEBUG 02-22 12:39:06,403==> Preparing: select * from t_user (BaseJdbcLogger.java:137)

DEBUG 02-22 12:39:06,420==> Parameters: (BaseJdbcLogger.java:137)

DEBUG 02-22 12:39:06,436<== Total: 3 (BaseJdbcLogger.java:137)

User{id=1, username=‘admin’, password=‘123456’, age=23, gender=‘男’, email=‘[e-mail]’}

User{id=2, username=‘root’, password=‘123’, age=23, gender=‘男’, email=‘[e-mail]’}

User{id=4, username=‘admin’, password=‘123456’, age=23, gender=‘男’, email=‘[e-mail]’}