MyBatis二、搭建 MyBatis
- 开发环境
- MySQL 不同版本的注意事项
- 驱动程序(Driver)
- JDBC URL
- 连接参数
- MyBatis配置文件
- 版本兼容性
- 常见问题与解决方案
- 示例(MySQL 8.x与MyBatis连接)
- 创建 Maven 工程
- 打包方式:Jar
- 引入依赖
- 创建数据库
- 创建 pojo
- 创建 MyBatis 的核心配置文件
- 创建 Mapper 接口
- 创建 MyBatis的映射文件
- 通过 `junit` 单元测试
- 加入 `log4j` 功能
- 加入依赖
- 加入log4j的配置文件
开发环境
- IDE:IDEA2024.1
- 构建工具:Maven3.8.8
- MySQL版本:MySQL8
- MyBatis版本:MyBatis3.5.7
MySQL 不同版本的注意事项
MySQL的不同版本与MyBatis连接的注意事项主要包括以下几个方面:
驱动程序(Driver)
- MySQL 5.x:对于MySQL 5.x版本,MyBatis通常使用
com.mysql.jdbc.Driver
作为驱动程序。 - MySQL 8.x:对于MySQL 8.x版本,由于JDBC驱动程序的更改,MyBatis应使用
com.mysql.cj.jdbc.Driver
作为驱动程序。
JDBC URL
- 时区设置:在连接MySQL时,有时需要设置时区以避免时区相关的错误。这可以通过在JDBC URL中添加
serverTimezone
参数来实现,例如serverTimezone=UTC
或serverTimezone=Asia/Shanghai
。 - SSL设置:根据需求,可能需要在JDBC URL中启用或禁用SSL连接。这可以通过添加
useSSL=true
或useSSL=false
参数来实现。
连接参数
- 字符集:为了确保数据的一致性,通常需要在JDBC URL中指定字符集,如
characterEncoding=UTF-8
。 - 其他参数:根据具体需求,可能还需要在JDBC URL中添加其他参数,如
useUnicode=true
等。
MyBatis配置文件
- 配置文件格式:MyBatis的配置文件(如
mybatis-config.xml
)需要按照MyBatis的规范进行编写,确保各项配置正确无误。 - 数据源配置:在配置文件中正确配置数据源,包括驱动程序、JDBC URL、用户名和密码等。
版本兼容性
- MyBatis版本:确保使用的MyBatis版本与MySQL版本兼容。虽然大多数情况下不同版本的MyBatis都能与MySQL正常工作,但最好还是使用经过验证的兼容版本组合。
- 依赖管理:在使用Maven或Gradle等构建工具时,确保添加了正确版本的MySQL JDBC驱动依赖。
常见问题与解决方案
- 时区问题:如果遇到时区相关的错误,检查并调整JDBC URL中的
serverTimezone
参数。 - SSL问题:如果遇到SSL相关的错误或警告,检查并调整JDBC URL中的
useSSL
参数以及相关的SSL证书配置。 - 驱动程序问题:如果遇到与驱动程序相关的错误,检查驱动程序是否正确添加并配置了正确的版本。
示例(MySQL 8.x与MyBatis连接)
- 在Maven的
pom.xml
中添加MySQL JDBC驱动依赖(以8.0.26版本为例):
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.26</version>
</dependency>
- 在MyBatis的配置文件中配置数据源(示例):
<dataSource type="POOLED"><property name="driver" value="com.mysql.cj.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/mydatabase?useSSL=false&serverTimezone=UTC"/><property name="username" value="root"/><property name="password" value="password"/>
</dataSource>
请注意,上述示例中的数据库URL、用户名和密码需要根据实际情况进行替换。
创建 Maven 工程
打包方式:Jar
引入依赖
<dependencies><dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.5.7</version></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><version>4.13</version><scope>test</scope></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.16</version></dependency>
</dependencies>
创建数据库
create database `ssm` character set 'utf8mb4';use `ssm`;create table if not exists `t_user`(`id` int primary key auto_increment,`username` varchar(20),`password` varchar(20),`age` int,`gender` char,`email` varchar(50)
) character set 'utf8mb4';
创建 pojo
package cn.keke.mybatis.pojo;/*** Copyright (C) 2024 - 2024 keke, Inc. All Rights Reserved** @Desc :* @Time : 2024/6/2 14:46* @Author : Code_By_keke* @Email : 2284037977@qq.com* @Class : User* @IDE : IntelliJ IDEA*/
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 + '\'' +'}';}
}
创建 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="123456"/></dataSource></environment></environments><!-- 引入 MyBatis 的映射文件 --><mappers><mapper resource=""/></mappers>
</configuration>
创建 Mapper 接口
MyBatis 中的 Mapper 接口相当于以前的 dao,但区别在于,Mapper 仅仅是接口,不需要提供实现类
package cn.keke.mybatis.mapper;/*** Copyright (C) 2024 - 2024 keke, Inc. All Rights Reserved** @Desc :* @Time : 2024/6/2 15:18* @Author : Code_By_keke* @Email : 2284037977@qq.com* @Class : UserMapper* @IDE : IntelliJ IDEA*/
public interface UserMapper {int insertUser();
}
创建 MyBatis的映射文件
相关概念:ORM(Object Relationship Mapping)对象关系映射。
- 对象:Java的实体类对象
- 关系:关系型数据库
- 映射:二者之间的对应关系
Java 概念 | 数据库概念 |
---|---|
类 | 表 |
属性 | 字段/列 |
对象 | 记录/行 |
- 映射文件的命名规则:
表所对应的实体类的类名+Mapper.xml
例如:表t_user,映射的实体类为User,所对应的映射文件为UserMapper.xml
因此一个映射文件对应一个实体类,对应一张表的操作
MyBatis映射文件用于编写SQL,访问以及操作表中的数据
MyBatis映射文件存放的位置是src/main/resources/mappers目录下- MyBatis中可以面向接口操作数据,要保证两个一致:
- mapper接口的全类名和映射文件的命名空间(namespace)保持一致
- 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="cn.keke.mybatis.mapper.UserMapper"><!--mapper 接口和映射文件要保证两个一致:1.mapper 接口中的全类名和映射文件的 namespace 一致2.mapper 接口中的方法名要和映射文件中的 SQL 的 id 保持一致--><insert id="insertUser">insert into t_user (`id`, `username`, `password`, `age`, `gender`, `email`)values (null, 'admin', '123456', 23, '男', '12345@qq.com');</insert>
</mapper>
通过 junit
单元测试
package cn.keke;import cn.keke.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;/*** Copyright (C) 2024 - 2024 keke, Inc. All Rights Reserved** @Desc :* @Time : 2024/6/2 21:49* @Author : Code_By_keke* @Email : 2284037977@qq.com* @Class : MyBatisTest* @IDE : IntelliJ IDEA*/
public class MyBatisTest {@Testpublic void testInsert() throws IOException {// 获取核心配置文件的输入流InputStream is = Resources.getResourceAsStream("mybatis-config.xml");// 获取 SqlSessionFactoryBuilder 对象SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();// 获取 SqlSessionFactory 对象SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);// 获取 SQL 的会话对象 SqlSession(会自动提交事务),是 MyBatis 提供的操作数据库的对象SqlSession sqlSession = sqlSessionFactory.openSession(true);// 获取 UserMapper 的代理实现类对象UserMapper mapper = sqlSession.getMapper(UserMapper.class);// 调用 mapper 中的方法,实现添加用户信息的功能int result = mapper.insertUser();System.out.println("结果:" + result);// 提交事务sqlSession.commit();// 关闭 SqlSessionsqlSession.close();}
}
- SqlSession:代表Java程序和数据库之间的会话。(HttpSession是Java程序和浏览器之间的
会话)- SqlSessionFactory:是“生产”SqlSession的“工厂”。
- 工厂模式:如果创建某一个对象,使用的过程基本固定,那么我们就可以把创建这个对象的
相关代码封装到一个“工厂类”中,以后都使用这个工厂类来“生产”我们需要的对象。
加入 log4j
功能
加入依赖
<dependency><groupId>log4j</groupId><artifactId>log4j</artifactId><version>1.2.17</version>
</dependency>
加入log4j的配置文件
log4j的配置文件名为log4j.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="ConversionParttern" 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(调试)
从左到右打印的内容越来越详细