mybatis-02-Mapper代理&SqlMapConfig.xml全局配置文件

一、概要

1、原始DAO开发中存在的问题:
（1）DAO实现方法体中存在很多过程性代码。
（2）调用SqlSession的方法(select/insert/update)需要指定Statement的id，存在硬编码，不利于代码维护。

2、Mapper动态代理方法：程序员只需要写dao接口(Mapper)，而不需要写dao实现类，由mybatis根据dao接口和映射文件中statement的定义生成接口实现类代理对象。

3、目标：通过一些规则让mybatis根据dao接口和映射文件中statement的定义生成接口实现代理对象。

二、开发规范

1、在XXXmapper.xml中namespace等于mapper接口地址（即mapper.xml文件中的namespace与mapper.java接口的类路径相同）。

2、XXXmapper.java接口中的方法和mapper.xml中的statement的Id一致。
3、mapper.java接口中的方法输入参数和mapper.xml中statement的parameterType指定的类型一致。
4、mapper.java接口中的方法的返回值类型和mapper.xml中statement的resultType指定的类型一致。

注：以上的开发规范主要是对下面的代码进行统一生成

SqlSession sqlSession = sqlSessionFactory.openSession();
User user = sqlSession.selectOne("test.findUserById", id);　
......

 三、UserMapper.java类代码（接口文件）

package com.mybatis.mapper;

import java.util.List;

import com.mybatis.entity.User;

/**
 * 用户管理mapper接口
 * @author lxx
 *
 */
public interface UserMapper {
    
    /** 根据ID查询用户信息 */
    public User findUserById(int id);

    /** 根据用户名称模糊查询用户信息 */
    public List findUserByName(String username);

    /** 添加用户 */
    public void insertUser(User user);

    /** 根据ID删除用户 */
    public void deleteUser(Integer id);

    /** 根据ID更新用户 */
    public void updateUser(User user);

}

四、将原来的User.xml拷贝并修改名称为UserMapper.xml，再将UserMapper.xml文件中的namespace改为mapper接口地址

 
<mapper namespace="com.mybatis.mapper.UserMapper">

注：namespace=mapper接口地址
五、在SqlMapConfig.xml中加载UserMapper.xml

    <mappers>
        <mapper resource="com/mybatis/mapping/User.xml"/>
        <mapper resource="com/mybatis/mapping/UserMapper.xml"/>
    mappers>

六、JUnit测试UserMapperTest.java

package com.mybatis.test;

import java.io.InputStream;
import java.util.Date;
import java.util.List;

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.Before;
import org.junit.Test;

import com.mybatis.entity.User;
import com.mybatis.mapper.UserMapper;

public class UserMapperTest {

    private SqlSessionFactory sqlSessionFactory;

    // 此方法是在执行@Test标注的方法之前执行
    @Before
    public void setUp() throws Exception {
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        // 创建SqlSessionFcatory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }
    
    @Test
    public void testFindUserById() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.findUserById(1);
        System.out.println(user);
        sqlSession.close();
    }

    @Test
    public void testFindUserByName() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List list = mapper.findUserByName("小");
        System.out.println(list);
        sqlSession.close();
    }
    
    @Test
    public void testInsertUser() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        User user = new User();
        user.setUsername("小东");
        user.setSex("1");
        user.setAddress("天津");
        user.setBirthday(new Date());
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        mapper.insertUser(user);
        sqlSession.commit();
        sqlSession.close();
    }
    
    @Test
    public void testUpdateUser() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        User user = new User();
        user.setId(2);//必须设置Id
        user.setUsername("小刘");
        user.setSex("1");
        user.setAddress("北京海淀");
        user.setBirthday(new Date());
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        mapper.updateUser(user);
        sqlSession.commit();
        sqlSession.close();
    }
    
    @Test
    public void testDeleteUser() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        mapper.deleteUser(3);
        sqlSession.commit();
        sqlSession.close();
    }

}

     原来这个sqlSession可以自动创建一个mapper接口的代理对象！我们只需要把刚刚写好的mapper接口类的字节码对象传给getMapper方法，即可得到一个该接口对应的代理对象，然后我们就可以使用这个代理对象来操作接口中具体的方法了。 
　　到这里，使用mapper代理的方式开发dao就总结完了，但是有个小细节，由于mapper接口中方法的参数要根据映射文件中的parameterType来指定，而parameterType只有一个，所以mapper接口中所有方法的参数都只有一个！那如果我们要传入两个或多个参数该咋整？这没办法，想要传多个参数还是死了这条心了吧，但是可以解决这个问题，就是对传入的对象进行增强，让传进去的对象包含我们需要的参数即可。这算是个小弊端吧，但是不会影响我们开发。

七、小结

1、用mapper代理开发时只要写2个：

（1）mapper.xml

（2）mapper接口

2、Mapper接口开发需要遵循以下规范：

（1）Mapper.xml文件中的namespace与mapper接口的类路径相同。
（2）Mapper接口方法名和Mapper.xml中定义的每个statement的id相同。 
（3）Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同。
（4）Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同。

