MyBatis简介
简介
来源于apache，关注于持久层(数据库层、po层、dao层)的orm(对象-关系-映射)框架，mybatis框架也可理解为是sql模板映射
优点
把sql语句提出到xml文件中，不再有Dao文件。
降低了java代码和sql语句的耦合度
全局配置文件mybatis.cfg.xml介绍
作用是全局参数设置、别名设置、数据库连接参数设置、sql映射文件(即mapper文件)的声明
<?xml version="1.0" encoding="UTF-8" ?>
<!--dtd文件相当于以前的xsd文件+命名空间-->
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- settings标签是全局参数的设置 -->
<settings>
<setting name="logImpl" value="STDOUT_LOGGING"/>
<!--在控制台输出日志语句-->
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="aggressiveLazyLoading" value="true"/>
<setting name="cacheEnabled" value="true"/>
</settings>
<!--environments标签是多个数据库连接参数的设置，default属性指定多个数据库连接里默认的一个-->
<environments default="mysqlDS">
<!-- environment是一个数据库连接的设置，oracle数据库-->
<environment id="oracleDS">
<transactionManager type="JDBC"/>
<dataSource type="UNPOOLED">
<property name="driver" value="oracle.jdbc.driver.OracleDriver" />
<property name="url" value="jdbc:oracle:thin:@localhost:1521:elm" />
<property name="username" value="ums"/>
<property name="password" value="ums"/>
</dataSource>
</environment>
<!-- environment是一个数据库连接的设置，mysql数据库-->
<environment id="mysqlDS">
<transactionManager type="JDBC"/>
<dataSource type="UNPOOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/elm?characterEncoding=UTF8" />
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- mappers标签是映射文件声明 -->
<mappers>
<!--mapper标签声明一个映射文件，直接映射到相应的mapper文件-->
<mapper resource="my1/dao/UserMapper.xml"/>
</mappers>
</configuration>
全局配置文件里，每个标签的详细设置，见后续部分
sql映射配置文件xxxmapper.xml介绍
作用Dao接口的实现文件(即替代dao接口的实现类)，放置ql语句的文件
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- 必须是mapper标签作为根， namespace属性的值是要实现的接口名字(包名+类名)-->
<mapper namespace="t.dao.UserDao">
<!--
在sql的映射文件里，用insert标签来写插入语句，用delete标签来写删除语句，用update标签来写更新语句，用select标签来写查询语句
共同属性
id - 值是实现的接口里的方法名字
parameterType - 值是实现的接口里的方法的参数的类型
resultType - 值是实现的接口里的方法的返回值的类型
>>>注意当是集合类型时，只需要表明泛型的类型
共同方法体
方法体里写相应的sql语句，sql语句里面要求的变量语法是：#{}或${}，#{}会自动加上单引号
变量的名字要和parameterType里提供的类里的属性名称一致
-->
<insert id="save" parameterType="t.po.User">
insert into USER_TABLE(user_name,password,email,role) values(#{username},#{password},#{email},#{role})
</insert>
<delete id="delete" parameterType="String">
<!-- 此时#{id}的id是接口中的参数名 -->
delete from USER_TABLE where id=#{id}
</delete>
<update id="update" parameterType="t.po.User">
update USER_TABLE user_name=#{username}, email=#{email}, password=#{password}, role=#{role} where id=#{id}
</update>
<select id="get" parameterType="String" resultType="t.po.User">
select * from USER_TABLE where id=#{id}
</select>
<select id="findAll" resultType="t.po.User">
<!-- 此时返回值类型是集合中的泛型 -->
select * from USER_TABLE
</select>
</mapper>
基本的增删改查
- 创建java工程，导入mybatis框架需要的jar包
mybatis-3.4.4.jar
- 创建mybatis的全局配置文件mybatis.cfg.xml
内容参考上面mybatis.cfg.xml
- 项目下分包
com.公司名.项目名.模块名.po com.公司名.项目名.模块名.mapper
- 根据数据库表的结构创建po类
// User.java
public class User {
private String id;
private String username;
private String password;
private String email;
private String role;
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public String getRole() {
return role;
}
public void setRole(String role) {
this.role = role;
}
}
- 创建mapper接口
// UserDao.java
import t.po.User;
public interface UserDao {
public void save(User u);
public void delete(String id);
public void update(User u);
public User get(String id);
public List<User> findAll();
}
- 创建mapper.xml作为mapper接口的实现
<!-- UserMapper.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="t.dao.UserDao">
<insert id="save" parameterType="t.po.User">
insert into USER_TABLE(user_name,password,email,role) values(#{username},#{password},#{email},#{role})
</insert>
<delete id="delete" parameterType="String">
delete from USER_TABLE where id=#{id}
</delete>
<update id="update" parameterType="t.po.User">
update USER_TABLE user_name=#{username}, email=#{email}, password=#{password}, role=#{role} where id=#{id}
</update>
<select id="get" parameterType="String" resultType="t.po.User">
select * from USER_TABLE where id=#{id}
</select>
<select id="findAll" resultType="t.po.User">
select * from USER_TABLE
</select>
</mapper>
- 创建测试类
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;
import t.po.User;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
public class TestUserDao {
public static void main(String[] args) {
try {
//从类路径下读取mybatis的全局配置文件
Reader reader = Resources.getResourceAsReader("mybatis.config.xml");
//构建sqlSession的工厂
SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(reader);
//从工厂取出一个session，即connection
SqlSession session = sessionFactory.openSession();
//通过getMapper方法给接口注入实现类
UserDao dao = session.getMapper(UserDao.class);
//添加
User u1=new User();
u1.setId("1");
u1.setEmail("yyyy@ddd.com");
u1.setPassword("7888888");
u1.setUsername("kafka");
u1.setRole("1");
dao.save(u1);
session.commit();
//修改
User u1=new User();
u1.setId("1");
u1.setEmail("yyyy@ddd.com");
u1.setPassword("11111111");
u1.setUsername("kafka");
u1.setRole("0");
dao.update(u1);
session.commit();
//查询
User u=dao.get("1");
System.out.println(u.getRole());
System.out.println(u.getUsername());
System.out.println(u.getPassword());
System.out.println(u.getEmail());
List<User> list = dao.findAll();
System.out.println(list.size());
for (User u : list) {
System.out.println(u.getUsername());
}
//删除
dao.delete("1");
session.commit();
session.close();
} catch (Exception e) {
e.printStackTrace();
}
}
}
全局配置文件标签属性参考
<?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>
<!-- 参数设置 -->
<settings>
<!-- 这个配置使全局的映射器启用或禁用缓存，一般不用Mybatis的缓存 -->
<setting name="cacheEnabled" value="true" />
<!-- 全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载 -->
<setting name="lazyLoadingEnabled" value="true" />
<!-- 当启用时，有延迟加载属性的对象在被调用时将会完全加载任意属性。否则，每种属性将会按需要加载 -->
<setting name="aggressiveLazyLoading" value="true" />
<!-- 允许或不允许多种结果集从一个单独的语句中返回（需要适合的驱动） -->
<setting name="multipleResultSetsEnabled" value="true" />
<!-- 使用列标签代替列名。不同的驱动在这方便表现不同。参考驱动文档或充分测试两种方法来决定所使用的驱动 -->
<setting name="useColumnLabel" value="true" />
<!-- 允许JDBC支持生成的键。需要适合的驱动。如果设置为true则这个设置强制生成的键被使用，尽管一些驱动拒绝兼容但仍然有效（比如Derby） -->
<setting name="useGeneratedKeys" value="true" />
<!-- 指定MyBatis如何自动映射列到字段/属性。PARTIAL只会自动映射简单，没有嵌套的结果。FULL会自动映射任意复杂的结果（嵌套的或其他情况） -->
<setting name="autoMappingBehavior" value="PARTIAL" />
<!--当检测出未知列（或未知属性）时，如何处理，默认情况下没有任何提示，这在测试的时候很不方便，不容易找到错误。
NONE : 不做任何处理 (默认值)
WARNING : 警告日志形式的详细信息
FAILING : 映射失败，抛出异常和详细信息
-->
<setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
<!-- 配置默认的执行器。SIMPLE执行器没有什么特别之处。REUSE执行器重用预处理语句。BATCH执行器重用语句和批量更新 -->
<setting name="defaultExecutorType" value="SIMPLE" />
<!-- 设置超时时间，它决定驱动等待一个数据库响应的时间 -->
<setting name="defaultStatementTimeout" value="25000" />
<!--设置查询返回值数量，可以被查询数值覆盖 -->
<setting name="defaultFetchSize" value="100"/>
<!-- 允许在嵌套语句中使用分页-->
<setting name="safeRowBoundsEnabled" value="false"/>
<!--是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。-->
<setting name="mapUnderscoreToCamelCase" value="false"/>
<!--MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession 的不同调用将不会共享数据。-->
<setting name="localCacheScope" value="SESSION"/>
<!-- 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR
OTHER。-->
<setting name="jdbcTypeForNull" value="OTHER"/>
<!-- 指定哪个对象的方法触发一次延迟加载。-->
<setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>
<!-- 别名定义 -->
<typeAliases>
<typeAlias alias="pageAccessURL" type="com.mybatis.model.PageAccessURL" />
</typeAliases>
<!--自定义类型处理器 -->
<typeHandlers>
<!-- <typeHandler handler="com.xhm.util.BooleanTypeHandlder" /> -->
<!--扫描整个包下的自定义类型处理器-->
<package name="com.mybatis.util"/>
</typeHandlers>
<!--plugins插件之 分页拦截器 -->
<plugins>
<plugin interceptor="com.mybatis.util.PageInterceptor"></plugin>
</plugins>
<!--配置environment环境-->
<environments default="development">
<!-- 环境配置1，每个SqlSessionFactory对应一个环境 -->
<environment id="development1">
<!-- 事务配置 type= JDBC、MANAGED
1.JDBC:这个配置直接简单使用了JDBC的提交和回滚设置。它依赖于从数据源得到的连接来管理事务范围。
2.MANAGED:这个配置几乎没做什么。它从来不提交或回滚一个连接。而它会让容器来管理事务的整个生命周期（比如Spring或JEE应用服务器的上下文）。 默认情况下它会关闭连接。然而一些容器并不希望这样，因此如果你需要从连接中停止它，将closeConnection属性设置为false -->
<transactionManager type="JDBC" />
<!-- <transactionManager type="MANAGED">
<property name="closeConnection" value="false"/>
</transactionManager> -->
<!-- 数据源类型：type = UNPOOLED、POOLED、JNDI 1.UNPOOLED：这个数据源的实现是每次被请求时简单打开和关闭连接。它有一点慢，这是对简单应用程序的一个很好的选择，因为它不需要及时的可用连接。
不同的数据库对这个的表现也是不一样的，所以对某些数据库来说配置数据源并不重要，这个配置也是闲置的 2.POOLED：这是JDBC连接对象的数据源连接池的实现，用来避免创建新的连接实例时必要的初始连接和认证时间。
这是一种当前Web应用程序用来快速响应请求很流行的方法。 3.JNDI：这个数据源的实现是为了使用如Spring或应用服务器这类的容器，容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用，从另一种软件中获取连接 -->
<dataSource type="UNPOOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
<property name="username" value="root" />
<property name="password" value="root" />
<!-- 默认连接事务隔离级别 <property name="defaultTransactionIsolationLevel" value="" /> -->
</dataSource>
</environment>
<!-- 环境配置2 -->
<environment id="development2">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
<property name="username" value="root" />
<property name="password" value="root" />
<!-- 在任意时间存在的活动（也就是正在使用）连接的数量 -->
<property name="poolMaximumActiveConnections" value="10" />
<!-- 任意时间存在的空闲连接数 -->
<property name="poolMaximumIdleConnections" value="5" />
<!-- 在被强制返回之前，池中连接被检查的时间 -->
<property name="poolMaximumCheckoutTime" value="20000" />
<!-- 这是给连接池一个打印日志状态机会的低层次设置，还有重新尝试获得连接，这些情况下往往需要很长时间（为了避免连接池没有配置时静默失败） -->
<property name="poolTimeToWait" value="20000" />
<!-- 发送到数据的侦测查询，用来验证连接是否正常工作，并且准备接受请求。 -->
<property name="poolPingQuery" value="NO PING QUERY SET" />
<!-- 这是开启或禁用侦测查询。如果开启，你必须用一个合法的SQL语句（最好是很快速的）设置poolPingQuery属性 -->
<property name="poolPingEnabled" value="false" />
<!-- 这是用来配置poolPingQuery多次时间被用一次。这可以被设置匹配标准的数据库连接超时时间，来避免不必要的侦测 -->
<property name="poolPingConnectionsNotUsedFor" value="0" />
</dataSource>
</environment>
<!-- 环境配置3 -->
<environment id="development3">
<transactionManager type="JDBC" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/env/jndi/mybatis" />
<property name="env.encoding" value="UTF8" />
<!-- <property name="initial_context" value=""/> <property name="env.encoding" value="UTF8"/> -->
</dataSource>
</environment>
</environments>
<!-- 映射文件，mapper的配置文件 -->
<mappers>
<!--直接映射到相应的mapper文件-->
<mapper resource="com/mybatis/mapper/UserMapper.xml"/>
<!--扫描包路径下所有xxMapper.xml文件-->
<package name="com.mybatis.mapper"/>
</mappers>
</configuration>
MyBatis核心配置文件
- properties （未提及）
- settings
- typeAliases
package name="包路径"
- typeHandlers
- objectFactory （未提及）
- plugins
- environments
- mappers
mysql和sqlserver自增长设置
<insert useGeneratedKeys="true" keyProperty="id"></insert>
<!--useGeneratedKeys 是否自增长；keyProperty 自增长列名-->
oracle序列类型列添加后返回刚刚添加的id值
<selectKey keyProperty="id" order="AFTER" resultType="int">
select 序列名.currval from dual
</selectKey>
动态sql
- where if
<select id="findAll" resultType="t.po.User">
select id,password,user_name as username,email,role from USER_TABLE
<where>
<if test="username != null">
and user_name =#{username}
</if>
<if test="password != null">
and password =#{password}
</if>
</where>
</select>
- set if
<update id="update" parameterType="t.po.User">
update USER_TABLE
<set>
<!-- 最后一个逗号会被处理掉 -->
<if test="username != null and username.length()>0">
user_name=#{username},
</if>
<if test="email != null and email.length()>0">
email=#{email},
</if>
<if test="password != null and password.length()>0">
password=#{password},
</if>
<if test="role != null and role.length()>0">
role=#{role}
</if>
</set>
where id=#{id}
</update>
- where choose when otherwise （相当于if(){ ... } else if () { ... } else { ... };
<!-- choose(判断参数) - 按顺序将实体类 User 第一个不为空的属性作为：where条件 -->
<select id="getUserList_choose" resultType="t.po.User" parameterType="t.po.User">
SELECT * FROM User u
<where>
<choose>
<when test="username !=null ">
u.username LIKE CONCAT(CONCAT('%', #{username, jdbcType=VARCHAR}),'%')
</when>
<when test="sex != null and sex != '' ">
AND u.sex = #{sex, jdbcType=INTEGER}
</when>
<when test="birthday != null ">
AND u.birthday = #{birthday, jdbcType=DATE}
</when>
<otherwise>
</otherwise>
</choose>
</where>
</select>
- foreach （用于有 in 的sql语句）
<select id="findUsersByIds" parameterType="String" resultType="t.po.User">
select id,password,user_name as username,email,role from USER_TABLE where id in
<foreach collection="list" item="r" open="(" separator="," close=")">
#{r}
</foreach>
</select>
- sql代码复用
<select id="findAll" resultType="t.po.User">
select id,password,user_name as username,email,role from USER_TABLE
<where>
<include refid="asdfghjkl"></include>
</where>
</select>
<sql id="asdfghjkl">
<if test="username != null">
and user_name =#{username}
</if>
<if test="password != null">
and password =#{password}
</if>
</sql>
一对一映射
<mapper namespace="t.dao.TiziDao">
<resultMap type="t.po.Tizi" id="tzObject">
<id property="id" column="id"/>
<result property="title" column="title"/>
<result property="content" column="content"/>
<association property="user" javaType="t.po.User">
<id property="id" column="myid"/>
<result property="username" column="username"/>
</association>
</resultMap>
<select id="get" parameterType="String" resultMap="tzObject">
select t.*,u.id as myid,u.password,u.user_name as username,u.email,u.role from tizi t,user_table u where t.id=#{id} and t.user_id=u.id
</select>
</mapper>
一对多映射
<resultMap type="t.po.User" id="userRM">
<id property="id" column="id"/>
<result property="username" column="user_name"/>
<result property="password" column="password"/>
<result property="email" column="email"/>
<result property="role" column="role"/>
<collection property="tizis" ofType="t.po.Tizi">
<id property="id" column="tid"/>
<result property="title" column="title"/>
</collection>
</resultMap>
<select id="get" parameterType="String" resultMap="userRM">
select t.id as tid,t.title,t.content,t.user_id,u.* from tizi t,user_table u where u.id=#{id} and t.user_id=u.id
</select>
多对多映射
参照上面一对多，多对多是两个一对多，因为有个关联表
井号和美元符号的区别
"#{}" - 生成sql语句时带单引号，"${}" - 生成sql语句时不带单引号，在进行模糊查询时需要：like '%${name}%'
分页
mybatis分页和数据库有关，用sql语句从数据库端分页
- mysql
select * from table limit 起始记录索引,每页显示条数;
select * from table limit 5,10; //表示，从表里第6条记录开始，查询10条，即检索记录行 6-15
select * from table limit 5; //检索前 5 个记录行 //换句话说，limit n 等价于 limit 0,n。
- oracle
// start - 起始记录索引 end - 结束记录索引
select z.*, rownum
from (select y.*, rownum as rn
from (select * from yonghu order by id desc) y
where rownum <= #{end}) z
where z.rn >= #{start}
缓存（一般由Redis处理）
mybatis一级缓存自动开启，不用配置
二级缓存开启
- 在mybatis的全局配置文件中设置参数
<settings>
<!-- 开启log4j -->
<setting name="logImpl" value="STDOUT_LOGGING"/>
<!-- 开启惰性加载 全局性设置懒加载。如果设为‘false’，则所有相关联的都会被初始化加载 -->
<setting name="lazyLoadingEnabled" value="true"/>
<!-- 当设置为‘true’的时候，懒加载的对象可能被任何懒属性全部加载。否则，每个属性都按需加载。 -->
<setting name="aggressiveLazyLoading" value="true"/>
<!-- 开启二级缓存 -->
<setting name="cacheEnabled" value="true"/>
</settings>
- 在mapper.xml映射配置文件中添加
<cache/>
- PO序列化
public class User implements Serializable {
}
注解（基本不用）
自动生成
- 安装eclipse里插件，mybatis-generator
- 在项目中新建，MyBatis Generator Configuration File
- 修改generatorConfig.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<context id="context1">
<jdbcConnection connectionURL="jdbc:mysql://localhost:3306/monitor?characterEncoding=UTF8" driverClass="com.mysql.jdbc.Driver" password="123456" userId="root" />
<javaModelGenerator targetPackage="my1.po" targetProject="Mybatis1\src" />
<sqlMapGenerator targetPackage="test.xml" targetProject="Mybatis1\src" />
<javaClientGenerator targetPackage="my1.dao" targetProject="Mybatis1\src" type="XMLMAPPER" />
<table tableName="data_table">
<!-- <columnOverride column="???" property="???" />-->
</table>
</context>
</generatorConfiguration>
- 右键eneratorConfig.xml文件，执行Generate MyBatis/iBATIS Artifacts
