Mybatis-入门（3. 配置解析）学习笔记

1. 核心配置文件

• mybatis-config.xml 系统核心配置文件

• MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。

• 能配置的内容如下：

• configuration（配置）
  • properties（属性）★
  • settings（设置）★
  • typeAliases（类型别名）★
  • typeHandlers（类型处理器）
  • objectFactory（对象工厂）
  • plugins（插件）
  • environments（环境配置）★
    • environment（环境变量）
      • transactionManager（事务管理器）
      • dataSource（数据源）
  • databaseIdProvider（数据库厂商标识）
  • mappers（映射器）★

• 注意元素节点的顺序！顺序不对会报错
  ★为必须要掌握的

2. 配置环境（environments）

<environments default="development">
 <environment id="development">
 <!-- 事务管理器 -->
   <transactionManager type="JDBC">
     <property name="..." value="..."/>
   </transactionManager>
 <!-- 数据源 -->
   <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>

• 配置MyBatis的多套运行环境，将SQL映射到多个不同的数据库上，必须指定其中一个为默认运行环境（通过default指定），所以需要保证每一个环境的 id 唯一

• 子元素节点：environment

  • transactionManager 用来配置事务管理器，如果使用的是 Spring + Mabatis 就不需要配置这项
    有两种选项：

  type="[JDBC(默认使用) / MANAGED]"

  • dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

    • 数据源是必须配置的。

    • 有三种内建的数据源类型

    type="[UNPOOLED | POOLED | JNDI]"）

    • unpooled：这个数据源的实现只是每次被请求时打开和关闭连接。
    • pooled：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来 , 这是一种使得并发 Web 应用快速响应请求的流行处理方式。(默认使用)
    • jndi：这个数据源的实现是为了能在如 Spring 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。

  • 数据源也有很多第三方的实现，比如dbcp，c3p0，druid等等…

3. 属性（properties）

• 我们可以通过 properties属性 来引用配置文件
• 示例

1. 编写数据库配置文件

   driver=com.mysql.cj.jdbc.Driver
   url=jdbc:mysql://localhost:3306/mybatis_test?useSSL=true&useUnicode=true&characterEncoding=utf8&serverTimezone=GMT
   username=root
   password=123456

2. 在 核心配置文件（mybatis.xml) 中引入，及使用

   <!--    引入外部配置文件-->
       <properties resource="db.properties">
   <!--  内部也可以添加键值对，和写在配置文件中一样的效果-->
   <!--  可以不写-->
   <!--  <property name="" value=""/>-->
   <!--  如果这里写的键值对和外部配置文件中的键值对冲突，会优先选择外部配置文件的-->
       </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. 类型别名（typeAliases）

• 是为 Java 类型设置一个短的名字，它之和xml 配置文件有关，避免类型的前缀的冗余
• 使用别名时可以忽略大小写
• 核心配置文件中的配置

1. 方式一： 给单个的实体类起别名

   <!--给类型起别名，使用别名时可以忽略大小写-->
       <typeAliases>
   <!--     给单个的实体类起别名-->
           <typeAlias type="com.pojo.User" alias="user"></typeAlias>
       </typeAliases>
   

2. 方式二：自动扫描实体类的包，并使用首字母小写来作为别名

   <!--给类型起别名，使用别名时可以忽略大小写-->
       <typeAliases>
   <!--     自动扫描实体类的包，并使用首字母小写来作为别名-->
           <package name="com.pojo"/>
       </typeAliases>
   

    如果想要修改，自动生成的别名，可以使用 注解 @Alias（“”）
   

   @Alias（“myuser”）
   public class User{
   }

3. 使用

   <select id="getAllUser" resultType="User" >
         select * from user
   </select>
   

5. 设置（settings）

• 一个配置完整的 settings 元素的示例如下：

  <settings>
   <setting name="cacheEnabled" value="true"/>
   <setting name="lazyLoadingEnabled" value="true"/>
   <setting name="multipleResultSetsEnabled" value="true"/>
   <setting name="useColumnLabel" value="true"/>
   <setting name="useGeneratedKeys" value="false"/>
   <setting name="autoMappingBehavior" value="PARTIAL"/>
   <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
   <setting name="defaultExecutorType" value="SIMPLE"/>
   <setting name="defaultStatementTimeout" value="25"/>
   <setting name="defaultFetchSize" value="100"/>
   <setting name="safeRowBoundsEnabled" value="false"/>
   <setting name="mapUnderscoreToCamelCase" value="false"/>
   <setting name="localCacheScope" value="SESSION"/>
   <setting name="jdbcTypeForNull" value="OTHER"/>
   <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
  </settings>
  