3、代理对象内部调用selectOne()和selectList():

如果mapper对象返回单个pojo对象(非集合对象)代理对象内部通过selectOne查询数据库，如果mapper方法返回集合对象，代理对象内部通过selectList查询数据库。

4、mapper接口中的方法参数只能有一个是否影响系统开发，mapper接口方法参数只能有一个，系统是否不利于维护？

回答：系统框架中，dao层的代码是被业务层公用的。mapper接口只有一个参数，可以使用包装类型的pojo满足不同的业务方法的需求。

  经过上两篇博文的总结，对mybatis中的dao开发方法和流程基本掌握了，这一节主要来总结一下mybatis中的全局配置文件SqlMapConfig.xml在开发中的一些常用配置，首先看一下该全局配置文件中都有哪些可以配置的东西：

配置内容	作用
	用来加载属性文件
	用来设置全局参数
	用来设置类型的别名
	用来设置类型处理器
	用来设置对象工厂
	用来设置插件
	用来设置mybatis的环境
	用来配置映射文件

 

 

 

 

 

 

 

 

 

      从前面的博文中可以看出，是用来配置mybatis的环境的，在和Spring整合前是由mybatis自己管理的，但是和Spring整合后，这些配置都将被废弃掉，部分在前面已经有提到过，这里就不再赘述了。然后objectFactory和plugins一般我们不用，所以在这里就不总结了，类型处理器是mybatis中用来完成jdbc类型和java类型之间转换的，mybatis默认支持的类型处理器基本够我们使用了，一般不需要自定义。这篇博文主要来总结一下剩下的几个配置的用法。

1、properties属性

作用：将数据连接单独配置在db.properties中，只需要在SqlMapConfig.xml中加载db.properties的属性值，在SqlMapConfig.xml中就不需要对数据库连接参数进行硬编码。数据库连接参数只配置在db.properties中，方便对参数进行统一管理，其它xml可以引用该db.properties。

db.properties的内容：

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.username=root
jdbc.password=root

在SqlMapConfig.xml中加载db.properties

<properties resource="db.properties">
        
        
    properties>
    
    <environments default="development">
        <environment id="development">
        
            <transactionManager type="JDBC" />
        
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}" />
                <property name="url" value="${jdbc.url}" />
                <property name="username" value="${jdbc.username}" />
                <property name="password" value="${jdbc.password}" />
            dataSource>
        environment>
    environments>

properties特性：
注意：
   （1）在properties元素体内定义的属性优先读取。
   （2）然后读取properties元素中resource或url加载的属性，它会覆盖已读取的同名属性。
   （3）最后读取parameterType传递的属性，它会覆盖已读取的同名属性。
建议：
　（1）不要在properties元素体内添加任何属性值，只将属性值定义在properties文件中。
   （2）在properties文件中定义属性名要有一定的特殊性，如xxxx.xxxx(jdbc.driver)。

2、settings全局参数设置

mybatis框架运行时可以调整一些运行参数。比如，开启二级缓存，开启延迟加载等等。全局参数会影响mybatis的运行行为。

　　　　　　　　　　　　　　　　　　　　　　　　　　mybatis-settings的配置属性以及描述

setting(设置)	Description(描述)	valid　Values(验证值组)	Default(默认值)
cacheEnabled	在全局范围内启用或禁用缓存配置 任何映射器在此配置下。	true | false	TRUE
lazyLoadingEnabled	在全局范围内启用或禁用延迟加载。禁用时，所有相关联的将热加载。	true | false	TRUE
aggressiveLazyLoading	启用时，有延迟加载属性的对象将被完全加载后调用懒惰的任何属性。否则，每一个属性是按需加载。	true | false	TRUE
multipleResultSetsEnabled	允许或不允许从一个单独的语句（需要兼容的驱动程序）要返回多个结果集。	true | false	TRUE
useColumnLabel	使用列标签，而不是列名。在这方面，不同的驱动有不同的行为。参考驱动文档或测试两种方法来决定你的驱动程序的行为如何。	true | false	TRUE
useGeneratedKeys	允许JDBC支持生成的密钥。兼容的驱动程序是必需的。此设置强制生成的键被使用，如果设置为true，一些驱动会不兼容性，但仍然可以工作。	true | false	FALSE
autoMappingBehavior	指定MyBatis的应如何自动映射列到字段/属性。NONE自动映射。 PARTIAL只会自动映射结果没有嵌套结果映射定义里面。 FULL会自动映射的结果映射任何复杂的（包含嵌套或其他）。	NONE,PARTIAL,FULL	PARTIAL
defaultExecutorType	配置默认执行人。SIMPLE执行人确实没有什么特别的。 REUSE执行器重用准备好的语句。 BATCH执行器重用语句和批处理更新。	SIMPLE,REUSE,BATCH	SIMPLE
safeRowBoundsEnabled	允许使用嵌套的语句RowBounds。	true | false	FALSE
mapUnderscoreToCamelCase	从经典的数据库列名A_COLUMN启用自动映射到骆驼标识的经典的Java属性名aColumn。	true | false	FALSE
localCacheScope	MyBatis的使用本地缓存，以防止循环引用，并加快反复嵌套查询。默认情况下（SESSION）会话期间执行的所有查询缓存。如果localCacheScope=STATMENT本地会话将被用于语句的执行，只是没有将数据共享之间的两个不同的调用相同的SqlSession。	SESSION STATEMENT	SESSION
dbcTypeForNull	指定为空值时，没有特定的JDBC类型的参数的JDBC类型。有些驱动需要指定列的JDBC类型，但其他像NULL，VARCHAR或OTHER的工作与通用值。	JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER	OTHER
lazyLoadTriggerMethods	指定触发延迟加载的对象的方法。	A method name list separated by commas	equals,clone,hashCode,toString
defaultScriptingLanguage	指定所使用的语言默认为动态SQL生成。	A type alias or fully qualified class name.	org.apache.ibatis.scripting.xmltags .XMLDynamicLanguageDriver
callSettersOnNulls	指定如果setter方法​​或地图的put方法时，将调用检索到的值是null。它是有用的，当你依靠Map.keySet（）或null初始化。注意原语（如整型，布尔等）不会被设置为null。	true | false	FALSE
logPrefix	指定的前缀字串，MyBatis将会增加记录器的名称。	Any String	Not set
logImpl	指定MyBatis的日志实现使用。如果此设置是不存在的记录的实施将自动查找。	SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING	Not set
proxyFactory	指定代理工具，MyBatis将会使用创建懒加载能力的对象。	CGLIB | JAVASSIST	CGLIB

