Mybatis的配置文件和映射文件具体解释

一、Mybatis的全局配置文件

1、SqlMapConfig.xml是mybatis的全局配置文件。配置内容例如以下：

properties（属性）

settings（全局配置參数）

typeAliases（类型别名）

typeHandlers（类型处理器）

objectFactory（对象工厂）

plugins（插件）

environments（环境集合属性对象）

--environment（环境子属性对象）

----transactionManager（事务管理）

----dataSource（数据源）

mappers（映射器）





2、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

<properties resource="db.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>

注意： MyBatis 将依照以下的顺序来载入属性：

首先在properties标签中指定的属性文件首先被读取。 

然后会读取properties元素中resource或 url 载入的属性，它会覆盖已读取的同名属性。

最后读取parameterType传递的属性，它会覆盖已读取的同名属性。

经常使用做法：

不要在properties元素体内加入不论什么属性值，仅仅将属性值定义在外部properties文件里。

在properties文件里定义属性名要有一定的特殊性。如：XXXXX.XXXXX.XXXX的形式，就像jdbc.driver。

这样能够防止和parameterType传递的属性名冲突，从而被覆盖掉。





3、settings

mybatis全局配置參数，全局參数将会影响mybatis的执行行为。比方：开启二级缓存、开启延迟载入。

详细可配置情况例如以下：





配置演示样例：

<settings>
<setting name="cacheEnabled" value="true"/>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="multipleResultSetsEnabled" value="true"/>
</settings>

4、typeAliases

typeAliases能够用来自己定义别名。在mapper.xml中。定义非常多的statement，而statement须要parameterType指定输入參数的类型、须要resultType指定输出结果的映射类型。

假设在指定类型时输入类型全路径，不方便进行开发，能够针对parameterType或resultType指定的类型定义一些别名。在mapper.xml中通过别名定义。方便开发。

比如：

<typeAliases>
	<!-- 单个别名定义 -->
	<typeAlias alias="user" type="com.kang.pojo.User"/>
	<!-- 批量别名定义。扫描整个包下的类，别名为类名（首字母大写和小写都能够） -->
	<package name="com.kang.pojo"/>
	<package name="其他包"/>
</typeAliases>

mapper.xml的引用形式

<select id="findUserById" parameterType="int" resultType="user">
		SELECT * FROM USER WHERE id=#{value}
</select>

5、typeHandlers

mybatis中通过typeHandlers完毕jdbc类型和java类型的转换。

通常情况下，mybatis提供的类型处理器满足日常须要。不须要自己定义。这里不作详述，详细可參考Mybatis的官方文档。





6、environments

MyBatis 能够配置多种环境。

这会帮助你将 SQL 映射应用于多种数据库之中。

可是要记得一个非常重要的问题：你能够配置多种环境，但每一个数据库相应一个 SqlSessionFactory。

所以，假设你想连接两个数据库，你须要创建两个 SqlSessionFactory 实例，每一个数据库相应一个。而假设是三个数据库。你就须要三个实例，以此类推。

为了明白创建哪种环境，你能够将它作为可选的參数传递给 SqlSessionFactoryBuilder。

能够接受环境配置的两个方法签名是：

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment);

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,environment,properties);

假设环境被忽略，那么默认环境将会被载入，依照例如以下方式进行：

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader);

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,properties);

配置演示样例：

<environments default="development">
		<environment id="development">
		<!-- 使用jdbc事务管理。事务控制由mybatis-->
			<transactionManager type="JDBC" />
		<!-- 数据库连接池。由mybatis管理-->
			<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>

注意:

---默认的环境 ID（比方： default=”development”）。

---每一个 environment 元素定义的环境 ID（比方： id=”development”）。

---事务管理器的配置（比方： type=”JDBC”）。

默认的环境和环境 ID 是自我解释的。你能够使用你喜欢的名称来命名，仅仅要确定默认

的要匹配当中之中的一个。





7、mappers

Mapper配置的几种方法：

第一种（经常使用）

<mapper resource=" " />

resource指向的是相对于类路径下的文件夹

如：<mapper resource="sqlmap/User.xml" />

另外一种

<mapper url=" " />

使用全然限定路径

如：<mapper url="file:///D:\workspace\mybatis1\config\sqlmap\User.xml" />

第三种

<mapper class=" " />

使用mapper接口类路径

如：<mapper class="cn.kang.mapper.UserMapper"/>

注意：此种方法要求mapper接口名称和mapper映射文件名同样，且放在同一个文件夹中。

第四种（推荐）

<package name=""/>

注冊指定包下的全部mapper接口

如：<package name="cn.kang.mapper"/>

注意：此种方法要求mapper接口名称和mapper映射文件名同样。且放在同一个文件夹中。

使用演示样例：

<mappers>
	<mapper resource="sqlmap/User.xml"/>
	<package name="cn.kang.mapper"/>
</mappers>

二、POJO的映射文件

