mybatis 的SqlMapConfig.xml和输出输入映射

最新推荐文章于 2019-07-28 11:01:24 发布

HELLO_Amour

最新推荐文章于 2019-07-28 11:01:24 发布

阅读量238

点赞数

分类专栏： mybatis

mybatis 专栏收录该内容

5 篇文章

订阅专栏

一 SqlMapConfig.xml

mybatis的全局配置文件SqlMapConfig.xml，配置内容如下：
properties（属性）
settings（全局配置参数）
typeAliases（类型别名）
typeHandlers（类型处理器）
objectFactory（对象工厂）
plugins（插件）
environments（环境集合属性对象）
environment（环境子属性对象）
transactionManager（事务管理）
dataSource（数据源）
mappers（映射器）

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/zhenai
jdbc.username=root
jdbc.password=root

在sqlMapConfig.xml加载属性文件

<configuration>
    <!--加载属性文件  -->
    <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>
    <mappers>
        <mapper resource="sqlmap/userMapper.xml"/>
        <mapper resource="sqlmap/userMapper2.xml"/>
    </mappers>
</configuration>

properties特性：

注意： MyBatis 将按照下面的顺序来加载属性：
在 properties 元素体内定义的属性首先被读取。
然后会读取properties 元素中resource或 url 加载的属性，它会覆盖已读取的同名属性。
最后读取parameterType传递的属性，它会覆盖已读取的同名属性。
建议：
不要在properties元素体内添加任何属性值，只将属性值定义在properties文件中。
在properties文件中定义属性名要有一定的特殊性，如：XXXXX.XXXXX.XXXX

2 settings全局参数配置

mybatis框架在运行时可以调整一些运行参数。
比如：开启二级缓存、开启延迟加载。。
全局参数将会影响mybatis的运行行为。
详细参见“学习资料/mybatis-settings.xlsx”文件

3 typeAliases（别名）重点
3.1 需求

在mapper.xml中，定义很多的statement，statement需要parameterType指定输入参数的类型、需要resultType指定输出结果的映射类型。
如果在指定类型时输入类型全路径，不方便进行开发，可以针对parameterType或resultType指定的类型定义一些别名，在mapper.xml中通过别名定义，方便开发。

3.2 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.3 自定义别名

在SqlMapConfig.xml中配置
配置顺序先后：(properties?, settings?, typeAliases?, typeHandlers?, objectFactory?, objectWrapperFactory?, reflectorFactory?, plugins?, environments?, databaseIdProvider?, mappers?)

<!--别名定义  -->
    <typeAliases>
        <!--针对单个别名定义
        type：类型的路径
        alias：别名  
        -->
        <typeAlias  alias="User" type="mybatis.po.User"/>
        <!-- 批量别名定义，扫描整个包下的类，别名为类名（首字母大写或小写都可以） -->
        <package name="mybatis.po"/>
        <package name="其它包"/>

    </typeAliases>

引用别名

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

4 typeHandlers（类型处理器）

mybatis中通过typeHandlers完成jdbc类型和java类型的转换。
通常情况下，mybatis提供的类型处理器满足日常需要，不需要自定义.
mybatis支持类型处理器：

