以前使用sqlSession通过命名空间调用Mybatis方法时,首先需要用到命名空间+方法id组成的字符串来调用相应的方法。
- 当参数多于1个的时候,需要将所有参数放到一个Map对象中,通过Map传递多个参数,由于命名空间通常会使用相对较长的、且有一定含义的字符串来作为其值,这样就很难保证我们在代码不出现拼写错误的情况使用起来很不方便很容易出错,而且无法避免很多重复的代码。
- 从selectXXX方法的签名可以看到,它的第二个参数是Object类型,那么如果我们传入的参数类型与映射文件中由parameterType属性指定的类型不一致时,将会出现不可预知的错误
- 同样,selectXXX方法返回值使用了泛型,我们须确保用于接收其返回值的变量类型与映射文件中属性resultType指定的类型相一致
使用接口调用的方式就可以规避以上风险而且使用起来更加方便,Mybatis使用java的动态代理可以直接通过接口来调用相应的方法,不需要提供接口的实现类,更不需要在实现类中使用SqlSession通过命名空间间接调用。
定义代理接口
映射文件的命名空间namespace的值配置成接口的全限定名,即接口所在的包名加上接口名称。
XML中的select标签的id属性值和定义的接口的方法名一致,Mybatis就是通过这种方式将接口方法和XML中定义的SQL语句关联到一起。如果不一致,启动程序便会报错。
<?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"> <mapper namespace="com.lhk.mybatis.dao.EmployeeMapper"> <!-- namespace:名称空间;指定为接口的全限定名 id:唯一标识,此时与接口的方法名相对应(getEmpById) resultType:返回值类型 #{id}:从传递过来的参数中取出id值 public Employee getEmpById(Integer id); --> <select id="getEmpById" resultType="com.lhk.mybatis.bean.Employee"> select id,last_name lastName,email,gender from tb1_employee where id = #{id} </select> </mapper>
定义接口
在代理接口中定义一些方法,并以相应元素的id属性值做为方法名,parameterType属性值做为方法参数类型,属性resultType值做为方法的返回值即可。
接口不需要实现。Mybatis会使用动态代理机制来帮助我们完成额外的工作。
package com.lhk.mybatis.dao; import com.lhk.mybatis.bean.Employee; public interface EmployeeMapper { public Employee getEmpById(Integer id); }
在Mybatis的全局配置文件(mybatis-config.xml)中,加入如下语句:
<mappers> <mapper resource="EmployeeMapper.xml" /> </mappers>
测试
package com.lhk.mybatis.test; import java.io.IOException; import java.io.InputStream; 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.Test; import com.lhk.mybatis.bean.Employee; import com.lhk.mybatis.dao.EmployeeMapper; /** * 1、接口式编程 * 原生: Dao ====> DaoImpl * mybatis: Mapper ====> xxMapper.xml * * 2、SqlSession代表和数据库的一次会话;用完必须关闭; * 3、SqlSession和connection一样它都是非线程安全。每次使用都应该去获取新的对象。 * 4、mapper接口没有实现类,但是mybatis会为这个接口生成一个代理对象。 * (将接口和xml进行绑定) * EmployeeMapper empMapper = sqlSession.getMapper(EmployeeMapper.class); * 5、两个重要的配置文件: * mybatis的全局配置文件:包含数据库连接池信息,事务管理器信息等...系统运行环境信息 * sql映射文件:保存了每一个sql语句的映射信息: * 将sql抽取出来。 */ public class MyBatisTest { public SqlSessionFactory getSqlSessionFactory() throws IOException { String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); return new SqlSessionFactoryBuilder().build(inputStream); } @Test public void test01() throws IOException { /* 1、获取sqlSessionFactory对象 */ SqlSessionFactory sqlSessionFactory = getSqlSessionFactory(); /* 2、获取sqlSession对象 */ SqlSession openSession = sqlSessionFactory.openSession(); try { /* 3、获取接口的实现类对象 */ /* 会为接口自动的创建一个代理对象,代理对象去执行增删改查方法 */ EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class); Employee employee = mapper.getEmpById(2); System.out.println(employee); } finally { openSession.close(); } } }