MyBatis配合开发Dao
使用Mybatis开发Dao,通常有两个方法,即普通Dao开发方法和Mapper接口开发方法。
1.手动编写Dao实现类
手动编写Dao实现类方法需要程序员编写Dao接口和Dao实现类。
映射文件
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="grade">
<!-- id:表示命名空间的唯一标识,与命名空间配合使用,组合后必须唯一-->
<!-- parameterType:传入的SQL语句参数类的全类名或者别名(参数类型) -->
<!-- resultType:执行SQL语句中返回的结果类型的全类名或者别名,如果是集合类型,那么返回的是集合可以包含的类型,而不是集合本身 -->
<!-- #{}:输入参数的占位符,相当于jdbc的[?] -->
<select id="findGradeById" parameterType="int" resultType="com.qsy.pojo.Grade">
SELECT * FROM grade WHERE id = #{id}
</select>
<select id="findGradeByNameLike2" parameterType="string" resultType="com.qsy.pojo.Grade">
SELECT * FROM grade where grade like '%${value}%'
</select>
</mapper>
Dao接口
import com.qsy.pojo.Grade;
import java.util.List;
public interface GradeDao {
public Grade findGradeById(Integer id);
public List<Grade> findGradeByGradeName(String grade);
}
接口实现类
package com.qsy.dao;
import com.qsy.pojo.Grade;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import java.util.List;
public class GradeDaoImpl implements GradeDao{
private SqlSessionFactory sqlSessionFactory;
//通过构造方法注入
public GradeDaoImpl(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
@Override
public Grade findGradeById(Integer id) {
//sqlSesion是线程不安全的,所以它的最佳使用范围在方法体内
SqlSession openSession = sqlSessionFactory.openSession();
Grade grade = openSession.selectOne("grade.findGradeById", id);
return grade;
}
@Override
public List<Grade> findGradeByGradeName(String grade) {
SqlSession openSession = sqlSessionFactory.openSession();
List<Grade> list = openSession.selectList("grade.findGradeByNameLike2", grade);
return list;
}
}
测试类
import com.qsy.dao.GradeDao;
import com.qsy.dao.GradeDaoImpl;
import com.qsy.pojo.Grade;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import java.io.InputStream;
import java.util.List;
public class GradeDaoTest {
private SqlSessionFactory factory;
//作用:在测试方法前执行这个方法
@Before
public void setUp() throws Exception {
String resource = "SqlMapConfig.xml";
//通过流将核心配置文件读取进来
InputStream inputStream = Resources.getResourceAsStream(resource);
//通过核心配置文件输入流来创建会话工厂
factory = new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindGradeById() {
//将初始化好的工厂注入到实现类中
GradeDao gradeDao = new GradeDaoImpl(factory);
Grade grade = gradeDao.findGradeById(1);
System.out.println(grade);
}
@Test
public void testFindGradeByGradeName() {
GradeDao gradeDao = new GradeDaoImpl(factory);
List<Grade> list = gradeDao.findGradeByGradeName("20");
System.out.println(list);
}
}
2.Mapper动态代理方式
2.1开发规范
Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口),由Mybatis框架根据接口定义创建接口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。
Mapper接口开发需要遵循以下规范:
-
Mapper接口名称和对应的Mapper.xml文件必须相同
-
Mapper.xml文件中的namespace与Mapper接口的类路径相同。
-
Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
-
Mapper接口方法的输入参数类型和Mapper.xml中定义的每个 sql 的parameterType的类型相同
-
Mapper接口方法的输出参数类型和Mapper.xml中定义的每个 sql 的resultType的类型相同
只要遵循了以上规范,MyBatis就可以自动生成Mapper接口实现类的代理对象,从而简化我们的开发
2.2 Mapper.xml(映射文件)
定义mapper映射文件GradeMapper.xml,需要修改namespace的值为 GradeMapper 接口路径。将GradeMapper.xml放在classpath 下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:命名空间【重要】-->
<mapper namespace="com.qsy.mapper.GradeMapper">
<select id="findGradeById" parameterType="int" resultType="com.qsy.pojo.Grade">
SELECT * FROM grade WHERE id = #{id}
</select>
<select id="findGradeByGradeName" parameterType="string" resultType="com.qsy.pojo.Grade">
SELECT * FROM grade where grade like '%${value}%'
</select>
<!-- 保存年级信息-主键自动增长 -->
<insert id="saveGrade" parameterType="com.qsy.pojo.Grade">
<selectKey keyColumn="id" keyProperty="id" order="AFTER"
resultType="int">
SELECT LAST_INSERT_ID()
</selectKey>
INSERT INTO Grade (id,grade) VALUES (#{id},#{grade})
</insert>
</mapper>
2.3 Mapper.java(接口文件)
import com.qsy.pojo.Grade;
import java.util.List;
public interface GradeMapper {
public Grade findGradeById(Integer id);
public List<Grade> findGradeByGradeName(String grade);
public void saveGrade(Grade grade);
}
接口定义有如下特点:
-
Mapper接口方法名和Mapper.xml中定义的statement的id相同
-
Mapper接口方法的输入参数类型和mapper.xml中定义的statement的parameterType的类型相同
-
Mapper接口方法的输出参数类型和mapper.xml中定义的statement的resultType的类型相同
2.4 加载GradeMapper.xml文件
sqlMapConfig.xml如下
<?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>
<!-- 和spring整合后 environments配置将废除 -->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事务管理 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url"
value="jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true" />
<property name="username" value="root" />
<property name="password" value="123456" />
</dataSource>
</environment>
</environments>
<!-- 加载映射文件 -->
<mappers>
<package name="com.qsy.mapper"/>
</mappers>
</configuration>
2.5 测试
import com.qsy.mapper.GradeMapper;
import com.qsy.pojo.Grade;
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;
import java.util.List;
public class GradeMapperTest {
private SqlSessionFactory factory;
//作用:在测试方法前执行这个方法
@Before
public void setUp() throws Exception {
String resource = "SqlMapConfig.xml";
//通过流将核心配置文件读取进来
InputStream inputStream = Resources.getResourceAsStream(resource);
//通过核心配置文件输入流来创建会话工厂
factory = new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindGradeById() {
SqlSession openSession = factory.openSession();
//通过getMapper方法来实例化接口
GradeMapper mapper = openSession.getMapper(GradeMapper.class);
Grade grade = mapper.findGradeById(1);
System.out.println(grade);
}
@Test
public void testFindGradeByGradeName() {
SqlSession openSession = factory.openSession();
//通过getMapper方法来实例化接口
GradeMapper mapper = openSession.getMapper(GradeMapper.class);
List<Grade> grades = mapper.findGradeByGradeName("20");
System.out.println(grades);
}
@Test
public void testSaveGrade() throws Exception{
SqlSession openSession = factory.openSession();
//通过getMapper方法来实例化接口
GradeMapper mapper = openSession.getMapper(GradeMapper.class);
Grade grade = new Grade();
grade.setGrade(2099);
mapper.saveGrade(grade);
openSession.commit();
}
}
2.6小结
selectOne和selectList
动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。
namespace
mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。