• 这里只介绍几个常用的

1. 缓存
   
2. 懒加载
   
3. 自动生成 Key
   
4. 开启驼峰命名
   
5. 指定 Mybatis 日志的具体实现
   

日志工厂

如果一个数据库操作出现了异常，我们需要排错，日志就是最好的助手
以前会使用 ： sout 、 debug
现在 ： 日志工厂（就是配置上述 “logImpl”）

• SLF4J
• LOG4J 【掌握】
• LOG4J2
• JDK_LOGGING
• COMMONS_LOGGING
• STDOUT_LOGGING 【掌握】标准日志输出
• NO_LOGGING

在 mybatis 具体使用哪一个，在核心配置文件中设定

STDOUT_LOGGING

<!--  可写多个  -->
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>

配置完后的控制台输出

LOG4J

• Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件
• 我们也可以控制每一条日志的输出格式
• 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程
• 通过一个配置文件来灵活地进行配置，而不需要修改应用的代码

配置

1. 导入 LOG4J 的包

   <!-- https://mvnrepository.com/artifact/log4j/log4j -->
   <dependency>
       <groupId>log4j</groupId>
       <artifactId>log4j</artifactId>
       <version>1.2.17</version>
   </dependency>
   

2. 编写 log4j.properties 配置文件

   #将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码
   log4j.rootLogger=DEBUG,console,file
   
   #控制台输出的相关设置
   log4j.appender.console = org.apache.log4j.ConsoleAppender
   log4j.appender.console.Target = System.out
   log4j.appender.console.Threshold=DEBUG
   log4j.appender.console.layout = org.apache.log4j.PatternLayout
   log4j.appender.console.layout.ConversionPattern=【%c】-%m%n
   
   #文件输出的相关设置
   log4j.appender.file = org.apache.log4j.RollingFileAppender
   log4j.appender.file.File=./log/hehe.log
   log4j.appender.file.MaxFileSize=10mb
   log4j.appender.file.Threshold=DEBUG
   log4j.appender.file.layout=org.apache.log4j.PatternLayout
   log4j.appender.file.layout.ConversionPattern=【%p】【%d{yy-MM-dd}】【%c】%m%n
   
   #日志输出级别
   log4j.logger.org.mybatis=DEBUG
   log4j.logger.java.sql=DEBUG
   log4j.logger.java.sql.Statement=DEBUG
   log4j.logger.java.sql.ResultSet=DEBUG
   log4j.logger.java.sql.PreparedStatement=DEBUG
   

3. 配置 log4j 的日志实现

   <!--  可写多个  -->
       <settings>
           <setting name="logImpl" value="LOG4J"/>
       </settings>
   

4. 直接运行，控制台结果
   

使用

1. 在需要使用 log4j 的类中 导入包（易错）

   import org.apache.log4j.Logger;
   

2. 创建日志对象

   static Logger logger = Logger.getLogger(userDaoTest.class);
   

3. 代码中的使用，可以理解为输出语句

   @Test
       public void log4jTest(){
           logger.info("info：进入 LOG4J");
           logger.debug("debug：进入 LOG4J");
           logger.error("error：进入 LOG4J");
       }
   

6. 映射器（mappers）

• 映射器 : 定义映射SQL语句文件
• 引入资源方式

1. 方式一：使用相对于类路径的资源引用（推荐）

   <mappers>
     <mapper resource="com/dao/UserMapper.xml"/>
   </mappers>
   

2. 方式二： 使用映射器接口实现类的完全限定类名

   <mappers>
     <mapper class="com.dao.UserMapper"/>
   </mappers>
   

   使用该方法发注意点：
   - 接口和他的 Mapper 配置文件必须同名
   - 接口和他的 Mapper 配置文件必须在同一个包下

3. 方式三：将包内的映射器接口实现全部注册为映射器

   <mappers>
     <package name="com.dao"/>
   </mappers>
   

   使用该方法发注意点：
   - 接口和他的 Mapper 配置文件必须同名
   - 接口和他的 Mapper 配置文件必须在同一个包下

• Mapper文件

  <?xml version="1.0" encoding="UTF-8" ?>
  <!DOCTYPE mapper
         PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
         "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  <mapper namespace="com.dao.UserMapper">
  </mapper>
  

• namespace中文意思：命名空间，作用如下：

  • namespace的命名必须跟某个接口同名

  • 接口中的方法与映射文件中sql语句id应该一一对应

  1. namespace和子元素的id联合保证唯一 , 区别不同的mapper

  2. 绑定DAO接口

  3. namespace命名规则 : 包名+类名