类型处理器   Java类型  JDBC类型
BooleanTypeHandler      Boolean，boolean     任何兼容的布尔值
ByteTypeHandler         Byte，byte           任何兼容的数字或字节类型
ShortTypeHandler        Short，short         任何兼容的数字或短整型
IntegerTypeHandler      Integer，int         任何兼容的数字和整型
LongTypeHandler         Long，long           任何兼容的数字或长整型
FloatTypeHandler        Float，float         任何兼容的数字或单精度浮点型
DoubleTypeHandler       Double，double       任何兼容的数字或双精度浮点型
BigDecimalTypeHandler   BigDecimal          任何兼容的数字或十进制小数类型
StringTypeHandler       String              CHAR和VARCHAR类型
ClobTypeHandler         String              CLOB和LONGVARCHAR类型
NStringTypeHandler      String              NVARCHAR和NCHAR类型
NClobTypeHandler        String              NCLOB类型
ByteArrayTypeHandler    byte[]              任何兼容的字节流类型
BlobTypeHandler         byte[]              BLOB和LONGVARBINARY类型
DateTypeHandler         Date（java.util） TIMESTAMP类型
DateOnlyTypeHandler     Date（java.util） DATE类型
TimeOnlyTypeHandler     Date（java.util） TIME类型
SqlTimestampTypeHandler Timestamp（java.sql）TIMESTAMP类型
SqlDateTypeHandler      Date（java.sql）      DATE类型
SqlTimeTypeHandler      Time（java.sql）      TIME类型
ObjectTypeHandler       任意                  其他或未指定类型
EnumTypeHandler         Enumeration类型       VARCHAR-任何兼容的字符串类型，作为代码存储（而不是索引）。

5 mappers（映射配置）

5.1 通过resource加载单个映射文件

<mappers>
        <mapper resource="sqlmap/userMapper.xml"/>
        <mapper resource="sqlmap/userMapper2.xml"/>
</mappers>

5.2 通过mapper接口加载单个mapper

<!--通过mapper接口加载映射文件
        遵循一些规范：需要将mapper接口类名和mapper.xml映射文件名称保持一致，且在一个目录中
         上边规范的前提是：使用的是mapper代理方法 -->
         <mapper class="mybatis.mapper.UserMapper"/>

5.3 批量加载mapper(推荐使用)

        <!--批量加载mapper
         指定mapper接口的包名，mybatis自动扫描包下边所有mapper接口进行加载
        遵循一些规范：需要将mapper接口类名和mapper.xml映射文件名称保持一致，且在一个目录中
         上边规范的前提是：使用的是mapper代理方法 -->
        <mapper class="mybatis.mapper"/>

二输入映射

通过parameterType指定输入参数的类型，类型可以是简单类型、hashmap、pojo的包装类型
1 传递pojo的包装对象
需求

完成用户信息的综合查询，需要传入查询条件很复杂（可能包括用户信息、其它信息，比如商品、订单的）

定义包装类型pojo

针对上边需求，建议使用自定义的包装类型的pojo。
在包装类型的pojo中将复杂的查询条件包装进去。

public class UserCustom extends User{
}

public class UserQueryVo {
    private UserCustom userCustom;

    public UserCustom getUserCustom() {
        return userCustom;
    }

    public void setUserCustom(UserCustom userCustom) {
        this.userCustom = userCustom;
    }

}

mapper.xml

<!-- 用户信息综合查询
    #{userCustom.sex}:取出pojo包装对象中的性别值
    ${userCustom.username}:取出pojo包装对象中的用户名称
     -->
     <select id="findUserList" parameterType="mybatis.po.UserQueryVo" resultType="mybatis.po.UserCustom">
        select * from user where user.sex=#{userCustom.sex} and user.loginname like '%${userCustom.loginname}%'
     </select>

mapper.java

public interface UserMapper {
    public List<UserCustom> findUserList(UserQueryVo userQueryVo) throws Exception;
}

测试代码

@Test
    public void testFindUserLust() throws Exception{
        SqlSession sqlSession=sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);

        //创建包装对象，设置查询条件
        UserQueryVo userQueryVo=new UserQueryVo();
        UserCustom userCustom=new UserCustom();
        userCustom.setSex("男");
        userCustom.setLoginname("小明");
        userQueryVo.setUserCustom(userCustom);

        //调用userMapper方法
        List<UserCustom> list=userMapper.findUserList(userQueryVo);
        System.out.println(list);
    }

三输出映射

1 resultType

使用resultType进行输出映射，只有查询出来的列名和pojo中的属性名一致，该列才可以映射成功。
如果查询出来的列名和pojo中的属性名全部不一致，没有创建pojo对象。
只要查询出来的列名和pojo中的属性有一个一致，就会创建pojo对象。

