总结的另外和一个关于Mybatis的博文:http://www.cnblogs.com/DreamDrive/p/4091004.html
1.namespace的作用
命名空间除了对sql进行隔离,mybatis中对命名空间有特殊的作用,用于定义mapper接口地址。
问题:
没有使用接口编程,java是面向接口编程语言,对数据库的操作应该定义一些操作接口,如:用户添加、用户删除、用户查询等,调用dao接口完成数据库操作。
上边代码,该调用selectOne、selectList,完全由人工判断不方便,selectList和selectOne方法参数是一个object类型,如果程序员在编码如果设置参数错误不会在编译阶段报错。
设想:能否mybatis封装 方法实现体,方法名:和mapper.xml中的statement的id保持一致。方法输入参数类型:和mapper.xml中parameterType指定类型一致。方法返回值:可以根据dao接口的 返回值的类型决定是调用selectOne还是selectList,类型和mapper.xml中的resulttype类型保持 一致采用mybatis提供动态代理方式生成接口实现对象。mapper.xml知道mapper.java,对应关系通过namespace进行配置。改为mapper 接口实现:
第一步:定义mapper.xml
Mapper.xml文件不变还用原来的。
第二步:定义mapper 接口
//mapper接口类路径和mapper.xml中的namespace一致public interface UserMapper { //根据mapper.xml中定义statement来方法 //方法名:和mapper.xml中的statement的id一致 //输入参数:和mapper.xml中的parametertype一致 //输入结果:和mapper.xml中的resulttype一致 public User findUserById(int id)throws Exception; //自定义条件查询用户信息 public ListfindUserList(User user)throws Exception; //查询用户列表输出map public List
接口定义有如下特点:
1、 Mapper接口方法名和mapper.xml中定义的每个sql的id相同
2、 Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
3、 Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同
第三步:修改namespace
Mapper.xml映射文件中的namepace改为如下:
<mapper namespace="cn.itcast.mybatis.mapper.UserMapper">
修改后namespace即是mapper接口的地址。
第四步:通过mapper接口调用statement
public class UserMapperTest { SqlSessionFactory sqlSessionFactory; @Before public void setUp() throws Exception { // 创建会话工厂 // 创建的会话工厂SqlsessionFactory String resource = "SqlMapConfig.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); // 创建的会话工厂SqlsessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); } @Test public void testFindUserById() throws Exception { SqlSession sqlSession = sqlSessionFactory.openSession(); //生成mapper接口的代理对象 UserMapper userMapper = sqlSession.getMapper(UserMapper.class); //调用 mapper接口的方法 User user = userMapper.findUserById(1); System.out.println(user); } @Test public void testInsertUser() throws Exception { SqlSession sqlSession = sqlSessionFactory.openSession(); //生成mapper接口的代理对象 UserMapper userMapper = sqlSession.getMapper(UserMapper.class); //构造查询条件 User user_insert = new User(); user_insert.setUsername("张三四"); user_insert.setSex("1"); //调用 mapper接口的方法 userMapper.insertUser(user_insert); //提交事务 sqlSession.commit(); sqlSession.close(); } }
session.getMapper(UserMapper.class)生成一个代理对象作为UserMapper的接口实现对象。
总结:
mapper接口动态代理对象生成规则:1、mapper接口类路径和mapper.xml中的namespace一致2、方法名:和mapper.xml中的statement的id一致3、输入参数:和mapper.xml中的parametertype一致4、输入结果:和mapper.xml中的resulttype一致两个文件:mapper.xml(mapper映射文件)和mapper.java(mapper接口文件)2.SqlMapConfig.xml
配置内容
SqlMapConfig.xml中配置的内容和顺序如下:
properties(属性)
settings(全局配置参数)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境集合属性对象)
environment(环境子属性对象)
transactionManager(事务管理)
dataSource(数据源)
mappers(映射器)
properties(属性)
SqlMapConfig.xml可以引用java属性文件中的配置信息如下:
在classpath下定义db.properties文件,
jdbc.driver=com.mysql.jdbc.Driverjdbc.url=jdbc:mysql://localhost:3306/mybatisjdbc.username=rootjdbc.password=mysql
SqlMapConfig.xml引用如下:
mappers(映射器)
Mapper配置的几种方法:<mapper resource=" " />使用相对于类路径的资源如:<mapper resource="sqlmap/user.xml" /><mapper url=" " />使用完全限定路径如:<mapper url="file:///D:\workspace_spingmvc\mybatis_01\config\sqlmap\user.xml" /><mapper class=" " />使用mapper接口类路径如:<mapper class="cn.itcast.mybatis.mapper.UserMapper"/>注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。<package name=""/>注册指定包下的所有mapper接口如:<package name="cn.itcast.mybatis.mapper"/>注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。3. Mapper.xml
Mapper.xml映射文件中定义了操作数据库的sql,每个sql是一个statement,映射文件是mybatis的核心。
parameterType (输入类型)
#{}与${}
#{}实现的是向prepareStatement中的预处理语句中设置参数值,sql语句中#{}表示一个占位符即?。
使用占位符#{}可以有效防止sql注入,在使用时不需要关心参数值的类型,mybatis会根据参数值的类型调用不同的statement设置参数值的方法。可以想象为:如果参数值是一个字符串则自动映射生成的sql中参数值两边自动有单引号,如果参数值是一个数字型则自动映射生成的sql中参数值两边没有单引号。
注意:当传递单个值时#{}中的参数名称通常和mapper接口的形参名称相同,也可以设置成任意值。
${}和#{}不同,${}是将参数值不加修饰的拼在sql中,相当中用jdbc的statement拼接sql,使用${}不能防止sql注入,但是有时用${}会非常方便,如下的例子:
如果本例子使用#{}则传入的字符串中必须有%号,而%是人为拼接在参数中,显然有点麻烦,如果采用${}在sql中拼接为%的方式则在调用mapper接口传递参数就方便很多。
//如果使用占位符号则必须人为在传参数中加%
List<User> list = userMapper.selectUserByName("%管理员%");
//如果使用${}原始符号则不用人为在参数中加%
List<User> list = userMapper.selectUserByName("管理员");
再比如order by排序,如果将列名通过参数传入sql,根据传的列名进行排序,应该写为:
ORDER BY ${columnName}
如果使用#{}将无法实现此功能。
注意:${}不能防止sql注入,对系统安全性有很大的影响,如果使用${}建议传入参数尽量不让用户自动填写,即使要用户填写也要对填写的数据进行校验,保证安全性。
另外,当传递单个值时${}中填写的参数名称经过测试填写value不错报。
传递pojo对象
Mybatis使用ognl表达式解析对象字段的值,如下例子:
上边大括号标注的是user对象中的字段名称。
测试:
public void testselectUserByUser()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件user对象 User user = new User(); user.setId(1); user.setUsername("管理员"); //传递user对象查询用户列表 Listlist = userMapper.selectUserByUser(user); //关闭session session.close(); }
异常测试:
Sql中字段名输入错误后测试,username输入dusername测试结果报错:
org.apache.ibatis.exceptions.PersistenceException: ### Error querying database. Cause: org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'dusername' in 'class cn.itcast.mybatis.po.User'### Cause: org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'dusername' in 'class cn.itcast.mybatis.po.User'
传递hashmap
Sql映射文件定义如下:
<!-- 传递hashmap综合查询用户信息 -->
<select id="selectUserByHashmap" parameterType="hashmap" resultType="user">
select * from user where id=#{id} and username like '%${username}%'
</select>
上边红色标注的是hashmap的key。
测试:
public void testselectUserByHashmap()throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); //构造查询条件Hashmap对象 HashMapmap = new HashMap (); map.put("id", 1); map.put("username", "管理员"); //传递Hashmap对象查询用户列表 List list = userMapper.selectUserByHashmap(map); //关闭session session.close(); }
异常测试:
传递的map中的key和sql中解析的key不一致。
测试结果没有报错,只是通过key获取值为空。
resultType(输出类型)
输出简单类型
参考getnow输出日期类型,看下边的例子输出整型:
Mapper.xml文件
Mapper接口
public int selectUserCount(User user) throws Exception;
调用:
public void testselectUserCount() throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获取mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); User user = new User(); user.setUsername("管理员"); //传递Hashmap对象查询用户列表 int count = userMapper.selectUserCount(user); //使用session实现 //int count = session.selectOne("cn.itcast.mybatis.mapper.UserMapper.selectUserCount", user); //关闭session session.close(); }
总结:
输出简单类型必须查询出来的结果集有一条记录,最终将第一个字段的值转换为输出类型。
使用session的selectOne可查询单条记录。
Sql片段
Sql中可将重复的sql提取出来,使用时用include引用即可,最终达到sql重用的目的,如下:
把where条件抽取出来:
and id=#{id} and username like '%${username}%'
使用include引用:
注意:如果引用其它mapper.xml的sql片段,则在引用时需要加上namespace,如下:
<include refid="namespace.sql片段”/>
resultMap
当输出pojo的字段和sql查询出来的字段名称不对应时而还想用这个pojo类作为输出类型这时就需要使用resultMap了。
另外,resultMap也解决了一对一关联查询、一对多关联查询等常见需求。
创建Person类:
public class Person { private int id; private String name;// 用户姓名,名称和User表的字段名称不一样 private String sex;// 性别 private Date birthday;// 出生日期 private String addr;// 地址,名称和User表的字段名称不一样 private String detail;// 详细信息 private Float score;// 成绩get/set。。。。
定义resultMap
在mapper.xml文件中定义resultMap:
<id />:此属性表示查询结果集的唯一标识,非常重要。如果是多个字段为复合唯一约束则定义多个<id />。
Property:表示person类的属性。
Column:表示sql查询出来的字段名。
Column和property放在一块儿表示将sql查询出来的字段映射到指定的pojo类属性上。
<result />:普通结果,即pojo的属性。
这里只将sql查询出来的字段与pojo属性名不一致的进行了定义,通过后边的测试pojo属性名和sql字段相同的自动进行映射。
Mapper.xml定义
使用resultMap指定上边定义的personmap。
Mapper接口定义
public ListselectUserListResultMap() throws Exception;
实际返回的类型是Person类型。
测试
public void testselectUserListResultMap() throws Exception{ //获取session SqlSession session = sqlSessionFactory.openSession(); //获限mapper接口实例 UserMapper userMapper = session.getMapper(UserMapper.class); User user = new User(); user.setUsername("管理员"); //查询用户列表返回resultMap Listlist = userMapper.selectUserListResultMap(); System.out.println(list); //关闭session session.close(); }