Mybatis(一)框架简述与工程示例

一时失言乱红尘 2022-06-01 09:06 162阅读 0赞

# 1. **MyBatis介绍** #

MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注SQL本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。

Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatement、CallableStatement）配置起来，并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。

# 2. **Mybatis架构** #

![SouthEast][]

1、 mybatis配置

SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。

mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。

2、 通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂

3、 由会话工厂创建sqlSession即会话，操作数据库需要通过sqlSession进行。

4、 mybatis底层自定义了Executor执行器接口操作数据库，Executor接口有两个实现，一个是基本执行器、一个是缓存执行器。

5、 Mapped Statement也是mybatis一个底层封装对象，它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象，sql的id即是Mapped statement的id。

6、 Mapped Statement对sql执行输入参数进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中，输入参数映射就是jdbc编程中对preparedStatement设置参数。

7、 Mapped Statement对sql执行输出结果进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql后将输出结果映射至java对象中，输出结果映射过程相当于jdbc编程中对结果的解析处理过程。

# 3. **Mybatis入门程序** #

## 3.1 **mybatis下载** ##

mybaits的代码由github.com管理，地址：https://github.com/mybatis/mybatis-3/releases

![SouthEast 1][]

mybatis-3.2.7.jar----mybatis的核心包

lib----mybatis的依赖包

mybatis-3.2.7.pdf----mybatis使用手册

## 3.2 工程**需求** ##

实现以下功能：

根据用户id查询一个用户信息

根据用户名称模糊查询用户信息列表

添加用户

更新用户

删除用户

## 3.3 **工程搭建** ##

### 3.3.1 **第一步：创建java工程** ###

使用eclipse创建java工程，jdk使用1.7.0\_72。

### 3.3.2 **第二步：加入jar包** ###

加入mybatis核心包、依赖包、数据驱动包。

![SouthEast 2][]

### 3.3.3 **第三步：log4j.properties** ###

在classpath下创建log4j.properties如下：

\# Global logging configuration

log4j.rootLogger=DEBUG, stdout

\# Console output...

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%5p \[%t\] - %m%n

mybatis默认使用log4j作为输出日志信息。

### 3.3.4 **第四步：SqlMapConfig.xml** ###

在classpath下创建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">

<environments default=*"development"*>

<environment id=*"development"*>

<transactionManager type=*"JDBC"* />

<dataSource type=*"POOLED"*>

<property name=*"driver"* value=*"com.mysql.jdbc.Driver"* />

<property name=*"url"* value=*"jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8"* />

<property name=*"username"* value=*"root"* />

<property name=*"password"* value=*"root"* />

</dataSource>

</environment>

</environments>

</configuration>

SqlMapConfig.xml是mybatis核心配置文件，上边文件的配置内容为数据源、事务管理。

### 3.3.5 **第五步：po类** ###

Po类作为mybatis进行sql映射使用，po类通常与数据库表对应，User.java如下：

Public class User {
    
      private int id;
    
      private String username;// 用户姓名
    
      private String sex;// 性别
    
      private Date birthday;// 生日
    
      private String address;// 地址
    
      get/set……
    
     }

### 3.3.6 **第六步：sql映射文件** ###

在classpath下的sqlmap目录下创建sql映射文件Users.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=*"test"*>

</mapper>

namespace：命名空间，用于隔离sql语句，后面会讲另一层非常重要的作用。

### 3.3.7 **第七步：加载映射文件** ###

mybatis框架需要加载映射文件，将Users.xml添加在SqlMapConfig.xml，如下：

<mapper resource=*"sqlmap/User.xml"*/>

</mappers>

## 3.4 **根据id查询用户信息** ##

### 3.4.1 **映射文件：** ###

在user.xml中添加：

<select id=*"findUserById" *parameterType=*"int" *resultType=*"cn.itcast.mybatis.po.User"*>

select \* from user where id = \#\{id\}

</select>

parameterType：定义输入到sql中的映射类型，\#\{id\}表示使用preparedstatement设置占位符号并将输入变量id传到sql。

resultType：定义结果映射类型。

