mybatis 学习笔记(三):mapper 代理开发 dao 层
mybatis 学习笔记(三):mapper 代理开发 dao 层
优势
通过使用mapper 代理,我们可以不需要去编写具体的实现类(使用 getMapper()
方法自动生成),只需编写接口即可,简化了原始 dao 开发的流程。
核心
mapper 代理开发 dao 层,最主要的其实就是两个步骤:
- 编写mapper.xml映射文件
- 编写mapper接口(相当于dao接口)
下面举个栗子。
步骤
1 编写 mapper.xml 映射文件
mapper.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">
<!-- namespace 命名空间,作用就是对sql进行分类化管理,理解为sql隔离
注意:使用mapper代理方法开发,namespace有特殊重要的作用
namespace等于 mapper 接口地址
-->
<mapper namespace="cn.itcast.mybatis.mapper.UserMapper">
<select id="findUserById" parameterType="int" resultType="cn.itcast.mybatis.po.User">
SELECT * FROM USER WHERE id=#{value}
</select>
</mapper>
其中 namespace 中的内容应为编写的 mapper接口的相对地址。这里的 SQL 语句以查询数据库中的 id 为例。
2 编写mapper接口:UserMapper.java
UserMapper.java:
package cn.itcast.mybatis.mapper;
import cn.itcast.mybatis.po.User;
import java.util.List;
public interface UserMapper {
//根据 id 查询用户信息
public User findUserById(int id) throws Exception;
}
调用封装好的数据库对象 User.java 内容,定义接口。
其中应该遵循以下几条规则:
- mapper接口中的方法名和mapper.xml中statement的id一致
- mapper接口中方法的输入参数类型和mapper.xml中statement的parameterType指定的类型一致
- mapper接口中方法返回值类型和mapper.xml中statement的resultType指定的类型一致
3 在全局配置文件 SqlMapConfig.xml 中 加载映射文件
SqlMapConfig.xml:
<!-- 加载映射文件 -->
<mappers>
<!-- 通过 resource 方法一次加载一个映射文件 -->
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
4 编写测试文件 UserMapperTest.java ,查看控制台输出结果
UserMapperTest.java:
package cn.itcast.mybatis.mapper;
import cn.itcast.mybatis.po.User;
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 org.junit.Before;
import org.junit.Test;
import java.io.InputStream;
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;
//注解Before是在执行本类所有测试方法之前先调用这个方法
@Before
public void setup() throws Exception{
//创建SqlSessionFactory
String resource="SqlMapConfig.xml";
//将配置文件加载成流
InputStream inputStream = Resources.getResourceAsStream(resource);
//创建会话工厂,传入mybatis配置文件的信息
sqlSessionFactory=new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindUserById() throws Exception{
SqlSession sqlSession=sqlSessionFactory.openSession();
//创建UserMapper代理对象
UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
//调用userMapper的方法
User user=userMapper.findUserById(1);
sqlSession.close();
System.out.println(user);
}
}
sqlSession可以自动创建一个mapper接口的代理对象,所以我们只需要把写好的mapper接口类的对象传给getMapper方法,即可得到一个该接口对应的代理对象,然后我们就可以使用这个代理对象来操作接口中具体的方法了。
运行 testFindUserById()
方法,查看控制台信息,正确输出查询结果。