Mybatis的配置文件和映射文件详解

最新推荐文章于 2024-05-30 19:54:10 发布

禅悟刂

最新推荐文章于 2024-05-30 19:54:10 发布

阅读量2.8k

点赞数 2

分类专栏： ssm 文章标签： mybatis

本文链接：https://blog.csdn.net/weixin_42575310/article/details/100522078

版权

ssm 专栏收录该内容

10 篇文章 0 订阅

订阅专栏

一、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。
使用示例：

jdbc.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///test
jdbc.name=root
jdbc.pwd=123456

相应的SqlMapConfig.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<properties resource="jdbc.properties"></properties>
	<!-- 别名配置 -->
	<typeAliases>
		<package name="com.sumeng.modle"/>
	</typeAliases>
	<environments default="development">
		<environment id="development">
			<!-- 使用jdbc事务管理 -->
			<transactionManager type="JDBC" />
			<!-- 数据库连接池 -->
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.name}" />
				<property name="password" value="${jdbc.pwd}" />
			</dataSource>
		</environment>
	</environments>
	<mappers>
		<mapper resource="com/sumeng/mapper/User.xml"/>
		<mapper resource="com/sumeng/mapper/UserInfoMapper.xml" /> 
		<!-- <package name="com.sumeng.mapper"/> -->
	</mappers>
</configuration>

注意： 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的引用形式

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
	PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.sumeng.mapper.UserInfoMapper">
	<select id="findUserNameAndPwd" resultType="User">
		select * from user where name=#{name} and age=#{age}
	</select>
	<select id="findUserNameMap" parameterType="map" resultType="User">
		select * from user where name= #{userName} 
	</select>
	<select id="findUserById" parameterType="int" resultType="map">
		select * from user where id= #{id} 
	</select>
</mapper>

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事务管理 -->
			<transactionManager type="JDBC" />
			<!-- 数据库连接池 -->
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.name}" />
				<property name="password" value="${jdbc.pwd}" />
			</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>

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

parameterType还可以传递pojo包装对象（也就是将多个对象包装为一个对象）。开发中通过pojo传递查询条件，查询条件是综合的查询条件，不仅包括用户查询条件还包括其它的查询条件（比如将用户购买商品信息也作为查询条件），这时可以使用包装对象传递输入参数。
例如下面的包装对象：

public class User {
	private int id;
	private String name;
	private String age;
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getAge() {
		return age;
	}
	public void setAge(String age) {
		this.age = age;
	}
	@Override
	public String toString() {
		return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
	}

}

在映射文件中的使用

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
	PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 这个映射配置文件需要写  对User表进行数据操作的SQL语句 -->
