文章目录
官方文档:
https://mybatis.net.cn/getting-started.html
1. 简介
1.1 什么是MyBatis
- MyBatis 是一款优秀的持久层框架。
- 它支持自定义 SQL、存储过程以及高级映射。
- MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
- MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
如何获取MyBatis?
- maven仓库
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
2. 第一个MyBatis程序
思路流程:搭建环境–>导入Mybatis—>编写代码—>测试
2.1 搭建环境
创建数据库:
CREATE DATABASE `mybatis`;
USE `mybatis`;
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(20) NOT NULL,
`name` varchar(30) DEFAULT NULL,
`pwd` varchar(30) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
insert into `user`(`id`,`name`,`pwd`) values (1,'江南','123456'),(2,'张
三','abcdef'),(3,'李四','987654');
创建项目:
- 新建一个maven项目
- 删除src目录
- 导入maven依赖
pom.xml
<!--导入依赖-->
<dependencies>
<!--mybatis驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
<!--junit-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
</dependencies>
2.2 创建一个模块
在生成的模块中也会有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">
<parent>
<artifactId>com.xxc</artifactId>
<groupId>org.example</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>mybatis-01</artifactId>
</project>
说明:从这里可以看到子模块的的父类引用配置是在外层的pom.xml中配置。可以实现资源的共用,好处多多。
- 编写MyBatis核心配置文件,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?useSSL=false&useUnicode=true&characterEncoding=UTF-8"/>
<property name="username" value="root"/>
<property name="password" value="xxc113206"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/xxc/dao/UserMapper.xml"/>
</mappers>
</configuration>
说明:environments default=“development”,说明可以配置多套环境,default是具体要取哪一套环境,这里使用development。mappers是注册所有的xml文件,如果还有其他的xml也需要往里添加,路径是斜杠,不是点,要注意。
- 编写mybatis工具类
// 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 (IOException e) {
e.printStackTrace();
}
}
// 既然有了sqlSessionFactory,顾名思义,我们就可以从中获得SqlSession的实例了
// SqlSession 完全包含了面向数据库执行SQL命令所需的所有方法
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
注意:mybatis-config.xml为对应的mybaits配置名称。工具类写好之后不用改变。
2.3 编写代码
- 实体类(pojo => User.java)
public class User {
private int id;
private String name;
private String pwd;
// 构造器
// get 和 set 方法
// toString方法
- Dao接口(UserDao.java)
public interface UserDao {
List<User> getUserList();
}
- 接口实现类有原来的UserDaoImpl转换为一个mapper.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">
<mapper namespace="com.xxc.dao.UserDao">
<select id="getUserList" resultType="com.xxc.pojo.User">
select * from user;
</select>
</mapper>
这里注意namespace不能写错,为UserDao的全路径地址。resultType为返回值类型。
2.4 测试
public class UserDaoTest {
@Test
public void test(){
// 第一步,获取SqlSession对象
SqlSession sqlSession = MyBatisUtils.getSqlSession();
// 执行 方式一:
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();
for (User user : userList){
System.out.println(user);
}
System.out.println("==============================");
// 方式二:
List<User> UserList1 = sqlSession.selectList("com.xxc.dao.UserDao.getUserList");
for (User user : UserList1){
System.out.println(user);
}
//关闭SqlSession
sqlSession.close();
}
}
在Test下创建一个UserDaoTest的文件。通过之前写的工具类MyBatisUtils获取到sqlSession。
方法二的一些说明:它在命名空间 “com.xxc.dao.UserDao” 中定义了一个名为 “selectList” 的映射语句,这样你就可以用全限定名 “com.xxc.dao.UserDao.selectList” 来调用映射语句了。
推荐使用第一种方式。
问题说明:
Maven静态资源过滤问题,需要在pom.xml中配置如下信息:
<build>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
说明:这个配置在父类的pom.xml和子类的pom.xml都进行配置。
程序完整目录结构:
3. CRUD
改造:
将原来的UserDao接口修改为UserMapper。并且编写增删改查代码。
public interface UserMapper {
// 查询所有用户
List<User> getUserList();
// 根据id查询用户
User getUserById(int id);
// 插入一个用户
int addUser(User user);
// 修改用户
int updateUser(User user);
// 删除一个用户
int deleteUserById(int id);
}
说明:在UserMapper中编写增删改查的接口。注意增删改查的返回值类型和传入的参数类型。
3.1 查询
修改UserMapper.xml
<select id="getUserById" parameterType="int" resultType="com.xxc.pojo.User">
select * from user where id = #{id}
</select>
// 修改DaoTest
@Test
public void getUserById(){
SqlSession sqlSession = MyBatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUserById(1);
System.out.println(user);
//关闭SqlSession
sqlSession.close();
}
3.2 新增
<insert id="addUser" parameterType="com.xxc.pojo.User">
insert into user (id,name,pwd) values (#{id},#{name},#{pwd});
</insert>
// 修改DaoTest
@Test
public void addUser(){
User user = new User(4,"哈哈","125452");
SqlSession sqlSession = MyBatisUtils.getSqlSession();
UserMapper user1 = sqlSession.getMapper(UserMapper.class);
int res = user1.addUser(user);
System.out.println(res);
// 提交事务
sqlSession.commit();
sqlSession.close();
}
3.3 修改
<update id="updateUser" parameterType="com.xxc.pojo.User">
update user set name = #{name}, pwd = #{pwd} where id = #{id};
</update>
// 修改DaoTest
@Test
public void updateUser(){
SqlSession sqlSession = MyBatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
int res = mapper.updateUser(new User(4, "呵呵", "258528"));
System.out.println(res);
// 提交事务
sqlSession.commit();
sqlSession.close();
}
3.4 删除
<delete id="deleteUserById" parameterType="int">
delete from user where id = #{id}
</delete>
// 修改DaoTest
@Test
public void deleteUserById(){
SqlSession sqlSession = MyBatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
int res = mapper.deleteUserById(4);
System.out.println(res);
// 提交事务
sqlSession.commit();
sqlSession.close();
}
注意点:查询不需要提交事务。增删改需要提交事务,sqlSession.commit();并且最后要关闭,sqlSession.close();
思路梳理
-
需要改变的文件有两个。UserMapper.java和UserMapper.xml。在UserMapper.java中编写增删改查的接口,然后在UserMapper.xml中编写所要执行的sql语句。
-
对于增删改,一定要提交事务,sqlSession.commit(),不然操作不成功。
-
增删改查最后都要关闭sqlsession。
-
实体类和工具类不用改变。
4. 常见错误
- UserMapper.xml中标签匹配错误
- UserMapper.xml中的resultType和parameterType写成了斜杠,应该是点
- .xml中有中文注释,GBK编码情况下容易有错误。
- mybatis-config.xml中的resource写成了点,应该是斜杠
- mybatis-config.xml中的url连接符写成了&,应该是& amp;
- MyBatisUtils.java中sqlSessionFactory的空指针问题,以下是正确写法。
5. 万能的map
假设,我们的实体类,或者数据库中的表字段或者参数过多,我们应该考虑使用map的方式。
我们将以上代码继续改造。
编写一个新增用户的接口。
// 万能的map新增一个用户
int addUser2(Map<String,Object> map);
修改UserMapper.xml
<insert id="addUser2" parameterType="map">
insert into user (id,name,pwd) values (#{userId},#{userName},#{userPwd});
</insert>
说明:这里的values中其实获取的是map中的键,并且不用和数据库字段名保持一致,字段也不一定要写全,只保证我要被插入的字段有即可。但是我们之前写的传递对象的方法中需要保持一致。
重点:其实所有的参数都可以写成map的形式。这种在实际开发中更常用。
修改测试类。
@Test
public void addUser2(){
SqlSession sqlSession = MyBatisUtils.getSqlSession();
UserMapper user2 = sqlSession.getMapper(UserMapper.class);
HashMap<String, Object> map = new HashMap<>();
map.put("userId",4);
map.put("userName","Hello");
map.put("userPwd","12456321");
int res = user2.addUser2(map);
System.out.println(res);
sqlSession.commit();
sqlSession.close();
}
这里map中的键和UserMapper.xml中的values里字段,数量保持一致。
6. 模糊查询
如果我有的查询需要使用到模糊查询。
// 使用模糊查询
List<User> getUserLike(String name);
方式一:
在java代码执行的时候,传递通配符% %
List<User> users = mapper.getUserLike("%李%");
方式二:
在sql拼接中使用通配符。
<select id="getUserLike" resultType="com.xxc.pojo.User">
select * from user where name like "%"#{name}"%";
</select>