### 3.4.2 **测试程序：** ###

public class Mybatis_first {
    	
    	//会话工厂
    	private SqlSessionFactory sqlSessionFactory;
    
    	@Before
    	public void createSqlSessionFactory() throws IOException {
    		// 配置文件
    		String resource = "SqlMapConfig.xml";
    		InputStream inputStream = Resources.getResourceAsStream(resource);
    
    		// 使用SqlSessionFactoryBuilder从xml配置文件中创建SqlSessionFactory
    		sqlSessionFactory = new SqlSessionFactoryBuilder()
    				.build(inputStream);
    
    	}
    
    	// 根据 id查询用户信息
    	@Test
    	public void testFindUserById() {
    		// 数据库会话实例
    		SqlSession sqlSession = null;
    		try {
    			// 创建数据库会话实例sqlSession
    			sqlSession = sqlSessionFactory.openSession();
    			// 查询单个记录，根据用户id查询用户信息
    			User user = sqlSession.selectOne("test.findUserById", 10);
    			// 输出用户信息
    			System.out.println(user);
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			if (sqlSession != null) {
    				sqlSession.close();
    			}
    		}
    
    	}
    }

## 3.5 **根据用户名查询用户信息** ##

### 3.5.1 **映射文件：** ###

在user.xml中添加：

<select id=*"findUserByUsername"* parameterType=*"java.lang.String"*

resultType=*"cn.itcast.mybatis.po.User"*>

select \* from user whereusername like '%$\{value\}%'

</select>

parameterType：定义输入到sql中的映射类型，$\{value\}表示使用参数将$\{value\}替换，做字符串的拼接。

注意：如果是取简单数量类型的参数，括号中的值必须为value

resultType：定义结果映射类型。

### 3.5.2 **测试程序：** ###

// 根据用户名称模糊查询用户信息
    	@Test
    	public void testFindUserByUsername() {
    		// 数据库会话实例
    		SqlSession sqlSession = null;
    		try {
    			// 创建数据库会话实例sqlSession
    			sqlSession = sqlSessionFactory.openSession();
    			// 查询单个记录，根据用户id查询用户信息
    			List<User> list = sqlSession.selectList("test.findUserByUsername", "张");
    			System.out.println(list.size());
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			if (sqlSession != null) {
    				sqlSession.close();
    			}
    		}
    
    	}

## 3.6 **小结** ##

### 3.6.1 **\#\{\}和$\{\}**  ###

\#\{\}表示一个占位符号，通过\#\{\}可以实现preparedStatement向占位符中设置值，自动进行java类型和jdbc类型转换，\#\{\}可以有效防止sql注入。 \#\{\}可以接收简单类型值或pojo属性值。如果parameterType传输单个简单类型值，\#\{\}括号中可以是value或其它名称。

$\{\}表示拼接sql串，通过$\{\}可以将parameterType传入的内容拼接在sql中且不进行jdbc类型转换，$\{\}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，$\{\}括号中只能是value。

### 3.6.2 **parameterType和resultType** ###

parameterType：指定输入参数类型，mybatis通过ognl从输入对象中获取参数值拼接在sql中。

resultType：指定输出结果类型，mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。

### 3.6.3 **selectOne和selectList** ###

selectOne查询一条记录，如果使用selectOne查询多条记录则抛出异常：

org.apache.ibatis.exceptions.TooManyResultsException: Expected one result (or null) to be returned by selectOne(), but found: 3

at org.apache.ibatis.session.defaults.DefaultSqlSession.selectOne(DefaultSqlSession.java:70)

selectList可以查询一条或多条记录。

## 3.7 **添加用户** ##

### 3.7.1 映射文件 ###

在SqlMapConfig.xml中添加：

<insert id=*"insertUser"* parameterType=*"cn.itcast.mybatis.po.User"*>

insert into user(username,birthday,sex,address)