Mapper.xml映射文件里定义了操作数据库的sql，每一个sql是一个statement，映射文件是mybatis的核心。

1、parameterType(输入类型)

通过parameterType指定输入參数的类型，类型能够是简单类型、hashmap、pojo的包装类型。

#{}实现的是向prepareStatement中的预处理语句中设置參数值，sql语句中#{}表示一个占位符即?。

比如：

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

使用占位符#{}能够有效防止sql注入，在使用时不须要关心參数值的类型，mybatis会自己主动进行java类型和jdbc类型的转换。#{}能够接收简单类型值或pojo属性值，假设parameterType传输单个简单类型值，#{}括号里能够是value或其他名称。

${}和#{}不同，通过${}能够将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换， ${}能够接收简单类型值或pojo属性值，假设parameterType传输单个简单类型值，${}括号里仅仅能是value。使用${}不能防止sql注入，可是有时用${}会很方便，例如以下的样例：

<select id="selectUserByName" parameterType="string" resultType="user">
	   select * from user where username like '%${value}%'
</select>

使用#{}则传入的字符串中必须有%号，而%是人为拼接在參数中，显然有点麻烦，假设採用${}在sql中拼接为%的方式则在调用mapper接口传递參数就方便非常多。

假设使用${}原始符号则必须人为在传參数中加%。

List<User> list = userMapper.selectUserByName("%管理员%");

假设使用%${value}%则不用人为在參数中加%。

List<User>list = userMapper.selectUserByName("管理员");





parameterType也能够传递pojo对象。

Mybatis使用ognl表达式解析对象字段的值，例如以下样例：

<!—传递pojo对象综合查询用户信息 -->
	<select id="findUserByUser" parameterType="user" resultType="user">
	   select * from user where id=#{id} and username like '%${username}%'
	</select>

上边%${username}%中的username就是user对象中相应的属性名称。

parameterType还能够传递pojo包装对象（也就是将多个对象包装为一个对象）。开发中通过pojo传递查询条件 ，查询条件是综合的查询条件，不仅包含用户查询条件还包含其他的查询条件（比方将用户购买商品信息也作为查询条件），这时能够使用包装对象传递输入參数。

比如以下的包装对象：

public class QueryVo {
	private User user;
	private UserCustom userCustom;
}

在映射文件里的使用

<!—传递pojo包装对象综合查询用户信息 -->
	<select id="findUserByUser" parameterType="queryVo" resultType="user">
	   select * from user where id=#{user.id} and username like '%${user.username}%'
	</select>

能够看出通过使用类似java中对象訪问属性的形式来进行參数传递。

parameterType也能够传递hashmap类型的參数

在xml映射文件里使用形式例如以下：

<select id="findUserByHashmap" parameterType="hashmap" resultType="user">
	   select * from user where id=#{id} and username like '%${username}%'
</select>

在代码中的调用形式例如以下：

Public void testFindUserByHashmap()throws Exception{
		//获取session
		SqlSession session = sqlSessionFactory.openSession();
		//获限mapper接口实例
		UserMapper userMapper = session.getMapper(UserMapper.class);
		//构造查询条件Hashmap对象
		HashMap<String, Object> map = new HashMap<String, Object>();
		map.put("id", 1);
		map.put("username", "管理员");

		//传递Hashmap对象查询用户列表
		List<User>list = userMapper.findUserByHashmap(map);
		//关闭session
		session.close();
}

这样，能够把參数以key-value的形式传给Mybatis。假设传递的map中的key和xml映射文件的sql语句中解析的key不一致，系统不会报错。可是通过key获取值为空。



2、resultType

使用resultType能够进行输出映射。仅仅有查询出来的列名和pojo中的属性名一致，才干够映射成功。

假设查询出来的列名和pojo中的属性名所有不一致。就不会创建pojo对象。可是仅仅要查询出来的列名和pojo中的属性有一个一致，就会创建pojo对象。

resultType能够输出简单类型。比如查询用户信息的综合查询列表总数。通过查询总数和上边用户综合查询列表才干够实现分页。

<!-- 获取用户列表总数 -->
	<select id="findUserCount" parameterType="user" resultType="int">
	   select count(*) from user
	</select>

resultType能够输出pojo对象和pojo列表。当使用动态代理时。输出pojo对象和输出pojo列表在xml映射文件里定义的resultType是一样的，而生成的动态代理对象中是依据mapper方法的返回值类型确定是调用selectOne(返回单个对象调用)还是selectList （返回集合对象调用 ）。

3、resultMap

mybatis中能够使用resultMap完毕高级输出结果映射。假设查询出来的列名和定义的pojo属性名不一致。就能够通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。然后使用resultMap作为statement的输出映射类型。resultMap能够实现将查询结果映射为复杂类型的pojo，比方在查询结果映射对象中包含pojo和list实现一对一查询和一对多查询。这里先不做详细详述，有兴趣的能够參看Mybatis的官方文档。