MyBatis快速入门

一、概述

MyBatis是Apache的一个开源项目，是一个基于Java的持久层框架。它支持普通SQL查询、存储过程以及高级映射。消除了几乎所有的JDBC代码，并且基本不需要手动去设置参数和获取检索结果。使用XML或者注解进行配置，能够映射基本数据元素、Map接口和POJO到数据库。

二、框架

MyBatis的功能架构分三层：基础支撑层、数据处理层、API接口层。

1. 基础支撑层

   负责最基本的功能支撑，包括连接管理、事务管理、配置加载和缓存处理。基础支撑层为上层的数据处理层提供了最基础的支撑。

2. 数据处理层

   负责具体的SQL查询、SQL解析、SQL执行和执行结果的映射处理等。数据处理层的主要目的是根据调用的请求完成一次数据库操作。

3. API接口层

   提供给外部使用的接口API，通过这些API来操作数据库。接口层接收到调用请求会立刻调用数据处理层来完成具体的操作。

三、工作流程

1、加载配置并初始化

通过配置文件或注解，将SQL的配置信息加载成MappedStatement对象，存储在内存中。

2、接收调用请求

调用MyBatis提供的API，并将请求传递给下层的数据处理层进行处理。

3、处理操作请求

• 根据传入的SQL的ID查找对应的MappedStatement对象
• 根据传入的参数解析MappedStatement对象，得到要执行的SQL
• 获取数据库连接，执行SQL，并得到执行结果
• 根据MappedStatement对象中的结果映射配置，对执行结果进行转换处理，得到最终结果
• 释放连接资源

4、返回处理结果

四、实现

1、创建与表对应的实体类

2、创建映射文件xxxMapper.xml



select * from user where id = #{id}

其中，namespace属性用来定义mapper的命名空间。<select>标签中的id属性用来标识sql语句，值必须唯一。parameterType属性用来定义查询时使用的参数类型。resultType属性用来定义查询返回的结果集类型。如果返回的结果集是个列表，应该定义resultMap类型。

select * from user where username like #{userName}

3、配置MyBatis的配置文件

五、关联查询

在实际应用中，经常需要进行关联查询，如一对多、多对一等。这时，就需要在配置文件中使用<association>标签进行关联。关联查询的配置有两种方式：内部关联和外部关联。

1、在内部关联

select user.id,user.userName,user.userAge,article.id aid,article.title,article.content from user,article where user.id=article.userid and user.id=#{id}

2、从外部关联

select user.id,user.userName,user.userAge,article.id aid,article.title,article.content from user,article where user.id=article.userid and user.id=#{id}

很显然，第二种方式更容易达到复用的效果。

六、分页

在实际应用中，如果查询返回的结果记录很多，就需要做物理分页。不同的数据库，对应不同的实现方法。mysql利用limit offset和pagesize来实现，而oracle利用rownum来实现。实现MyBatis的物理分页。

1、在mapper的sql语句中直接使用分页条件

select user.id,user.userName,user.userAge,article.id aid,article.title,article.content from user,article where user.id=article.userid and user.id=#{id} limit #{offset},#{pagesize}

这里的parameterType是传入的参数类或者Map，包含offset和pagesize，以及其他需要的参数。相对来说，这是比较简单的一种方式。

2、使用MyBatis插件

更通用的一种方式是使用插件进行分页。使用插件的话，需要在MyBatis的配置文件中进行设置。

七、动态SQL

MyBatis的动态sql语句是基于OGNL表达式的，可以很方便地在sql语句中实现某些逻辑。

1、if

select * from user where 1 = 1 and userName = #{userName}

如果提供的userName参数不为空，就为sql语句动态添加userName=#{userName}的语句。

2、choose

select * from user where 1 = 1 and userName = #{userName} and userName = "sean"

当userName不为空时，为sql语句动态添加userName=#{userName}。否则，为sql语句动态添加userName="sean"语句。当条件满足时，不再继续判断，直接跳出choose。当所有条件都不满足时，输出otherwise中的内容。

3、where

select * from user userName = #{userName}

在where元素的地方输出一个where，并且能够智能地处理and和or条件。主要用来简化sql语句中where条件判断。

4、trim

select * from user userName = #{userName}

用来给包含的内容加上前缀或后缀，也可以把包含内容的首部或尾部的某些内容覆盖。通常可以利用trim来代替where元素的功能。

5、set

update user


userName = #{userName}


where userId = #{userId}

主要用于更新操作，在包含的语句前输出一个set，功能和where元素基本相同。

6、foreach

主要用于构建in条件，可以在sql语句中迭代一个集合。foreach元素主要有几个属性：

• item：表示每个元素在进行迭代时的别名
• index：表示在迭代时，每次迭代到的位置
• open：表示语句以什么开始
• separator：表示迭代之间以什么作为分隔符
• close：表示语句以什么结束
• collection：表示集合

不同情况下，collection属性的值是不同的。如果传入的是单参数且参数类型是一个List的时候，属性值为list。

select * from user where userId in #{item}

如果传入的是单参数且参数类型是一个Array的时候，属性值为array。

select * from user where userId in #{item}

如果传入的是多个参数时，将参数封装成一个Map，属性值为map里的key。

select * from user where userName like "%"#{userName}"%" and userId in #{item}

八、代码生成工具

由于MyBatis应用程序需要大量的配置文件，如果完全手工配置，工作量巨大。MyBatis官方推出一个代码生成工具mybatis-generator-core的jar包，以便提高效率。

代码生成工具主要有几个功能：

• 生成pojo与数据库结构相对应
• 如果有主键，能够匹配主键；如果没有主键，可以用其他字段匹配
• 动态select、update、delete方法
• 自动生成接口
• 自动生成mapper，以及对单表的增删改查语句配置
• 提供例子以供参考

首先需要创建一个配置文件，进行生成工具的各种设置。

<classPathEntry location=""

然后创建一个代码生成类，用于生成代码。

public class GenMain {
public static void main(String[] args) {
List warnings = new ArrayList();
boolean overwrite = true;
String genCfg = "/mbgConfiguration.xml";
File configFile = new File(GenMain.class.getResource(genCfg).getFile());
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = null;
try {
config = cp.parseConfiguration(configFile);
} catch (IOException e) {
e.printStackTrace();
} catch (XMLParserException e) {
e.printStackTrace();
}
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
MyBatisGenerator myBatisGenerator = null;
try {
myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
} catch (InvalidConfigurationException e) {
e.printStackTrace();
}
try {
myBatisGenerator.generate(null);
} catch (SQLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}