Mybatis
环境:
- JDK1.8
- Mysql 5.7
- maven 3.6.1
- IDEA
回顾:
- JDBC
- Mysql
- java基础
- Maven
- junit
框架:配置文件的。最好的方式:看官网文档:https://mybatis.org/mybatis-3/zh/getting-started.html
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。
如何获得Mybatis
-
maven仓库
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.5</version> </dependency>
-
Github : https://github.com/mybatis/mybatis-3/releases
-
中文文档:https://mybatis.org/mybatis-3/zh/index.html
1.2 持久化
数据持久化
- 持久化就是将程序的数据在持久状态和瞬时状态的过程
- 内存:断电即失
- 数据库(jdbc),io文件持久化。
- 生活:冷藏,罐头。
为什么需要持久化?
有一些对象,不能让它丢掉
- 内存太贵了
1.3 持久层
Dao层 Service层 Controller层
- 完成持久化工作的代码块
- 层是界限十分明显。
1.4 为什么需要Mybatis?
- 帮助程序猿将数据存入到数据库中。
- 方便
- 传统的JDBC代码太复杂了。简化,框架。
- 不用Mybatis也可以,更容易上手,技术没有高低之分
- 优点:
- 简单易学
- 灵活
- sql和代码的分离,提高了可维护性。
- 提供映射标签,支持对象与数据库的orm字段关系映射
- 提供对象关系映射标签,支持对象关系组建维护
- 提供xml标签,支持编写动态sql。
最重要的一点:使用的人多!
Spring SpringMVC SpringBoot
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,'tom','123456'),
(2,'jak','123456'),
(3,'jam','123456')
新建项目
1、新建一个普通的maven项目
2、删除src目录
3、导入maven依赖
<!--导入依赖-->
<dependencies>
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.30</version>
</dependency>
<!--mybatis-->
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<!--junit-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
在idea连接mysql时出现报错
出现问题原因:时区问题,MySQL驱动默认UTC时区。
解决办法:
-
在url后添加
?serverTimezone=GMT%2B8
2.2 创建一个模块
-
编写mybatis的核心配置文件
<?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核心配置文件--> <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&characterEncoding=UTF-8"/> <property name="username" value="root"/> <property name="password" value="123456"/> </dataSource> </environment> </environments> </configuration>
-
编写mybatis工具类
//SqlSessionFactory ---> sqlSession
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory;
static{
try {
//使用Mybatis获取sqlSessionFactory对象
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//既然有了 SqlSessionFactory,顾名思义,我们可以从中获得 SqlSession 的实例。
//SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
2.3 编写代码
-
实现类
-
package com.nine.pojo; /** * @Author 韦浪 * @create 2020/10/29 12:39 */ //实体类 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; } @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.nine.dao.UserDao"> <!--select查询语句--> <select id="getUserList" resultType="com.nine.pojo.User"> select * from mybatis.user </select> </mapper>
2.4 测试
注意点:
org.apache.ibatis.binding.BuindingException:Type interface com.nine.dao.UserDao is not Know to the MapperRegistry.
MapperRegistry是什么
核心配置文件中注册mappers
-
<!--在build中配置resoureces,来防止我们资源导出失效的问题--> <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>
-
junit测试
@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(); }
可能会遇到的问题:
- 1、配置文件没有注册
- 2、绑定接口错误
- 3、方法名不对
- 4、返回类型不对
- 5、Maven资源导出问题
3、CRUD
1. namespace
namespace中的包名要和Dao/mapper接口的包名一致
2. select
选择,查询语句:
- id:就是对应的namespace中的方法名;
- resultType:Sql语句执行的返回值!
- parameterType:参数类型!
1、编写接口
//获取全部用户
List<User> getUserList();
//根据id查询用户
User getUserById(int id);
//insert一个用户
int addUser(User user);
//修改用户
int updateUser(User user);
//删除一个用户
int deleteUser(int id);
2、编写对应的mapper中的sql语句
<select id="getUserById" parameterType="int" resultType="com.nine.pojo.User">
select * from mybatis.user where id =#{id}
</select>
3、测试
@Test
public void getUserById(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUserById(1);
System.out.println(user);
sqlSession.close();
}
3. Insert
<insert id="addUser" parameterType="com.nine.pojo.User">
insert into mybatis.user (id,name,pwd) values (#{id},#{name},#{pwd});
</insert>
4. update
<update id="updateUser" parameterType="com.nine.pojo.User">
update mybatis.user set name =#{name },pwd=#{pwd} where id = #{id};
</update>
5. delete
<delete id="deleteUser" parameterType="int">
delete from mybatis.user where id = #{id};
</delete>
注意点:
- 增删改需要提交事务
6. 万能的Map
假设,我们的实体类,或者数据库中的表,参数或者参数过多,我们应当考虑使用Map
//万能的Map
int addUser2(Map<String,Object> map);
<!--对象中的属性,可以直接取出来 传递map的key-->
<insert id="addUser2" parameterType="map">
insert into mybatis.user (id,pwd) values (#{userid},#{password});
</insert>
@Test
public void addUser2(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
HashMap<String, Object> map = new HashMap<String, Object>();
map.put("userid",5);
map.put("userName","xiaoming");
map.put("password","147258");
mapper.addUser2(map);
sqlSession.close();
}
Map传递参数,直接在sql中取key即可!parameterType=“map”
对象传递参数,直接在sql中取对象的属性即可!parameterType=“Object”
只有一个基本类型参数的情况下,可以直接在sql中取到!
多个参数用Map,或者注解!
7. 模糊查询
模糊查询怎么写?
1、Java代码执行的时候,传递通配符 % %
List<User> userlist = mapper.getUserList2("%李%");
2、在sql拼接中使用通配符!
select * from mybatis.user where name like "%"#{value}"%"
4、配置解析
1. 核心配置文件
- mybatis-config.xml
- Mybatis的配置文件包含了会深深影响Mybatis行为的设置和属性
学习的目标:
configuration(配置)
properties(属性)//掌握
settings(设置)//掌握部分
typeAliases(类型别名)//完全掌握
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境配置)
environment(环境变量)
transactionManager(事务管理器)
dataSource(数据源)
databaseIdProvider(数据库厂商标识)
mappers(映射器)
2. 环境配置(environments)
MyBatis 可以配置成适应多种环境
不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
学会使用配置多套运行环境!
Mybatis默认的事务管理器就是JDBC,连接池:POOLED
3. 属性(properties)
我们可以通过properties属性来实现引用配置文件
这些属性可以在外部进行配置,并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置。【db.properties】
编写一个配置文件
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF8
username=root
password=123456
在核心配置文件中引入
<!--引入外部配置文件-->
<properties resource="db.properties">
<property name="username" value="root"/>
<property name="pwd" value="111111"/>
</properties>
- 可以直接引入外部文件
- 可以在其中增加一些属性配置
- 如果俩个文件有同一个字段,优先使用外部配置文件的!
4. 类型别名(typeAliases)
- 类型别名可为 Java 类型设置一个缩写名字
- 存在的意义是降低冗余的全限定类名书写
<!--可以给实体类起别名-->
<typeAliases>
<typeAlias type="com.nine.pojo.User" alias="User"/>
</typeAliases>
也可以指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean,比如:
扫描实体类的包,它的默认别名就为这个类的 类名 ,首字母小写!
<!--可以给实体类起别名-->
<typeAliases>
<typeAlias type="com.nine.pojo/>
</typeAliases>
在实体类比较少的方式,使用第一个方法
如果实体类十分多,建议使用第二种方式。
第一种可以DIY别名,第二种则不行,如果非要改,需要在实体类上增加注解
@Alias("user")
public class User {}
5. 设置
这是MyBatis中极为重要的调整设置,它们会改变MyBatis的运行时行为。
6. 其他设置
- typeHandlers(类型处理器)
- objectFactory(对象工厂)
- plugins(插件)
- mybatis-generator-core
- mybatis-plus
- 通用Mapper
7. 映射器(mappers)
MapperRegistry:注册绑定我们的Mapper文件;
方式一:
<!--每一个Mapper,XML都需要在Mybatis核心配置文件中注册!-->
<mappers>
<mapper resource="com/nine/dao/UserMapper.xml"/>
</mappers>
方式二:使用class绑定文件注册
<!--每一个Mapper,XML都需要在Mybatis核心配置文件中注册!-->
<mappers>
<!-- <mapper resource="com/nine/dao/UserMapper.xml"/>-->
<mapper class="com.nine.dao.UserMapper"/>
</mappers>
注意点:
- 接口和他的Mapper配置文件必须同名!
- 接口和他的Mapper配置文件必须在同一个包下
方式三:使用扫描包进行注入绑定
<!--每一个Mapper,XML都需要在Mybatis核心配置文件中注册!-->
<mappers>
<mapper package="com,nine.dao"/>
</mappers>
练习:
- 将数据库配置文件外部引入
- 实体类别名
- 保证UserMapper接口 和UserMapper.xml改为一致,并放在同一个包下!
8. 生命周期和作用域
不同作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。
SqlSessionFactoryBuilder:
- 一旦创建了SqlSessionFactory,就不再需要它了
- 局部变量
SqlSessionFactory:
- 说白了就是可以想象成:数据库连接池
- SqlSessionFactory一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或者重新创建另一个实例。
- SqlSessionFactory 的最佳作用域是应用作用域
- 最简单的就是使用单例模式或者静态单例模式
SqlSession:
- 连接到连接池的一个请求!(每个线程都应该有它自己的 SqlSession 实例)
- SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。
- 用完之后需要赶紧关闭
这里的每一个Mapper,代表一个具体的业务
5、ResultMap(解决属性名和字段名不一致的问题)
5.1 问题
数据库中的字段
新建一个项目,拷贝之前的,测试实体类字段不一致的情况
public class User {
private int id;
private String name;
private String password;
}
测试出现问题
//select * from mybatis.user where id = #{id};
//类型处理器
//select id,name,pwd from mybatis.user where id =#{id};
解决办法:
- 起别名
<select id="getUserById" parameterType="int" resultType="com.nine.pojo.User">
select id,name,pwd as password from mybatis.user where id =#{id}
</select>
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">
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标准日志输出
<settings>
<!--标准的日志工厂的实现-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
6.2 Log4j
什么是Log4j:
- Log4j是Apache的一个开源项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件,
- 我们也可以控制每一条日志的输出格式
- 通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程
- 通过一个配置文件来灵活地进行配置,而不需要修改应用的代码
1、先导入log4j的包
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
2、log4j.properties
#将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file
#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n
#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/kuang.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n
#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG
3.配置log4j为日志的实现
<settings>
<setting name="logImpl" value="LOG4j"/>
</settings>
4.Log4j的使用!直接测试运行刚才的查询
简单使用
1、在要使用Log4j的类中,导入import org.apache.log4j.Logger;
2、日志对象,参数为当前类的class
static Logger logger = Logger.getLogger(UserDaoTest.class);
3、日志级别
logger.info("info:进入了testLog4j");
logger.debug("debug:进入testLog4j");
logger.error("erroe:进入了testLog4j");
7、分页
思考:为什么要分页?
- 减少数据的处理量
7.1 使用Limit分页
语法:SELECT * FROM user LIMIT startIndex,pageSize
SELECT * FROM user LIMIT 3; #[0,n]
使用Mybatis实现分页,核心SQL
1、接口
//分页
List<User> getUserByLimit(Map<String,Integer> map);
2、Mapper.XML
<!--分页-->
<select id="getUserByLimit" parameterType="map" resultMap="UserMap">
select * from mybatis.user limit #{startIndex},#{pageSize};
</select>
3、测试
@Test
public void getUserByLimit(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
HashMap<String, Integer> map = new HashMap<String, Integer>();
map.put("startIndex",0);
map.put("pageSize",2);
List<User> userByLimit = mapper.getUserByLimit(map);
for (User user:userByLimit){
System.out.println(user);
}
sqlSession.close();
}
7.2 RowBounds分页
不再使用SQL实现分页
1、接口
2、mapper.xml
3、测试
7.3 分页插件
了解即可。
8、使用注解开发
8.1 面向接口编程
真正的开发中,很多时候会选择面向接口编程
根本原因:解耦,可拓展,提高复用,分层开发中,上层不用管具体的实现,大家都遵守共同的标准,使开发变得更容易,规范性更好
- FROM user LIMIT startIndex,pageSize
SELECT * FROM user LIMIT 3; #[0,n]
使用Mybatis实现分页,核心SQL
1、接口
```java
//分页
List<User> getUserByLimit(Map<String,Integer> map);
2、Mapper.XML
<!--分页-->
<select id="getUserByLimit" parameterType="map" resultMap="UserMap">
select * from mybatis.user limit #{startIndex},#{pageSize};
</select>
3、测试
@Test
public void getUserByLimit(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
HashMap<String, Integer> map = new HashMap<String, Integer>();
map.put("startIndex",0);
map.put("pageSize",2);
List<User> userByLimit = mapper.getUserByLimit(map);
for (User user:userByLimit){
System.out.println(user);
}
sqlSession.close();
}
7.2 RowBounds分页
不再使用SQL实现分页
1、接口
2、mapper.xml
3、测试
7.3 分页插件
了解即可。