mybatis学习记录
1.mybatis是什么
mybatis是一款优秀的持久层框架,它支持定制化sql,存储过程以及高级映射的功能,mybatis几乎避免所有jdbc原生代码复杂的操作和手动获取参数以及对结果集的封装,。mybatis中可以使用简单xml或注解来配置与描述对象映射关系,将java实体类对象映射成数据库中的优势。
2.mybatis有哪些优势
- 简单易学:mybatis本身就很轻巧且简单,没有任何第三方的依赖,最简单的安装只需要两个jar文件+配置几个sql文件。易于学习,易于使用,通过文档和源代码,可以比较完全的掌握它的设计思路和实现。
- 灵活:mybatis不会对程序或者数据库的现有设计强加任何影响。sql写入xml文件里,便于统一管理与优化,通过sql基本上可以实现任何对数据库操作的需求。
- 接触了sql于程序代码的耦合:通过提供DAO层,将业务逻辑与数据访问逻辑分离,使系统的设计更加清晰,更易维护,更易单元测试,sql与代码的分离,提高了可维护性。
- 提供映射标签:支持对象与数据库的字段关系映射。
- 提供对象关系映射标签:支持对象关系组建维护。
- 提供xml标签:提供xml标签来编写动态sql。
3.mybatis有哪些缺点
- 编写sql时工作量很大,尤其是字段多,关联多表时,更是如此。
- sql语句依赖与数据库,导致sql语句的可移植性变差,更换数据库时,需要做更多的工作。
- 二级缓存机制不佳。
4.mybatis框架搭建(下载jar包等前置工作不赘述)
1.创建配置文件
在src目录下创建mybatis-config.xml文件,该文件时mybatis的核心配置文件,用户配置数据库连接信息以及mybatis的一些属性设置。
<configuration>
<environments default="default">
<environment id="default">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/bank?serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
标签作用:
configuration:根标签
environments:配置数据库连接环境,default属性标识该默认使用的环境,在mybatis中可以配置多套环境用于切换
environment:数据库连接环境配置,id表示该环境的名称,在environments的default属性中可以使用id指定当前环境
transactionManager:事务管理模式标签,这里使用的是JDBC事务
dataSource:数据源,type属性中POOLED表示使用mybatis自身的连接池数据源
property:配置连接源的各项属性信息
2.创建session工厂
public class SessionFactory {
private static SqlSessionFactory sqlSessionFactory;
static {
String resource = "config.xml";
try {
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactoryBuilder factoryBuilder = new SqlSessionFactoryBuilder();
sqlSessionFactory = factoryBuilder.build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession getSqlSession() {
return sqlSessionFactory.openSession();
}
}
创建连接工厂便于我们获取连接进行操作,下面我们测试一下连接是否获取正常
SqlSession sqlSession = SessionFactory.getSqlSession();
System.out.println(sqlSession.getConnection());
[图片上传失败...(image-60aced-1590670310779)]
可以看到,我们已经在控制台输出了连接信息,执行到这一步,已经成功获取到连接了
3.通过mapper代理实现自定义接口
mybatis在设计时采用动态代理模式,我们在使用mybatis进行增删改查时,只需要提供数据层接口以及对应该接口的xml映射文件,映射文件中要针对数据层接口的每一个方法提供对应的sql数据,参数类型,以及返回值类型,最终mybatis会创建动态代理对象实现数据层接口,而动态代理中的方法会执行映射文件中对应的sql语句。
下面我们写一个查询来了解一下mapper代理的是怎样实现的
mapper(数据层接口)
public interface UserMapper {
public User selectById(int id);
}
mapper.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">
<mapper namespace="com.woniuxy.mapper.UserMapper">
<select id="selectById" parameterType="int" resultType="com.woniuxy.entity.User">
select <include refid="columns"></include> from users where id=#{id}
</select>
</mapper>
在进行xml文件书写时需要遵守以下几点规则
- 映射文件的根标签mapper的namespace属性必须等于数据层接口的全限定名
- 映射文件中的id必须等于接口方法的名称
在数据层接口映射文件中同样要引入DTD文件作为验证标准,现简单介绍一下几个常用的标签
- mapper:根标签,那么namespace属性必须于该映射文件对应的接口的全限定名一致
- delete-select-insert-update:这四种标签对应了数据操作中的增删改查,其id必须与要对应的数据层接口的方法名一致,resultType表示mybatis在遍历结果集时要封装的实体类类型,parameterType,表示该方法的参数类型,标签之间的内容用于sql语句的书写以及一些其他的标签(如上述代码中的引用标签或动态sql诸如此类等等)。
- select:查询标签
- insert:新增标签
- update:更新标签
- delete:删除标签
- 并不是说新增数据的sql就一定要写在insert标签中,但是每一种不同的标签,执行sql的过程会有所差异,中间执行的功能也不一致。例如:select标签开启了事务的自动提交,除此之外的增删改都没有开启自动提交。insert、update、delete标签执行完毕会自动返回受影响行数、insert还具备返回主键的功能。所以以后在开发过程中尽量使用对应的标签完成对应的操作。
注册mapper.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>
<settings>
<setting name="logImpl" value="STDOUT_LOGGING" />
</settings>
<typeAliases>
<package name="com.woniuxy.entity"/>
</typeAliases>
<environments default="default">
<environment id="default">
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/bank?serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<package name="com.woniuxy"/>
<!-- <mapper resource="com/woniuxy/mapper/UserMapper.xml"></mapper>
<mapper class="com.woniuxy.mapper.UserMapper"></mapper>-->
</mappers>
</configuration>
注册mapper.xml映射文件使用mappers标签,有三种方式,在上述中xml片段中已经列出(注释掉的是另外两种方式)
测试
public class test {
public static void main(String[] args) {
SqlSession sqlSession = SessionFactory.getSqlSession();
System.out.println(sqlSession.getConnection());
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.selectById(27); //byid查询
System.out.println(user);
}
}
[图片上传失败...(image-356b24-1590670310779)]
这里我们需要先得到sqlsession对象,通过sqlsession对象再得到我们需要的数据层接口的代理类,这里我们用接口的class对象作为参数,直接调用getMapper方法就可以得到代理对象,由代理对象直接调用方法,就可以实现数据操作了。
5.使用mybaits实现增删改查操作
- Mapper接口开发需要遵循以下规范:
- Mapper.xml文件中的namespace与mapper接口的类路径相同。
- Mapper接口方法名和Mapper.xml中定义的每个增删改查标签的id相同
- Mapper接口方法的参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
- Mapper接口方法的返回值类型和mapper.xml中定义的每个sql的resultType的类型相同
- 在执行某些数据库操作时,在sql语句中需要动态的赋予参数,参数的来源是数据层接口中方法的参数,在映射文件中使用这些参数有两种写法#{}和${}:
- #{}表示一个占位符号,通过#{}可以实现preparedStatement向占位符中设置值,自动进行java类型和jdbc类型转换,#{}可以有效防止sql注入。 #{}可以接收简单类型值或pojo属性值。如果parameterType传输单个简单类型值,#{}括号中可以是value或其它名称。
- {}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换,{}括号中只能是value。
- 基本上能使用#{}就不要使用{}来拼接的时候。例如:语句是
- select * from 因为一旦使用#,语句会变成select * from ‘student’。
- 如果传入的参数是实体类的对象,那么可以使用${实体类的属性名称}或者#{实体类的属性名称}都可以使用参数完成sql的入参。
- 如果传入的参数是一个基本数据类型,你可以使用#{}括号内任意的名称来获取该参数并完成入参,也可以使用${}括号内填充_parameter来入参
- 如果需要传入多个参数,并且这多个参数无法封装为一个对象的时候。我们可以将所有的数据封装为一个键值对。同时将方法的参数也定义为键值对类型。你可以使用#{}或${},括号内使用键值对的键获取数据入参。
6.映射文件的配置
1.新增数据时获取主键值
在某些业务场景中,我们需要用到新增的这一行的主键数据,例如我新增了订单,我需要获取订单的主键,对订单详情中的订单外键进行赋值,这样我们就可以使用配置的方式来获取到主键的值。
<insert id="insert" parameterType="user" useGeneratedKeys="true" keyProperty="id" >
insert into users values(null,#{password},#{account})
</insert>
- useGeneratedKeys设置为true表示当前数据库使用自增长的方式生成主键值,在操作完毕以后会使用该自增长的值
- keyProperty则表示在新增完毕以后生成的主键值保存在参数的那个属性中,比如说id属性
- 最后执行新增以后就可以从新增的用户对象中取出id的值
2.使用mybatis的日志打印输出sql语句的执行过程
在开发中,可以使用这个打印功能,我们可以更加清晰的看到sql语句最终是什么样的,参数如何赋入的,使用这个功能,需要在核心配置文件中添加这一句标签
<settings>
<setting name="logImpl" value="STDOUT_LOGGING" />
</settings>
3.在mybatis核心配置文件中指定类型的别名
在映射文件中的标签中经常需要用到类型的名称,例如parameterType 和resultType,虽然直接写类型的全限定名称完全可以,但是类的限定名称往往特别复杂,写起来非常麻烦,mybatis同时还支持以别名的方式来定义参数类型或者返回值类型。对于java中的常见类型mybatis已经为其提供了对应的别名,见下图:
如果想为项目中的自定义实体类型定义别名就需要在mybatis的核心配置文件的根标签中使用typeAliases标签。
<typeAliases>
<!--定义单个类型的别名-->
<typeAlias type="com.woniuxy.entity.User" alias="User"></typeAlias>
<!--批量定义别名:将自动以该包中的所有类的类名作为别名,不区分大小写-->
<package name="com.woniuxy.entity"/>
</typeAliases>
在核心配置文件中注意标签的书写位置:
properties,settings,typeAliases,typeHandlers,objectFactory,objectWrapperFactory,reflectorFactory,plugins,environments,databaseIdProvider,mappers
4.使用sql标签定义可重用的sql片段
使用sql标签来定义可重用的sql语句片段,可以在需要使用的时候使用include标签来引入定义好的sql语句,下面来做个示范
<sql id="columns">id,account,password</sql>
定义sql标签
<select id="selectById" parameterType="int" resultType="user">
select <include refid="columns"></include> from users where id=#{id}
</select>
使用include标签引入sql语句
5.使用foreach标签多行新增数据
某些数据库是支持多行新增的,例如mysql,mysql中多行新增的语法是:
insert into 表 values(第一行的数据),(第二行的数据),....以此类推
根据语法结构我们不难发现,要实现多行新增需要在values后重复书写每一行的数据内容,mybatis提供了foreach标签可以在执行新增时根据参数,循环拼接sql语句,以此我们可以实现多行新增。
多行新增的参数应该定义为集合类型
public int batchInsert(List<User> users);
映射文件中的标签写法:
<insert id="batchInsert" parameterType="list">
insert into users values
<foreach collection="list" item="user" separator=",">
(null,#{user.password},#{user.account})
</foreach>
</insert>
foreach标签属性说明:
- collection:需要遍历的集合类型,必须写作list或者collection,如果参数是set集合,则必须写作collection
- item:foeach进行循环时的局部变量,可以使用该变量获取每一个对象的属性,通过对象.属性获取
- separator:分隔符,每循环一次在末尾自动添加(除最后一次循环)
6.动态sql语句编写
动态sql主要用于动态的添加查询条件,或者动态的修改某个数据,动态添加查询条件可以使用if标签和where标签
<select id="select" parameType="user">
select <include refid="columns"></include> from users
<where>
<if test="account!=null and account!=''">
and account=#{account}
</if>
</where>
</select>
where 标签只会在至少有一个子元素的条件返回 SQL 子句的情况下才去插入“WHERE”子句。而且,若语句的开头为“AND”或“OR”,where 标签也会将它们去除。
if标签不止用在此处,在编写sql时可以单独灵活的使用
动态的修改数据可以使用set+if标签:
<update id="update" parameterType="user" >
update users
<set>
<if test="account!=null and account!=''">
account=#{account},
</if>
<if test="password!=null and password!=''">
password=#{password},
</if>
</set>
where id=#{id}
</update>
set和where的原理类似,用于动态生成更新语句中的字段列表,set中嵌套if标签,if标签中书写更新字段在最后加上一个","号,mybatis会自动去掉最后一个更新字段的逗号
7.手动的结果集映射
1.单表的结果集映射
mybatis在执行查询时,首先会使用我们提供的sql语句和参数查询出结果集,然后再将结果集的数据封装成我们想要的实体类对象。那么将结果集的数据封装成实体类对象的过程中,mybatis必须知道字段名和属性名之间的对应关系,mybatis会默认的将数据保存在和实体类属性名相同的属性中,在使用mybaits时,推荐将实体类的属性名与数据库的字段名保持一致,这样可以省去我们映射关系的这一步操作,但是在属性名和字段名不一致时,mybatis也提供了解决方案,我们这时就需要使用resultMap标签来实现手动的结果集映射。
<resultMap id="userMap" type="User">
<id property="id" column="id"></id>
<result column="account" property="account"></result>
<result column="password" property="password"></result>
</resultMap>
标签以及属性说明:
- <resultMap id="userMap" type="User">:id属性表示映射关系的id,在查询时使用该id完成结果集映射,type表示要对应映射的实体类类型,这里使用的是前面定义的别名。
- <id property="id" column="id"></id>:mybatis对于特殊的主键提供了id标签,主键的映射需要使用该标签
- <result column="password" property="password"></result>:对于其他字段的映射标签:column属性表示其在数据库中的列明,property表示其在实体类中的属性名
2.一对一结果集映射
一对一关联查询的结果封装有两种形式,一种直接以map<string,boject>键值对的方式直接响应,这种方式只需将resultType的值定义为map即可。
第二种方式是通过实体类封装来完成,例如我有一个存款信息,我查询存款信息时希望将所有的账户也查询出来。
<resultMap id="recordMap" type="Record">
<id column="id" property="id"></id>
<result column="amount" property="amount"></result>
<result property="datetime" column="time"></result>
<result property="type" column="type"></result>
<association property="user" javaType="User">
<id column="uid" property="id"></id>
<result property="password" column="password"></result>
<result property="account" column="account"></result>
</association>
</resultMap>
<select id="getRecordByAll" resultMap="recordMap">
select r.*,u.id as uid,u.password,u.account
from record as r,users as u
where u.id=r.user_id
</select>
RecordMapper mapper = sqlSession.getMapper(RecordMapper.class);
List<Record> recordByAll = mapper.getRecordByAll();
recordByAll.forEach(e->{
System.out.println(e);
});
[图片上传失败...(image-1b449e-1590670310779)]
首先我需要在record类里定义一个user对象才可以进行映射,association标签用于自定user对象,porperty属性书写对象在封装类中的属性名,javaType中则写其对应类型(这里写的上面定义的别名)
3.一对多结果集映射
一对多结果映射,例如我要查找每个用户的所有订单,我希望它的数据结构时这个样子的:
[图片上传失败...(image-2be592-1590670310779)]
这种情况下,一对多映射就发挥效果了,我们来看看它的代码要如何书写
<resultMap id="userMap" type="User">
<id property="id" column="uid"></id>
<result column="account" property="account"></result>
<result column="password" property="password"></result>
<collection property="record" ofType="Record">
<id column="id" property="id"></id>
<result property="type" column="type"></result>
<result property="datetime" column="time"></result>
<result property="amount" column="amount"></result>
</collection>
</resultMap>
<select id="selectByAll" resultMap="userMap">
select r.*,u.id as uid,u.password,u.account
from record as r,users as u
where u.id=r.user_id
</select>
List<User> users = mapper.selectByAll(); // 查询所有的
users.forEach(e->{
System.out.println(e);
});
[图片上传失败...(image-79d7de-1590670310779)]
首先我需要在user类里定义一个list<record>集合才可以进行映射,collection标签用于自定records对象,porperty属性书写对象在封装类中的属性名,ofType中则写其集合对应的泛型