mybatis-samples

mybatis示例 mybatis版本：3.4.6

mybatis基础配置

准备数据库

创建数据库 mybatis

CREATE DATABASE mybatis DEFAULT CHARACTER 
SET utf8 COLLATE utf8_general_ci;```

创建表 country

USE mybatis;

CREATE TABLE `mybatis`.`country` (
	`id` int(3) NOT NULL AUTO_INCREMENT,
	`countryname` varchar(255) NULL,
	`countrycode` varchar(255) NULL,
	PRIMARY KEY (`id`)
);

插入数据

INSERT country ( `countryname`, `countrycode` )
VALUES
	( '**', 'CN' ),
	( '美国', 'US' ),
	( '俄罗斯', 'RU' ),
	( '英国', 'GB' ),
	( '法国', 'FR' );

mybatis XML方式的基本用法

<select>元素

<insert>元素

id
parameterType
flushCache
默认为true，任何时候只要语句被调用，都会清空一级缓存和二级缓存
timeout
设置在抛出异常前，驱动程序等待数据库返回请求结果的描述
statementType STATEMENT, PREPARED和CALLABLE分别使用对应的Statement, PreparedStatement和CallableStatement, 默认为PREPARED
useGenerateKeys
默认为false，如果设置为true，mybatis会使用JDBC的getGeneratedKeys方法取出数据库内部生成的主键
keyProperty
mybatis通过useGenerateKeys获取的主键值后将要赋值的属性名，如果有多个，使用都好分隔
keyColumn
仅对insert和update有效。通过生成的键值设置表中的列名（仅PostgreSQl必须），当主键列不是表中的第一列时需要设置，生成多列时使用都好分隔
databaseId
如果设置了databaseIdProvider,mybatis会加载所有不带databaseId的或匹配当前databaseId的语句，如果同时存在带databaseId和不带databaseId的语句，后者会被忽略

<update>元素

<delete>元素

多个参数接口

将参数封装为JavaBean
参数少时不划算
使用Map类型作为参数
手工封装，不方便
使用@Param
给参数配置@Param注解后，MyBatis就会自动将参数封装成Map类型，@Param注解值会作为Map中的key 当参数为JavaBean时，XML中需要使用点取值方式，如#{user.id}

Mapper接口动态代理实现原理

准备表和数据

# 创建用户表
CREATE TABLE sys_user (
id BIGINT NOT NULL auto_increment COMMENT '用户ID', 
user_name VARCHAR ( 50 ) COMMENT '用户名',
user_password VARCHAR ( 50 ) COMMENT '密码',
user_email VARCHAR ( 50 ) COMMENT '邮箱',
user_info text COMMENT '简介',
head_img BLOB COMMENT '头像',
create_time datetime COMMENT '创建时间',
PRIMARY KEY ( id ) 
);

ALTER TABLE sys_user COMMENT '用户表';

# 创建角色表
CREATE TABLE sys_role (
id BIGINT NOT NULL auto_increment COMMENT '角色ID',
role_name VARCHAR ( 50 ) COMMENT '角色名',
enabled INT COMMENT '有效标志',
create_by BIGINT COMMENT '创建人',
create_time datetime COMMENT '创建时间', 
PRIMARY KEY ( id ) 
);

ALTER TABLE sys_role COMMENT '角色表';

# 创建权限表
CREATE TABLE sys_privilege (
id BIGINT NOT NULL auto_increment COMMENT '权限ID', 
privilege_name VARCHAR ( 50 ) COMMENT '权限名称',
privilege_url VARCHAR ( 200 ) COMMENT '权限URL',
PRIMARY KEY ( id ) 
);

ALTER TABLE sys_privilege COMMENT '权限表';

# 创建用户角色关联表
CREATE TABLE sys_user_role ( 
user_id BIGINT COMMENT '用户ID', 
role_id BIGINT COMMENT '角色ID' );

ALTER TABLE sys_user_role COMMENT '用户角色关联表';

# 创建角色权限关联表
CREATE TABLE sys_role_privilege ( 
role_id BIGINT COMMENT '角色ID', 
privilege_id BIGINT COMMENT '权限ID' ); 

ALTER TABLE sys_role_privilege COMMENT '角色权限关联表';

# 插入数据
INSERT INTO `sys_user` VALUES ( '1', 'admin', '123456', '[email protected]', '管理员', NULL, '2016-04-01 17:00:58' );
INSERT INTO `sys_user` VALUES ( '1001', 'test', '123456', '[email protected]', '测试用户', NULL, '2016-04-01 17:01:52' );
	
INSERT INTO `sys_role` VALUES ( '1', '管理员', '1', '1', '2016-04-01 17:02:14' );
INSERT INTO `sys_role` VALUES ( '2', '普通用户', '1', '1', '2016-04-01 17:02:14' );
	
INSERT INTO `sys_user_role` VALUES ( '1', '1' );
INSERT INTO `sys_user_role` VALUES ( '1', '2' );
INSERT INTO `sys_user_role` VALUES ( '1001', '2' );
	
INSERT INTO `sys_privilege` VALUES ( '1', '用户管理', '/users' );
INSERT INTO `sys_privilege` VALUES ( '2', '角色管理', '/roles' );
INSERT INTO `sys_privilege` VALUES ( '3', '系统日志', '/logs' );
INSERT INTO `sys_privilege` VALUES ( '4', '人员维护', '/persons' );
INSERT INTO `sys_privilege` VALUES ( '5', '单位维护', '/companies' );

INSERT INTO `sys_role_privilege` VALUES ('1','1');
INSERT INTO `sys_role_privilege` VALUES ('1','3');
INSERT INTO `sys_role_privilege` VALUES ('1','2');
INSERT INTO `sys_role_privilege` VALUES ('2','4');
INSERT INTO `sys_role_privilege` VALUES ('2','5');

mybatis注解方式的基本用法

优点：对于需求简单的系统，效率较高缺点：更新sql后需要重新编译

@Select 字段与属性映射三种方式
@Insert
@Update
@Delete
@Provider
- @SelectProvider
- @InsertProvider
- @UpdateProvider
- @DeleteProvider

mybatis动态SQL

OGNL(Object-Graph Navigation Language)

MyBatis中可以使用OGNL的地方有两处：
- 动态SQL表达式中
- ${param}参数中
MyBatis常用OGNL表达式:
- e1 or e2
- e1 and e2
- e1 == e2,e1 eq e2
- e1 != e2,e1 neq e2
- e1 lt e2：小于
- e1 lte e2：小于等于，其他gt（大于）,gte（大于等于）
- e1 in e2
- e1 not in e2
- e1 + e2,e1 * e2,e1/e2,e1 - e2,e1%e2
- !e,not e：非，求反
- e.method(args)调用对象方法
- e.property对象属性值
- e1[e2]按索引取值，List,数组和Map
- @class@method(args)调用类的静态方法
- @class@field 调用类的静态字段值

if

- 在where条件中使用if

- 在update更新列种使用if

- 在insert动态插入列中使用if

choose(when, otherwise)

if提供了基本的条件判断，但无法实现if...else的逻辑，此时可以使用choose，when和otherwise choose元素包含when和otherwise两个标签，至少有一个when，有0个或1个otherwise

trim(where, set)

- where
如果该标签包含的元素中有返回值，就插入一个where  
如果where后面的字符串是以AND和OR开头，就将他们删除
- set
若该标签包含的元素有返回值，就插入一个set  
若set后面的字符串以逗号结尾，就将逗号删除
- trim
where和set底层通过trim实现  
trim标签属性：
    - prefix: 当trim元素内包含内容时，会给内容增加prefix指定的前缀  
    - prefixOverrides: 当trim元素内包含内容时，会把内容中匹配的前缀字符串去掉
    - suffix： 当trim元素内包含内容时，会给内容增加prefix指定的后缀  
    - suffixOverrides: 当trim元素内包含内容时，会把内容中匹配的后缀字符串去掉  
    
    **where标签对应的trim实现：**
    ```xml
     <trim prifix="WHERE" prefixOverrides="AND |OR ">
     ...     
     </trim>
    ```
    这里的AND和OR后面的空格不能省略，为了避免匹配到andes、orders等单词。  
    实际的prefixeOverrides包含“AND”、“OR”、“AND\n”、“OR\n”、“AND\r”、“OR\r”、“AND\t”、“OR\t”，不仅仅是上面提到的两个带空格的前缀。  

    **set标签对应的trim实现：**
    ```xml
     <trim prifix="SET" suffixOverrides=",">
     ...     
     </trim>
    ```

foreach

id in（1，2，3）。可以使用${ids}方式直接获取值，但这种写法不能防止SQL注入，想避免SQL注入就需要用＃{}的方式，这时就要配合使用foreach标签来满足需求。
foreach可以对数组、Map或实现了Iterable接口（如List、Set）的对象进行遍历。数组在处理时会转换为List对象，因此foreach遍历的对象可以分为两大类：Iterable类型和Map类型。这两种类型在遍历循环时情况不一样
数组或集合类型的参数默认的名字。推荐使用@Param来指定参数的名字，这时collection就设置为通过@Param注解指定的名字。
- foreach包含的属性：
- collection: 必填，值为要迭代循环的属性名 - item：变量名，值为从迭代对象中取出的每一个值 - index：索引的属性名，在集合数组情况下为当前索引值，当迭代循环的对象是Map类型时，这个值为Map的key - open: 整个循环内容开头字符串 - close：整个循环内容结尾的字符串 - separator：每次循环的分隔符

- 参数为List

- 参数为Array

- 参数为Map
使用Map和使用@Param注解方式类似，将collection指定为对应Map中的key即可。如果要循环所传入的Map，推荐使用@Param注解指定名字，此时可将collection设置为指定的名字，如果不想指定名字，就使用默认值_parameter。

- 参数为对象
这种情况下指定为对象的属性名即可。当使用对象内多层嵌套的对象时，使用属性.属性（集合和数组可以使用下标取值）的方式可以指定深层的属性值。

- foreach批量插入
从MyBatis3.3.1版本开始，MyBatis开始支持批量新增回写主键值的功能，这个功能首先要求数据库主键值为自增类型，同时还要求该数据库提供的JDBC驱动可以支持返回批量插入的主键值（JDBC提供了接口，但并不是所有数据库都完美实现了该接口），因此到目前为止，可以完美支持该功能的仅有MySQL数据库。由于SQLServer数据库官方提供的JDBC只能返回最后一个插入数据的主键值，所以不能支持该功能。

- foreach实现动态更新
当参数是Map类型的时候，foreach标签的index属性值对应的不是索引值，而是Map中的key，利用这个key可以实现动态UPDATE。

bind

bind标签可以使用OGNL表达式创建一个变量并将其绑定到上下文中。  
bind标签的两个属性都是必选项，name为绑定到上下文的变量名，value为OGNL表达式。创建一个bind标签的变量后，就可以在下面直接使用，使用bind拼接字符串不仅可以避免因更换数据库而修改SQL，也能预防SQL注入

多数据库支持

bind标签并不能解决更换数据库带来的所有问题，那么还可以通过什么方式支持不同的数据库呢？
这需要用到if标签以及由MyBatis提供的databaseIdProvider数据库厂商标识配置。 MyBatis可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的databaseId属性的。MyBatis会加载不带databaseId属性和带有匹配当前数据库databaseId属性的所有语句。如果同时找到带有databaseId和不带databaseId的相同语句，则后者会被舍弃。为支持多厂商特性，只要在mybatis-config.xml文件中加入databaseIdProvider配置即可。

＜databaseIdProvidertype=＂DB_VENDOR＂/＞

这里的DB_VENDOR会通过DatabaseMetaData＃getDatabaseProductName（）返回的字符串进行设置。由于通常情况下这个字符串都非常长而且相同产品的不同版本会返回不同的值，所以通常会通过设置属性别名来使其变短，在有property配置时，databaseId将被设置为第一个能匹配数据库产品名称的属性键对应的值，如果没有匹配的属性则会被设置为null。在这个例子中，如果getDatabaseProductName（）返回MicrosoftSQLServer，databaseId将被设置为sqlserver。 DB_VENDOR的匹配策略为，DatabaseMetaData＃getDatabaseProductName（）返回的字符串包含property中name部分的值即可匹配，所以虽然SQLServer的产品全名一般为MicrosoftSQLServer，但这里只要设置为SQLServer就可以匹配。数据库产品名一般由所选择的当前数据库的JDBC驱动所决定，只要找到对应数据库DatabaseMetaData接口的实现类，一般在getDatabaseProductName（）方法中就可以直接找到该值。任何情况下都可以通过调用DatabaseMetaData＃getDatabaseProductName（）方法获取具体的值。除了增加上面的配置外，映射文件也是要变化的，关键在于以下几个映射文件的标签中含有的databaseId属性：

select
insert
delete
update
selectKey
sql

数据准备

ALTER TABLE `sys_user` 
MODIFY COLUMN `user_email` VARCHAR ( 50 ) NOT NULL DEFAULT '[email protected]' COMMENT '邮箱' 
AFTER `user_password`;

MBG(mybatis generator)

概述

MBG与mybatis版本无关
[文档] http://www.mybatis.org/generator/

##使用：

配置XML文件
运行MBG,MBG运行方式：
- 使用java编写代码运行
  1. 引用mybatis-generator-core包
  2. 编写运行代码
    使用java运行的优点：对于特殊配置类只要在classpath中就可以直接使用
    使用java运行的缺点：和当前项目绑定，多子模块项目需要增加代码编写量
- 从命令提示符运行
- 使用maven plugin运行
- 使用eclipse插件运行

example

概述

Example类指定如何构建一个动态的where子句. 表中的每个non-BLOB列可以被包括在where子句中.
Example类可以用来生成一个几乎无限的where子句.
Example类包含一个内部静态类 Criteria 包含一个用 anded 组合在where子句中的条件列表. Example类包含一个 List 属性,所有内部类Criteria中的子句会用 ored组合在一起. 使用不同属性的 Criteria 类允许您生成无限类型的where子句.
创建 Criteria 对象可以使用Example类中的 createCriteria() 或者 or() . 如果 Criteria 对象是用 createCriteria() 创建的，它会自动为 List 属性添加一个 Criteria 对象 - 这使得它更容易写一个简单的where子句，如果您不需要 or 或者其他几个子句组合的话. 用 or(Criteria criteria) 方法创建 Criteria 对象, 方法里的 criteria 对象会被添加进 Criteria 对象的列表中.

Criteria
Criteria包含一个Cretiron的集合,每一个Criteria对象内包含的Cretiron之间是由AND连接的,是逻辑与的关系。
oredCriteria
Example内有一个成员叫oredCriteria,是Criteria的集合,就想其名字所预示的一样，这个集合中的Criteria是由OR连接的，是逻辑或关系。oredCriteria就是ORed Criteria。
distinct Example类的distinct字段用于指定DISTINCT查询。
orderByClause orderByClause字段用于指定ORDER BY条件,这个条件没有构造方法,直接通过传递字符串值指定。

总结

在条件很多并且判断很多的情况下，避免使用Example查询。这种情况下，使用XML方式会更有效。

mybatis高级查询

高级结果映射

一对一映射

使用自动映射

关联的嵌套结果映射

优点：
- 减少数据库查询次数，减轻数据库的压力
缺点：
- SQL复杂
- 由于在应用服务器上映射，会增加应用服务器压力当一定会用到嵌套结果，且整个复杂的SQL执行速度很快时，建议使用关联的嵌套结果映射

使用resultMap

resultMap支持继承

使用resultMap的association标签配置一对一映射

association标签的嵌套查询

懒加载可以将多表关联查询变为多个单表查询，提高查询效率，只有当调用属性的get/set方法时才进行嵌套查询，aggressiveLazyLoading配置为false时生效 Mybatis提供了参数lazyLoadTriggerMethods，当调用配置的方法时便可加载全部的延迟数据，默认值为： equals,clone,hashCode,toString

一对多映射

使用collection构建一对多映射

注意别名的嵌套
collection和association的配合使用

collection嵌套查询

鉴别器映射

存储过程

第一个存储过程

第二个存储过程

第三、四个存储过程

在Oracle中使用游标参数的存储过程

使用枚举或其他对象

使用Mybatis提供的枚举处理器

使用自定义的类型处理器

对JAVA8日期(JSR-310)的支持

mybatis缓存的配置

一级缓存

二级缓存

二级缓存的配置

使用二级缓存

集成EhCache

集成redis缓存

脏数据的产生和避免

二级缓存使用场景

总结

mybatis插件开发

拦截器接口

拦截器签名

Executor接口

ParameterHandler接口

ResultSetHandler接口

StatementHandler接口

下划线键值转小写驼峰形式插件

分页插件

PageInterceptor拦截器类

Dialect接口

MySqlDialect实现

总结

Spring集成Mybatis

创建基本的Maven Web项目

集成Spring和 Spring MVC

集成Mybatis

实例

总结

Spring boot集成mybatis

Mybatis开源项目

类型处理器

MyBatis在预处理语句（PreparedStatement）中设置一个参数或从结果集中取出一个值时，都会使用类型处理器将获取的值以合适的方式转换成Java类型。

mingfeichn / mybatis-samples Goto Github PK

mybatis-samples's Introduction