MyBatis
Mybatis
环境:
- JDK1.8
- MySql5.7
- maven3.6.1
- IDEA
用到知识点:
- JDBC
- Mysql
- java基础
- Maven
- Junit
框架:配置文件。最好的学习方式:看官网文档;
1、简介
1.1 什么是Mybatis?
- MyBatis 是一款优秀的持久层框架。
- 它支持自定义 SQL、存储过程以及高级映射。
- MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。
- MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO(Plain Old Java Objects,普通老式 Java 对象)为数据库中的记录。
- MyBatis本是apache的一个开源项目iBatis,2010年这个项目由apache software foundation迁移到了google code,并且改名为MyBatis。
- 2013年11月迁移到Github。
1.2、如何获得Mybatis
maven仓库
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
Github: https://github.com/mybatis/mybatis-3/releases
中文文档:https://mybatis.org/mybatis-3/zh/index.html
1.3、持久化
数据持久化
- 持久化就是将程序的数据在持久状态和瞬时状态转化的过程
- 内存:断电即失
- 数据库(jdbc),io文件持久化。
- 生活中例子:冷藏食品。
为会需要持久化?
- 有一些对象,不能让他丢掉。
- 内存太贵了
1.4、持久层
Dao层,Service层,Controller层....
- 完成持久化工作的代码块
- 层界限十分明显。
1.5、为什么需要Mybatis?
- 帮助程序员将数据存入数据库中。
- 方便
- 传统的JDBC代码太复杂了。简化成框架,实现自动化。
- 不用Mybatis也可以。用了更容易上手。技术没有高低之分
- 优点:
- 简单易学。
- 灵活
- sql和代码的分离,提高了可维护性。
- 提供映射标签,支持对象与数据库的orm字段关系映射。
- 提供对象关系映射标签,支持对象关系组建维护。
- 提供xml标签,支持编写动态sql。
最重要的一点:使用的人多!
2、第一个Mybatis程序
思路:搭建环境-->导入Mybatis-->编写代码-->测试!
2.1、搭建环境
创建数据库:
CREATE DATABASE `mybatis`;
USE `mybatis`;
CREATE TABLE `user`(
`id` INT(20) NOT NULL PRIMARY KEY,
`name` VARCHAR(30) DEFAULT NULL,
`pwd` VARCHAR(30) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `user`(`id`,`name`,`pwd`) VALUES
(1,'狂神','123456'),
(2,'张三','123456'),
(3,'李四','142398');
新建项目:
1.新建一个普通的maven项目
2.删除src目录
3.导入maven依赖
<dependencies>
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!--mybatis-->
<!-- https://mvnrepository.com/artifact/org.mybatis/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>
<scope>test</scope>
</dependency>
</dependencies>
2.2、创建一个模块
- 编写mybatis配置文件
<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=true&useUnicode=true&charracterEncoding=UTF-8"/>
<property name="username" value="root"/>
<property name="password" value="PB838707@pcspcj"/>
</dataSource>
</environment>
</environments>
</configuration>
- 编写mybatis工具类
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 的实例。
//org.apache.ibatis.session.SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
2.3、编写代码
- 实体类
public class User {
private int id;
private String name;
private String pwd;
public User() {
}
public User(int id, String name, String pwd) {
this.id = id;
this.name = name;
this.pwd = pwd;
}
public int getId() {
return id;
}
public String getName() {
return name;
}
public String getPwd() {
return pwd;
}
public void setId(int id) {
this.id = id;
}
public void setName(String name) {
this.name = name;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
- Dao接口
public interface UserDao {
List<User> getUserList();
}
- 接口实现类由原来的UserDaoImpl转变为一个 Mapper配置文件
<?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 绑定一个对应的Dao/Mapper接口 -->
<mapper namespace="com.kuang.dao.UserDao">
<!-- select 查询语句-->
<select id="getUserList" resultType="com.kuang.pojo.User" >
select * from mybatis.user;
</select>
</mapper>
2.4、测试
注意点:
org.apache.ibatis.binding.BindingException:Type interface com.kuang.dao.UserDao is not known to the
MapperRegistry.
MapperRegistry是什么?
mybatis核心配置文件中,配置mappers
<mappers>
<mapper resource="com/kuang/dao/UserMapper.xml"></mapper>
</mappers>
- junit测试
public class UserDaoTest {
@Test
public void test(){
//第一步:获得sqlSession对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
//方式一:执行SQL
UserDao userDao = sqlSession.getMapper(UserDao.class);
List<User> userList = userDao.getUserList();
for (User user : userList) {
System.out.println(user);
}
//关闭sqlSession
sqlSession.close();
}
}
可能会遇到的问题:
-
配置文件没有注册:在mybatis.xml文件中增加配置mappers
-
绑定接口错误
-
方法名不对
-
返回类型不对
-
Maven导出资源问题:在pom.xml文件增加配置资源导出
<!-- 在build中配置resource,来防止我们资源导出失败的问题 -->
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
3、CRUD
3.1、namespace
namespace中的包名要和 Dao/mapper 接口的包名一致!
3.2、select
选择,查询语句;
- id:就是对应的namespace中的方法名;
- resultTyep:Sql语句执行的返回值!
- parameterType:参数类型
1.编写接口
//根据id查询用户
User getUserById(int id);
2.编写对应的Mapper中的sql语句
<!-- select 根据id查询用户-->
<select id="getUserById" resultType="com.kuang.pojo.User" parameterType="int">
select * from mybatis.user where id = #{id};
</select>
3.测试
@Test
public void getUserById(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.getUserById(3);
System.out.println(user);
sqlSession.close();
}
3.3、insert
<!-- insert一个用户 对象中的属性可以直接取出来-->
<insert id="addUser" parameterType="com.kuang.pojo.User">
insert into mybatis.user(id,name,pwd) values (#{id}, #{name}, #{pwd});
</insert>
3.4、update
<!-- 修改用户 -->
<update id="updateUser" parameterType="com.kuang.pojo.User">
update mybatis.user set name=#{name},pwd=#{pwd} where id=#{id};
</update>
3.5、delete
<!-- 删除一个用户 -->
<delete id="deleteUser" parameterType="int">
delete from mybatis.user where id = #{id};
</delete>
注意点:增删改需要提交事务。
3.6、万能的Map
假设,我们的实体类,或者数据库中的表,字段或者参数过多,我们应当考虑使用Map!
//万能的map
int addUser2(Map<String,Object> map);
<!-- insert一个用户 传递map的key-->
<insert id="addUser2" parameterType="map">
insert into mybatis.user(id,name,pwd) values (#{userId}, #{userName}, #{password});
</insert>
@Test
public void addUser2(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
Map<String, Object> map = new HashMap<String, Object>();
map.put("userId",5);
map.put("userName", "东友");
map.put("password", "222333");
userMapper.addUser2(map);
sqlSession.commit();
sqlSession.close();
}
Map传递参数,直接在sql中取出key即可。【parameterType="map"】
对象传递参数,直接在sql中取对象的属性即可。【parameterType="com.kuang.pojo.User"】
只有一个基本类型参数的情况,可以直接在sql中取到,可以省略不写。【parameterType="int"】
多个参数用Map,或者注解。
3.7、思考题
模糊查询怎么写?
- Java代码执行的时候,传递通配符 % %
List<User> userList = mapper.getUserLike("李");
- 在sql拼接中使用通配符
select * from mybatis.user where name like "%"#{value}"%";
4、配置解析
4.1、核心配置文件
- mybatis-config.xml
- Mybatis的配置文件包含了深深影响Mybatis行为的设置和属性信息。
- configuration(配置)
- properties(属性)
- settings(设置)
- typeAliases(类型别名)
- typeHandlers(类型处理器)
- objectFactory(对象工厂)
- plugins(插件)
- environments(环境配置)
- environment(环境变量)
- transactionManager(事务管理器)
- dataSource(数据源)
- databaseIdProvider(数据库厂商标识)
- mappers(映射器)
- configuration(配置)
4.2、环境配置(environments)
MyBatis 可以配置成适应多种环境
不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
学会配置多套运行环境!
Mybatis默认的事务管理器就是JDBC,连接池:POOLED
4.3`、属性(properties)
我们可以通过properties属性来实现引用配置文件 。
这些属性可以在外部进行配置,并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置。【db.properties】
编写一个配置文件
db.properties
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
username=root
passwrod=PB838707@pcspcj
在核心配置文件中引入
<!-- 引入外部配置文件 -->
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="password" value="1111111"/>
</properties>
- 可以直接引入外部文件
- 可以在其中增加一些属性配置
- 如果两个文件有同一个字段,优先使用外部文件的。
4.4、类型别名(typeAliases)
- 类型别名可为 Java 类型设置一个缩写名字。
- 意在降低冗余的全限定类名书写。
<!-- 可以给实体类设置别名 -->
<typeAliases>
<typeAlias type="com.kuang.pojo.User" alias="User"/>
</typeAliases>
也可以指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean,比如:
扫描实体类的包,它的默认别名就为这个类的类名,首字母小写!
<typeAliases>
<package name="com.kuang.pojo"/>
</typeAliases>
在实体类比较少的时候,使用第一种方式。
如果实体类十分多,建议使用第二种。
第一种可以IDY别名,第二种则不行。如果非要改,要在实体类上增加注解。
@Alias("hello")
public class User {}
4.5、设置(settings)
这是 Mybatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。
4.6、其他设置
- typeHandlers(类型处理器)
- objectFactory(对象工厂)
- plugins(插件)
- MyBatis Generator Core
- MyBatis-Plus
- 通用Mapper
4.7、映射器(mapper)
MapperRegistry:注册绑定我们的 Mapper 文件;
方式一:【推荐使用】
<!-- 每一个Mapper.xml配置文件都需要在mybatis核心配置文件中注册 -->
<mappers>
<mapper resource="com/kuang/dao/UserMapper.xml"></mapper>
</mappers>
方式二:使用class文件绑定注册
<mappers>
<mapper class="com.kuang.dao.UserMapper"/>
</mappers>
注意点:
- 接口和他的Mapper配置文件必须同名
- 接口和他的Mapper配置文件必须在同一个包下!
方式三:通过包扫描
<mappers>
<package name="com.kuang.dao"/>
</mappers>
注意点:
- 接口和他的Mapper配置文件必须同名
- 接口和他的Mapper配置文件必须在同一个包下!
练习:
- 将数据库配置文件外部引入
- 实体类别名
- 保存 UserMapper 接口与 UserMapper.xml 改为一致!并放在同一包下。
4.8、生命周期和作用域
作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。
SqlSessionFactoryBuilder:
- 一旦创建了 SqlSessionFactory,就不再需要它了。
- 局部变量
SqlSessionFactory:
-
说白了就是可以想象为:数据库连接池
-
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
-
因此 SqlSessionFactory 的最佳作用域是应用作用域。
-
最简单的就是使用单例模式或者静态单例模式。
SqlSession:
- 连接到连接池的一个请求!
- SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。
- 用完之后需要赶紧关闭,否则资源被浪费!
这里的每一个Mapper,就代表一个具体的业务。
5、解决属性名和字段名不一致的问题
5.1、问题
数据库中的字段
新建一个项目拷贝之前的,测试实体类字段不一致的情况
测试出现问题
//select * from mybatis.user where id = #{id};
//类型处理器
//select id,name,pwd from mybatis.user where id = #{id};
解决方法:
- 起别名
<select id="getUserById" resultType="user" parameterType="int">
select id,name,pwd as password from mybatis.user where id = #{id};
</select>
5.2 、ResultMap
结果集映射
id name pwd
id name password
<!--结果集映射-->
<resultMap id="UserMap" type="user">
<!--column数据库中的字段,property 实体类中的属性-->
<result column="id" property="id"/>
<result column="name" property="name"/>
<result column="pwd" property="password"/>
</resultMap>
<select id="getUserById" resultMap="UserMap" parameterType="int">
select * from mybatis.user where id = #{id};
</select>
- resultMap 元素是 MyBatis 中最重要最强大的元素。
- ResultMap 的设计思想是,对简单的语句做到零配置,对于复杂一点的语句,只需要描述语句之间的关系就行了。
- ResultMap 的优秀之处——你完全可以不用显式地配置它们。
6、日志
6.1、日志工厂
如果一个数据库操作,出现异常,我们需要排错。日志就是最好的帮手!
曾经:sout、debug
现在:日志工厂!
- SLF4J
- LOG4J【掌握】
- LOG4J2
- JDK_LOGGING
- COMMONS_LOGGING
- STDOUT_LOGGING 【掌握】
- NO_LOGGING
在 Mybatis 中具体使用那个日志实现,在设置中设定。
**STDOUT_LOGGING 标准日志输出 **