1 Mybatis概述
- MyBatis 是一款优秀的持久层框架,用于简化 JDBC 开发
- MyBatis 本是 Apache 的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis 。2013年11月迁移到Github
- 官网:https://mybatis.org/mybatis-3/zh/index.html
- 持久层:负责将数据到保存到数据库的那一层代码,以后开发我们会将操作数据库的Java代码作为持久层,而Mybatis就是对jdbc代码进行了封装。
- JavaEE三层架构:表现层、业务层、持久层
2 Mybatis基本使用
- 基本结构:
2.1 添加依赖
- 在Maven项目的
pom.xml
中添加相关依赖库(mybatis、mysql、junit、slf4j日志、logback
)
<dependencies>
<!--mybatis 依赖-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.5</version>
</dependency>
<!--mysql 驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.46</version>
</dependency>
<!--junit 单元测试-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<scope>test</scope>
</dependency>
<!-- 添加slf4j日志api -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.20</version>
</dependency>
<!-- 添加logback-classic依赖 -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.3</version>
</dependency>
<!-- 添加logback-core依赖 -->
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.2.3</version>
</dependency>
</dependencies>
需要在项目的 resources 目录下创建logback的配置文件
2.2 编写MyBatis核心配置文件
- 编写
MyBatis
核心配置文件(resources/mybatis-config.xml
) – > 替换连接信息 解决硬编码问题
<!--
environments:配置数据库连接环境信息。可以配置多个environment,通过default属性切换不同的environment
-->
<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:///db1?useSSL=false"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<mappers>
<!--加载sql映射文件-->
<mapper resource="org/example/mapper/UserMapper.xml"/>
</mappers>
2.3 编写SQL映射配置文件
- 编写
SQL
映射文件(resources/org/example/mapper/UserMapper.xml
) --> 统一管理sql语句,解决硬编码问题
<mapper namespace="test">
<select id="selectAll" resultType="org.example.pojo.User">
select *
from user;
</select>
</mapper>
在映射配置文件中的 resultType
属性需要配置数据封装的类型(类的全限定名)。而每次这样写是特别麻烦的,Mybatis提供了 类型别名 (typeAliases
) 可以简化这部分的书写:首先需要现在核心配置文件(mybatis-config.xml
)中配置类型别名,也就意味着给pojo包下所有的类起了别名(别名就是类名),不区分大小写
<typeAliases>
<package name="org.example.pojo"/>
</typeAliases>
通过上述的配置,我们就可以简化映射配置文件中 resultType
属性值的编写
<mapper namespace="test.UserMapper">
<select id="selectAll" resultType="User">
select *
from user;
</select>
</mapper>
2.4 编写测试类UserTest
@Test
public void testSelctALL() throws IOException {
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
List<User> list = sqlSession.selectList("test.selectAll"); //参数是一个字符串,该字符串必须是映射配置文件的namespace.id
for(User s : list){
System.out.println(s);
}
sqlSession.close();
}
2.5 Mapper代理开发
2.5.1 Mapper代理目的
之前我们写的代码是基本使用方式,它也存在硬编码的问题,如下:
List<User> list = sqlSession.selectList("test.selectAll");
这里调用 selectList()
方法传递的参数是映射配置文件中的namespace.id
值。这样写也不便于后期的维护。如果使用Mapper 代理方式(如下图)则不存在硬编码问题
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
List<User> list = userMapper.selectAll();
Mapper 代理方式的目的:
- 解决原生方式中的硬编码
- 简化后期执行
SQL
2.5.2 Mapper代理实现
- Step1:定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射配置文件放置在相同目录下
- Step2:设置SQL映射文件的namespace属性为Mapper接口全限定名
<!--namespace:名称空间,必须是对应接口的全限定名-->
<mapper namespace="org.example.mapper.UserMapper">
...
</mapper>
- Step3:在 Mapper 接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致
- Step4:如果Mapper接口名称和SQL映射文件名称相同,并在同一目录下,则可以使用包扫描的方式简化SQL映射文件的加载。修改
mybais-config.xml
核心配置文件的加载映射配置文件的配置修改为:
<mappers>
<!--加载sql映射文件-->
<!--<mapper resource="org/example/mapper/UserMapper.xml"/>-->
<!--Mapper代理方式-->
<package name="org.example.mapper"/>
</mappers>
即加载代理即可,无需再加载SQL映射配置文件
2.6 MyBatisX插件
功能:
- XML映射配置文件 和 接口方法 间相互跳转
- 根据接口方法生成
statement
安装: - 点击 file ,选择 settings ,就能看到如下图所示界面
安装后重启IDEA即可