MyBatis是一个开源的持久层框架,用于处理数据库的增删改查操作。它能够将Java对象与数据库中的数据进行映射关系的配置,并自动生成对应的SQL语句,从而简化了数据库操作的编码工作。
MyBatis的核心思想是将SQL语句与Java代码分离,通过XML或注解来配置SQL语句,使得SQL语句可以进行灵活的管理和维护。通过MyBatis,开发人员可以使用面向对象的思维来进行数据库操作,而不需要直接编写繁琐的SQL语句。
ORM(Object Relational Mapping,对象关系映射)是一种数据持久化技术,它在对象模型和关系型数据库之间建立起对应关系,并且提供了一种机制,通过 JavaBean 对象去操作数据库表中的数据。
关于Maven的相关配置见之前的博客:Maven项目搭建
搭建MyBatis
1. 配置依赖项
在pom.xml文件中配置Mybatis依赖库和SQL链接库等
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.26</version>
</dependency>
2. 配置数据源
在resources文件夹下创建application.yml配置文件
yml基本语法
#注释用井号
名称跟冒号:
属性前面空两格: 值前面空一格
- 数组元素用短横线加空格
#配置mybatis的数据源 DataSource
spring:
datasource:
username: root
password: 123123
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/easydata
3.创建封装类
package com.easy.bean;
import java.math.BigDecimal;
public class Staff {
private int id;
private String code;
private String name;
private BigDecimal salary;
private String username;
private String userpass;
//这里省略getter和setter方法...
}
4.定义Mapper
在resources文件夹下创建一个mapper文件夹用于存放mapper的xml文件
在该目录下新建应该xml文件:
mapper 标签内指定连接的对应接口是 com.easy.dao.IStaffDao
标签之间写SQL语句,在 id 中指明调用的方法名,resultType 指定返回值类型小写
<?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.easy.dao.IStaffDao">
<!-- 在这里写SQL语句 -->
<select id="getNow" resultType="string">
select now()
</select>
</mapper>
5.配置Mapper文件路径和别名以及日志级别
在application.yml文件中配置以下内容:
#配置mapper的xml文件位置
mybatis:
mapper-locations: classpath:mapper/*.xml
#用于打印日志
logging:
level:
com.easy.dao: debug
6.定义数据访问层接口
在com.easy包下建一个dao包用于定义数据访问层的接口,接口用 @Mapper 注解
package com.easy.dao;
import org.apache.ibatis.annotations.Mapper;
import com.easy.bean.Staff;
@Mapper
public interface IStaffDao {
String getNow();
}
7.编写业务处理层(可以使用面向接口)
在controller包下编写控制类,使用 @RestController 注解,
类内用 @Autowired 注入接口,并在方法上使用 @GetMapping 等指定请求方式
@RestController
public class EasyController {
@Autowired
IStaffDao dao;
@GetMapping("now")
public String now() {
return dao.getNow();
}
}
浏览器测试输出:
参数传递
这里以通过姓名和编号查询staff员工表为例
mapper的对应xml文件中编写SQL语句:
<select id="getStaff" resultType="com.easy.bean.Staff">
select * from staff where name=#{name} and code=#{code}
</select>
1.使用注解传递参数
在接口中定义方法:
@Mapper
public interface IStaffDao {
List<Staff> getStaff(@Param("name")String name,@Param("code")String code);
}
控制类中编写 getStaff 方法:
@GetMapping("staff")
public List<Staff> getStaff(@RequestParam("name")String name,@RequestParam("code")String code) {
List<Staff> staffs = dao.getStaff(name, code);
return staffs;
}
2.使用Map传递参数
在接口中定义方法:
@Mapper
public interface IStaffDao {
List<Staff> getStaff(Map params);
}
控制类中编写 getStaff 方法:
@GetMapping("staff")
public List<Staff> getStaff(@RequestParam Map map) {
List<Staff> staffs = dao.getStaff(map);
return staffs;
}
3.使用JavaBean传递参数
在接口中定义方法:
@Mapper
public interface IStaffDao {
List<Staff> getStaff(Staff staff);
}
控制类中编写 getStaff 方法:
@GetMapping("staff")
public List<Staff> getStaff(Staff staff) {
List<Staff> staffs = dao.getStaff(staff);
return staffs;
}
区别:
- 使用 Map 传递参数会导致业务可读性的丧失,继而导致后续扩展和维护的困难,所以在实际应用中我们应该果断废弃该方式。
- 使用 @Param 注解传递参数会受到参数个数的影响。当 n≤5 时,它是最佳的传参方式,因为它更加直观;当 n>5 时,多个参数将给调用带来困难。
- 当参数个数大于 5 个时,建议使用 JavaBean 方式。
占位符#和$的区别
SQL语句分为两个过程:编译,执行。在MyBatis中,#
和$
是两种不同的占位符用法。
#
是预编译的占位符,使用#
时,MyBatis会对传入的参数进行预处理,类型解析之后,将参数的值安全地替换到SQL语句中。例如,使用#{param}
占位符时,MyBatis会将参数值作为字符串的形式传递给数据库,这样可以防止SQL注入攻击。
$
是直接替换的占位符,使用$
时,MyBatis会将占位符替换为参数的字符串值。例如,使用${param}
占位符时,MyBatis会直接将参数的值替换到SQL语句中,不进行预处理。这意味着,使用$
时需要注意安全性和潜在的SQL注入风险,因为参数值直接拼接到SQL语句中,可能会导致不安全的查询。
总结来说,#
符号用于预处理参数,提高安全性,而$
符号用于直接替换参数,更加灵活但需要注意安全性。在实际使用中,一般推荐使用#
符号,除非有特殊需求,需要动态拼接SQL语句时才使用$
符号。
注:SQL注入是一种常见的安全漏洞,指的是攻击者通过在应用程序中注入恶意的SQL代码,使得应用程序在处理SQL语句时执行了攻击者意图的代码。
当使用$占位符时,如替换的内容为 ' or '1'='1 直接替换会导致SQL语句执行了不符合本意的逻辑。
映射文件常用标签
1.select标签
为了使数据库的查询结果和返回值类型中的属性能够自动匹配,通常会对 MySQL 数据库和 JavaBean 采用同一套命名规则,即 Java 命名驼峰规则,这样就不需要再做映射了(数据库表字段名和属性名不一致时需要手动映射)。
常用属性
2.insert标签
MySQL、SQL Server 等数据库表可以采用自动递增的字段作为其主键,当向这样的数据库表插入数据时,即使不指定自增主键的值,数据库也会根据自增规则自动生成主键并插入到表中。
<insert id="addStaff">
insert into staff(code,name,salary,username,userpass)
value(#{code},#{name},#{salary},#{username},#{userpass})
</insert>
3.update标签
<update id="editStaff">
update staff set name=#{name},salary=#{salary},username=#{username},
userpass=#{userpass} where id=#{id}
</update>
4.delete标签
<delete id="delStaff">
delete from staff where id=#{id}
</delete>