首页 > 资讯 > 其他 > 正文

Mapper映射文件进行详细说明

18-05-08 来源：[db:作者]

收藏我要投稿

紧接上文所述，在这篇文章中我将对Mapper映射文件进行详细的说明。

Mapper映射文件是一个xml格式文件，必须遵循相应的dtd文件规范，如ibatis-3-mapper.dtd。我们先大体上看看支持哪些配置？如下所示，从Eclipse里截了个屏：

从上图可以看出，映射文件是以作为根节点，在根节点中支持9个元素，分别为insert、update、delete、select（增删改查）;cache、cache-ref、resultMap、parameterMap、sql。

下文中，我们将首先对增删改进行描述，然后对查进行详细说明，最后对其他五个元素进行简单说明。

（1）insert、update、delete

我们先从配置文件看起：

   
 




    
      
      id="addUser"
      
      
      
      parameterType="user"
      
      
      
      flushCache="true"
      
      
      
      statementType="PREPARED"
      
      
      
      keyProperty=""
      
      
      
      keyColumn=""
      
      
      
      useGeneratedKeys="false"
      
      
      timeout="20">

上面给出了一个比较全面的配置说明，但是在实际使用过程中并不需要都进行配置，可根据自己的需要删除部分配置项。

在这里，我列举出我自己的配置文件，精简之后是这样的：

   


	
	
		insert into user(name,password,age) values(#{name},#{password},#{age, jdbcType=Integer})  
	
	
	
		delete from user where id = #{id}
	
	
	
		update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}

这里的parameterType设置成user是因为如果不设置的情况下，会自动将类名首字母小写后的名称，原来的类名为User。不过，建议大家还是使用typeAlias进行配置吧。唯一需要说明的就是元素里面的useGeneratedKeys和keyProperties属性，这两个属性是用来获取数据库中的主键的。

在数据库里面经常性的会给数据库表设置一个自增长的列作为主键，如果我们操作数据库后希望能够获取这个主键该怎么弄呢？正如上面所述，如果是支持自增长的数据库，如mysql数据库，那么只需要设置useGeneratedKeys和keyProperties属性便可以了，但是对于不支持自增长的数据库（如oracle）该怎么办呢？

mybatis里面在元素下面提供了子元素用于帮助解决这个问题。来看下配置：


        keyProperty="id"
        
        resultType="int"
        
        order="BEFORE"
        
        statementType="PREPARED">

针对不能使用自增长特性的数据库，可以使用下面的配置来实现相同的功能：


           
           
        
              select seq_user_id.nextval as id from dual
        
  
           insert into user(id, name, password, age, deleteFlag) 
               values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})

讲完了insert、update、delete，接下来我们看看用的比较多的select。

（2）select、resultType、resultMap

我们先来看看select元素都有哪些配置可以设置：

<select  
        <!--  1. id （必须配置）  
        id是命名空间中的唯一标识符，可被用来代表这条语句。   
        一个命名空间（namespace） 对应一个dao接口,   
        这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致  -->  
       
     id="findUserById"  
       
     <!-- 2. parameterType （可选配置, 默认为mybatis自动选择处理）  
        将要传入语句的参数的完全限定类名或别名， 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理  
        parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->  
     parameterType="int"  
       
     <!-- 3. resultType (resultType 与 resultMap 二选一配置)  
         resultType用以指定返回类型，指定的类型可以是基本类型，可以是java容器，也可以是javabean -->  
     resultType="User"  
       
     <!-- 4. resultMap (resultType 与 resultMap 二选一配置)  
         resultMap用于引用我们通过 resultMap标签定义的映射类型，这也是mybatis组件高级复杂映射的关键 -->  
     resultMap="userResultMap"  
       
     <!-- 5. flushCache (可选配置)  
         将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空，默认值：false -->  
     flushCache="false"  
       
     <!-- 6. useCache (可选配置)  
         将其设置为 true，将会导致本条语句的结果被二级缓存，默认值：对 select 元素为 true -->  
     useCache="true"  
       
     <!-- 7. timeout (可选配置)   
         这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）-->  
     timeout="10000"  
       
     <!-- 8. fetchSize (可选配置)   
         这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset（依赖驱动)-->  
     fetchSize="256"  
       
     <!-- 9. statementType (可选配置)   
         STATEMENT，PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement，默认值：PREPARED-->  
     statementType="PREPARED"  
       
     <!-- 10. resultSetType (可选配置)   
         FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个，默认值为 unset （依赖驱动）-->  
     resultSetType="FORWARD_ONLY">

