Mybatis框架
前言
这篇是作者学习数据持久层框架Mybatis的学习笔记,希望对大家有所帮助,希望大家能够与作者交流讨论
Mybatis
Mybatis是一款优秀的持久层框架,用于简化JDBC的开发
Mybatis自2013年11月迁移到GitHub中,源码由GitHub管理
官网:https://mybatis.org/mybatis-3/zh/index.html
本片讲解的是基于SpringBoot整合Mybatis来进行讲解
Mybatis入门
- 使用Mybatis查询所有的用户数据
入门基础操作:
- 准备工作(创建springboot工程,数据库表user,实体类User)
- 引入Mybatis的相关依赖,配置Mybatis(数据库的连接信息)
- 编写SQL语句(注解/xml)
Mybatis通过java访问数据库服务器,将返回回来的数据封装到实体类当中
在引入Mybatis的相关依赖的时候需要连接数据库(知道自己要访问哪一个数据库),需要Mybatis数据库连接四要素:
标记数据库驱动的全类名
数据库连接的URL
用户名
密码
java
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis
spring.datasource.username=root
spring.datasource.password=
在进行数据库的SQL语句编写的时候需要注意定义一个数据层接口
java
@Mapper
public interface UserMapper{
@select("select * from user")
public List<User> list();
}
使用注解 @Mapper来定义数据层接口,通过注解定义SQL语句, @select表示是查询操作,其中写入查询语句,当要执行次查询语句的时候调用下方的list方法就可以,这时框架会自动的执行SQL语句,并将结果封装到方法的返回值当中
如何配置mybatis,与数据库建立连接
在resources中打开application.properties文件(sping自带的默认配置文件)
在其中将连接四要素配置进去
java
# 驱动类名称
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 数据库连接的URL
spring.datasource.url=jdbc:mysql://localhost:3306/ mybatistest
# 连接数据库的用户名
spring.datasource.username=root
# 连接数据库的密码
spring.datasource.password=
进行测试:
java
@Mapper //在运行时,会自动生成该接口的实现类对象(代理对象),并且该对象交由IOC容器管理
public interface UserMapper {
@Select("select * from user")
public List<User> list();
}
测试通过test文件下的测试类进行测试
测试类中的注解 @SpringBootTest表示springboot整合单元测试的注解
java
@SpringBootTest
class MybatisTestApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
List<User> list = userMapper.list();
list.stream().forEach(user -> {
System.out.println(user);
});
}
}
前面所说的UserMapper接口由IOC代理,所以使用依赖注入的方式在测试类中创建对象,通过stream流的方式将数据进行遍历
最后运行测试,由于此单元测试是spring整合的单元测试,在运行的时候会自动的加载整个spring环境,创建spring的IOC容器
配置SQL提示
默认在mybatis中编写SQL语句是不识别的,可以通过配置进行识别:
将sql语句全选右键选择
再次进行选择
选择Mysql(sql)
这个时候再次输入SQL语句就会有响应的提示,但是在输入表名的时候没有进行提示,这是因为:idea和数据库没有建立连接,不识别表信息
- 解决方式
在idea中配置MySQL数据库连接
配置idea连接MySQL数据库
注意:配置完成后没有表的刷新一下就行了
JDBC
就是使用java语言操作关系型数据库的一套API
什么是驱动:
java提供一个可供操作的接口JDBC各个数据库厂商通过实现实现接口将自己的数据库操作引入到java中,提供数据库驱动jar包,这个实现的过程就称为数据库的驱动,我们通过使用这套接口(JDBC)编程,真正执行的代码是驱动jar包中的实现类
- 原始的JDBC操作数据库
java
@Test
public void jdbctest() throws Exception{
//注册驱动
Class.forName("com.mysql.cj.jdbc.Driver");
//获取连接对象
String url="jdbc:mysql://localhost:3306/mybatistest";
String username="root";
String password="";
Connection connection= DriverManager.getConnection(url,username,password);
//获取执行sql的对象statement,执行SQL,返回结果
String sql="select * from user";
//通过connection创建一个statement对象用来将sql语句与数据库联系执行
Statement statement = connection.createStatement();
//通过执行查询语句返回一个ResultSet结果集,用来封装得到的数据
ResultSet resultSet=statement.executeQuery(sql);
//解析并封装结果数据(需要一个一个字段的继续宁解析)
List<User> list=new ArrayList<>();
while (resultSet.next())
{
//在解析的时候需要一个字段一个字段进行解析
int id=resultSet.getInt("id");
String name=resultSet.getString("name");
int age=resultSet.getInt("age");
int gender=resultSet.getInt("gender");
String phone=resultSet.getString("phone");
User user=new User(id,name,age,gender,phone);
list.add(user);
}
//释放资源
statement.close();
connection.close();
}
在JDBC原始代码中进行数据库的连接与最后释放资源都是非常繁琐且损耗效率的。
数据库连接池
数据库连接池是一个容器,负责分配,管理数据库连接(Connetion)
它允许应用程序重复使用一个现有的数据库连接,而不是重新建立一个
释放空间时间超过最大空闲时间的连接,来避免因为没有释放连接而引起的数据库连接遗漏
数据库连接池的优势:
资源重用,提示系统响应速度,避免数据库连接遗漏
数据库连接池:
由官方提供一个标准接口:DataSource,所有的数据库连接池都必须实现DataSource
官方提供的数据库连接池接口,由第三方实现此接口
现在项目中使用的最多的连接池:Druid,Hikari(springboot默认)
-
Druid(德鲁伊)
是阿里巴巴开源的数据库连接池项目,功能强大,性能优秀,是java语言最好的数据库连接池之一
-
如何切换连接池
- 首先引进Druid的依赖
java
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.2.8</version>
- 第二步
同上述一样通过连接四要素进行数据库连接
java
# 驱动类名称
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 数据库连接的URL
spring.datasource.url=jdbc:mysql://localhost:3306/ mybatistest
# 连接数据库的用户名
spring.datasource.username=root
# 连接数据库的密码
spring.datasource.password=
或者
java
# 驱动类名称
spring.datasource.druid.driver-class-name=com.mysql.cj.jdbc.Driver
# 数据库连接的URL
spring.datasource.druid.url=jdbc:mysql://localhost:3306/ mybatistest
# 连接数据库的用户名
spring.datasource.druid.username=root
# 连接数据库的密码
spring.datasource.druid.password=
lombok
Lombok是一个实用的的java类库,能够通过注解的形式自动生成构造器,getter/setter,equals,hascode,toString等方法,并可以自动化生成日志变量,简化java开发,提高效率
首先在pom.xml中提供lombok的依赖
java
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
注意:这里不需要版本号,因为在父工程依赖中已经集成lombok并对其版本进行管理
java
/*@Getter
@Setter
@ToString
@EqualsAndHashCode*/ //这四个注解集成到一个注解当中
@Data
@NoArgsConstructor //无参构造注解
@AllArgsConstructor //全参构造注解
public class User {
private Integer id;
private String name;
private Integer age;
private Integer gender;
private String phone;
}
Mybatis基础操作
- 删除
根据主键传回来的id进行删除
此处用到mybatis提供的参数占位符 #{}
java
@Mapper
public interface EmpMapper {
@Delete("delete from emp where id=#{id}}")
public void delete(Integer id);
}
在测试类中进行测试
java
@SpringBootTest
class Projecttest1ApplicationTests {
@Autowired
private EmpMapper empMapper;
@Test
void contextLoads() {
empMapper.delete(2);
}
}
注意:如果Mapper接口方法形参只有一个普通类型的参数,#{...}里面的属性名可以随便写,如#{id},#{value}
- 新增
java
@Insert("insert into user (username,name,gender,image,job,entrydate,dept_id,create_time,update_time) values(#{username},#{name},#{gender},#{image},#{job},#{entrydate},#{deptId},#{createTime},#{updateTime})")
public void insert(Emp emp);
主键返回功能:
在数据添加成功后,需要获取插入数据库数据的关键
需要注解 @options(keyProperty='id',useGeneratedKeys=true) (第一个参数表示获取的主键封装到哪个属性,第二个参数表示我们要返回主键值) //注解会自动生成主键值,赋值给emp对象的id属性值
- 更新
java
//更新数据
@Update("update emp set username=#{username} ... where id=#{id}")
public void update(Emp emp);
- 查询(条件查询)
举例一个条件,根据输入的姓名,性别,入职时间,搜索满足条件的员工信息,其中姓名支持模糊匹配,对应的sql语句是
sql
select * from emp where name like '%张%' and gender=1 and entrydate between '' and '' order by update_time desc;
对应的操作:
java
//条件查询员工信息
@Select("select * from emp where name like '%#{name}%' "+
"and gender=#{gender} and entrydate between #{begin} and #{end} order by update_time desc")
public List<Emp> list(String name, Short gender, LocalDate begin,LocalDate end);
}
注意 : #{} 不能出现在引号当中,需要把此处的#换成$
但是这样就出现了性能低,不安全,存在SQL注入的问题,所以我们还可以使用mysql提供的字符串拼接函数concat
上述就可以修改为
sql
concat('%',#{name},'%')
- 数据封装
实体类属性名和数据库表查询返回的字段名一致,mybatis会自动进行封装
如果实体类属性名和数据库表查询返回的字段名不一致,不能自动封装
如何解决?
方法一:给字段起别名,让别名与实体类属性一致
方法二:通过 @Results,@Result 注解手动映射封装
java
@Results({@Result(column="",property="")}) //Results就是一个一个的Result注解,注解中定义映射,前一个参数时表中的字段名,后一个参数表示需要映射到的属性名
(推荐使用)方法三:开启mybatis的驼峰命名自动映射开关(下划线会自动封装到对应的驼峰命名的属性)
需要在spring配置文件中进行配置
mybatis.configuration.map-underscore-to-camel-case=true
日志输出
虽然我们使用mybatis进行数据操作,但是我们并不知道mybatis底层是如何执行操作的,我们可以在spring配置文件中打开mybatis的日志,并指定输出到控制台
配置信息:
mybatis.configuration.log-impl=org.apache.lbatis.logging.stdout.StdOutImpl
意思是要往控制台传输日志
输出结果如下:
此处是SQL预编译,在运行的时候系统将两条消息一起发送给数据库
为什么这样做:预编译SQL性能更高,更安全(防止SQL注入)
为什么性能更高:
java中sql语句执行的流程:
java将sql语句传入数据库中,首先通过前三个内容,处理完后语句停留在缓存当中,当再次遇上相同语句的时候,将不需要前面的步骤,可以直接执行,但是如果没有预编译直接传入带有id的语句,可能每次都碰不到相同的语句,但是通过预编译采用参数占位符,这样同种语句会更方便识别,效率更高
为什么更加安全:
- SQL注入
SQL注入是通过操作输入的数据来修改事先定义好的SQL语句,以达到执行代码对服务器进行攻击的方法
进行SQL注入的演示:
在一个用户登录的界面,登录进入后台需要填写用户名和密码
当我们在密码栏中写入:
java
' or '1' = '1'
时发现登录成功,实际上用户的登录就是将输入的用户名和密码在数据库中进行查找,当查询到有相同数据便是登陆成功,但是输入上述数据后,查询操作就会变为:
sql
select count(*) from emp where username='' and password='' or '1'='1';
这样查询操作永远为真,就会修改查询操作,这就是SQL注入
在mybatis开发中使用#{}下来就是预编译语句,#{}最终会被?替代掉
还存在另外一种${},这是直接将参数拼接在sql语句后,存在sql注入问题
XML映射文件
- 规范
- XML映射文件的名称与Mapper接口名称一致,并且将XML映射文件和Mapper接口放置在相同包下(同包同名)
- XML映射文件的namespace属性为Mapper接口全限定名一致
- XML映射文件中sql语句的id与Mapper接口中的方法名一致,并保持返回类型一致
- 配置XML映射文件
首先根据规范配置xml文件,在xml中配置sql语句:
在mybatis中文网中找到xml的配置信息复制到xml文件当中
java
<?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.example.projecttest1.mapper.EmpMapper">
<!--resultType :单条记录所封装的类型-->
<select id="list" resultType="com.example.projecttest1.pojo.Emp">
select * from emp where name like '%#{name}%'and gender=#{gender} and entrydate between #{begin} and #{end} order by update_time desc
</select>
</mapper>
使用注解来映射简单语句会使代码显得更加简洁,但对于稍微复杂一点的语句,Java 注解不仅力不从心,还会让你本就复杂的 SQL 语句更加混乱不堪。 因此,如果你需要做一些很复杂的操作,最好用 XML 来映射语句。
- MybatisX
MybatisX是一款基于idea的快速开发Mybatis的插件,为效率而生
可以通过点击前面的标识快速的实现他们之间的互相定位
Mybatis的动态SQL
随着用户的输入或外部条件的变化而变化的SQL语句,我们称为动态SQL
通俗的来说,就好比我需要三个条件进行查询,我只前将三个条件固定写入sql,如果后期我只通过两个条件进行查询另一个就是null,这样就查不到数据
我们可以通过if标签进行有条件的拼接:
<if>
进行有条件的sql语句拼接<where>
会自动去除拼接后多余的and<set>
使用set标签将更新字段进行包裹,动态的在首行创建set标签,可以去除多余的特殊字符
<foreach>
属性:
collection:要遍历的集合
item:遍历出来的元素
separator:分隔符
open:遍历开始前拼接的sql片段
close:遍历结束之后拼接的sql片段
<sql>
和<include>
标签
当程序中sql语句出现大量重复的时候,为了提高程序的可复用性,我们可以采取sql和include标签将重复的sql语句进行抽取和复用
通过<sql>
进行抽取,在sql属性id给定一个唯一的id值
例如:
sql
<sql id="commonSelect">
select ....
</sql>
然后通过<include>
标签进行复用,在需要sql语句的地方:
sql
<include refid="commonSelect"/>