官方文档settings的例子：

<setting name="cacheEnabled" value="true"/>
    <setting name="lazyLoadingEnabled" value="true"/>
    <setting name="multipleResultSetsEnabled" value="true"/>
    <setting name="useColumnLabel" value="true"/>
    <setting name="useGeneratedKeys" value="false"/>
    <setting name="autoMappingBehavior" value="PARTIAL"/>
    <setting name="defaultExecutorType" value="SIMPLE"/>
    <setting name="defaultStatementTimeout" value="25"/>
    <setting name="safeRowBoundsEnabled" value="false"/>
    <setting name="mapUnderscoreToCamelCase" value="false"/>
    <setting name="localCacheScope" value="SESSION"/>
    <setting name="jdbcTypeForNull" value="OTHER"/>
    <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
settings>

3、typeAiases(别名)——重点掌握

      这是配置中的一个重点，我们知道，在mapper.xml中，定义很多的statement，statement需要parameterType指定输入参数的类型、需要resultType指定输出结果的映射类型。如果在指定类型时输入类型全路径，有时候会很长，不方便进行开发，那么我们就可以针对parameterType或resultType指定的类型定义一些别名，在mapper.xml中通过别名来定义，方便开发。

3.1、Mybatis默认支持的别名

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

3.2、自定义别名

3.2.1、单个别名定义（在SqlMapConfig.xml）

上面讲的是Mybatis默认支持的一些别名，但是针对pojo的需要我们就要自定义别名了，比如我们将自己定义的User对象取个别名为user，如下：

<typeAliases><typeAlias type="com.mybatis.entity.User" alias="user"/>typeAliases>

UserMapper.xml中引用别名（输入参数或者输出结果为com.mybatis.entity.User时，就可以用user来代替了）：

<select id="findUserById" parameterType="int" resultType="user" >
    　　select * from t_user where id=#{id}
select>

3.2.2、批量定义别名（常用）

但是问题来了，如果工程中有很多pojo，那岂不是要一个一个定义……这得定义多少个啊，所以mybatis帮我们解决了这个问题，它提供了批量别名的定义，如下：

<typeAliases>
      <package name="com.mybatis.entity"/>
      <package name="其它包"/>
typeAliases>

这就爽了，如果进行了上面这样设置，那么所有放在com.mybatis.entity包下的pojo都可以不用定义了，直接使用类名就可以了，所以我们直接使用user即可。毫无疑问，开发中肯定使用这个批量的别名定义。

4、mappers（映射配置）

4.1、通过resource加载单个映射文件

    <mappers>
    
        <mapper resource="sqlmap/User.xml"/>
        <mapper resource="mapper/UserMapper.xml"/>
    mappers>

4.2、通过mapper接口加载单个映射文件

<mapper class="com.mybatis.mapper.UserMapper"/> 

按照上边的规范，将mapper.java和mapper.xml放在一个目录，且同名。

4.3、批量加载mapper（推荐使用）

但是还是有个弊端，就跟上面那个别名的配置一样，如果现在有好多个mapper怎么办，所以mybatis也给我们提供了批量加载方法：我们只要指定mapper接口的包名，mybatis自动扫描包下面所有的mapper接口进行加载。当然，还是要遵循上面的那个规范。配置如下：

<package name="com.mybatis.mapper"/> 

这样com.mybatis.mapper包下的所有mapper.xml映射文件都可以加载了，这就更加简洁了。在开发中推荐使用这种批量加载映射文件的方法。

关于SqlMapConfig.xml文件中的配置就总结这么多吧~