values(\#\{ username\},\#\{birthday\},\#\{sex\},\#\{address\})

</insert>

### 3.7.2 **测试程序：** ###

// 添加用户信息
    	@Test
    	public void testInsert() {
    		// 数据库会话实例
    		SqlSession sqlSession = null;
    		try {
    			// 创建数据库会话实例sqlSession
    			sqlSession = sqlSessionFactory.openSession();
    			// 添加用户信息
    			User user = new User();
    			user.setUsername("张小明");
    			user.setAddress("河南郑州");
    			user.setSex("1");
    			user.setPrice(1999.9f);
    			sqlSession.insert("test.insertUser", user);
    			//提交事务
    			sqlSession.commit();
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			if (sqlSession != null) {
    				sqlSession.close();
    			}
    		}
    	}

### 3.7.3 **mysql自增主键返回** ###

通过修改sql映射文件，可以将mysql自增主键返回：

<insert id=*"insertUser" *parameterType=*"cn.itcast.mybatis.po.User"*>

<selectKey keyProperty=*"id" *order=*"AFTER" *resultType=*"java.lang.Integer"*>

select LAST\_INSERT\_ID()

</selectKey>

insert into user(username,birthday,sex,address)

values(\#\{ username\},\#\{birthday\},\#\{sex\},\#\{address\});

</insert>

添加selectKey实现将主键返回

keyProperty:返回的主键存储在pojo中的哪个属性

order：selectKey的执行顺序，是相对与insert语句来说，由于mysql的自增原理执行完insert语句之后才将主键生成，所以这里selectKey的执行顺序为after

resultType:返回的主键是什么类型

select LAST\_INSERT\_ID():是mysql的函数，返回auto\_increment自增列新记录id值。

### 3.7.4 **Mysql使用uuid实现主键** ###

需要增加通过select uuid()得到uuid值

<insert  id="insertUser" parameterType="cn.itcast.mybatis.po.User">

select uuid()

</selectKey>

insert into user(id,username,birthday,sex,address)

values(\#\{id\},\#\{ username\},\#\{birthday\},\#\{sex\},\#\{address\})

</insert>

注意这里使用的order是“BEFORE”

## 3.8 **删除用户** ##

### 3.8.1 **映射文件：** ###

<delete id=*"deleteUserById"* parameterType=*"int"*>

delete from user where id=\#\{id\}

</delete>

### 3.8.2 **测试程序：** ###

// 根据id删除用户
    	@Test
    	public void testDelete() {
    		// 数据库会话实例
    		SqlSession sqlSession = null;
    		try {
    			// 创建数据库会话实例sqlSession
    			sqlSession = sqlSessionFactory.openSession();
    			// 删除用户
    			sqlSession.delete("test.deleteUserById",18);
    			// 提交事务
    			sqlSession.commit();
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			if (sqlSession != null) {
    				sqlSession.close();
    			}
    		}
    	}

## 3.9 **修改用户** ##

### 3.9.1 **映射文件** ###

<update id=*"updateUser"* parameterType=*"cn.itcast.mybatis.po.User"*>

update user set username=\#\{username\},birthday=\#\{birthday\},sex=\#\{sex\},address=\#\{address\}

where id=\#\{id\}

</update>

### 3.9.2 **测试程序** ###

// 更新用户信息
    	@Test
    	public void testUpdate() {
    		// 数据库会话实例
    		SqlSession sqlSession = null;
    		try {
    			// 创建数据库会话实例sqlSession
    			sqlSession = sqlSessionFactory.openSession();
    			// 添加用户信息
    			User user = new User();
    			user.setId(16);
    			user.setUsername("张小明");
    			user.setAddress("河南郑州");
    			user.setSex("1");
    			user.setPrice(1999.9f);
    			sqlSession.update("test.updateUser", user);
    			// 提交事务
    			sqlSession.commit();
    
    		} catch (Exception e) {
    			e.printStackTrace();
    		} finally {
    			if (sqlSession != null) {
    				sqlSession.close();
    			}
    		}
    	}

[SouthEast]: /images/20220601/d945865abae14157b46ed9a308386b52.png
[SouthEast 1]: /images/20220601/43a2bc4dff1e46edb69067ab3ea8545b.png
[SouthEast 2]: /images/20220601/851b781710fb4841b5c9402f32357167.png