一、创建 mybatis-intermediate 工程
将MyBatis 源码学习笔记(一)- MyBatis概述中创建的mybatis-quick-start工程拷贝并重命名为mybatis-intermediate。
二、MyBatis Configuration 配置文件
mybatis-config.xml是MyBatis的核心,它将影响MyBatis的行为。
MyBatis configuration标签中又包含了以下这些标签,每个标签都有不同的作用
typeAliases 别名的使用
在mybatis-config.xml中的settings标签下面增加别名的配置
<!--定义默认的别名,类名首字母小写--> <typeAliases> <package name="com.lilith.entity" /> </typeAliases> 复制代码
在UserMapper中,凡是使用到“com.lilith.entity.User”的地方都可以使用“user”来代替
<select id="selectByPrimaryKey" resultType="user"> SELECT <include refid="userColumns"></include> FROM t_user where id = #{id} </select> 复制代码
执行测试类中的selectByPrimaryKey方法
environment 标签配置MyBatis开发环境(DEV,TEST,PROD)
- environment 元素是配置一个数据源的开始,属性id是它的唯一标识,DEV,TEST,PROD
- transactionManager 元素配置数据库事务,其中type属性有三种配置方式
- jdbc,采用jdbc的方式管理事务;
- managed,采用容器的方式管理事务,在JNDI数据源中使用;
- 自定义,自定义数据库事务管理办法;
- dataSource 元素配置数据源连接信息,type属性是连接数据库的方式配置,有四种配置方式
- UNPOOLED 非连接池方式连接
- POOLED 使用连接池连接,数据库连接关闭后会放回连接池,等待下一次使用
- JNDI 使用JNDI数据源
- 自定义数据源
MyBatis settings标签配置
settings中的配置都是全局配置,虽然配置很多,但是常用的也就只有几个
- cacheEnabled: 该配置会影响所有映射器(Mapper XML文件中 mapper标签)配置的缓存的全局开关,默认值为true。
- lazyLoadingEnabled: 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联 关系中可通过设置fetchType属性来覆盖该项的开关状态,默热值为false
- aggressiveLazyLoading: 当启用时,对任意延迟属性的调用会使带有延迟加载属性的对象完整加载; 反之,每种属性将会按需加载,默认值为true
- multipleResultSetsEnabled:是否允许单一语句返回多结果集(需要兼容驱动),默认为true
- userColumnLabel: 使用列标签代替列名。不同的驱动在这方面会有不同的表现, 具体可参考 相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果,默认为true
- userGeneratedKeys:允许 JDBC 支持自动生成主键,需要驱动兼容。 如果设置为 true 则这个设 置强制使用自动生成主键,尽管一些驱动不能兼容但仍可正常工作,默认为fasle,当设置了主键auto increment时要开启这个配置
- autoMappingBehavior:指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射 PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集(无论是否嵌套),默认为PARTIAL
- defaultExecutorType:配置默认的执行器。SIMPLE 就是普通的执行器;REUSE 执行器会 重用预处理语句(prepared statements); BATCH 执行器将重用 语句并执行批量更新。默认值时SIMPLE
- defaultStatementTimeout:设置超时时间,它决定驱动等待数据库响应的秒数
- safeRowBoundsEnabled:允许在嵌套语句中使用分页(RowBounds),默认是false
- mapUnderscoreToCamelCase:是否开启自动驼峰命名规则(camel case)映射,即从经典数据库 列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射,默认是false
- localCacheScope:MyBatis 利用本地缓存机制(Local Cache)防止循环引用(circula r references)和加速重复嵌套查询。 默认值为 SESSION,这种情 况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT, 本地会话仅用在语句执行上,对相同 SqlSession 的不同调用将不会 共享数据
- jdbcTypeForNull:当没有为参数提供特定的 JDBC 类型时,为空值指定 JDBC 类型。某些驱动需要指定列的 JDBC 类型,多数情况直接用一般类型即可,比如 NULL、VARCHAR 或 OTHER,jdbcType枚举最常见的是NULL,VARCHAR,OTHER。默认是OTHER
- lazyLoadTriggerMethods:指定哪个对象的方法触发一次延迟加载,如果是方法列表用逗号隔开,默认值equals,clon e,hashCode ,toString
- callSettersOnNulls:指定当结果集中值为 null 的时候是否调用映射对象的 setter (map 对象时为 put)方法,这对于有 Map.keySet() 依赖或 null 值初始化的时候是有用的。注意基本类型(int、boolean 等)是不能设置成 null 的。
- logPrefix:指定 MyBatis 增加到日志名称的前缀。
- logImpl:指定 MyBatis 所用日志的具体实现,未指定时将自动查找。
- proxyFactory:指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具
<!-- 参数设置 --> <settings> <!-- 这个配置使全局的映射器启用或禁用缓存 --> <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> 复制代码
mappers标签配置mapper文件
在mappers标签下配置Mapper XML文件共有四种方式
- 用classpath类路径资源引用
<mappers> <mapper resource="mappers/UserMapper.xml"></mapper> </mappers> 复制代码
- 用类注册的方式引用
<mappers> <mapper resource="com.lilith.mapper.UserMapper"></mapper> </mappers> 复制代码
- 使用包名引入映射文件名
<mappers> <mapper resource="com.lilith.mapper"></mapper> </mappers> 复制代码
- 用映射文件的绝对路径应用
<mappers> <mapper resource="/Users/Practice/March/mybatis-intermediate/src/main/resources/mappers/UserMapper.xml"></mapper> </mappers> 复制代码
推荐使用第一种方式
三、MyBatis Mapper XML 文件
mapper配置文件主要用来配置SQL语句和映射规则,mapper标签有一个namespace属性,它的属性值应该是Mapper接口的全类名,这是一个约定,这样才能形成Mapper接口与Mapper文件的映射关系,而mapper标签中又包含了以下这几个标签
- cache – 给定命名空间的缓存配置
- cache-ref – 其他命名空间缓存配置的引用
- resultMap – 是最复杂也是最强大的元素,用来描述如何从数据库结果集中来加载对象
- sql – 可被其他语句引用的可重用语句块
- insert – 映射插入语句
- update – 映射更新语句
- delete – 映射删除语句
- select – 映射查询语句
sql 标签
sql标签用来配置sql片段,针对重复次数较多的SQL片段,并使用include标签来引用配置的sql片段
<sql id="Base_Column_List"> id,user_name,real_name,sex,mobile,email,note,position_id </sql> <select id="selectByPrimaryKey" resultType="user"> SELECT <include refid="Base_Column_List"></include> FROM t_user where id = #{id} </select> 复制代码
参数传递 #{} 和 ${}
SQL语句中获取参数值的方式有两种,一种是#{参数名},另一种是${参数名},两者的区别在于:
- #{} 会将传入的数据当成一个字串,进行预编译也就是会对自动传入的数据加一个双引号,能很大程度上方式SQL注入
- ${} 则是将传入的值直接显示在SQL语句中,无法防止SQL注入
${}传值出现SQL注入
在UserMapper中新增一个方法selectById
List<User> selectById(Object id); 复制代码
在UserMapper.xml中增加映射的SQL语句,这里使用${}传值
<select id="selectById" resultType="user"> SELECT <include refid="userColumns"></include> FROM t_user where id = ${id} </select> 复制代码
在UserMapperTest中新增测试方法selectById
@Test public void selectById() { SqlSession sqlSession = sqlSessionFactory.openSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); List<User> users = mapper.selectById("1 or 1 = 1"); System.out.println("查询到的数据为:" + users); } 复制代码
执行测试
根据控制台输出,该方法将所有的数据全部查询出来,这就是典型的SQL注入情况,将${}改为#{}再次执行测试
只查出了id为1的数据,有效的避免了SQL注入
表名、选取的列是动态的,ORDER BY和IN操作都可以使用${}来传值
UserMapper接口中新增方法selectByTablename
User selectByTablename(String tablename); 复制代码
增加selectByTablename的映射SQL语句
<select id="selectByTablename" resultType="user"> SELECT <include refid="userColumns"></include> FROM ${tablename} where id = 1 </select> 复制代码
测试类中增加测试方法selectByTablename
@Test public void selectByTablename() { SqlSession sqlSession = sqlSessionFactory.openSession(); UserMapper mapper = sqlSession.getMapper(UserMapper.class); User user = mapper.selectByTablename("t_user"); System.out.println("查询到的数据为:" + user); } 复制代码
执行测试