** MyBatis 是一款优秀的持久层框架**
它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
第一个案例快速上手:
1.使用工具
IDEA,创建maven项目管理工具。
2.项目目录
这是第一个项目的大致目录
3.导入pom依赖
我们可以在父pom依赖里面添加我们所需要的插件,mysql,mybatis,和测试用的junit
<?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.krystal</groupId>
<artifactId>Mybatis-Study</artifactId>
<packaging>pom</packaging>
<version>1.0-SNAPSHOT</version>
<modules>
<module>mybatis-01</module>
</modules>
<!-- 导入依赖-->
<dependencies>
<!-- mysql驱动-->
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.4</version>
</dependency>
<!--junit-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
<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>
</project>
此处的build标签里的filtering是为了解决后期测试时候maven的导包过滤的情况,一般都选择加上这段,否则后面启动测试类时候可能出错。
4.数据库编写
在数据库中创建数据库: mybatis
在mybatis中创建表: user
在user表中创建字段并插入值(其中id为主键)
如下:
5.在IDEA中连接数据库
如图,在idea右侧:
然后选入mysql:
输入用户名和密码,点击测试连接即可(注意:mysql8以上的用户建议点击driver查询和使用8.0.0以上的版本,5.x的宝宝们可以不用设置)
mysql版本8以上的:
然后在Advanced中,找到serverTimeZone 把里面默认的UFC改成 Asia/Shanghai (这一步很重要,因为时区分区问题)
最后在Schemas这个选项下,选住我们设置的mybatis数据库
点击应用和确定即可,然后就可以看见右边我们的数据库信息就有啦:
5.配置文件等编写
- 编写mybatis的核心配置文件 mybatis-config.xml 存放在resources目录下
<?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>
<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/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 每一个mapper.xml 都需要在mybatis核心配置文件中注册!-->
<mappers>
<mapper resource="com/krystal/dao/UserMapper.xml"/>
</mappers>
</configuration>
这里需要注意,mysql8以后的驱动driver里面有加.cj,而5.x的不需要加,此外在这里的url里面也加上了serverTimeZone。
用户名和密码,需要使用自己的。
mapper标签,注释中有写,我们每写的一个.xml文件(映射文件写sql执行语句的),都需要在这里面注册,路径建议使用resource方法,路径需要自己手动,也可以右键.xml文件,copyPath
- 编写mybatis工具类
不知道这个类在哪创建的可以↑翻工作目录,也可以直接在下面中间中查看包名 。
这个工具类的编写类似于我们之前学习的JDBCUtils一样,具体的可以查看mybatis官网,建议写法
package com.krystal.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.InputStream;
// sqlSessionFactory ----->sqlsession
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static {
try {
//使用mybatis的第一步:获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (Exception e) {
e.printStackTrace();
}
}
//获取SqlSession连接
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
6.实体类等编写
- Dao接口:
package com.krystal.dao;
import com.krystal.pojo.User;
import java.util.List;
public interface UserDao {
List<User> getUserList();
}
- UserDao对应的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 namespace="com.krystal.dao.UserDao">
<select id="getUserList" resultType="com.krystal.pojo.User">
select * from mybatis.user
</select>
</mapper>
此处是mybatis的核心精髓,在这里面编写sql(取代了jdbc的impl类),注意自己的类路径
- 然后pojo包下的User类,封装数据
package com.krystal.pojo;
public class User {
private int id;
private String name;
private String pwd;
public User() {
}
public User(int id, String name, String pwd) {
this.id = id;
this.name = name;
this.pwd = pwd;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPwd() {
return pwd;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
嫌麻烦的可以使用lombok包,可以省去构造函数和get/set方法(自动创建了),本例中没有使用
到这,我们的代码结束了
可以写个测试,来测试以下数据,拿出我们数据库user表中的所有数据:
7.测试类编写
我们尽量保证测试类的目录结构和正式的差不多:
package com.krystal.dao;
import com.krystal.pojo.User;
import com.krystal.utils.MybatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Test;
import java.util.List;
public class UserDaoTest {
@Test
public void test() {
//第一步,获取获取sqlSession对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
//方式一:执行sql
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();
for (User user : userList) {
System.out.println(user);
}
//关闭sqlSession
sqlSession.close();
}
}
测试结果:
测试成功
可能出现的问题:
配置文件没有注册
绑定接口错误
方法名不对
返回类型不对
Maven导出资源问题
org.apache.ibatis.binding.BindingException: Type interface com.krystal.dao.UserDao is not known to the MapperRegistry.
出现这个问题可能是maven自动资源过滤问题,可以查看target目录下(F:\springbootProjects\Mybatis-Study\mybatis-01\target\test-classes\com\krystal\dao)把我们的mapper.xml文件赋值到.class文件相同的目录中试试,再重新测试。(可以使用maven的clean清除target文件)
很多错误,可能是由粗心造成的,可以仔细查看mybatis-config.xml和UserMapper.xml(一般是mapper.xml)文件,这两个文件中的配置和路径需要仔细查看。
本次笔记分享,参考了狂神老师的学习视频,加入个人理解。