<mapper namespace="user">
	<!-- 查询语句 -->
	<select id="queryUserById" parameterType="int" resultType="User">
		select * from user where id = #{id}
	</select>
	<!-- 查询全部语句 -->
	<select id="queryUserList" resultType="com.sumeng.modle.User">
		select * from user 
	</select>
	<!-- 模糊查询 -->
	<select id="queryUserLikeName" parameterType="String" resultType="User">
		select * from user where name like #{name}
	</select>
	<!-- 修改语句 -->
	<update id="updateUser" parameterType="com.sumeng.modle.User">
		update user set name=#{name},age=#{age} where id=#{id}
	</update>
	<!-- 删除语句-->
	<delete id="deleteUserById" parameterType="int">
		delete from user where id=#{id}
	</delete>
	<!-- 保存语句 -->
	<insert id="insertUser" parameterType="com.sumeng.modle.User">
		insert into user(name,age) values(#{name},#{age})
	</insert>
	
</mapper>

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

/** 

* @author 作者 Your-Name: 

* @version 创建时间：2019年8月30日 下午1:07:58 

* 类说明 

*/ 
package com.sumeng.test;

import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.context.support.FileSystemXmlApplicationContext;
import org.springframework.core.annotation.AnnotationConfigurationException;
import org.springframework.test.context.support.AnnotationConfigContextLoader;

import com.ibatis.common.resources.Resources;
import com.sumeng.dao.UserDao;
import com.sumeng.daoImpl.UserDaoImpl;
import com.sumeng.mapper.UserInfoMapper;
import com.sumeng.modle.User;

/**
 * @author Administrator
 *
 */


public class Demo {
	@Test
	public void demoTest() throws IOException{ 
		String str = "SqlMapConfig.xml";
		//读取配置文件
		InputStream in = Resources.getResourceAsStream(str);
		//创建工厂
		SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
		//创建session
		SqlSession session = factory.openSession();
		User user = session.selectOne("user.queryUserById", 8);
		System.out.println(user);
	}
	//模糊查询
	@Test
	public void demoTestLike() throws IOException{
		String str = "SqlMapConfig.xml";
		//读取配置文件
		InputStream in = Resources.getResourceAsStream(str);
		//创建工厂
		SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
		//创建session
		SqlSession session = factory.openSession();
		List<User> list = session.selectList("user.queryUserLikeName", "%n%");
		for (User user : list) {
			System.out.println(user);
		}
		
	}
	//修改方法
		@Test
		public void demoTestupdate() throws IOException{
			String str = "SqlMapConfig.xml";
			//读取配置文件
			InputStream in = Resources.getResourceAsStream(str);
			//创建工厂
			SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
			//创建session
			SqlSession session = factory.openSession();
			User u = new User();
			u.setId(4);
			u.setName("陈");
			u.setAge("男");
			int code = session.update("user.updateUser",u);
			session.commit();
			System.out.println(code);
		}
		//删除方法
		@Test
		public void demoTestDelete() throws IOException{
			String str = "SqlMapConfig.xml";
			//读取配置文件
			InputStream in = Resources.getResourceAsStream(str);
			//创建工厂
			SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
			//创建session
			SqlSession session = factory.openSession();
			int code = session.delete("user.deleteUserById",5);
			session.commit();
			System.out.println(code);
		}
		//添加方法
		@Test
		public void demoTestInsert() throws IOException{
			String str = "SqlMapConfig.xml";
			//读取配置文件
			InputStream in = Resources.getResourceAsStream(str);
			//创建工厂
			SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
			//创建session
			SqlSession session = factory.openSession();
			User u = new User();
			u.setName("陈作麟");
			u.setAge("男");
			int code = session.insert("user.insertUser",u);
			session.commit();
			System.out.println(code);
		}
		//查询全部方法
		@Test
		public void demoTestAllUser() throws IOException{
			String str = "SqlMapConfig.xml";
			//读取配置文件
			InputStream in = Resources.getResourceAsStream(str);
			//创建工厂
			SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
			UserDao dao = new UserDaoImpl(factory);
			List<User> code = dao.getAllUserList();
			for (User user : code) {
				System.out.println(user);
			}
			
		}
		//查询全部方法
		@Test
		public void demoTestAllNameandPwd() throws IOException{
			String str = "SqlMapConfig.xml";
			//读取配置文件
			InputStream in = Resources.getResourceAsStream(str);
			//创建工厂
			SqlSessionFactory  factory = new SqlSessionFactoryBuilder().build(in);
			//创建session
			SqlSession session = factory.openSession();
			User u = new User();
			u.setName("001");
			u.setAge("女");
			UserInfoMapper mapper = session.getMapper(UserInfoMapper.class);
			User user = mapper.findUserNameAndPwd(u);
			System.out.println(user);
		
			
		}
		//传入参数为map
		@Test
		public void demoTestNameMap() throws Exception{
			InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
			SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
			SqlSession session = factory.openSession();
			Map<String,Object> map = new HashMap<String,Object>();
			map.put("userName", "陈作麟");
			UserInfoMapper mapper = session.getMapper(UserInfoMapper.class);
			User findUserNameMap = mapper.findUserNameMap(map);
			System.out.println(findUserNameMap);
		}
		//输出参数为map
		@Test
		public void demoTestNameGetMap() throws Exception{
			InputStream in = Resources.getResourceAsStream("SqlMapConfig.xml");
			SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
			SqlSession session = factory.openSession();
			UserInfoMapper mapper = session.getMapper(UserInfoMapper.class);
			Map<String,Object> map = mapper.findUserById(8);
			System.out.println(map.get("name"));
			System.out.println(map.get("age"));
		}

}

禅悟刂

关注

2
点赞
踩
8

收藏

觉得还不错? 一键收藏
0
评论
Mybatis的配置文件和映射文件详解

一、Mybatis的全局配置文件1、SqlMapConfig.xml是mybatis的全局配置文件，配置内容如下：properties（属性）settings（全局配置参数）typeAliases（类型别名）typeHandlers（类型处理器）objectFactory（对象工厂）plugins（插件）environments（环境集合属性对象）--environment（环境...
复制链接

扫一扫