本文已参与「新人创作礼」活动,一起开启掘金创作之路。
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](baike.baidu.com/item/google code/2346604),并且改名为MyBatis 。
-
2013年11月迁移到Github。
如何获得Mybatis?
- Maven
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.2</version>
</dependency>
- Github GitHub - mybatis/mybatis-3: MyBatis SQL mapper framework for Java
- 中文文档 mybatis – MyBatis 3 | 简介
1.2、 持久化层
数据持久化
- 持久化就是将程序的数据在持久化状态和顺时状态转化的过程
- 内存:断电即失
- 数据库(Jdbc),io文件持久化
- 生活:冷藏,罐头
为什么需要持久化?
- 有一些对象不能让它丢失
- 内存太贵
1.3、其它一些层次
Dao层,Service层,Controller层
- 完成持久化工作的代码
- 层界限十分明显
1.4、为什么需要Mybatis?
-
帮助程序员将数据存入到数据库中。
-
方便
-
传统的JDBC代码太复杂了。简化,框架。自动化
-
不用Mybatis也可以。更容易上手。技术没有高低之分。
-
优点
- 简单易学
- 灵活
- sql和代码的分离,提高了可维护性。
- 提供映射标签,支持对象与数据库的orm字段关系映射
- 提供对象关系映射标签,支持对象关系组建维护
- 提供xml标签,支持编写动态sql。
最重要的一点:使用的人多!
2、第一个Mybatis程序
思路:搭建环境-->导入Mybatis-->编写代码-->测试!
2.1、搭建环境
- 搭建数据库
CREATE DATABASE `mybatis`;
CREATE TABLE `users`(
`id` INT(20) NOT NULL PRIMARY KEY,
`name` VARCHAR(30) DEFAULT NULL,
`pwd` VARCHAR(30) DEFAULT NULL
)ENGINE=INNODB DEFAULT CHARSET=utf8;
INSERT INTO `users` (`id`,`name`,`pwd`) VALUES
(1,'索隆','123456'),
(2,'索隆1','783456'),
(3,'索隆2','893456');
-
搭建项目
- 新建一个空项目
- 删除src目录
- 导入依赖
<dependencies> <!-- junit依赖--> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> </dependency> <!-- 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> </dependencies> <build> <resources> <resource> <directory>src/main/java</directory> <includes> <include>**/*.properties</include> <include>**/*.xml</include> </includes> <filtering>true</filtering> </resource> </resources> </build>
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>
<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>
<mappers>
<mapper class="com.xiao.dao.UserDao"/>
</mappers>
- 编写mybatis工具类
package com.xiao.utils;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
//编写 Mybatis 工具类 获取SqlSessionFactory
public class MybatisUtils {
private static SqlSessionFactory sqlSessionFactory = null;
static{//静态代码块封装 从一开始就会加载
String resource = "mybatis-config.xml";
try {
InputStream inputStream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//获取sqlSession 对象
public static SqlSession getSqlSession(){
return sqlSessionFactory.openSession();
}
}
2.3、编写代码
- 编写实体类
package com.xiao.pojo;
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 void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPwd() {
return pwd;
}
public void setPwd(String pwd) {
this.pwd = pwd;
}
@Override
public String toString() {
return "User{" +
"id=" + id +
", name='" + name + '\'' +
", pwd='" + pwd + '\'' +
'}';
}
}
- 编写接口
package com.xiao.Dao;
import com.xiao.pojo.User;
import java.util.List;
public interface UserDao {
public abstract List<User> getUserList();
}
- 编写配置文件
<?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 命名空间 : 这里等价于之前缩写的 UserDaoImp 指向一个Mapper接口-->
<mapper namespace="com.xiao.Dao.UserDao">
<!-- id 表示的是实现 namespace 中所对应接口的方法 resultType 表示的是返回值类型 -->
<select id="getUserList" resultType="com.xiao.pojo.User">
select * from mybatis.users
</select>
</mapper>
2.4、测试
public class UserMapperTest {
@Test
public void test(){
//获取Sqlsession 对象
SqlSession sqlSession = MybatisUtils.getSqlSession();
//从 接口的反射类 获得相应的 mapper
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
/*
1.这里一开始就有错误 命名的重名了
*/
List<User> userList = mapper.getUserList();
for (User user : userList) {
System.out.println(user);
}
//关闭资源
sqlSession.close();
}
}
可能会遇到的问题
- 配置文件没有配置
- 绑定接口错误
- 方法名不对
- 返回类型不对
- Maven导出资源问题
6.如果出现 connect failure
通过管理员下的命令窗口打开mysql
2.5、最后呈现的结构图
3、CRUD
3.1、namespace
namespace中的包名要和接口的包名一致。
3.2、select
id:就是对应的namespace中的方法名;
resultType:sql语句的返回值 类型在包中的位置
parameter:参数类型
- 编写接口
//查询对应的具体人的信息
User getUser(int id);
- 编写sql
<select id="getUser" parameterType="int" resultType="com.xiao.pojo.User">
select * from mybatis.users where id=#{id}
</select>
- 测试
//获取id确定的 用户信息
@Test
public void getUser(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.getUser(1);
System.out.println(user);
sqlSession.close();
}
3.3、 insert
<insert id="insertUser" parameterType="com.xiao.pojo.User">
insert into mybatis.users (id, name, pwd) VALUES (#{id},#{name},#{pwd})
</insert>
3.4、update
<update id="updateUser" parameterType="com.xiao.pojo.User">
update mybatis.users set name=#{name}, pwd=#{pwd} where id=#{id};
</update>
3.5、delete
<delete id="deleteUser" parameterType="int">
delete from mybatis.users where id=#{id}
</delete>
注意点:
增删改都必须执行提交事务阶段。
3.6、分析错误
- 标签不要写错
- namespace必须是对应接口的位置名称
- resource中必须是/隔开
- 程序配置文件必须符合规范
- 空指针异常问题,sqlSessionFactory
- 输出的xml文件中存在中文乱码问题
- Maven中存在资源导出问题
3.7、万能的Map
假设我们实体类或数据库中的字段过多,我们应当考虑使用Map
//根据Map传参实现不需要 传入大量的参数,如果 是之前的查询 需要new 一个User ,但 如果字段过多,可以通过Map传参
User getUserBy(Map<String,Object> map);//当需要传入多个参数
<select id="getUserBy" parameterType="map" resultType="com.xiao.pojo.User">
select * from mybatis.users where id=#{Id} and name=#{Name}
</select>
-
Map传递参数,直接在sql中取出Key即可
-
对象传递参数,直接在sql中取对象的即可
- 只有一个基本数据类型,可以不写,可以直接在sql中取到
- 多个参数使用Map,或者注解
3.8、模糊查询
- 在java代码中书写的模糊查询
List<User> users = mapper.getUserBy1("%索%");
- 在sql语句中使用通配符
select * from mybatis.users 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(映射器)
4.2、环境配置
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?useUnicode=true&characterEncoding=UTF-8&useSSL=true
username=root
password=123456
在核心文件中映入
<!-- 引入资源文件-->
<properties resource="db.properties"></properties>
<!-- 还可以在之间添加一些 其他属性-->
-
可以直接引入外部文件
-
可以在其中增加一些属性配置
-
如果两个文件有同一个字段,优先使用外部文件配置文件的。
4.4、类别名
- 类型别名可为 Java 类型设置一个缩写名字。
- 意在降低冗余的全限定类名书写
类别名
<typeAliases>
<typeAlias type="com.xiao.pojo.User" alias="User"></typeAlias>
</typeAliases>
也可以指定一个包名,Mybatis会在包名下面搜索需要的JavaBean,比如扫描实体类的包,他的默认别名就是这个类的类名,首字母小写!
包别名
<typeAliases>
<package name="com.xiao.pojo"/>
</typeAliases>
-
在实体类比较少的时候,使用第一种方式
-
如果实体类十分多,建议使用第二种
-
第一种可以DIY别名,第二种则不行,如果非要改,需要在实体类上增加注解。
@Alias("hello")
public class User {
4.5、设置
- 这是Mybatis中极为重要的调整设置,他们会改变Mybatis的运行时行为。
4.6、其他配置
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
-mybatis-plus
-通用mapper
-mybatis-generator-core
4.7、映射器(mappers)
方式一:使用相对于类路径的资源引用
<mappers>
<mapper resource="com/xiao/Dao/UserMapper.xml"/>
<!-- 2.这里的映射路径 映射的是一个xml文件 所以前面的路径指代 是用/隔开 -->
</mappers>
方式二:使用映射器接口实现类的完全限定类名
<mappers>
<mapper class="com.xiao.Dao.UserMapper"/>
</mappers>
注意点:
- 接口和他的Mapper配置文件必须同名
- 接口和他的配置文件必须在同一个包下
方式三:将包内的映射器接口实现全部注册为映射器
<mappers>
<package name="com.xiao.Dao"/>
<!-- 2.这里的映射路径 映射的是一个xml文件 所以前面的路径指代 是用/隔开 -->
</mappers>
注意点:
- 接口和他的Mapper配置文件必须同名
- 接口和他的配置文件必须在同一个包下
4.8、生命周期和作用域
不同作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。
(1)、SqlSessionFactoryBuilder
- 一旦创建了 SqlSessionFactory,就不再需要它了
- 局部变量
(2)、SqlSessionFactory:
- 说白了就是可以想象为:数据库连接池
- SqlSessionFactory一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
- 因此 SqlSessionFactory 的最佳作用域是应用作用域。
- 最简单的就是使用单例模式或者静态单例模式。
(3)、SqlSession
- 连接到连接池的一个请求!
- SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。
- 用完之后需要赶紧关闭,否则资源被占用!
这里面的每一个Mapper,就代表一个具体的业务!