MyBatis框架-XML映射器

文章目录

XML映射器

MyBatis 的真正强大在于它的语句映射,这是它的魔力所在。由于它的异常强大,映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比,你会立即发现省掉了将近 95% 的代码。MyBatis 致力于减少使用成本,让用户能更专注于 SQL 代码。

SQL 映射文件只有很少的几个顶级元素(按照应被定义的顺序列出):

  • cache -- 该命名空间的缓存配置。
  • cache-ref -- 引用其它命名空间的缓存配置。
  • resultMap -- 描述如何从数据库结果集中加载对象,是最复杂也是最强大的元素。
  • parameterMap -- 老式风格的参数映射。此元素已被废弃,并可能在将来被移除!请使用行内参数映射。文档中不会介绍此元素。
  • sql -- 可被其它语句引用的可重用语句块。
  • insert -- 映射插入语句。
  • update -- 映射更新语句。
  • delete -- 映射删除语句。
  • select -- 映射查询语句。

CRUD操作

select

查询语句是 MyBatis 中最常用的元素之一------光能把数据存到数据库中价值并不大,还要能重新取出来才有用,多数应用也都是查询比修改要频繁。 MyBatis 的基本原则之一是:在每个插入、更新或删除操作之间,通常会执行多个查询操作。因此,MyBatis 在查询和结果映射做了相当多的改进。一个简单查询的 select 元素是非常简单的。

根据id查询用户
java 复制代码
public interface UserMapper {
    //查询user表数据
    List<User> selectUser();

    //根据id查询用户
    User selectUserById(int id);

}

UserMapper.xml

xml 复制代码
<!--
	id : 与mapper层的接口做映射
	parameterType : 参数类型
	resultType : 返回的类型对象
-->
<select id="selectUserById" resultType="com.sin.pojo.User" parameterType="int">
    select * from user where id = #{id}
</select>

#{id}告诉 MyBatis 创建一个预处理语句(PreparedStatement)参数,在 JDBC 中,这样的一个参数在 SQL 中会由一个"?"来标识,并被传递到一个新的预处理语句中,

类似于

java 复制代码
// 近似的 JDBC 代码,非 MyBatis 代码...
String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
PreparedStatement ps = conn.prepareStatement(selectPerson);
ps.setInt(1,id);

测试用例

java 复制代码
@Test
public void selectUserById(){
    SqlSession session = MyBatisUtil.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    System.out.println(mapper.selectUserById(2));
}
根据名字和密码查询
方法一:使用对象
UserMapper.java
  • 参数传入对象
java 复制代码
//根据用户名和密码查询
User findByUserAndPwd(User user);
UserMapper.xml
java 复制代码
<select id="findByUserAndPwd" resultType="com.sin.pojo.User" parameterType="com.sin.pojo.User">
    select * from user where name = #{name} and pwd = #{pwd}
</select>
测试用例
java 复制代码
@Test
public void selectByUserAndPwd(){
    SqlSession session = MyBatisUtil.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    User user = new User();
    user.setName("张三");
    user.setPwd("321321");
    System.out.println(mapper.findByUserAndPwd(user));

}
方法二:使用Map
UserMapper.java
java 复制代码
//根据用户名和密码查询
User findByUserAndPwd2(Map<String,Object> map);
UserMapper.xml
xml 复制代码
<select id="findByUserAndPwd2" resultType="com.sin.pojo.User"
        parameterType="java.util.Map">
    select * from user where name = #{name} and pwd = #{pwd}
</select>
测试用例
java 复制代码
@Test
public void selectByUserAndPwd2(){
    SqlSession session = MyBatisUtil.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    Map<String,Object> map = new HashMap<>();
    map.put("name","张三");
    map.put("pwd","321321");
    System.out.println(mapper.findByUserAndPwd2(map));

}
方法三:方法种传递参数
UserMapper.java
  • 在接口方法的参数前加@Param属性
  • Sql语句编写的时候,直接取@Param中设置的值即可,不需要单独设置参数类型
java 复制代码
//根据用户名和密码查询
User findByUserAndPwd3(@Param("username") String username, @Param("pwd") String pwd);
UserMapper.xml
java 复制代码
<select id="findByUserAndPwd3" resultType="com.sin.pojo.User">
     select * from user where name = #{username} and pwd = #{pwd}
