文章目录
- [1. MyBatis概述](#1. MyBatis概述)
- [2. MyBatis快速入门](#2. MyBatis快速入门)
-
- [2.1 创建项目](#2.1 创建项目)
- [2.2 添加依赖](#2.2 添加依赖)
- [2.3 数据准备](#2.3 数据准备)
- [2.4 编写代码](#2.4 编写代码)
-
- [2.4.1 编写核心配置文件](#2.4.1 编写核心配置文件)
- [2.4.2 编写SQL映射文件](#2.4.2 编写SQL映射文件)
- [2.4.3 编写Java代码](#2.4.3 编写Java代码)
- [3. Mapper代理开发](#3. Mapper代理开发)
- [4. MyBatis核心配置文件](#4. MyBatis核心配置文件)
- [5. 案例练习](#5. 案例练习)
-
- [5.1 数据准备](#5.1 数据准备)
- [5.2 查询数据](#5.2 查询数据)
-
- [5.2.1 查询所有数据](#5.2.1 查询所有数据)
- [5.2.2 查询单条数据详情](#5.2.2 查询单条数据详情)
- [5.2.3 条件查询](#5.2.3 条件查询)
-
- [5.2.3.1 固定多条件查询](#5.2.3.1 固定多条件查询)
- [5.2.3.2 动态多条件查询](#5.2.3.2 动态多条件查询)
- [5.2.3.3 动态单条件查询](#5.2.3.3 动态单条件查询)
- [5.3 添加数据](#5.3 添加数据)
- [5.4 修改数据](#5.4 修改数据)
- [5.5 删除数据](#5.5 删除数据)
-
- [5.5.1 删除单条数据](#5.5.1 删除单条数据)
- [5.5.2 批量删除数据](#5.5.2 批量删除数据)
- [6. Mybatis参数传递](#6. Mybatis参数传递)
-
- [6.1 多个参数](#6.1 多个参数)
- [6.2 单个参数](#6.2 单个参数)
- [7. 注解实现CRUD](#7. 注解实现CRUD)
1. MyBatis概述
1.MyBatis概念:MyBatis是一款优秀的持久层框架,用于简化JDBC开发。
- 它支持自定义 SQL、存储过程以及高级映射
- 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作
- 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录
注:JavaEE分为三层架构:表现层、业务层和持久层,持久层是负责将数据保存到数据库的那一层代码。
2.MyBatis文档: https://mybatis.net.cn/
3.MyBatis简化了JDBC的开发,免除了JDBC 代码以及设置参数和获取结果集的工作
- 硬编码:通过配置文件简化
- 注册驱动,获取连接
- SQL语句
- 操作繁琐:MyBatis自动完成
- 设置参数
- 封装结果集
2. MyBatis快速入门
MyBatis开发步骤:
- 导入MyBatis和数据库驱动等相关依赖
- 创建数据表以及该表对应的实体类
- 编写MyBatis核心配置文件(用于替换连接信息,解决硬编码问题)
- 编写SQL映射文件(用于统一管理SQL语句,解决硬编码问题)
- 编写代码
- 加载核心配置文件,获取SqlSessionFactory对象
- 获取SqlSession对象,执行SQL语句
- 释放资源
2.1 创建项目
1.New Project,创建新项目
2.填写项目名称等信息,Build System勾选Maven,创建maven项目
3.修改maven配置,修改settings.xml
内容和IDEA
配置
注:settings.xml路径如下:
apache-maven-3.9.3\conf\settings.xml
修改settings.xml
内容如下:
xml
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.2.0 https://maven.apache.org/xsd/settings-1.2.0.xsd">
<localRepository>D:\repository</localRepository>
<mirrors>
<mirror>
<id>nexus-aliyun</id>
<mirrorOf>central</mirrorOf>
<name>Nexus aliyun</name>
<url>http://maven.aliyun.com/nexus/content/groups/public</url>
</mirror>
</mirrors>
</settings>
修改IDEA
配置如下:
2.2 添加依赖
1.查找mybatis依赖配置
查看mybatis快速入门文档,得到mybatis依赖配置如下:https://mybatis.net.cn/getting-started.html
xml
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>x.x.x</version>
</dependency>
2.查找mysql驱动依赖配置
打开cmd,输入mysql -V
,查看mysql版本:此处我的版本是 8.0.32
mvnrepository
官网,查找该版本对应的mysql驱动:https://mvnrepository.com/
xml
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.32</version>
</dependency>
3.复制依赖代码到pom.xml
中,最终pom.xml
代码如下
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>com.itheima</groupId>
<artifactId>mybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<!--mybatis依赖-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.13</version>
</dependency>
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.32</version>
</dependency>
<!--junit单元测试-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13.1</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
2.3 数据准备
1.创建数据库
sql
-- 创建mybatis数据库
create database if not exists mybatis;
2.创建表
sql
-- 删除tb_user表
drop table if exists tb_user;
-- 创建tb_user表
create table tb_user (
id int primary key auto_increment, -- id主键
username varchar(20), -- 用户名
password varchar(20), -- 密码
gender varchar(1), -- 性别
addr varchar(30)-- 地址
);
-- 向tb_user表插入数据
insert into tb_user values (1, '张三' , '123', '男', '北京');
insert into tb_user values (2, '李四' , '456', '女', '天津');
insert into tb_user values (3, '王五' , '123456', '男', '西安');
-- 查询tb_user表
select * from tb_user;
3.在 com.itheima
包下新建 pojo
包,并在 pojo
包下创建实体类 User
,对应tb_user
表
java
package com.itheima.pojo;
/**
* 用户类
* 在实体类中,基本数据类型建议使用其对应的包装类型
*/
public class User {
private Integer id; // id主键
private String username; // 用户名
private String password; // 密码
private String gender; // 性别
private String addr; // 地址
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 String getGender() {
return gender;
}
public void setGender(String gender) {
this.gender = gender;
}
public String getAddr() {
return addr;
}
public void setAddr(String addr) {
this.addr = addr;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", username='" + username + '\'' +
", password='" + password + '\'' +
", gender='" + gender + '\'' +
", addr='" + addr + '\'' +
'}';
}
}
2.4 编写代码
2.4.1 编写核心配置文件
resources
目录下新建 mybatis-config.xml
,作为核心配置文件,内容如下:
注:数据库的连接信息,根据自己本地电脑的数据库信息填写
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.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<!--加载sql映射文件-->
<mapper resource="UserMapper.xml"/>
</mappers>
</configuration>
2.4.2 编写SQL映射文件
resources
目录下新建 UserMapper.xml
,作为用户表sql映射文件,需要与mybatis-config.xml
中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">
<!--namespace: 名称空间-->
<mapper namespace="test">
<select id="selectAll" resultType="com.itheima.pojo.User">
select * from tb_user;
</select>
</mapper>
2.4.3 编写Java代码
在com.itheima
包下新建MybatisDemo.java
,内容如下:
java
package com.itheima;
import com.itheima.pojo.User;
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;
import java.util.List;
/**
* Mybatis快速入门代码
*/
public class MybatisDemo {
public static void main(String[] args) throws IOException {
// 1.加载mybatis核心配置文件,获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.从SqlSessionFactory中获取SqlSession,用它来执行sql语句
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.执行sql语句
List<User> users = sqlSession.selectList("test.selectAll"); // 名称空间.id为唯一标识
System.out.println(users);
// 4.释放资源
sqlSession.close();
}
}
执行代码,运行结果如下:
最终项目结构如下:
总结:
mybatis-config.xml
:为核心配置文件,存在着数据库连接信息,以及需要加载的映射文件信息(UserMapper.xml)UserMapper.xml
:为SQL映射文件,此处用于编写和管理SQL语句,并对每个SQL语句提供唯一的标识,由名称空间.id
组成,如test.selectAll
MybatisDemo.java
:mybatis
的程序执行入口代码,通过执行方法sqlSession.selectList("test.selectAll")
,执行test.selectAll
对应的SQL语句select * from tb_user;
3. Mapper代理开发
使用Mapper代理开发的优势:
- 解决原生方式中的硬编码
- 简化后期执行SQL
原生方式:
java
List<User> users = sqlSession.selectList("test.selectAll");
System.out.println(users);
Mapper代理开发方式:
java
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
List<User> users = userMapper.selectAll();
System.out.println(users);
使用Mapper代理开发方式完成入门案例:
- 定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射文件放置在同一目录下
- 设置SQL映射文件的namespace属性Mapper接口全限定名
- 在Mapper接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致
- 编码
- 通过SqlSession的getMapper方法获取Mapper接口的代理对象
- 调用对应方法完成sql的执行
注:如果Mapper接口名称和SQL映射文件名称相同,并在同一目录下,则可以使用包扫描的方式简化SQL映射文件的加载
1.定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射文件放置在同一目录下
- 在
com.itheima
包下,新建mapper
包,并新建UserMapper
的接口 - 在
resource
目录下,新建目录层次结构com/itheima/mapper
,然后把UserMapper.xml
拖到该目录下
将
UserMapper
的接口的目录结构与UserMapper.xml
都放在在com/itheima/mapper
目录下,是为了保证在maven工程编译之后,UserMapper
的接口和UserMapper.xml
会打包在同一目录下
编译前的结构:
编译后的结构:
2.设置SQL映射文件 UserMapper.xml
的namespace属性为Mapper接口全限定名 com.itheima.mapper.UserMapper
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 namespace="com.itheima.mapper.UserMapper">
<select id="selectAll" resultType="com.itheima.pojo.User">
select * from tb_user;
</select>
</mapper>
3.在Mapper接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致
- 方法名为
selectAll()
,对应的是UserMapper.xml
的id="selectAll"
- 返回类型为
User
对象的集合,即List<User>
类型
java
package com.itheima.mapper;
import com.itheima.pojo.User;
import java.util.List;
public interface UserMapper {
List<User> selectAll();
}
4.由于 UserMapper.xml
路径发生了变化,所以也要相应的修改 mybatis-config.xml
的sql映射文件路径为 com/itheima/mapper/UserMapper.xml
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.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<!--加载sql映射文件-->
<mapper resource="com/itheima/mapper/UserMapper.xml"/>
</mappers>
</configuration>
注:由于Mapper接口名称和SQL映射文件名称相同,且在同一目录下,那么也可以使用包扫描的方式简化SQL映射文件的加载
xml
<!--一般方式:加载sql映射文件-->
<mapper resource="com/itheima/mapper/UserMapper.xml"/>
以上一般方式,可以替换为包扫描方式:
xml
<!--包扫描方式:加载sql映射文件-->
<package name="com.itheima.mapper"/>
5.编码
- 通过SqlSession的getMapper方法获取Mapper接口的代理对象
- 调用对应方法完成sql的执行
java
package com.itheima;
import com.itheima.mapper.UserMapper;
import com.itheima.pojo.User;
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;
import java.util.List;
/**
* Mybatis快速入门代码
*/
public class MybatisDemo {
public static void main(String[] args) throws IOException {
// 1.加载mybatis核心配置文件,获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.从SqlSessionFactory中获取SqlSession,用它来执行sql语句
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取UserMapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 4.执行sql语句
List<User> users = userMapper.selectAll();
System.out.println(users);
// 5.释放资源
sqlSession.close();
}
}
执行代码,运行结果如下:
4. MyBatis核心配置文件
MyBatis核心配置文件说明见官网:https://mybatis.net.cn/configuration.html
注:配置各个标签时,需要遵守前后顺序,这个顺序就是以上截图的顺序
1.environments
:环境配置,MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中, 现实情况下有多种理由需要这么做。例如,开发、测试和生产环境需要有不同的配置;或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。
例如:以下配置表示有开发和测试两个环境的数据库信息,默认使用开发环境的数据库信息。
如果想切换默认的数据库信息,则修改
default
属性为对应的environment
配置的id
即可,比如default="test"
,表示默认使用测试数据库的环境信息
xml
<!--
environments:
1.配置数据库连接环境信息,可以配置多个environment
2.通过default属性切换不同的environment
-->
<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://127.0.0.1:3306/mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
<!--测试环境数据库信息-->
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!--数据库连接信息-->
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
2.typeAliases
:类型别名,可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。
例如:原先 UserMapper.xml
中的 resultType
属性为 com.itheima.pojo.User
xml
<!--namespace: 名称空间-->
<mapper namespace="com.itheima.mapper.UserMapper">
<select id="selectAll" resultType="com.itheima.pojo.User">
select * from tb_user;
</select>
</mapper>
使用 typeAliases
:
- 首先修改核心配置文件
mybatis-config.xml
中的typeAliases
配置 - 然后修改
UserMapper.xml
中的resultType
属性
mybatis-config.xml
:
xml
<typeAliases>
<package name="com.itheima.pojo"/>
</typeAliases>
UserMapper.xml
xml
<!--namespace: 名称空间-->
<mapper namespace="com.itheima.mapper.UserMapper">
<select id="selectAll" resultType="User">
select * from tb_user;
</select>
</mapper>
5. 案例练习
5.1 数据准备
需求:能够使用映射配置文件实现CRUD操作,此处是对商品品牌数据的增删改查操作
如上图所示产品原型,里面包含了品牌数据的 查询
、按条件查询
、添加
、删除
、批量删除
、修改
等功能,而这些功能其实就是对数据库表中的数据进行CRUD操作。接下来我们就使用Mybatis完成品牌数据的增删改查操作。以下是我们要完成功能列表:
- 查询
- 查询所有数据
- 查询详情
- 条件查询
- 添加
- 修改
- 修改全部字段
- 修改动态字段
- 删除
- 删除一个
- 批量删除
1.创建数据库表 tb_brand
sql
-- 删除tb_brand表
drop table if exists tb_brand;
-- 创建tb_brand表
create table tb_brand (
id int primary key auto_increment, -- id主键
brand_name varchar(20), -- 品牌名称
company_name varchar(20), -- 企业名称
ordered int, -- 排序字段
description varchar(100), -- 描述信息
status int -- 状态:0:禁用 1:启用
);
-- 向tb_brand表插入数据
insert into tb_brand (brand_name, company_name, ordered, description, status)
values ('三只松鼠', '三只松鼠股份有限公司', 5, '好吃不上火', 0),
('华为', '华为技术有限公司', 100, '华为致力于把数字世界带入每个人、每个家庭、每个组织,构建万物互联的智能世界', 1),
('小米', '小米科技有限公司', 50, 'are you ok', 1);
-- 查询tb_brand表
select * from tb_brand;
2.在 com.itheima.pojo
包下创建 Brand
实体类
java
package com.itheima.pojo;
/**
* 品牌
* 在实体类中,基本数据类型建议使用其对应的包装类型
*/
public class Brand {
private Integer id; // id 主键
private String brandName; // 品牌名称
private String companyName; // 企业名称
private Integer ordered; // 排序字段
private String description; // 描述信息
private Integer status; // 状态:0:禁用 1:启用
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
public String getBrandName() {
return brandName;
}
public void setBrandName(String brandName) {
this.brandName = brandName;
}
public String getCompanyName() {
return companyName;
}
public void setCompanyName(String companyName) {
this.companyName = companyName;
}
public Integer getOrdered() {
return ordered;
}
public void setOrdered(Integer ordered) {
this.ordered = ordered;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public Integer getStatus() {
return status;
}
public void setStatus(Integer status) {
this.status = status;
}
@Override
public String toString() {
return "Brand{" +
"id=" + id +
", brandName='" + brandName + '\'' +
", companyName='" + companyName + '\'' +
", ordered=" + ordered +
", description='" + description + '\'' +
", status=" + status +
'}';
}
}
3.编写测试用例,在 test/java
目录下创建包 com.itheima.test
,以及测试用例类 MybatisTest
项目结构如下:
4.编写MyBatis核心配置文件,在 resources
目录下创建 mybatis-config.xml
文件,内容如下:
注:数据库的连接信息,根据自己本地电脑的数据库信息填写
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>
<!--类型别名-->
<typeAliases>
<package name="com.itheima.pojo"/>
</typeAliases>
<!--environments:配置数据库连接环境信息,可以配置多个environment-->
<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://127.0.0.1:3306/mybatis?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!--加载sql映射文件-->
<mappers>
<package name="com.itheima.mapper"/>
</mappers>
</configuration>
5.安装 MyBatisX
插件
MybatisX 是一款基于 IDEA 的快速开发插件,为效率而生,功能如下:
- XML映射配置文件 和 接口方法 间相互跳转
- 根据接口方法生成 statement
安装方式:点击 File
-> Settings
-> Plugins
-> 搜索 MybatisX
,就能看到如下图所示界面,点击 install
安装。
插件效果:
红色头绳的表示映射配置文件,蓝色头绳的表示mapper接口。在mapper接口点击红色头绳的小鸟图标会自动跳转到对应的映射配置文件,在映射配置文件中点击蓝色头绳的小鸟图标会自动跳转到对应的mapper接口。
也可以在mapper接口中定义方法,自动生成映射配置文件中的 statement
,如图所示:
5.2 查询数据
5.2.1 查询所有数据
如图所示就是页面上展示的数据,而这些数据需要从数据库进行查询:
接下来我们就来讲查询所有数据功能,而实现该功能我们分以下步骤进行实现:
- 编写接口方法
- 编写SQL语句
- 编写测试方法
1.编写接口方法:在 com.itheima.mapper
包写创建名为 BrandMapper
的接口,并在该接口中定义 List<Brand> selectAll()
方法。
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import java.util.List;
public interface BrandMapper {
/**
* 查询所有
*/
List<Brand> selectAll();
}
2.编写SQL语句:在 reources
目录下创建 com/itheima/mapper
目录结构,并在该目录下创建名为 BrandMapper.xml
的映射配置文件
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 namespace="com.itheima.mapper.BrandMapper">
<select id="selectAll" resultType="brand">
select * from tb_brand;
</select>
</mapper>
3.编写测试方法:在MybatisTest
类中,编写如下代码
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testSelectAll() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
List<Brand> brands = brandMapper.selectAll();
System.out.println(brands);
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
根据上述运行结果可以看到:id
、ordered
、description
和 status
数据封装成功,能够正常打印数据,但是 brandName
和 companyName
数据自动封装失败。
原因:是因为实体类中的属性名和数据库表中的字段名不一致导致的,查询 实体类 和 表中的字段 发现,在实体类中属性名是 brandName
和 companyName
,而表中的字段名为 brand_name
和 company_name
,如下图所示 。
解决方案:只需要保持这两部分的名称一致这个问题就迎刃而解,有以下两种方式可以解决
- 给字段起别名
- 使用resultMap定义字段和属性的映射关系(推荐)
1.给字段取别名
编写SQL语句时,给字段取别名,将别名定义成与属性名一致即可
xml
<mapper namespace="com.itheima.mapper.BrandMapper">
<select id="selectAll" resultType="brand">
select
id, brand_name as brandName, company_name as companyName, ordered, description, status
from tb_brand;
</select>
</mapper>
上面的SQL语句中的字段列表书写麻烦,如果表中还有更多的字段,同时其他的功能也需要查询这些字段时就显得我们的代码不够精炼,Mybatis提供了sql
片段可以提高sql的复用性。
xml
<mapper namespace="com.itheima.mapper.BrandMapper">
<!--定义sql片段,id属性值是唯一标识-->
<sql id="brand_column">
id, brand_name as brandName, company_name as companyName, ordered, description, status
</sql>
<!--使用include标签引用sql片段,refid指定sql片段的id值-->
<select id="selectAll" resultType="brand">
select
<include refid="brand_column" />
from tb_brand;
</select>
</mapper>
注:起别名 + sql片段的方式可以解决上述问题,但是它也存在问题。如果还有功能只需要查询部分字段,而不是查询所有字段,那么我们就需要再定义一个 SQL 片段,这就显得不是那么灵活。
2.使用resultMap定义字段和属性的映射关系
xml
<mapper namespace="com.itheima.mapper.BrandMapper">
<!--定义了brandResultMap对应的是brand类型-->
<resultMap id="brandResultMap" type="brand">
<!--
1.id标签完成主键字段的映射,result标签完成一般字段的映射
2.column为数据库表字段,property为实体类属性
-->
<result column="brand_name" property="brandName"/>
<result column="company_name" property="companyName"/>
</resultMap>
<!--此处改为使用resultMap,而不是resultType-->
<select id="selectAll" resultMap="brandResultMap">
select *
from tb_brand;
</select>
</mapper>
注意:上面只需要定义 字段名 和 属性名 不一样的映射,而一样的则不需要专门定义出来。
修改后的运行结果如下:
5.2.2 查询单条数据详情
有些数据的属性比较多,在页面表格中无法全部实现,而只会显示部分,而其他属性数据的查询可以通过 查看详情
来进行查询,如下图所示:
1.编写接口方法
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import java.util.List;
public interface BrandMapper {
/**
* 查看详情:根据Id查询
*/
Brand selectById(int id);
}
2.编写SQL语句
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 namespace="com.itheima.mapper.BrandMapper">
<!--字段与属性映射-->
<resultMap id="brandResultMap" type="brand">
<result column="brand_name" property="brandName"/>
<result column="company_name" property="companyName"/>
</resultMap>
<select id="selectById" resultMap="brandResultMap">
select * from tb_brand where id = #{id};
</select>
</mapper>
3.编写测试方法
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testSelectById() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
int id = 1; // 接收参数,该id以后需要传递过来
Brand brand = brandMapper.selectById(id);
System.out.println(brand);
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
1.参数占位符:可以看到以上SQL语句中使用了 #{id}
,也就是参数占位符。
mybatis提供了两种参数占位符:
#{}
:执行SQL时,会将#{}
占位符替换为?
,底层使用的是PreparedStatement
,可以防止SQL注入。${}
:直接拼接SQL,底层使用的是Statement
,会存在SQL注入问题。
注:对比得出,开发都是使用
#{}
参数占位符
2.parameterType的使用:对于有参数的mapper接口方法,我们在映射配置文件中应该配置 ParameterType
来指定参数类型,只不过该属性都可以省略。
xml
<select id="selectById" parameterType="int" resultMap="brandResultMap">
select * from tb_brand where id = #{id};
</select>
3.SQL语句中的特殊字符处理
以后肯定会在SQL语句中写一下特殊字符,比如某一个字段大于某个值,但是 >
<
等字符在xml中有特殊含义,所以此时我们需要将这些符号进行转义,可以使用以下两种方式进行转义:
- 使用xml的转义字符,例如:
<
就是<
的转义字符。 - 使用
CDATA
,格式为<![CDATA[内容]]>
,例如:<![CDATA[ < ]]>
就是<
的转义字符。
xml
<select id="selectById" resultMap="brandResultMap">
select * from tb_brand
where id <![CDATA[ < ]]> #{id};
</select>
注:如果使用了大于或者小于某个值,那么返回的就是
List
集合,此时要修改mapper接口的返回对象为List<Brand>
5.2.3 条件查询
5.2.3.1 固定多条件查询
我们经常会遇到如上图所示的多条件查询,将多条件查询的结果展示在下方的数据列表中。而我们做这个功能需要分析最终的SQL语句应该是什么样,思考两个问题
- 条件表达式
- 如何连接
条件字段 企业名称
和 品牌名称
需要进行模糊查询,所以条件应该是:
简单的分析后,我们来看功能实现的步骤:
- 编写接口方法
- 参数:所有查询条件
- 结果:
List<Brand>
- 在映射配置文件中编写SQL语句
- 编写测试方法并执行
1.编写接口方法:该功能有三个参数,我们就需要考虑定义接口时,参数应该如何定义。
Mybatis针对多参数有多种实现:
- 散装参数:需要使用
@Param("SQL中的参数占位符名称")
- 实体类封装参数:只需要保证SQL中的参数名和实体类属性名对应上,即可设置成功
- map集合:只需要保证SQL中的参数名和map集合的键名对应上,即可设置成功
1.1 散装参数:使用 @Param("参数名称")
标记每一个参数,在映射配置文件中就需要使用 #{参数名称}
进行占位
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import org.apache.ibatis.annotations.Param;
import java.util.List;
public interface BrandMapper {
/**
* 多条件查询
*/
List<Brand> selectByCondition(@Param("status") int status, @Param("companyName") String companyName, @Param("brandName") String brandName);
}
1.2 实体类封装参数:将多个参数封装成一个 实体对象 ,将该实体对象作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容}
时,里面的内容必须和实体类属性名保持一致。
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import org.apache.ibatis.annotations.Param;
import java.util.List;
public interface BrandMapper {
/**
* 多条件查询
*/
List<Brand> selectByCondition(Brand brand);
}
1.3 map集合:将多个参数封装到map集合中,将map集合作为接口的方法参数。该方式要求在映射配置文件的SQL中使用 #{内容}
时,里面的内容必须和map集合中键的名称一致。
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import org.apache.ibatis.annotations.Param;
import java.util.List;
import java.util.Map;
public interface BrandMapper {
/**
* 多条件查询
*/
List<Brand> selectByCondition(Map map);
}
2.编写SQL语句
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 namespace="com.itheima.mapper.BrandMapper">
<!--字段与属性映射-->
<resultMap id="brandResultMap" type="brand">
<result column="brand_name" property="brandName"/>
<result column="company_name" property="companyName"/>
</resultMap>
<select id="selectByCondition" resultMap="brandResultMap">
select * from tb_brand
where status = #{status}
and company_name like #{companyName}
and brand_name like #{brandName}
</select>
</mapper>
3.编写测试方法
3.1 对应 1.1
中使用 @Param("参数名称")
标记每一个参数的方式
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testSelectByCondition() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int status = 1;
String companyName = "华为";
String brandName = "华为";
// 处理参数
companyName = "%" + companyName + "%";
brandName = "%" + brandName + "%";
// 接口方法参数使用 @Param 方式调用的方法
List<Brand> brands = brandMapper.selectByCondition(status, companyName, brandName);
System.out.println(brands);
// 5.释放资源
sqlSession.close();
}
}
3.2 对应 1.2
中的将多个参数封装成一个 实体对象的方式
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testSelectByCondition() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int status = 1;
String companyName = "华为";
String brandName = "华为";
// 处理参数
companyName = "%" + companyName + "%";
brandName = "%" + brandName + "%";
// 接口方法参数是 实体类对象 方式调用的方法
Brand brand = new Brand();
brand.setStatus(status);
brand.setCompanyName(companyName);
brand.setBrandName(brandName);
List<Brand> brands = brandMapper.selectByCondition(brand);
System.out.println(brands);
// 5.释放资源
sqlSession.close();
}
}
3.3 对应 1.3
中的将多个参数封装到map集合的方式
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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.HashMap;
import java.util.List;
import java.util.Map;
public class MybatisTest {
@Test
public void testSelectByCondition() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int status = 1;
String companyName = "华为";
String brandName = "华为";
// 处理参数
companyName = "%" + companyName + "%";
brandName = "%" + brandName + "%";
// 接口方法参数是 map集合对象 方式调用的方法
Map map = new HashMap();
map.put("status" , status);
map.put("companyName", companyName);
map.put("brandName" , brandName);
List<Brand> brands = brandMapper.selectByCondition(map);
System.out.println(brands);
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
5.2.3.2 动态多条件查询
上述使用固定多条件查询的功能实现存在很大的问题,用户在输入条件时,不一定会所有的条件都填写,这个时候我们的SQL语句就不能像上面那样写。
例如用户只输入 当前状态
时,SQL语句就是:
sql
select * from tb_brand where status = #{status}
而用户如果只输入 企业名称
时,SQL语句就是:
sql
select * from tb_brand where company_name like #{companName}
而用户如果输入了 当前状态
和 企业名称
时,SQL语句又不一样:
sql
select * from tb_brand where status = #{status} and company_name like #{companName}
针对上述的需要,Mybatis对动态SQL有很强大的支撑:
if
choose (when, otherwise)
trim (where, set)
foreach
1.修改SQL语句
if
标签的作用:条件判断test
属性:逻辑表达式
where
标签的作用:- 替换where关键字
- 会动态的去掉第一个条件前的 and
- 如果所有的参数没有值则不加where关键字
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 namespace="com.itheima.mapper.BrandMapper">
<!--字段与属性映射-->
<resultMap id="brandResultMap" type="brand">
<result column="brand_name" property="brandName"/>
<result column="company_name" property="companyName"/>
</resultMap>
<select id="selectByCondition" resultMap="brandResultMap">
select * from tb_brand
<where>
<if test="status != null">
and status = #{status}
</if>
<if test="companyName != null and companyName != '' ">
and company_name like #{companyName}
</if>
<if test="brandName != null and brandName != '' ">
and brand_name like #{brandName}
</if>
</where>
</select>
</mapper>
注意:需要给每个条件前都加上
and
关键字。
2.修改测试方法:构造测试场景,运行观察是否发生报错
- 用户只输入了
当前状态
- 用户如果只输入了
企业名称
- 用户输入了
当前状态
和企业名称
- 用户什么都没输入
此处以
5.2.3.1
小节使用map集合封装参数的方式为例
java
// 用户只输入了"当前状态"
Map map = new HashMap();
map.put("status" , status);
List<Brand> brands = brandMapper.selectByCondition(map);
System.out.println(brands);
java
// 用户只输入了"企业名称"
Map map = new HashMap();
map.put("companyName", companyName);
List<Brand> brands = brandMapper.selectByCondition(map);
System.out.println(brands);
java
// 用户只输入了"当前状态"和"企业名称"
Map map = new HashMap();
map.put("status" , status);
map.put("companyName", companyName);
List<Brand> brands = brandMapper.selectByCondition(map);
System.out.println(brands);
java
// 用户什么都没输入
Map map = new HashMap();
List<Brand> brands = brandMapper.selectByCondition(map);
System.out.println(brands);
5.2.3.3 动态单条件查询
如下图所示,在查询时只能选择 品牌名称
、当前状态
、企业名称
这三个条件中的一个,但是用户到底选择哪儿一个,我们并不能确定。这种就属于单个条件的动态SQL语句,这种需求需要使用到 choose(when,otherwise)标签
实现, 而 choose
标签类似于Java 中的switch
语句。
1.编写接口方法
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import org.apache.ibatis.annotations.Param;
import java.util.List;
import java.util.Map;
public interface BrandMapper {
/**
* 单条件动态查询
* @param brand
* @return
*/
List<Brand> selectBySingleCondition(Brand brand);
}
2.编写SQL语句
choose(when,otherwise)标签
:可以类比 Java 中的switch
语句
choose
相当于switch
when
相当于case
otherwise
相当于default
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 namespace="com.itheima.mapper.BrandMapper">
<!--字段与属性映射-->
<resultMap id="brandResultMap" type="brand">
<result column="brand_name" property="brandName"/>
<result column="company_name" property="companyName"/>
</resultMap>
<select id="selectBySingleCondition" resultMap="brandResultMap">
select * from tb_brand
<where>
<choose> <!--相当于switch-->
<when test="status != null"> <!--相当于case-->
status = #{status}
</when>
<when test="companyName != null and companyName != '' "> <!--相当于case-->
company_name like #{companyName}
</when>
<when test="brandName != null and brandName != ''"> <!--相当于case-->
brand_name like #{brandName}
</when>
</choose>
</where>
</select>
</mapper>
3.编写测试方法
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testSelectBySingleCondition() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int status = 1;
String companyName = "华为";
String brandName = "华为";
// 处理参数
companyName = "%" + companyName + "%";
brandName = "%" + brandName + "%";
// 接口方法参数是 实体类对象 方式调用的方法
Brand brand = new Brand();
brand.setCompanyName(companyName);
List<Brand> brands = brandMapper.selectBySingleCondition(brand);
System.out.println(brands);
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
5.3 添加数据
如下图是我们平时在添加数据时展示的页面,而我们在该页面输入想要的数据后添加 提交
按钮,就会将这些数据添加到数据库中。接下来我们就来实现添加数据的操作。
1.编写接口方法
参数:除了id之外的所有的数据,id对应的是表中主键值,而主键我们是 自动增长 生成的。
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
import org.apache.ibatis.annotations.Param;
import java.util.List;
import java.util.Map;
public interface BrandMapper {
/**
* 添加
*/
void add(Brand brand);
}
2.编写SQL语句
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 namespace="com.itheima.mapper.BrandMapper">
<insert id="add">
insert into tb_brand (brand_name, company_name, ordered, description, status)
values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>
</mapper>
3.编写测试方法
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testAdd() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int status = 1;
String companyName = "波导手机";
String brandName = "波导";
String description = "手机中的战斗机";
int ordered = 100;
// 封装对象
Brand brand = new Brand();
brand.setStatus(status);
brand.setCompanyName(companyName);
brand.setBrandName(brandName);
brand.setDescription(description);
brand.setOrdered(ordered);
// 执行方法
brandMapper.add(brand);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}
执行完上述代码后,查询 tb_brand
表,发现数据已更新:
在数据添加成功后,有时候需要获取插入数据库数据的主键(主键是自增长)。
例如:添加订单和订单项,如下图就是京东上的订单
订单数据存储在订单表中,订单项存储在订单项表中。
添加订单数据:
添加订单项数据,订单项中需要设置所属订单的id:
明白了什么时候 主键返回
。接下来我们简单模拟一下,在添加完数据后打印id属性值,能打印出来说明已经获取到了。
我们将上面添加品牌数据的案例中映射配置文件里 statement
进行修改,如下:
useGeneratedKeys
属性:是否获取自动增长的主键值,true表示获取keyProperty
属性:指定将获取到的主键值封装到哪儿个属性里
xml
<insert id="add" useGeneratedKeys="true" keyProperty="id">
insert into tb_brand (brand_name, company_name, ordered, description, status)
values (#{brandName}, #{companyName}, #{ordered}, #{description}, #{status});
</insert>
修改执行方法,打印返回的主键 id
java
// 执行方法
brandMapper.add(brand);
Integer id = brand.getId();
System.out.println(id);
5.4 修改数据
如下图所示是修改页面,用户在该页面书写需要修改的数据,点击 提交
按钮,就会将数据库中对应的数据进行修改。需要注意的是,如果哪儿个输入框没有输入内容,我们是将表中数据对应字段值替换为空白还是保留字段之前的值?答案肯定是保留之前的数据。
1.编写接口方法
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
public interface BrandMapper {
/**
* 修改
*/
int update(Brand brand);
}
2.编写SQL语句
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 namespace="com.itheima.mapper.BrandMapper">
<update id="update">
update tb_brand
<set>
<if test="brandName != null and brandName != ''">
brand_name = #{brandName},
</if>
<if test="companyName != null and companyName != ''">
company_name = #{companyName},
</if>
<if test="ordered != null">
ordered = #{ordered},
</if>
<if test="description != null and description != ''">
description = #{description},
</if>
<if test="status != null">
status = #{status}
</if>
</set>
where id = #{id};
</update>
</mapper>
3.编写测试方法
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testUpdate() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int id = 5;
int status = 0;
String companyName = "波导手机";
String brandName = "波导";
String description = "波导手机,手机中的战斗机";
int ordered = 200;
// 封装对象
Brand brand = new Brand();
brand.setId(id);
brand.setStatus(status);
brand.setOrdered(ordered);
// 执行方法
int count = brandMapper.update(brand);
System.out.println(count);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
执行代码前:
执行代码后:
5.5 删除数据
5.5.1 删除单条数据
如下图所示,每行数据后面都有一个 删除
按钮,当用户点击了该按钮,就会将改行数据删除掉。那我们就需要思考,这种删除是根据什么进行删除呢?是通过主键id删除,因为id是表中数据的唯一标识。
1.编写接口方法
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
public interface BrandMapper {
/**
* 根据id删除
*/
void deleteById(int id);
}
2.编写SQL语句
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 namespace="com.itheima.mapper.BrandMapper">
<delete id="deleteById">
delete from tb_brand where id = #{id};
</delete>
</mapper>
3.编写测试方法
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testDeleteById() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int id = 5;
// 执行方法
brandMapper.deleteById(id);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
执行代码前:
执行代码后:
5.5.2 批量删除数据
如下图所示,用户可以选择多条数据,然后点击上面的 删除
按钮,就会删除数据库中对应的多行数据。
1.编写接口方法
java
package com.itheima.mapper;
import com.itheima.pojo.Brand;
public interface BrandMapper {
/**
* 批量删除
*/
void deleteByIds(int[] ids);
}
参数是一个数组,数组中存储的是多条数据的
id
2.编写SQL语句:编写SQL时需要遍历数组来拼接SQL语句,Mybatis 提供了 foreach
标签供我们使用。
foreach
标签:用来迭代任何可迭代的对象(如数组、集合等)。
collection
属性: mybatis会将数组参数,封装为一个Map集合。- 默认:array = 数组
- 可以使用@Param注解改变map集合的默认key的名称
item
属性:本次迭代获取到的元素。separator
属性:集合项迭代之间的分隔符。foreach
标签不会错误地添加多余的分隔符,也就是最后一次迭代不会加分隔符。open
属性:该属性值是在拼接SQL语句之前拼接的语句,只会拼接一次close
属性:该属性值是在拼接SQL语句拼接后拼接的语句,只会拼接一次
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 namespace="com.itheima.mapper.BrandMapper">
<delete id="deleteByIds">
delete from tb_brand where id
in
<foreach collection="array" item="id" separator="," open="(" close=")">
#{id}
</foreach>
;
</delete>
</mapper>
假如数组中的id数据是{1,2,3}
,那么拼接后的sql语句就是:
sql
delete from tb_brand where id in (1,2,3);
可以使用@Param注解改变map集合的默认key的名称,例如修改默认key为 ids
:
xml
<foreach collection="ids" item="id" separator="," open="(" close=")">
#{id}
</foreach>
java
void deleteByIds(@Param("ids") int[] ids);
3.编写测试方法
java
package com.itheima.test;
import com.itheima.mapper.BrandMapper;
import com.itheima.pojo.Brand;
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 MybatisTest {
@Test
public void testDeleteByIds() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
BrandMapper brandMapper = sqlSession.getMapper(BrandMapper.class);
// 4.执行方法
// 接收参数
int[] ids = {1, 2, 3};
// 执行方法
brandMapper.deleteByIds(ids);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
执行代码前:
执行代码后:
6. Mybatis参数传递
Mybatis 接口方法中可以接收各种各样的参数,如下:
- 多个参数
- 单个参数:单个参数又可以是如下类型
POJO
类型Map
集合类型Collection
集合类型List
集合类型Array
类型- 其他类型
6.1 多个参数
如下面的代码,就是接收两个参数,而接收多个参数需要使用 @Param
注解,那么为什么要加该注解呢?这个问题要弄明白就必须来研究Mybatis 底层对于这些参数是如何处理的。
java
User select(@Param("username") String username,@Param("password") String password);
xml
<select id="select" resultType="user">
select * from tb_user
where username=#{username}
and password=#{password}
</select>
我们在接口方法中定义多个参数,Mybatis 会将这些参数封装成 Map 集合对象,值就是参数值,而键在没有使用 @Param
注解时有以下命名规则:
-
以 arg 开头 :第一个参数就叫 arg0,第二个参数就叫 arg1,以此类推。如:
map.put("arg0",参数值1);
map.put("arg1",参数值2);
-
以 param 开头 : 第一个参数就叫 param1,第二个参数就叫 param2,依次类推。如:
map.put("param1",参数值1);
map.put("param2",参数值2);
代码验证:
1.编写接口方法:在 UserMapper
接口中定义如下方法
java
package com.itheima.mapper;
import com.itheima.pojo.User;
import java.util.List;
public interface UserMapper {
User select(String username,String password);
}
2.编写SQL语句:在 UserMapper.xml
映射配置文件中定义SQL,可以使用 arg
或者 param
使用 arg
开头:
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 namespace="com.itheima.mapper.UserMapper">
<select id="select" resultType="user">
select * from tb_user
where username=#{arg0}
and password=#{arg1}
</select>
</mapper>
使用 param
开头:
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 namespace="com.itheima.mapper.UserMapper">
<select id="select" resultType="user">
select * from tb_user
where username=#{param1}
and password=#{param2}
</select>
</mapper>
3.编写测试方法:在MybatisTest
类中,编写如下代码
java
package com.itheima.test;
import com.itheima.mapper.UserMapper;
import com.itheima.pojo.User;
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 MybatisTest {
@Test
public void test() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 4.执行方法
// 接收参数
String username = "张三";
String password = "123";
User user = userMapper.select(username, password);
System.out.println(user);
// 5.释放资源
sqlSession.close();
}
}
运行结果如下:
在映射配合文件的SQL语句中使用用 arg
开头的和 param
书写,代码的可读性会变的特别差,此时可以使用 @Param
注解。在接口方法参数上使用 @Param
注解,Mybatis 会将 arg
开头的键名替换为对应注解的属性值。
代码验证:
1.在 UserMapper
接口中定义如下方法,在 username
参数前加上 @Param
注解
Mybatis 在封装 Map 集合时,键名就会变成如下:
map.put("username",参数值1);
map.put("arg1",参数值2);
map.put("param1",参数值1);
map.put("param2",参数值2);
java
User select(@Param("username") String username, String password);
2.在 UserMapper.xml
映射配置文件中定义SQL
正确的SQL语句:
xml
<select id="select" resultType="user">
select * from tb_user
where username=#{username}
and password=#{arg1}
</select>
错误的SQL语句:
xml
<select id="select" resultType="user">
select * from tb_user
where username=#{arg0}
and password=#{arg1}
</select>
运行报错如下:显示没找到arg0
参数,有效的参数为 [arg1, param1, username, param2]
结论:以后接口参数是多个时,在每个参数上都使用
@Param
注解。这样代码的可读性更高
6.2 单个参数
单个参数的类型:
-
POJO 类型:直接使用,要求
属性名
和参数占位符名称
一致 -
Map 集合类型:直接使用,要求
map集合的键名
和参数占位符名称
一致 -
Collection 集合类型:Mybatis 会将集合封装到 map 集合中,如下:
map.put("arg0",collection集合);
map.put("collection",collection集合);
-
List 集合类型:Mybatis 会将集合封装到 map 集合中,如下:
map.put("arg0",list集合);
map.put("collection",list集合);
map.put("list",list集合);
-
Array 类型:Mybatis 会将集合封装到 map 集合中,如下:
map.put("arg0",数组);
map.put("array",数组);
-
其他类型: 比如int类型,
参数占位符名称
叫什么都可以,尽量做到见名知意。
注:以上都可以使用
@Param
注解替换map集合中默认的 arg 键名
7. 注解实现CRUD
使用注解开发会比配置文件开发更加方便,但是注解只能完成简单功能,而配置文件可以完成复杂功能
Mybatis 针对 CURD 操作都提供了对应的注解,已经做到见名知意。如下:
- 查询 :
@Select
- 添加 :
@Insert
- 修改 :
@Update
- 删除 :
@Delete
注解是用来替换映射配置文件方式配置的,所以使用了注解,就不需要再映射配置文件中书写对应的
statement
1.查询数据
编写接口方法:
java
package com.itheima.mapper;
import com.itheima.pojo.User;
import org.apache.ibatis.annotations.Select;
import java.util.List;
public interface UserMapper {
@Select("select * from tb_user where id = #{id}")
User selectById(int id);
}
编写测试方法:
java
package com.itheima.test;
import com.itheima.mapper.UserMapper;
import com.itheima.pojo.User;
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 MybatisTest {
@Test
public void test() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 4.执行方法
// 接收参数
int id = 1;
User user = userMapper.selectById(id);
System.out.println(user);
// 5.释放资源
sqlSession.close();
}
}
2.添加数据
编写接口方法:
java
package com.itheima.mapper;
import com.itheima.pojo.User;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import java.util.List;
public interface UserMapper {
@Insert("insert into tb_user (username, password, gender, addr) " +
"values (#{username}, #{password}, #{gender}, #{addr})")
int add(User user);
}
编写测试方法:
java
package com.itheima.test;
import com.itheima.mapper.UserMapper;
import com.itheima.pojo.User;
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 MybatisTest {
@Test
public void test() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 4.执行方法
// 接收参数
String username = "诸葛亮";
String password = "234";
String gender = "男";
String addr = "成都";
// 封装对象
User user = new User();
user.setUsername(username);
user.setPassword(password);
user.setGender(gender);
user.setAddr(addr);
// 执行方法
int count = userMapper.add(user);
System.out.println(count);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}
3.修改数据
编写接口方法:
java
package com.itheima.mapper;
import com.itheima.pojo.User;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import java.util.List;
public interface UserMapper {
@Update("update tb_user " +
"set username = #{username}, password = #{password}, gender = #{gender}, addr = #{addr}" +
"where id = #{id};")
int update(User user);
}
编写测试方法:
java
package com.itheima.test;
import com.itheima.mapper.UserMapper;
import com.itheima.pojo.User;
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 MybatisTest {
@Test
public void test() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 4.执行方法
// 接收参数
int id = 1;
String username = "诸葛亮";
String password = "234";
String gender = "男";
String addr = "成都";
// 封装对象
User user = new User();
user.setId(id);
user.setUsername(username);
user.setPassword(password);
user.setGender(gender);
user.setAddr(addr);
// 执行方法
int count = userMapper.update(user);
System.out.println(count);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}
4.删除数据
编写接口方法:
java
package com.itheima.mapper;
import com.itheima.pojo.User;
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import java.util.List;
public interface UserMapper {
@Delete("delete from tb_user where id = #{id};")
void deleteById(int id);
}
编写测试方法:
java
package com.itheima.test;
import com.itheima.mapper.UserMapper;
import com.itheima.pojo.User;
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 MybatisTest {
@Test
public void test() throws IOException {
// 1.获取SqlSessionFactory
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 2.获取SqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
// 3.获取Mapper接口的代理对象
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
// 4.执行方法
// 接收参数
int id = 1;
// 执行方法
userMapper.deleteById(id);
// 提交事务
sqlSession.commit();
// 5.释放资源
sqlSession.close();
}
}