Mapper代理开发规范
使用过程中我们要遵守下面规则:
1.定义与SQL映射文件同名的Mapper接口,并且将Mapper接口和SQL映射文件放在同一目录下。
在resource目录下创建文件夹 com/zua/mapper 然后创建SQL映射文件,这样就能使接口与SQL映射文件在编译后处于同一目录下,创建后的目录结构为:
注意!!!
创建完UserMapper.xml后,不要忘记修改mybatis-config.xml中的mappers标签为:
<mappers>
<!--指定SQL映射文件-->
<mapper resource="com/zua/mapper/UserMapper.xml"/>
</mappers>
2.设置SQL映射文件中的namespace属性为Mapper接口全限定名
在SQL配置文件(UserMapper.xml)中修改
<mapper namespace="com.zua.mapper.UserMapper">
3.在Mapper接口中定义方法,方法名就是SQL映射文件中sql语句的id,并保持参数类型和返回值类型一致。
SQL配置文件(UserMapper.xml)配置文件如下:
<mapper namespace="com.zua.mapper.UserMapper">
<select id="findById" parameterType="int" resultType="com.zua.pojo.User">
select * from user where id = #{id}
</select>
</mapper>
所以在com.zua.mapper包下的UserMapper就得如下:
package com.zua.mapper;
import com.zua.pojo.User;
public interface UserMapper {
User findById(int id);
}
4.编码
(1)通过SqlSession的getMapper方法获取Mapper接口的代理对象。
(2)调用对应方法完成sql的执行。
package com.zua.test;
import com.zua.mapper.UserMapper;
import com.zua.pojo.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 java.io.InputStream;
public class MyBatisTest {
public static void main(String[] args) throws Exception {
//从 XML 中构建 SqlSessionFactory 固定代码
String resource = "mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
//获取SqlSession对象,用于执行sql语句
SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
User user = mapper.findById(1);
System.out.println(user.getUserName());
sqlSession.close();
}
}
一个细节
在mybatis中修改:
<mappers>
<package name="com.zua.mapper"/>
</mappers>
可扫描包内所有SQL配置文件。