1.1 输出简单类型
需求

用户信息的综合查询列表总数，通过查询总数和上边用户综合查询列表才可以实现分页。

mapper.xml

<!-- 用户信息综合查询
    parameterType:指定输入类型
    resultType：输出结果类型
    查询出来的结果集只有一行且一列，可以使用简单类型进行输出映射
     -->
     <select id="findUserCount" parameterType="mybatis.po.UserQueryVo" resultType="int">
        select * from user where user.sex=#{userCustom.sex} and user.loginname like '%${userCustom.loginname}%'
     </select>

mapper.java

public int findUserCount(UserQueryVo userQueryVo) throws Exception;

测试代码

@Test
    public void testFindUserCount() throws Exception{
        SqlSession sqlSession=sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
        //创建包装对象，设置查询条件
        UserQueryVo userQueryVo=new UserQueryVo();
        UserCustom userCustom=new UserCustom();
        userCustom.setSex("男");
        userCustom.setLoginname("小明");
        userQueryVo.setUserCustom(userCustom);
        //调用userMapper方法
        int count=userMapper.findUserCount(userQueryVo);
        System.out.println(count);
    }

1.2 输出pojo对象和pojo列表

不管是输出的pojo单个对象还是一个列表（list中包括pojo），在mapper.xml中 resultType指定的类型是一样的。
在mapper.java指定的方法返回值类型不一样：
1、输出单个pojo对象，方法返回值是单个对象类型
public User findUserById(int id) throws Exception;
2、输出pojo对象list，方法返回值是List
public List findUserList(UserQueryVo userQueryVo) throws Exception;
生成的动态代理对象中是根据mapper方法的返回值类型确定是调用selectOne(返回单个对象调用)还是selectList （返回集合对象调用）.

2 resultMap
mybatis中使用resultMap完成高级输出结果映射
2.1 resultMap使用方法

如果查询出来的列名和pojo的属性名不一致，通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。
1、定义resultMap
2、使用resultMap作为statement的输出映射类型

2.2 将下边的sql使用User完成映射

SELECT id id_,username username_ FROM USER WHERE id=#{value}
User类中属性名和上边查询列名不一致。

2.2.1 定义reusltMap

<!--定义resultMap
    将select uid id_,loginname loginname_ from user 和User类中的属性 作一个映射关系
     type：resultMap最终映射的Java对象类型，可以使用别名
     id：对resultMap的唯一标识
     -->
     <resultMap type="user" id="userResultMap">
        <!--id表示查询结果集中唯一标识
        column：查询出来的列名
        property:type指定的pojo类型中的属性名
        最终resultMap对column和property作一个映射关系（对应关系）
       -->
       <id column="id_" property="uid"/>
       <!--result:对普通名映射定义
       column：查询出来的列名
       property：type指定pojo类型中的属性名
        最终resultMap对column和property作一个映射关系（对应关系）
         -->
         <result column="loginname_" property="loginname"/>
     </resultMap>

2.2.2 使用resultMap作为statement的输出映射类型

<!--使用resultMap进行输出映射
        resultMap:指定定义的resultMap的id，如果这个resulMap在其他的mapper文件，前边需要加namespace
        -->
        <select id="findUserByIdResultMap" parameterType="int" resultMap="userResultMap">
            select uid id_,loginname loginname_ from user where uid=#{value}
        </select>

2.2.3 mapper.java

public User findUserByIdResultMap(int id) throws Exception;

2.2.4 测试

@Test
    public void testFindUserByIdResultMap() throws Exception{
        SqlSession sqlSession=sqlSessionFactory.openSession();
        //创建UserMapper对象，mybatis自动生成mapper代理对象
        UserMapper userMapper=sqlSession.getMapper(UserMapper.class);
        User user=userMapper.findUserByIdResultMap(1234285);

        System.out.println(user);
    }

3 小结