我们还是从具体的示例来看看，

<select id="findUserById" resultType="User">  
    select * from user where id = #{id}  
</select>

这里我们根据用户id去查询这个用户的信息，resultType=User是一个别名，如果我们接触到的是这种一对一的问题，那么可以简单的定义一个实体，这个实体代表数据库表中的一条记录即可。但是如果我们遇到一对多的问题呢，就拿这里的查询用户信息来说，如果每个用户有各种兴趣，需要维护每个用户的兴趣信息，那么我们可能就存在下面的数据表结构：

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `password` varchar(255) NOT NULL,
  `age` int(3) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8;

CREATE TABLE `userinterests` (
  `userid` int(11) DEFAULT NULL,
  `interestid` int(11) DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

CREATE TABLE `interests` (
  `interestid` int(11) NOT NULL,
  `interestname` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`interestid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

其中user表用于记录用户信息，interests表用于维护所有的兴趣标签，而userinterests用于维护每个用户的兴趣情况。

这时候，如果我们需要根据用户id去查询用户的信息和兴趣信息该怎么做呢？这时候我们就要用到 select a.*,c.* from user as a right join userinterests as b on a.id = b.userid right join interests as c on b.interestid = c.interestid where id = #{id}

最后将这个映射文件添加到元素配置下：

或者

使用MyBatis-Spring-Boot-Starter依赖将会提供如下：

自动检测现有的DataSource
将创建并注册SqlSessionFactory的实例，该实例使用SqlSessionFactoryBean将该DataSource作为输入进行传递
将创建并注册从SqlSessionFactory中获取的SqlSessionTemplate的实例。

自动扫描您的mappers，将它们链接到SqlSessionTemplate并将其注册到Spring上下文，以便将它们注入到您的bean中。

就是说，使用了该Starter之后，只需要定义一个DataSource即可（application.properties中可配置），它会自动创建使用该DataSource的SqlSessionFactoryBean以及SqlSessionTemplate。会自动扫描你的Mappers，连接到SqlSessionTemplate，并注册到Spring上下文中。

spring.datasource.url = jdbc:mysql://localhost:3306/spring?useUnicode=true&characterEncoding=utf-8
spring.datasource.username = root
spring.datasource.password = root
spring.datasource.driver-class-name = com.mysql.jdbc.Driver

下面我们来写个测试代码来测试一下是否可以正常运行：

public class UserDaoTest3 {
	@Test
	public void testFindUserById(){
		SqlSession sqlSession = getSessionFactory().openSession(true);  
		UserDao2 userMapper = sqlSession.getMapper(UserDao2.class);  

		User2 user = userMapper.findUserById(10);  
		System.out.println("记录为："+user);

	}

	// Mybatis 通过SqlSessionFactory获取SqlSession, 然后才能通过SqlSession与数据库进行交互
	private static SqlSessionFactory getSessionFactory() {
		SqlSessionFactory sessionFactory = null;
		String resource = "configuration.xml";
		try {
			sessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader(resource));
		} catch (IOException e) {
			e.printStackTrace();
		}
		return sessionFactory;
	}
}

运行代码后，我们可以看到成功啦！

（3）sql

sql元素的意义，在于我们可以定义一串SQL语句，其他的语句可以通过引用它而达到复用它的目的。

<sql id="Base_Column_List">  
    id, title, author, publishDate, newsKey, content, detailUrl, newsType, status, createTime, updateTime  
</sql>  
      
<select id="getAll" resultMap="BaseResultMap">  
    SELECT  
    <include refid="Base_Column_List"></include>  
    FROM  
        osmcs_news  
</select>

点击复制链接与好友分享!回本站首页