Mybatis的学习随笔
MyBatis是一款优秀的持久层框架，支持自定义SQL，存储过程以及高级映射。MyBatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。MyBatis可以通过简单的XML或注解来配置和映射原始类型，接口和Java POJO(Planin Old java Objects，普通的java对象)为数据库中的记录（官方解释）
通过JDBC连接（其实这些CRM其实本质上是对于jdbc操作的封装）
先在项目的resource文件夹创建db.propertres
driver=com.mysql.jdbc.Driver 驱动
url=jdbc:mysql://localhost:3306/数据库名?useUnicode=true&characterEncoding=UTF-8&useSSL=false
name=root 用户名
pwd=123456 密码
package jdbc;
import sun.java2d.cmm.Profile;
import java.io.InputStream;
import java.sql.*;
import java.util.Properties;
/**
* @author：www
* @copyright: www
**/
public class Demo01 {
private static String driver;
private static String url;
private static String username;
private static String pwd;
static {
try {
//获取properties中的值
InputStream inStream = Demo01.class.getClassLoader().getResourceAsStream("db.properties");
Properties properties=new Properties();
properties.load(inStream);
driver= properties.getProperty("driver");
url= properties.getProperty("url");
username= properties.getProperty("name");
pwd= properties.getProperty("pwd");
//加载驱动
Class.forName(properties.getProperty("driver"));
}catch (Exception E){
E.printStackTrace();
}
}
//获得连接
public static Connection getConnection(){
Connection connection=null;
try {
connection= DriverManager.getConnection(url,username,pwd);
} catch (SQLException e) {
e.printStackTrace();
}
return connection;
}
//关闭资源
public static boolean close(Connection connection, PreparedStatement preparedStatement, ResultSet resultSet){
boolean flag=true;
if(null!=resultSet){
try {
resultSet.close();
//GC回收。直接把这个对象设置为null ，在垃圾回收的时候会直接回收这种垃圾/
resultSet=null;
} catch (SQLException e) {
e.printStackTrace();
flag=false;
}
}
if(null!=connection){
try {
connection.close();
//GC回收。直接把这个对象设置为null ，在垃圾回收的时候会直接回收这种垃圾/
connection=null;
} catch (SQLException e) {
e.printStackTrace();
flag=false;
}
}
if(null!=preparedStatement){
try {
preparedStatement.close();
//GC回收。直接把这个对象设置为null ，在垃圾回收的时候会直接回收这种垃圾/
preparedStatement=null;
} catch (SQLException e) {
e.printStackTrace();
flag=false;
}
}
return flag;
}
public static void main(String[] args) {
System.out.println(Demo01.getConnection());
}
}
2.我的第一个Mybatis程序
首先mybatis的中文文档官网：https://mybatis.org/mybatis-3/zh/getting-started.html
mybatis的jar包获取。通过maven仓库，或者是官网，或者是github都可以。
-
创建一个maven项目，引入需要的jar包
<!--mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.44</version>
</dependency>
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.3</version>
</dependency>
<!--junit 测试用-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
</dependency> -
创建一个模块
-
编写工具类获得session
package com.dbh.mybatis.utils;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;
/**
* 通帮助类：通过SqlSessionFactoryBuilder().build(inputStream)来获取SqlSessionFactory
* @version 1.0
* @author：www
* @copyright: www
* @Date: 2020/9/27 16:44
**/
public class MybatisUtils {
//线程本地变量，线程安全
private static ThreadLocal<SqlSession> threadLocal=new InheritableThreadLocal<SqlSession>();
private static SqlSessionFactory sqlSessionFactory;
static {
try {
InputStream resourceAsStream = Resources.getResourceAsStream("mybatis-config.xml");
sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
} catch (IOException e) {
e.printStackTrace();
}
}
//既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
//SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的
//打开
public static SqlSession openSession(){
SqlSession sqlSession = threadLocal.get();
if(null==sqlSession){
sqlSession=sqlSessionFactory.openSession();
threadLocal.set(sqlSession);
}
return sqlSession;
}
//关闭
//一般这种资源需要使用了就要关闭。不然会造成资源的浪费
public static void closeSession(){
SqlSession sqlSession = threadLocal.get();
if(null!=sqlSession){
sqlSession.close();
threadLocal.remove();
threadLocal.set(null);
}
}
//测试是否可以获得，如果更据我的操作的话，一般会报错，在Mapper中的内容不存在。所以可以先注释，也可以生命再写。mapper在mybatis一般就是你对数据库持久层操作的内容
public static void main(String[] args){
SqlSession sqlSession =MybatisUtils.openSession();
System.out.println(sqlSession);
MybatisUtils.closeSession();
}
}
-
编写代码
-
实体类(数据库需要有user，列名一样)
-
Dao接口
package com.dbh.mybatis.mapper;
import com.dbh.mybatis.model.User;
import java.util.List;
/**
* @version 1.0
* @author：www
* @copyright: www
* @Date: 2020/9/27 17:27
**/
public interface UserMapper {
//查看全部user
List<User> getUserList();
} -
接口实现,mybtis的实行和其他的不一样。是同过xml
-
测试
package com.dbh.mybatis.mapper; import com.dbh.mybatis.mapper.UserMapper; import com.dbh.mybatis.model.User; import com.dbh.mybatis.utils.MybatisUtils; import org.apache.ibatis.session.SqlSession; import org.junit.After; import org.junit.Before; import org.junit.Test; import java.util.List; /** * @version 1.0 * @author：www * @copyright: www * @Date: 2020/9/27 17:38 **/ public class UserMapperTest { SqlSession sqlSession; UserMapper mapper; @Before public void before(){ //通过帮助类获取到sqlsession sqlSession = MybatisUtils.openSession(); //执行sql mapper = sqlSession.getMapper(UserMapper.class); } @After public void after(){ //关闭sqlsession，防止浪费资源 MybatisUtils.closeSession(); } @Test public void test1(){ //方式一 List<User> users = mapper.getUserList(); users.forEach((a)-> System.out.println(a)); //方式二 List<User> users2 = sqlSession.selectList("com.dbh.mybatis.mapper.UserMapper.getUserList"); users2.forEach((a)-> System.out.println(a)); } }
-
3.基于myatis的CRUD（基于上面的配置）
在接口中增加4个方法
//查看单个
User getUser(int id);
//增加
int addUser(User user);
//删除
int delUser(int id);
//修改
int update(User user);
xml文件中
<select id="getUser" resultType="com.dbh.mybatis.model.User">
select *from user where id=#{id}
</select>
<!--parameterType 参数类型-->
<insert id="addUser" parameterType="com.dbh.mybatis.model.User">
insert into user(username) values (#{username})
</insert>
<delete id="delUser">
delete from user where id=#{id}
</delete>
<update id="update" parameterType="com.dbh.mybatis.model.User">
update user set username =#{username} where id=#{id}
</update>
测试类(增删改需要提交事务，所以在after方法加一个提交)
//查询单个
@Test
public void test2(){
User users = mapper.getUser(2);
System.out.println(users);
}
//增加
@Test
public void test3(){
User user =new User();
user.setUsername("dbh");
int i=mapper.addUser(user);
System.out.println(i);
}
//删除
@Test
public void test4(){
int i=mapper.delUser(11);
System.out.println(i);
}
//修改
@Test
public void test5(){
User user =new User();
user.setUsername("周杰伦");
user.setId(9);
int i=mapper.update(user);
System.out.println(i);
}
@After
public void after(){
//如果不提交的话，增加数据不会被插入数据库
sqlSession.commit();
MybatisUtils.closeSession();
}
4.配置解析以及优化
1.核心配置文件
mybatis-config.xml
configuration（配置） properties（属性） settings（设置） typeAliases（类型别名） typeHandlers（类型处理器） objectFactory（对象工厂） plugins（插件） environments（环境配置） environment（环境变量） transactionManager（事务管理器） dataSource（数据源） databaseIdProvider（数据库厂商标识） mappers（映射器）
2.环境配置
MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。
不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。
1.事务管理器（transactionManager）
-
JDBC(默认)：这个配置直接使用了 JDBC 的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。
-
MANAGED：这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。
2. 数据源（dataSource）
-
UNPOOLED：
这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：
-
driver– 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。 -
url– 这是数据库的 JDBC URL 地址。 -
username– 登录数据库的用户名。 -
password– 登录数据库的密码。 -
defaultTransactionIsolationLevel– 默认的连接事务隔离级别。 -
defaultNetworkTimeout– 等待数据库操作完成的默认网络超时时间（单位：毫秒）。查看java.sql.Connection#setNetworkTimeout()的 API 文档以获取更多信息。
作为可选项，你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可，例如：
-
driver.encoding=UTF8
这将通过 DriverManager.getConnection(url, driverProperties) 方法传递值为
UTF8的encoding属性给数据库驱动。 -
-
POOLED(默认)：
这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。
除了上述提到 UNPOOLED 下的属性外，还有更多属性用来配置 POOLED 的数据源：
-
poolMaximumActiveConnections– 在任意时间可存在的活动（正在使用）连接数量，默认值：10 -
poolMaximumIdleConnections– 任意时间可能存在的空闲连接数。 -
poolMaximumCheckoutTime– 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒） -
poolTimeToWait– 这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直失败且不打印日志），默认值：20000 毫秒（即 20 秒）。 -
poolMaximumLocalBadConnectionTolerance– 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过poolMaximumIdleConnections与poolMaximumLocalBadConnectionTolerance之和。 默认值：3（新增于 3.4.5） -
poolPingQuery– 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动出错时返回恰当的错误消息。 -
poolPingEnabled– 是否启用侦测查询。若开启，需要设置poolPingQuery属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。 -
poolPingConnectionsNotUsedFor– 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。
-
-
JNDI：
这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的数据源引用。这种数据源配置只需要两个属性：
-
initial_context– 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data_source 属性。 -
data_source– 这是引用数据源实例位置的上下文路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。
-
3.属性properties
这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置
例如：
创建一个db.properties
driver=com.mysql.jdbc.Driver url=jdbc:mysql://localhost:3306/dbhblog?useUnicode=true&characterEncoding=UTF-8 username=root password=123456
在mybatis核心配置文件中引用
<!--引入外部文件-->
<properties resource="db.properties"/>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
注意点：
-
可以直接引入外部的
-
可以在里面增加一些配置
-
如果外部和内部存在同一个字段，优先会使用外部配置
4.类型别名
-
类型别名可为 Java 类型设置一个缩写名字。
-
意在降低冗余的全限定类名书写
<!--可以给实体类和包起别名-->
<typeAliases>
<!--类 -->
<!-- <typeAlias alias="user" type="com.dbh.mybatis02.model.User"></typeAlias>-->
<!--包 每一个在包 domain.blog 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名-->
<package name="com.dbh.mybatis02.model" />
</typeAliases>
-
实体类比较少的话使用类起别名，可以增强代码的可读性。如果过多的话使用给包起别名的方式。
-
类起别名可以DIY，包起别名就不行，如果需要改的话，需要在配置包的别名的基础上加@Alias("别名")注解
@Alias("user") @Data public class User {下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的，注意，为了应对原始类型的命名重复，采取了特殊的命名风格。
别名 映射的类型 _byte byte _long long _short short _int int _integer int _double double _float float _boolean boolean string String byte Byte long Long short Short int Integer integer Integer double Double float Float boolean Boolean date Date decimal BigDecimal bigdecimal BigDecimal object Object map Map hashmap HashMap list List arraylist ArrayList collection Collection iterator Iterator
5.设置
这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。
| 设置名 | 描述 | 有效值 | 默认值 |
|---|---|---|---|
| cacheEnabled | 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 | true | false | true |
| lazyLoadingEnabled | 延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。 |
true | false | false |
| aggressiveLazyLoading | 开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 lazyLoadTriggerMethods)。 |
true | false | false （在 3.4.1 及之前的版本中默认为 true） |
| multipleResultSetsEnabled | 是否允许单个语句返回多结果集（需要数据库驱动支持）。 | true | false | true |
| useColumnLabel | 使用列标签代替列名。实际表现依赖于数据库驱动，具体可参考数据库驱动的相关文档，或通过对比测试来观察。 | true | false | true |
| useGeneratedKeys | 允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）。 | true | false | False |
| autoMappingBehavior | 指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射；PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集（无论是否嵌套）。 | NONE, PARTIAL, FULL | PARTIAL |
| autoMappingUnknownColumnBehavior | 指定发现自动映射目标未知列（或未知属性类型）的行为。NONE: 不做任何反应WARNING: 输出警告日志（'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN）FAILING: 映射失败 (抛出 SqlSessionException) |
NONE, WARNING, FAILING | NONE |
| defaultExecutorType | 配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
| defaultStatementTimeout | 设置超时时间，它决定数据库驱动等待数据库响应的秒数。 | 任意正整数 | 未设置 (null) |
| defaultFetchSize | 为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。 | 任意正整数 | 未设置 (null) |
| defaultResultSetType | 指定语句默认的滚动策略。（新增于 3.5.2） | FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT（等同于未设置） | 未设置 (null) |
| safeRowBoundsEnabled | 是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。 | true | false | False |
| safeResultHandlerEnabled | 是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。 | true | false | True |
| mapUnderscoreToCamelCase | 是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。 | true | false | False |
| localCacheScope | MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。 | SESSION | STATEMENT | SESSION |
| jdbcTypeForNull | 当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。 | JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。 | OTHER |
| lazyLoadTriggerMethods | 指定对象的哪些方法触发一次延迟加载。 | 用逗号分隔的方法列表。 | equals,clone,hashCode,toString |
| defaultScriptingLanguage | 指定动态 SQL 生成使用的默认脚本语言。 | 一个类型别名或全限定类名。 | org.apache.ibatis.scripting.xmltags.XMLLanguageDriver |
| defaultEnumTypeHandler | 指定 Enum 使用的默认 TypeHandler 。（新增于 3.4.5） |
一个类型别名或全限定类名。 | org.apache.ibatis.type.EnumTypeHandler |
| callSettersOnNulls | 指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。 | true | false | false |
| returnInstanceForEmptyRow | 当返回行的所有列都是空时，MyBatis默认返回 null。 当开启这个设置时，MyBatis会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2） |
true | false | false |
| logPrefix | 指定 MyBatis 增加到日志名称的前缀。 | 任何字符串 | 未设置 |
| logImpl | 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。 | SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未设置 |
| proxyFactory | 指定 Mybatis 创建可延迟加载对象所用到的代理工具。 | CGLIB | JAVASSIST | JAVASSIST （MyBatis 3.3 以上） |
| vfsImpl | 指定 VFS 的实现 | 自定义 VFS 的实现的类全限定名，以逗号分隔。 | 未设置 |
| useActualParamName | 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1） |
true | false | true |
| configurationFactory | 指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。（新增于 3.2.3） |
一个类型别名或完全限定类名。 | 未设置 |
| shrinkWhitespacesInSql | Removes extra whitespace characters from the SQL. Note that this also affects literal strings in SQL. (Since 3.5.5) | true | false | false |
6.映射器
<!-- 使用相对于类路径的资源引用 --> <!-- 一般是使用这个方式 --> <mappers> <mapper resource="org/mybatis/builder/AuthorMapper.xml"/> <mapper resource="org/mybatis/builder/BlogMapper.xml"/> <mapper resource="org/mybatis/builder/PostMapper.xml"/> </mappers> <!-- 使用完全限定资源定位符（URL） 基本上不怎么用--> <mappers> <mapper url="file:///var/mappers/AuthorMapper.xml"/> <mapper url="file:///var/mappers/BlogMapper.xml"/> <mapper url="file:///var/mappers/PostMapper.xml"/> </mappers> <!-- 使用映射器接口实现类的完全限定类名 --> <!--注意点： 1.接口和它的Mapper配置文件必须同名 2.接口和它的Mapper配置文件必须在同一个包下 --> <mappers> <mapper class="org.mybatis.builder.AuthorMapper"/> <mapper class="org.mybatis.builder.BlogMapper"/> <mapper class="org.mybatis.builder.PostMapper"/> </mappers> <!-- 将包内的映射器接口实现全部注册为映射器 --> <!--注意点： 1.接口和它的Mapper配置文件必须同名 2.接口和它的Mapper配置文件必须在同一个包下 --> <mappers> <package name="org.mybatis.builder"/> </mappers>
注意：如果将xml文件放置到非resource处，maven导包项目的时候不会导入，所以需要在pom.xml加入过滤条件
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
</resource>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<filtering>true</filtering>
</resource>
</resources>
</build>
