MyBatis笔记
工作之后一直使用 C 和 Python,最近因为一些原因接触到了一个 Java 的项目,发现自己已经忘得差不多了,查了一些资料,特此做笔记记录一下。
本笔记参考:代码贩子、:SSM框架讲解(史上最详细的文章)
编译器:IntelliJ IDEA 2022.1.4
数据库:MySQL 5.7
数据库连接工具:Navicat for MySQL
Maven:4.0.0
一、准备工作
1、构建空白Maven项目
2、创建项目结构
项目创建完成后,在 src 下的 main 目录下的 java 包中可以看到我们的 com.fei 包,在该包下创建新的包:
- entity:用于存放数据库实例映射类
- mapper:用于存放 mapper 接口
- util:用于存放工具类
在 resources 目录下创建 com.fei.mapper 包,与上述路径对应,用于存放 mapper 的 xml 文件
3、创建数据库实例
创建Person实例
并插入三条数据
4、导入Maven依赖
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>cmo.fei</groupId>
<artifactId>LearnSSM</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<!-- 配置mybatis依赖与MySQL依赖 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.36</version>
</dependency>
<!-- 配置测试依赖 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
等待Maven依赖加载完毕。
5、配置MyBatis核心文件
在项目的 src 下的 main 目录下的 resources 目录下创建 jdbc.properties
配置文件
jdbc.properties
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/learnssm # 此处更改为你的数据库链接与名称
username=root # 用户名
password=123456 # 密码
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
PUBLIC "-//ibatis.apache.org//DTD Config 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-config.dtd">
<configuration>
<!--导入jdbc.properties配置文件-->
<properties resource="jdbc.properties"/>
<!--setttings:控制mybatis全局配置行为-->
<settings>
<!--设置mybatis输出日志-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
<!--环境配置:数据库的连接信息-->
<!--default:中配置的值需要和某个environment配置的id相同,
通知mybatis使用具体哪一个数据库的连接信息,即具体访问对应的数据库-->
<environments default="development">
<!--environment:一个数据库信息的配置,环境-->
<!--id属性:一个唯一值,自定义,表示环境的名称-->
<environment id="development">
<!--transactionManager属性:mybatis的事务类型-->
<transactionManager type="JDBC" />
<!--dataSoure属性:代表数据源,连接数据库-->
<!--type属性:JDBC 表示使用的是使用连接池的数据源-->
<dataSource type="POOLED">
<!--配置驱动-->
<property name="driver" value="${driver}"/>
<!--配置连接数据库的url字符串-->
<property name="url" value="${url}"/>
<!--配置连接数据库的用户名-->
<property name="username" value="${username}"/>
<!--配置连接数据库的密码-->
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
</configuration>
至此环境准备完毕,最终项目结构如下:
二、编码
1、在 entity 目录下编写实体类 Person
Person.java
package com.fei.entity;
public class Person {
private Integer id;
private String name;
private Integer age;
public Person() {
}
public Person(Integer id, String name, Integer age) {
this.id = id;
this.name = name;
this.age = age;
}
@Override
public String toString() {
return "Person{" +
"id=" + id +
", name='" + name + '\'' +
", age=" + age +
'}';
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
}
2、在 util 目录下编写工具类 SqlSessionUtil
SqlSessionUtil.java
package com.fei.util;
import com.fei.mapper.PersonMapper;
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;
public class SqlSessionUtil {
// mybatis 核心配置文件,系统会自动扫描 resources 下的配置文件
private final String resourcePath = "mybatis-config.xml";
private SqlSession sqlSession;
// 在无参构造类里完成 sqlSession 初始化工作
public SqlSessionUtil() throws IOException {
// 1.获取 mybatis-config.xml 配置文件流,抛出了一个IO异常
InputStream in = Resources.getResourceAsStream("mybatis-config.xml");
// 2.实例化 SqlSessionFactoryBuilder 对象
SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
// 3.调用 builder 对象的 builder() 方法,获取 sqlSessionFactory 对象
SqlSessionFactory factory = builder.build(in);
// 4.调用 factory 对象的 openSession() 方法,获取 sqlSession 对象
sqlSession = factory.openSession();
}
public SqlSession getSqlSession() {
return sqlSession;
}
}
3、在 mapper 目录下编写接口 PersonMapper
PersonMapper.java
package com.fei.mapper;
import com.fei.entity.Person;
import java.util.List;
public interface PersonMapper {
// 查询数据库总条数
public Integer findCount();
// 增加实例
public int add(Person person);
// 删除实例
public int delete(int id);
// 更改实例
public int update(Person person);
// 查找全部实例
public List<Person> selectAll();
// 根据id查找
public Person selectById(int id);
// 模糊查找
public List<Person> selectByName(String name);
}
4、编写对应的接口实现文件
在 resources 目录下的 com.fei.mapper 目录中新建 PersonMapper.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:标注该 映射 属于哪个 Mapper 接口-->
<mapper namespace="com.fei.mapper.PersonMapper">
<!--
resultType:标识返回的数据类型,列表类型返回其泛型类型,特殊情况需要使用 Map 映射,由 resultMap 标 注
parameterType:参数类型,除基本数据类型外,自定义类或者map类型参数可使用 #{} 直接取得其属性值或者 value值
-->
<!--查询表内总条目数-->
<select id="findCount" resultType="java.lang.Integer">
select count(*) from learnssm.person
</select>
<!--插入-->
<insert id="add" parameterType="com.fei.entity.Person">
insert into learnssm.person(id, name, age) values (#{id}, #{name}, #{age})
</insert>
<!--删除-->
<delete id="delete" parameterType="int">
delete from learnssm.person where id = #{Id}
</delete>
<!--更新-->
<update id="update" parameterType="com.fei.entity.Person">
update learnssm.person set name=#{name}, age=#{age} where id=#{id}
</update>
<!--查询全部-->
<select id="selectAll" resultType="com.fei.entity.Person">
select * from learnssm.person
</select>
<!--根据id查找-->
<select id="selectById" parameterType="int" resultType="com.fei.entity.Person">
select * from learnssm.person where id=#{id}
</select>
<!--模糊查找-->
<select id="selectByName" parameterType="String" resultType="com.fei.entity.Person">
select * from learnssm.person where person.name like concat('%', #{name}, '%')
</select>
</mapper>
配置完成后,在 mybatis-config.xml 中注册 mapper,在最后面添加
mybatis-config.xml
<!--sql映射文件标签-->
<mappers>
<!--reource:从类路径开始的路径信息:target/clasess(类路径),此处使用的路径-->
<mapper resource="com/fei/mapper/PersonMapper.xml"/>
</mappers>
至此完成编码工作。
三、测试
在 src 下的 main 下的 test 中创建类 MyTest
MyTest.java
import com.fei.entity.Person;
import com.fei.mapper.PersonMapper;
import com.fei.util.SqlSessionUtil;
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;
import java.util.List;
public class MyTest {
@Test
public void testMethods() throws IOException {
SqlSession sqlSession = new SqlSessionUtil().getSqlSession();
// 获取对应 mapper
PersonMapper mapper = sqlSession.getMapper(PersonMapper.class);
// 创建公共对象用于后续测试
Person person = new Person(4, "小徐", 20);
// 1.测试计算总数
Integer count = mapper.findCount();
System.out.println("当前表中数据总数为:" + count + "条");
// 2.测试增加实例
int n = mapper.add(person);
System.out.println("增加了" + n + "条实例");
List<Person> personList = mapper.selectAll();
for (Person p : personList) {
System.out.println(p);
}
sqlSession.commit();
// 3.测试删除
n = mapper.delete(4);
System.out.println("删除了" + n + "条实例");
personList = mapper.selectAll();
for (Person p : personList) {
System.out.println(p);
}
sqlSession.commit();
// 4.测试更新
mapper.add(person);
person.setName("明明");
n = mapper.update(person);
System.out.println("更新了" + n + "条实例");
personList = mapper.selectAll();
for (Person p : personList) {
System.out.println(p);
}
sqlSession.commit();
// 5.测试根据ID查找
person = mapper.selectById(2);
System.out.println(person);
// 6.测试模糊查找
personList = mapper.selectByName("明");
for (Person p : personList) {
System.out.println(p);
}
sqlSession.close();
}
}