</select>
测试用例
java 复制代码
@Test
public void selectByUserAndPwd3(){
    System.out.println(mapper.findByUserAndPwd3("张三","321321"));
}
java 复制代码
<select
  id="selectPerson"
  parameterType="int"
  parameterMap="deprecated"
  resultType="hashmap"
  resultMap="personResultMap"
  flushCache="false"
  useCache="true"
  timeout="10"
  fetchSize="256"
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">

Select 元素的属性

属性 描述
id 在命名空间中唯一的标识符,可以被用来引用这条语句。
parameterType 将会传入这条语句的参数的类全限定名或别名。这个属性是可选的,因为 MyBatis 可以通过类型处理器(TypeHandler)推断出具体传入语句的参数,默认值为未设置(unset)。
parameterMap 用于引用外部 parameterMap 的属性,目前已被废弃。请使用行内参数映射和 parameterType 属性。
resultType 期望从这条语句中返回结果的类全限定名或别名。 注意,如果返回的是集合,那应该设置为集合包含的类型,而不是集合本身的类型。 resultType 和 resultMap 之间只能同时使用一个。
resultMap 对外部 resultMap 的命名引用。结果映射是 MyBatis 最强大的特性,如果你对其理解透彻,许多复杂的映射问题都能迎刃而解。 resultType 和 resultMap 之间只能同时使用一个。
flushCache 将其设置为 true 后,只要语句被调用,都会导致本地缓存和二级缓存被清空,默认值:false。
useCache 将其设置为 true 后,将会导致本条语句的结果被二级缓存缓存起来,默认值:对 select 元素为 true。
timeout 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为未设置(unset)(依赖数据库驱动)。
fetchSize 这是一个给驱动的建议值,尝试让驱动程序每次批量返回的结果行数等于这个设置值。 默认值为未设置(unset)(依赖驱动)。
statementType 可选 STATEMENT,PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。
resultSetType FORWARD_ONLY,SCROLL_SENSITIVE, SCROLL_INSENSITIVE 或 DEFAULT(等价于 unset) 中的一个,默认值为 unset (依赖数据库驱动)。
databaseId 如果配置了数据库厂商标识(databaseIdProvider),MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句;如果带和不带的语句都有,则不带的会被忽略。
resultOrdered 这个设置仅针对嵌套结果 select 语句:如果为 true,则假设结果集以正确顺序(排序后)执行映射,当返回新的主结果行时,将不再发生对以前结果行的引用。 这样可以减少内存消耗。默认值:false
resultSets 这个设置仅适用于多结果集的情况。它将列出语句执行后返回的结果集并赋予每个结果集一个名称,多个名称之间以逗号分隔。
insert
给数据库增加一个用户
UserMapper.java
java 复制代码
//添加一条用户
int addUser(User user);
UserMapper.xml
java 复制代码
<insert id="addUser" parameterType="com.sin.pojo.User">
    insert into  user(id,name,pwd) values (#{id},#{name},#{pwd})
</insert>
测试用例
java 复制代码
@Test
public void addUser(){
    SqlSession session = MyBatisUtil.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    User user = new User(5,"王五","123456");
    System.out.println(mapper.addUser(user));
    session.commit();//提交事务,重点!不写的话不会提交到数据库
}
update

修改用户的信息

UserMapper.java
java 复制代码
//修改一个用户
int updateUser(User user);
UserMapper.xml
xml 复制代码
<update id="updateUser" parameterType="com.sin.pojo.User">
    update user set name = #{name},pwd = #{pwd} where id = #{id}
</update>
测试用例
java 复制代码
@Test
public void testUpdateUser(){
    SqlSession session = MyBatisUtil.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    User user = mapper.selectUserById(1);
    user.setName("赵六");
    user.setPwd("123456");
    int i = mapper.updateUser(user);
    System.out.println(mapper.selectUserById(1));
    session.commit();//提交事务,
    session.close();
}
delete

根据id删除一个用户

UserMapper.java
java 复制代码
//根据id删除用户
int deleteUserById(int id);
UserMapper.xml
xml 复制代码
<delete id="deleteUserById" parameterType="com.sin.pojo.User">
    delete  from user where id = #{id};
</delete>
测试用例
java 复制代码
@Test
public void deleteUesrById(){
    SqlSession session = MyBatisUtil.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    System.out.println(mapper.deleteUserById(5));
    session.commit();//提交事务,
    List<User> users = mapper.selectUser();
    for (User user: users){
        System.out.println(user);
    }

    session.close();
}
xml 复制代码
<insert
  id="insertAuthor"
  parameterType="com.sin.pojo.User"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  timeout="20">

<update
  id="updateAuthor"
  parameterType="com.sin.pojo.User"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

<delete
  id="deleteAuthor"
  parameterType="com.sin.pojo.User"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

Insert, Update, Delete 元素的属性

属性 描述
id 在命名空间中唯一的标识符,可以被用来引用这条语句。
parameterType 将会传入这条语句的参数的类全限定名或别名。这个属性是可选的,因为 MyBatis 可以通过类型处理器(TypeHandler)推断出具体传入语句的参数,默认值为未设置(unset)。
parameterMap 用于引用外部 parameterMap 的属性,目前已被废弃。请使用行内参数映射和 parameterType 属性。
flushCache 将其设置为 true 后,只要语句被调用,都会导致本地缓存和二级缓存被清空,默认值:(对 insert、update 和 delete 语句)true。
timeout 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为未设置(unset)(依赖数据库驱动)。
statementType 可选 STATEMENT,PREPARED 或 CALLABLE。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。
useGeneratedKeys (仅适用于 insert 和 update)这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键(比如:像 MySQL 和 SQL Server 这样的关系型数据库管理系统的自动递增字段),默认值:false。
keyProperty (仅适用于 insert 和 update)指定能够唯一识别对象的属性,MyBatis 会使用 getGeneratedKeys 的返回值或 insert 语句的 selectKey 子元素设置它的值,默认值:未设置(unset)。如果生成列不止一个,可以用逗号分隔多个属性名称。
keyColumn (仅适用于 insert 和 update)设置生成键值在表中的列名,在某些数据库(像 PostgreSQL)中,当主键列不是表中的第一列的时候,是必须设置的。如果生成列不止一个,可以用逗号分隔多个属性名称。
databaseId 如果配置了数据库厂商标识(databaseIdProvider),MyBatis 会加载所有不带 databaseId 或匹配当前 databaseId 的语句;如果带和不带的语句都有,则不带的会被忽略。

selectKey

xml 复制代码
<selectKey
  keyProperty="id"
  resultType="int"
  order="BEFORE"
  statementType="PREPARED">

selectKey元素属性

属性 描述
keyProperty selectKey 语句结果应该被设置到的目标属性。如果生成列不止一个,可以用逗号分隔多个属性名称。
keyColumn 返回结果集中生成列属性的列名。如果生成列不止一个,可以用逗号分隔多个属性名称。
resultType 结果的类型。通常 MyBatis 可以推断出来,但是为了更加准确,写上也不会有什么问题。MyBatis 允许将任何简单类型用作主键的类型,包括字符串。如果生成列不止一个,则可以使用包含期望属性的 Object 或 Map。
order 可以设置为 BEFOREAFTER。如果设置为 BEFORE,那么它首先会生成主键,设置 keyProperty 再执行插入语句。如果设置为 AFTER,那么先执行插入语句,然后是 selectKey 中的语句 - 这和 Oracle 数据库的行为相似,在插入语句内部可能有嵌入索引调用。
statementType 和前面一样,MyBatis 支持 STATEMENTPREPAREDCALLABLE 类型的映射语句,分别代表 Statement, PreparedStatementCallableStatement 类型。
相关推荐
络71 小时前
Spring14——案例:利用AOP环绕通知计算业务层接口执行效率
java·后端·spring·mybatis·aop
IvorySQL10 小时前
济南站活动回顾|IvorySQL中的Oracle XML函数使用示例及技术实现原理
xml·数据库·sql·postgresql·oracle·开源
企业码道刘某12 小时前
EasyExcel 大数据量导入导出解决方案进阶
java·后端·mybatis
计算机学姐13 小时前
基于微信小程序的调查问卷管理系统
java·vue.js·spring boot·mysql·微信小程序·小程序·mybatis
小徐敲java1 天前
通用mybatis-plus查询封装(QueryGenerator)
mybatis
OEC小胖胖1 天前
Spring Boot + MyBatis 项目中常用注解详解(万字长篇解读)
java·spring boot·后端·spring·mybatis·web
计算机学姐1 天前
基于SpringBoot+Vue的在线投票系统
java·vue.js·spring boot·后端·学习·intellij-idea·mybatis
落落落sss1 天前
MybatisPlus
android·java·开发语言·spring·tomcat·rabbitmq·mybatis
海绵波波1071 天前
Qt操作主/从视图及XML——实例:汽车管理系统
xml·qt·汽车
罗曼蒂克在消亡1 天前
2.3MyBatis——插件机制
java·mybatis·源码学习