MyBatis 使用手冊

月圓吖 發表於 2020-11-21

MyBatis 是一款優秀的持久層框架,它支援自定義 SQL、儲存過程以及高階對映。MyBatis 免除了幾乎所有的 JDBC 程式碼以及設定引數和獲取結果集的工作。MyBatis 可以通過簡單的 XML 或註解來配置和對映原始型別、介面和 Java POJO(Plain Old Java Objects,普通老式 Java 物件)為資料庫中的記錄。

越來越多的企業已經將 MyBatis 使用到了正式的生產環境,本文就使用 MyBatis 的幾種方式提供簡單的示例,以及如何對資料庫密碼進行加密,目前有以下章節:

  • 單獨使用 MyBatis
  • 整合 Spring 框架
  • 整合 Spring Boot 框架
  • Spring Boot 配置資料庫密碼加密

1.單獨使用

引入 MyBatis 依賴,單獨使用,版本是3.5.6

引入依賴

<dependencies>
        <!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.6</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>
    </dependencies>

新增mybatis-config.xml

<?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>
    <!-- plugins在配置檔案中的位置必須符合要求,否則會報錯,順序如下: properties?, settings?, typeAliases?,
        typeHandlers?, objectFactory?,objectWrapperFactory?, plugins?, environments?,
        databaseIdProvider?, mappers? -->
    <!-- 配置mybatis的快取,延遲載入等等一系列屬性 -->
    <settings>
        <!-- 全域性對映器啟用快取 -->
        <setting name="cacheEnabled" value="false" />
        <!-- 對於未知的SQL查詢,允許返回不同的結果集以達到通用的效果 -->
        <setting name="multipleResultSetsEnabled" value="true" />
        <!-- 是否開啟自動駝峰命名規則對映,資料庫的A_COLUMN對映為Java中的aColumn -->
        <setting name="mapUnderscoreToCamelCase" value="true" />
        <!-- MyBatis利用本地快取機制(Local Cache)防止迴圈引用(circular references)和加速重複巢狀查詢 -->
        <setting name="localCacheScope" value="STATEMENT" />
    </settings>
    <!-- 指定路徑下的實體類支援別名(預設實體類的名稱,首字母小寫), @Alias註解可設定別名 -->
    <typeAliases>
        <package name="tk.mybatis.simple.model" />
    </typeAliases>
    <!-- 配置當前環境資訊 -->
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC">
                <property name="" value=""/>
            </transactionManager>
            <!-- 配置資料來源 -->
            <dataSource type="UNPOOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/gsfy_user?useUnicode=true&amp;characterEncoding=UTF-8&amp;useSSL=false"/>
                <property name="username" value="user"/>
                <property name="password" value="password"/>
            </dataSource>
        </environment>
    </environments>
	<!-- 指定Mapper介面的路徑 -->
    <mappers>
        <package name="tk.mybatis.simple.mapper"/>
    </mappers>
</configuration>

開始使用

Model類

tk.mybatis.simple.model.DbTest.java

package tk.mybatis.simple.model;

public class DbTest {

    public Integer id;
    public String text;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    @Override
    public String toString() {
        return "DbTest{" +
                "id=" + id +
                ", text='" + text + '\'' +
                '}';
    }
}

Mapper介面

tk.mybatis.simple.mapper.DbTestMapper

package tk.mybatis.simple.mapper;

import tk.mybatis.simple.model.DbTest;

public interface DbTestMapper {

    DbTest queryById(Integer id);
}

XML對映檔案

XML對映檔案請放於Mapper介面所在路徑下,保證名稱相同

tk/mybatis/simple/mapper/DbTestMapper.xml

<?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="tk.mybatis.simple.mapper.DbTestMapper">
    <select id="queryById" parameterType="int" resultType="DbTest">
        SELECT db_test_id AS id, db_test_text AS text
        FROM db_test
        WHERE db_test_id = #{id, jdbcType=INTEGER}
    </select>
</mapper>

執行示例

package tk.mybatis.simple;

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 tk.mybatis.simple.mapper.DbTestMapper;

import java.io.IOException;
import java.io.Reader;

public class MyBatisHelper {

    private static SqlSessionFactory sqlSessionFactory;

    static {
        try {
            // MyBatis的配置檔案
            Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
            // 建立一個 sqlSessionFactory 工廠類
            sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
            reader.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static SqlSession getSqlSession() {
        return sqlSessionFactory.openSession();
    }

    public static void main(String[] args) {
        // 建立一個 SqlSession 會話
        SqlSession sqlSession = MyBatisHelper.getSqlSession();
        // 獲取 DbTestMapper 介面的動態代理物件
        DbTestMapper dbTestMapper = sqlSession.getMapper(DbTestMapper.class);
        // 執行查詢
        System.out.println(dbTestMapper.queryById(1).toString());
    }
}

2.整合Spring

在 Spring 專案中,使用 MyBatis 的模板,請注意 Spring 的版本為5.2.10.RELEASE

日誌框架使用Log4j2(推薦),版本為2.13.3,效能高於logback和log4j

我的專案模板 Git 地址

工程結構圖

MyBatis-Spring-Example-Structure
  • 其中jquery.min.js檔案可以去官網下載

引入依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>tk.mybatis.simple</groupId>
    <artifactId>mybatis-spring</artifactId>
    <packaging>war</packaging>

    <properties>
        <!-- MyBatis 版本號 -->
        <mybatis.version>3.5.6</mybatis.version>
        <!-- Jackson 版本號 -->
        <jackson.version>2.11.3</jackson.version>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-framework-bom</artifactId>
                <version>5.2.10.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-bom</artifactId>
                <version>2.13.3</version>
                <scope>import</scope>
                <type>pom</type>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!-- MyBatis 相關 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>${mybatis.version}</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>
        <!-- druid 資料來源-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- pagehelper 分頁外掛 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper</artifactId>
            <version>5.2.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.jsqlparser</groupId>
            <artifactId>jsqlparser</artifactId>
            <version>3.2</version>
        </dependency>

        <!--web-->
        <!--支援 Servlet-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <!--支援 JSP-->
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.1</version>
            <scope>provided</scope>
        </dependency>
        <!--支援 JSTL-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>

        <!--Spring 上下文,核心依賴-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
        </dependency>
        <!--Spring JDBC-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
        </dependency>
        <!--Spring 事務-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
        </dependency>
        <!--Spring 面向切面程式設計-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
        </dependency>
        <!--spring-aop 依賴-->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.2</version>
        </dependency>
        <!--JSR 250 公共註解-->
        <dependency>
            <groupId>javax.annotation</groupId>
            <artifactId>javax.annotation-api</artifactId>
            <version>1.2</version>
        </dependency>
        <!--Java 事務介面-->
        <dependency>
            <groupId>javax.transaction</groupId>
            <artifactId>javax.transaction-api</artifactId>
            <version>1.2</version>
        </dependency>

        <!--Spring Web 核心-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
        </dependency>
        <!--Spring MVC-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
        </dependency>
        <!--spring mvc-json依賴-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>${jackson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>${jackson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>${jackson.version}</version>
        </dependency>

        <!-- 日誌檔案管理包 -->
        <!-- log4j2 start -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
        </dependency>
        <!-- 保證 web 應用正常清理 log 資源 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
        </dependency>
        <dependency> <!-- 橋接:slf4j 到 log4j2 的橋樑 -->
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
        </dependency>
        <dependency> <!-- 後向相容:log4j1.x 平滑升級到 log4j2 -->
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-1.2-api</artifactId>
        </dependency>
        <dependency> <!-- 橋接:commons-logging(jcl) 到 log4j2 的橋樑 -->
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-jcl</artifactId>
        </dependency>
        <!-- slf4j 日誌切面,相當於一個介面卡 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.7</version>
        </dependency>
        <!-- 高效能併發程式設計框架 log4j2 使用 -->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.2</version>
        </dependency>
        <!-- log4j2 end -->

        <!-- 上傳元件包 -->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.4</version>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>commons-codec</groupId>
            <artifactId>commons-codec</artifactId>
            <version>1.15</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>study-ssm</finalName>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources/META-INF/spring</directory>
                <includes>
                    <include>spring-mybatis.xml</include>
                    <include>spring-mvc.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

</project>

新增spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                           http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
                           http://www.springframework.org/schema/context
                           http://www.springframework.org/schema/context/spring-context-3.1.xsd
                           http://www.springframework.org/schema/mvc
                           http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">
    <!-- 自動掃描該包,將 Spring Bean 註冊到 Spring 的上下文中 -->
    <context:component-scan base-package="tk.mybatis.simple" />

    <!--避免 IE 執行 AJAX 時,返回 JSON 出現下載檔案 -->
    <bean id="mappingJacksonHttpMessageConverter"
          class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
        <property name="supportedMediaTypes">
            <list>
                <value>text/html;charset=UTF-8</value>
            </list>
        </property>
    </bean>
    <!-- 啟動 SpringMVC 的註解功能,完成請求和註解 POJO 的對映 -->
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter ">
        <property name="messageConverters">
            <list>
                <ref bean="mappingJacksonHttpMessageConverter" /> <!-- JSON轉換器 -->
            </list>
        </property>
    </bean>

    <!-- 配置檔案上傳,如果沒有使用檔案上傳可以不用配置,pom 中也不必引入上傳元件包 -->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <!-- 預設編碼 -->
        <property name="defaultEncoding" value="utf-8" />
        <!-- 檔案大小最大值 100M -->
        <property name="maxUploadSize" value="104857600" />
        <!-- 記憶體中的最大值 4M-->
        <property name="maxInMemorySize" value="40960" />
        <!-- 啟用是為了推遲檔案解析,以便捕獲檔案大小異常 -->
        <property name="resolveLazily" value="true"/>
    </bean>

    <!-- 定義 ViewResolver(檢視解析器),配置多個需要使用 order 屬性排序,InternalResourceViewResolver 放在最後-->
    <bean class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
        <property name="favorParameter" value="true" />
        <property name="parameterName" value="format"/>
        <property name="ignoreAcceptHeader" value="true" />
        <property name="mediaTypes">
            <value>
                <!-- 告訴檢視解析器,返回的型別為 json 格式 -->
                json=application/json
                xml=application/xml
                html=text/html
            </value>
        </property>
        <property name="defaultContentType" value="text/html" />

    </bean>

    <!-- 定義跳轉的檔案的前字尾,檢視名稱解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 自動給後面 action 的方法 return 的字串加上字首和字尾,變成一個可用的地址 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <property name="suffix" value=".jsp" />
    </bean>

    <!-- 擴充了註解驅動,可以將請求引數繫結到控制器引數 -->
    <mvc:annotation-driven />
    <!-- 讓一些靜態的不被 SpringMVC 的攔截器攔截 -->
    <mvc:default-servlet-handler/>
    <!-- 靜態資源 -->
    <mvc:resources location="static/" mapping="/static/**"/>

</beans>

新增mybatis-config.xml

<?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>
	<!-- plugins在配置檔案中的位置必須符合要求,否則會報錯,順序如下: properties, settings, typeAliases, plugins,
			objectFactory, objectWrapperFactory, reflectorFactory, environments, databaseIdProvider, typeHandlers, mappers -->
	<!-- 配置mybatis的快取,延遲載入等等一系列屬性 -->
	<settings>
		<!-- 全域性的開啟或關閉配置檔案中的所有對映器已經配置的任何快取,關閉二級快取,預設開啟 -->
		<setting name="cacheEnabled" value="false" />
		<!-- 開啟一級快取,快取級別為SESSION(預設),如果快取級別為STATEMENT將不會再同一個SqlSession中快取 -->
		<setting name="localCacheScope" value="STATEMENT" />
		<!-- 通過resultMap標籤內的association標籤可使用延遲載入 -->
		<!-- 查詢時,關閉關聯物件即時載入以提高效能,開啟延遲載入,預設關閉,關閉表示直接載入,查詢時就進行關聯查詢 -->
		<setting name="lazyLoadingEnabled" value="true" />
		<!-- 設定關聯物件載入的形態,關閉侵入式延遲載入,在訪問主物件時不進行查詢關聯物件,而是在真正訪問關聯物件時才進行關聯查詢,以提高效能 -->
		<!-- 3.4.1及之前的版本預設為開啟,表示查詢時不進行關聯查詢,訪問主物件時才進行關聯查詢 -->
		<setting name="aggressiveLazyLoading" value="false" />
		<!-- 允許使用列標籤代替列名 -->
		<setting name="useColumnLabel" value="true" />
		<!-- 不允許使用自定義的主鍵值(比如由程式生成的UUID 32位編碼作為鍵值),資料表的PK生成策略將被覆蓋 -->
		<setting name="useGeneratedKeys" value="false" />
		<!-- 是否開啟自動駝峰命名規則(camel case)對映,即從經典資料庫列名A_COLUMN到經典Java屬性名aColumn的類似對映 -->
		<setting name="mapUnderscoreToCamelCase" value="true" />
	</settings>
	<!-- 指定路徑下的實體類支援別名(預設實體類的名稱 全小寫), @Alias 註解可設定別名 -->
	<typeAliases>
		<package name="tk.mybatis.simple.model" />
	</typeAliases>
	<plugins>
		<!-- PageHelper 分頁外掛,配置參考:https://github.com/pagehelper/Mybatis-PageHelper -->
		<plugin interceptor="com.github.pagehelper.PageInterceptor">
			<!-- 使用哪種方言的分頁方式,預設會檢測資料庫連線,自動選擇合適的分頁方式 -->
			<property name="helperDialect" value="mysql"/>
			<!-- 預設值為 false,該引數對使用 RowBounds 作為分頁引數時有效。
			當該引數設定為 true 時,會將 RowBounds 中的 offset 引數當成 pageNum 使用,可以用頁碼和頁面大小兩個引數進行分頁 -->
			<property name="offsetAsPageNum" value="true" />
			<!-- 預設值為false,該引數對使用 RowBounds 作為分頁引數時有效。
			當該引數設定為true時,使用 RowBounds 分頁會進行 count 查詢 -->
			<property name="rowBoundsWithCount" value="true" />
			<!-- 預設值為 false,當該引數設定為 true 時,
			如果 pageSize=0 或者 RowBounds.limit = 0 就會查詢出全部的結果(相當於沒有執行分頁查詢,但是返回結果仍然是 Page 型別)-->
			<property name="pageSizeZero" value="true" />
		</plugin>
	</plugins>
</configuration>

新增spring-mybatis.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
                        http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
                        http://www.springframework.org/schema/tx
                        http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
                        http://www.springframework.org/schema/aop
                        https://www.springframework.org/schema/aop/spring-aop.xsd">
    <!-- 定義一個資料來源 -->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
          init-method="init" destroy-method="close">
        <property name="url" value="jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&amp;characterEncoding=utf8"/>
        <property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
        <property name="username" value="root"/>
        <property name="password" value="password"/>
        <property name="filters" value="stat,log4j,wall"/>
        <!-- 最大連線池數量 -->
        <property name="maxActive" value="20"/>
        <property name="minIdle" value="20"/>
        <!-- 初始化時建立物理連線的個數 -->
        <property name="initialSize" value="5"/>
        <!-- 獲取連線時最大等待時間 -->
        <property name="maxWait" value="10000"/>
        <!-- 在指定時間間隔內執行一次空閒連線回收器 -->
        <property name="timeBetweenEvictionRunsMillis" value="3600000"/>
        <!-- 池中的連線空閒指定時間後被回收 -->
        <property name="minEvictableIdleTimeMillis" value="120000"/>
        <property name="testWhileIdle" value="true"/>
        <property name="testOnBorrow" value="false"/>
    </bean>

    <!-- Spring 和 MyBatis 整合 -->
    <bean id="mySqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <!-- 引入 MyBatis 配置檔案 -->
        <property name="configLocation" value="classpath:mybatis-config.xml"/>
        <!-- 自動掃描 XML 對映檔案 -->
        <property name="mapperLocations" value="classpath:tk/mybatis/simple/mapper/*.xml"/>
    </bean>

    <!-- 通過 MapperScannerConfigurer 類自動掃描 Mapper 介面 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- Mapper 介面所在包路徑 -->
        <property name="basePackage" value="tk.mybatis.simple.mapper"/>
        <!--引用上面的 SqlSessionFactoryBean 物件 -->
        <property name="sqlSessionFactoryBeanName" value="mySqlSessionFactory"/>
    </bean>

    <!-- 事務管理器 -->
    <bean id="txManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <!-- 指定資料來源 -->
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!-- 設定為上面定義事務管理器,預設值為 transactionManager -->
    <tx:annotation-driven transaction-manager="txManager"/>

    <!-- 配置事務傳播特性  -->
    <tx:advice id="transactionAdvice" transaction-manager="txManager">
        <tx:attributes>
            <tx:method name="insert*" rollback-for="java.lang.Exception"/>
            <tx:method name="delete*" rollback-for="java.lang.Exception"/>
            <tx:method name="update*" rollback-for="java.lang.Exception"/>
            <tx:method name="*" read-only="true"/>
        </tx:attributes>
    </tx:advice>
    <!--  配置哪些類的哪些方法參與事務 -->
    <aop:config>
        <aop:advisor advice-ref="transactionAdvice" pointcut="execution(* tk.mybatis.*.service..*Service*.*(..))"/>
    </aop:config>
    <aop:aspectj-autoproxy/>

</beans>

新增log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="INFO" monitorInterval="30">
    <appenders>
        <!-- 參考官方地址:https://logging.apache.org/log4j/2.x/ -->
        <!-- 這個輸出控制檯的配置  -->
        <Console name="Console" target="SYSTEM_OUT">
            <!-- 設定輸出日誌級別(高於 level),匹配才列印 -->
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
            <!-- 列印日誌的格式 -->
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"/>
        </Console>
        <!-- 定義一個日誌輸入檔案 RollingFile,按天或者超過 100M 分割會進行分割 -->
        <RollingFile name="RollingFile" fileName="logs/trace.log"
                     append="true" filePattern="logs/$${date:yyyy-MM}/trace-%d{yyyy-MM-dd}-%i.log.gz">
            <!-- 需要接收的日誌的級別(高於 level) -->
            <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
			<!-- 日誌的格式 -->
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
		<!-- 定義一個日誌輸入檔案 RollingErrorFile,按天或者超過 100M 分割會進行分割 -->
        <RollingFile name="RollingErrorFile" fileName="logs/error.log"
                     append="true" filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
			<!-- 需要接收的日誌的級別(高於 level) -->
            <ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
			<!-- 日誌的格式 -->
            <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"/>
            <Policies>
                <TimeBasedTriggeringPolicy/>
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </appenders>
    <loggers>
        <!--過濾掉 Spring 和 Mybatis 的一些無用的 DEBUG 資訊 -->
        <logger name="org.springframework" level="INFO"/>
        <logger name="org.mybatis" level="INFO"/>
        <root level="INFO" includeLocation="true">
            <appender-ref ref="Console"/>
            <appender-ref ref="RollingFile"/>
            <appender-ref ref="RollingErrorFile"/>
        </root>
    </loggers>
</configuration>

新增web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
         version="3.0">
    <display-name>Archetype Created Web Application</display-name>

    <!-- Spring 和 MyBatis 的配置檔案 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring-mybatis.xml</param-value>
    </context-param>

    <!-- 編碼過濾器,Spring 提供了 CharacterEncodingFilter 過濾器
         這個過濾器就是針對於每次瀏覽器請求進行過濾的,然後再其之上新增了父類沒有的功能即處理字元編碼 -->
    <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <async-supported>true</async-supported>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <!-- 在容器(Tomcat、Jetty)啟動時會被 ContextLoaderListener 監聽到,從而呼叫其 contextInitialized() 方法,初始化 Root WebApplicationContext 容器 -->
    <!-- 宣告 Spring Web 容器監聽器 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <!-- 防止 Spring 記憶體溢位監聽器 -->
    <listener>
        <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
    </listener>

    <!-- 1.SpringMVC 配置 前置控制器(SpringMVC 的入口)
         DispatcherServlet 是一個 Servlet,所以可以配置多個 DispatcherServlet -->
    <servlet>
        <!-- 在 DispatcherServlet 的初始化過程中,框架會在 web 應用 的 WEB-INF 資料夾下,
             尋找名為 [servlet-name]-servlet.xml 的配置檔案,生成檔案中定義的 Bean. -->
        <servlet-name>SpringMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 配置需要載入的配置檔案 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
        <!-- 程式執行時從 web.xml 開始,載入順序為:context-param -> Listener -> Filter -> Structs -> Servlet
             設定 web.xml 檔案啟動時載入的順序(1 代表容器啟動時首先初始化該 Servlet,讓這個 Servlet 隨 Servlet 容器一起啟動)
             load-on-startup 是指這個 Servlet 是在當前 web 應用被載入的時候就被建立,而不是第一次被請求的時候被建立  -->
        <load-on-startup>1</load-on-startup>
        <async-supported>true</async-supported>
    </servlet>
    <servlet-mapping>
        <!-- 這個 Servlet 的名字是 SpringMVC,可以有多個 DispatcherServlet,是通過名字來區分的
             每一個 DispatcherServlet 有自己的 WebApplicationContext 上下文物件,同時儲存在 ServletContext 中和 Request 物件中
             ApplicationContext(Spring 容器)是 Spring 的核心
             Context 我們通常解釋為上下文環境,Spring 把 Bean 放在這個容器中,在需要的時候,可以 getBean 方法取出-->
        <servlet-name>SpringMVC</servlet-name>
        <!-- Servlet 攔截匹配規則,可選配置:*.do、*.action、*.html、/、/xxx/* ,不允許:/* -->
        <url-pattern>/</url-pattern>
    </servlet-mapping>


    <welcome-file-list>
        <!-- 瀏覽器輸入到專案名,預設開啟如下配置頁面 -->
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>

</web-app>

開始使用

Model類

tk.mybatis.simple.model.DbTest.java

package tk.mybatis.simple.model;

public class DbTest {

    public Integer id;
    public String text;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    @Override
    public String toString() {
        return "DbTest{" +
                "id=" + id +
                ", text='" + text + '\'' +
                '}';
    }
}

Mapper介面

tk.mybatis.simple.mapper.DbTestMapper

package tk.mybatis.simple.mapper;

import tk.mybatis.simple.model.DbTest;

public interface DbTestMapper {

    DbTest queryById(Integer id);
}

XML對映檔案

XML對映檔案請放於Mapper介面所在路徑下,保證名稱相同

tk/mybatis/simple/mapper/DbTestMapper.xml

<?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="tk.mybatis.simple.mapper.DbTestMapper">
    <select id="queryById" parameterType="int" resultType="DbTest">
        SELECT db_test_id AS id, db_test_text AS text
        FROM db_test
        WHERE db_test_id = #{id, jdbcType=INTEGER}
    </select>
</mapper>

Controller類

package tk.mybatis.simple.controller;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.servlet.ModelAndView;
import tk.mybatis.simple.mapper.DbTestMapper;
import tk.mybatis.simple.model.DbTest;

@Controller
@RequestMapping(value = "/test")
public class DbTestController {

    private static final Logger logger = LogManager.getLogger(DbTestController.class);

    @Autowired
    private DbTestMapper dbTestMapper;

    @GetMapping("/")
    public String index() {
        return "welcome";
    }

    @GetMapping("/query")
    public ModelAndView query(@RequestParam("id") Integer id) {
        DbTest dbTest = dbTestMapper.queryById(id);
        logger.info("入參:{},查詢結果:{}", id, dbTest.toString());
        ModelAndView mv = new ModelAndView();
        mv.setViewName("result");
        mv.addObject("test", dbTest);
        return mv;
    }
}

index.jsp

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>首頁</title>
</head>
<body>
<h3>Hello World!</h3>
<form method="get" action="<c:url value="/test/"/>">
    <button class="btn btn-default" type="submit">
        <span>開始測試</span>
    </button>
</form>
</body>
</html>

welcome.jsp

<%--
  Created by IntelliJ IDEA.
  User: jingp
  Date: 2019/6/5
  Time: 15:17
  To change this template use File | Settings | File Templates.
--%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>查詢</title>

</head>
<body>
<h3>查詢資料庫</h3>
<form method="get" action="<c:url value="/test/query"/>">
    <div class="input-group">
        <span class="input-group-addon">ID:</span>
        <input type="number" name="id" class="form-control" required>
    </div>
    <button class="btn btn-default" type="submit">
        <span>查詢</span>
    </button>
</form>

<script src="../../static/jquery.min.js"></script>
</body>
</html>

result.jsp

<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html lang="zh-CN">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>結果</title>
</head>
<body>
<h4>查詢結果:${test.toString()}</h4>
<form method="post" action="<c:url value="/"/>">
    <button class="btn btn-default" type="submit">
        <span>退出</span>
    </button>
</form>

<script src="../../static/jquery.min.js"></script>
</body>
</html>

執行程式

配置好Tomcat,然後啟動就可以了,進入頁面,點選開始測試,然後查詢資料庫就可以通過MyBatis運算元據庫了

3.整合SpringBoot

引入依賴

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    
    <groupId>tk.mybatis.simple</groupId>
    <artifactId>mybatis-spring-boot</artifactId>
    <packaging>jar</packaging>

    <properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.apache.logging.log4j</groupId>
                <artifactId>log4j-bom</artifactId>
                <version>2.13.3</version>
                <scope>import</scope>
                <type>pom</type>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!-- Spring Boot 核心包,包括自動裝配,日誌,以及YAML檔案解析 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- 提供全棧的 WEB 開發特性,包括 Spring MVC 依賴和 Tomcat 容器 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 提供通用單元測試依賴,包括 JUnit, Hamcrest , Mockito -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <!-- lombok 工具 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.22</version>
            <scope>provided</scope>
        </dependency>

        <!-- MyBatis 相關 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.4</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.19</version>
        </dependency>
        <!-- druid 資料來源-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.2.3</version>
        </dependency>
        <!-- pagehelper 分頁外掛 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>

        <!-- 日誌檔案管理包 -->
        <!-- log4j2 start -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
        </dependency>
        <!-- 保證 web 應用正常清理 log 資源 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-web</artifactId>
        </dependency>
        <dependency> <!-- 橋接:slf4j 到 log4j2 的橋樑 -->
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j-impl</artifactId>
        </dependency>
        <dependency> <!-- 後向相容:log4j1.x 平滑升級到 log4j2 -->
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-1.2-api</artifactId>
        </dependency>
        <dependency> <!-- 橋接:commons-logging(jcl) 到 log4j2 的橋樑 -->
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-jcl</artifactId>
        </dependency>
        <!-- slf4j 日誌切面,相當於一個介面卡 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.7.7</version>
        </dependency>
        <!-- 高效能併發程式設計框架 log4j2 使用 -->
        <dependency>
            <groupId>com.lmax</groupId>
            <artifactId>disruptor</artifactId>
            <version>3.4.2</version>
        </dependency>
        <!-- log4j2 end -->

        <!-- JSON 工具 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.54</version>
        </dependency>
    </dependencies>

    <build>
        <finalName>basic</finalName>
        <!-- 配置相關外掛 -->
        <plugins>
            <!-- appassembler-maven-plugin -->
            <!-- mvn clean package appassembler:assemble -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -->
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>appassembler-maven-plugin</artifactId>
                <version>1.10</version>
                <configuration>
                    <!-- 生成linux和windows兩種執行指令碼 -->
                    <platforms>
                        <platform>unix</platform>
                        <platform>windows</platform>
                    </platforms>
                    <!-- jar存放的目錄 -->
                    <repositoryName>lib</repositoryName>
                    <!-- jar包存放在指定目錄的規則,預設是${groupId}/${artifactId}的目錄格式,flat表示直接把jar放到目錄下 -->
                    <repositoryLayout>flat</repositoryLayout>
                    <!-- 配置檔案存放的目錄 -->
                    <configurationDirectory>conf</configurationDirectory>
                    <!-- copy配置檔案到上面目錄 -->
                    <copyConfigurationDirectory>true</copyConfigurationDirectory>
                    <!-- 從哪裡copy配置檔案(預設src/main/config) -->
                    <configurationSourceDirectory>src/main/resources</configurationSourceDirectory>
                    <includeConfigurationDirectoryInClasspath>true</includeConfigurationDirectoryInClasspath>
                    <!-- ${project.build.directory}:target, 檔案存放的根目錄 -->
                    <assembleDirectory>${project.build.directory}/basic-assemble</assembleDirectory>
                    <programs>
                        <program>
                            <!-- 啟動類 -->
                            <mainClass>com.fullmoon.study.Application</mainClass>
                            <!-- 生成的檔名稱:basic.sh -->
                            <id>basic</id>
                            <!-- 配置JVM引數 -->
                            <jvmSettings>
                                <extraArguments>
                                    <!--<extraArgument>-server</extraArgument>-->
                                    <extraArgument>-XX:+HeapDumpOnOutOfMemoryError</extraArgument>
                                    <extraArgument>-XX:HeapDumpPath=/app/dump</extraArgument>
                                    <extraArgument>-Xmx512m</extraArgument>
                                    <extraArgument>-Xms512m</extraArgument>
                                </extraArguments>
                            </jvmSettings>
                        </program>
                    </programs>
                </configuration>
            </plugin>
            <!-- 編譯外掛 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
        <!-- 指定 resources -->
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>*.properties</include>
                    <include>*.xml</include>
                    <include>*.yml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
            <resource>
                <directory>src/main/resources/mapper</directory>
                <targetPath>mapper/</targetPath>
                <includes>
                    <include>*.xml</include>
                </includes>
                <filtering>false</filtering>
            </resource>
        </resources>
    </build>

</project>

新增mybatis-config.xml

MyBatis 的配置檔案

<?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>
	<!-- plugins在配置檔案中的位置必須符合要求,否則會報錯,順序如下: properties, settings, typeAliases, plugins,
			objectFactory, objectWrapperFactory, reflectorFactory, environments, databaseIdProvider, typeHandlers, mappers -->
	<!-- 配置mybatis的快取,延遲載入等等一系列屬性 -->
	<settings>
		<!-- 全域性的開啟或關閉配置檔案中的所有對映器已經配置的任何快取,關閉二級快取,預設開啟 -->
		<setting name="cacheEnabled" value="false" />
		<!-- 開啟一級快取,快取級別為SESSION(預設),如果快取級別為STATEMENT將不會再同一個SqlSession中快取 -->
		<setting name="localCacheScope" value="STATEMENT" />
		<!-- 通過resultMap標籤內的association標籤可使用延遲載入 -->
		<!-- 查詢時,關閉關聯物件即時載入以提高效能,開啟延遲載入,預設關閉,關閉表示直接載入,查詢時就進行關聯查詢 -->
		<setting name="lazyLoadingEnabled" value="true" />
		<!-- 設定關聯物件載入的形態,關閉侵入式延遲載入,在訪問主物件時不進行查詢關聯物件,而是在真正訪問關聯物件時才進行關聯查詢,以提高效能 -->
		<!-- 3.4.1及之前的版本預設為開啟,表示查詢時不進行關聯查詢,訪問主物件時才進行關聯查詢 -->
		<setting name="aggressiveLazyLoading" value="false" />
		<!-- 允許使用列標籤代替列名 -->
		<setting name="useColumnLabel" value="true" />
		<!-- 不允許使用自定義的主鍵值(比如由程式生成的UUID 32位編碼作為鍵值),資料表的PK生成策略將被覆蓋 -->
		<setting name="useGeneratedKeys" value="false" />
		<!-- 是否開啟自動駝峰命名規則(camel case)對映,即從經典資料庫列名A_COLUMN到經典Java屬性名aColumn的類似對映 -->
		<setting name="mapUnderscoreToCamelCase" value="true" />
	</settings>
</configuration>

新增application.yml

Spring Boot 的配置檔案

server:
  port: 9092
  servlet:
    context-path: /mybatis-spring-boot-demo
  tomcat:
    accept-count: 200
    min-spare-threads: 200
spring:
  application:
    name: mybatis-spring-boot-demo
  profiles:
    active: test
  servlet:
    multipart:
      max-file-size: 100MB
      max-request-size: 100MB
  datasource:
    druid:
      driver-class-name: com.mysql.cj.jdbc.Driver # 不配置則會根據 url 自動識別
      initial-size: 5 # 初始化時建立物理連線的個數
      min-idle: 20 # 最小連線池數量
      max-active: 20 # 最大連線池數量
      max-wait: 10000 # 獲取連線時最大等待時間,單位毫秒
      validation-query: SELECT 1 # 用來檢測連線是否有效的 sql
      test-while-idle: true # 申請連線的時候檢測,如果空閒時間大於 timeBetweenEvictionRunsMillis,則執行 validationQuery 檢測連線是否有效
      test-on-borrow: false # 申請連線時執行 validationQuery 檢測連線是否有效
      min-evictable-idle-time-millis: 120000 # 連線保持空閒而不被驅逐的最小時間,單位是毫秒
      time-between-eviction-runs-millis: 3600000 # 配置間隔多久才進行一次檢測,檢測需要關閉的空閒連線,單位是毫秒
      filters: stat,log4j,wall # 配置過濾器,stat-監控統計,log4j-日誌,wall-防禦 SQL 注入
      connection-properties: 'druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000' # StatFilter配置,開啟合併 SQL 功能和慢 SQL 記錄
      web-stat-filter: # WebStatFilter 配置
        enabled: true
        url-pattern: '/*'
        exclusions: '*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*'
      stat-view-servlet: # StatViewServlet 配置
        enabled: true
        url-pattern: '/druid/*'
        reset-enable: false
        login-username: druid
        login-password: druid
      aop-patterns: 'com.fullmoon.study.service.*' # Spring 監控配置
mybatis:
  type-aliases-package: tk.mybatis.simple.model
  mapper-locations: classpath:mapper/*.xml
  config-location: classpath:mybatis-config.xml
pagehelper:
  helper-dialect: mysql
  reasonable: true # 分頁合理化引數
  offset-as-page-num: true # 將 RowBounds 中的 offset 引數當成 pageNum 使用
  supportMethodsArguments: true # 支援通過 Mapper 介面引數來傳遞分頁引數
# 測試環境
---
spring:
  profiles: test
  datasource:
    druid:
      url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&amp;characterEncoding=utf8
      username: root
      password: password

注意上面 mybatis 的相關配置,XML 對映檔案是存放於 classpath 下的 mapper 資料夾下面的

新增log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="INFO" monitorInterval="30">
	<appenders>
		<!-- 參考官方地址:https://logging.apache.org/log4j/2.x/ -->
		<!-- 這個輸出控制檯的配置  -->
		<Console name="Console" target="SYSTEM_OUT">
			<!-- 設定輸出日誌級別(高於 level),匹配才列印 -->
			<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
			<!-- 列印日誌的格式 -->
			<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"/>
		</Console>
		<!-- 定義一個日誌輸入檔案 RollingFile,按天或者超過 100M 分割會進行分割 -->
		<RollingFile name="RollingFile" fileName="logs/trace.log"
					 append="true" filePattern="logs/$${date:yyyy-MM}/trace-%d{yyyy-MM-dd}-%i.log.gz">
			<!-- 需要接收的日誌的級別(高於 level) -->
			<ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
			<!-- 日誌的格式 -->
			<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"/>
			<Policies>
				<TimeBasedTriggeringPolicy/>
				<SizeBasedTriggeringPolicy size="100 MB"/>
			</Policies>
		</RollingFile>
		<!-- 定義一個日誌輸入檔案 RollingErrorFile,按天或者超過 100M 分割會進行分割 -->
		<RollingFile name="RollingErrorFile" fileName="logs/error.log"
					 append="true" filePattern="logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log.gz">
			<!-- 需要接收的日誌的級別(高於 level) -->
			<ThresholdFilter level="WARN" onMatch="ACCEPT" onMismatch="DENY"/>
			<!-- 日誌的格式 -->
			<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:%4p %t (%F:%L) - %m%n"/>
			<Policies>
				<TimeBasedTriggeringPolicy/>
				<SizeBasedTriggeringPolicy size="100 MB"/>
			</Policies>
		</RollingFile>
	</appenders>
	<loggers>
		<!--過濾掉 Spring 和 Mybatis 的一些無用的 DEBUG 資訊 -->
		<logger name="org.springframework" level="INFO"/>
		<logger name="org.mybatis" level="INFO"/>
		<root level="INFO" includeLocation="true">
			<appender-ref ref="Console"/>
			<appender-ref ref="RollingFile"/>
			<appender-ref ref="RollingErrorFile"/>
		</root>
	</loggers>
</configuration>

開始使用

在 Spring Boot 專案的啟動類上面新增 @MapperScan("tk.mybatis.simple.mapper") 註解,指定 Mapper 介面所在的包路徑,啟動類如下:

@SpringBootApplication
@EnableTransactionManagement
@MapperScan("tk.mybatis.simple.mapper")
public class Application {
    public static void main(String[] args){
        SpringApplication.run(Application.class, args);
    }
}

然後在 classpath 下的 mapper 資料夾(根據 application.yml 配置檔案中的定義)新增 XML 對映檔案,即可開始使用 MyBatis了

其中 @EnableTransactionManagement 註解表示開啟事務的支援(@SpringBootApplication 註解在載入容器的時候已經開啟事務管理的功能了,也可不需要新增該註解)

在需要事務的方法或者類上面新增 @Transactional 註解即可,引入spring-boot-starter-jdbc依賴,注入的是 DataSourceTransactionManager 事務管理器,事務的使用示例如下:

@Transactional(propagation = Propagation.REQUIRED, rollbackFor = Exception.class)
public int insertFeedback(UserFeedbackInfo requestAddParam) {
    try {
        // ... 業務邏輯 
    } catch (Exception e) {
        // 事務回滾
        TransactionAspectSupport.currentTransactionStatus().setRollbackOnly();
        return 0;
    }
}

4.SpringBoot配置資料庫密碼加密?

4.1 藉助Druid資料來源

Druid 資料來源支援資料庫密碼進行加密,在 Spring Boot 中配置方式如下:

加密資料庫密碼,通過 Druid 的 com.alibaba.druid.filter.config.ConfigTools 工具類對資料庫密碼進行加密(RSA 演算法),如下:

public static void main(String[] args) throws Exception {
    ConfigTools.main(new String[]{"you_password"});
}

或者執行以下命令:

java -cp druid-1.0.16.jar com.alibaba.druid.filter.config.ConfigTools you_password

輸出:

privateKey:MIIBVgIBADANBgkqhkiG9w0BAQEFAASCAUAwggE8AgEAAkEA6+4avFnQKP+O7bu5YnxWoOZjv3no4aFV558HTPDoXs6EGD0HP7RzzhGPOKmpLQ1BbA5viSht+aDdaxXp6SvtMQIDAQABAkAeQt4fBo4SlCTrDUcMANLDtIlax/I87oqsONOg5M2JS0jNSbZuAXDv7/YEGEtMKuIESBZh7pvVG8FV531/fyOZAiEA+POkE+QwVbUfGyeugR6IGvnt4yeOwkC3bUoATScsN98CIQDynBXC8YngDNwZ62QPX+ONpqCel6g8NO9VKC+ETaS87wIhAKRouxZL38PqfqV/WlZ5ZGd0YS9gA360IK8zbOmHEkO/AiEAsES3iuvzQNYXFL3x9Tm2GzT1fkSx9wx+12BbJcVD7AECIQCD3Tv9S+AgRhQoNcuaSDNluVrL/B/wOmJRLqaOVJLQGg==
publicKey:MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAOvuGrxZ0Cj/ju27uWJ8VqDmY7956OGhVeefB0zw6F7OhBg9Bz+0c84RjzipqS0NQWwOb4kobfmg3WsV6ekr7TECAwEAAQ==
password:PNak4Yui0+2Ft6JSoKBsgNPl+A033rdLhFw+L0np1o+HDRrCo9VkCuiiXviEMYwUgpHZUFxb2FpE0YmSguuRww==

然後在 application.yml 中新增以下配置:

spring:
  datasource:
    druid:
      password: ${password} # 加密後的資料庫密碼
      filters: config # 配置 ConfigFilter ,通過它進行解密
      # 提示需要對資料庫密碼進行解密
      connection-properties: 'config.decrypt=true;config.decrypt.key=${publickey}'
publicKey: MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAJvQUB7pExzbzTpaQCCY5qS+86MgYWvRpqPUCzjFwdMgrBjERE5X5oojSe48IGZ6UtCCeaI0PdhkFoNaJednaqMCAwEAAQ==

這樣就OK了,主要是在 ConfigFilter 過濾器中,會先對密碼進行解密,然後再設定到 DataSource 資料來源

4.2 藉助Jasypt加密包

Jasypt是一個 Java 庫,可以讓開發人員將基本的加密功能新增到專案中,而無需對加密的工作原理有深入的瞭解

接下來講述的在 Spring Boot 專案中如何使用Jasypt,其他使用方法請參考Jasypt Github地址

引入依賴

<!-- jasypt 加密工具,https://github.com/ulisesbocchio/jasypt-spring-boot -->
<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

新增註解

在啟動類上面新增@EnableEncryptableProperties註解,使整個 Spring 環境啟用 Jasypt 加密功能,如下:

@SpringBootApplication
@EnableEncryptableProperties
public class Application {
    public static void main(String[] args){
        SpringApplication.run(Application.class, args);
    }
}

獲取密文

需要通過 Jasypt 官方提供的 jar 包進行加密,如下:

import com.ulisesbocchio.jasyptspringboot.properties.JasyptEncryptorConfigurationProperties;
import org.jasypt.encryption.pbe.PooledPBEStringEncryptor;
import org.jasypt.encryption.pbe.config.PBEConfig;
import org.jasypt.encryption.pbe.config.SimpleStringPBEConfig;

/**
 * @author jingping.liu
 * @date 2020-11-20
 * @description Jasypt 安全框架加密類工具包
 */
public class JasyptUtils {

    /**
     * 生成一個 {@link PBEConfig} 配置物件
     * <p>
     * 注意!!!
     * 可檢視 Jasypt 全域性配置物件 {@link JasyptEncryptorConfigurationProperties} 中的預設值
     * 這裡的配置建議與預設值保持一致,否則需要在 application.yml 中定義這裡的配置(也可以通過 JVM 引數的方法)
     * 注意 password 和 algorithm 配置項,如果不一致在啟動時可能會解密失敗而報錯
     *
     * @param salt 鹽值
     * @return SimpleStringPBEConfig 加密配置
     */
    private static SimpleStringPBEConfig generatePBEConfig(String salt) {
        SimpleStringPBEConfig config = new SimpleStringPBEConfig();
        // 設定 salt 鹽值
        config.setPassword(salt);
        // 設定要建立的加密程式池的大小,這裡僅臨時建立一個,設定 1 即可
        config.setPoolSize("1");
        // 設定加密演算法, 此演算法必須由 JCE 提供程式支援,預設值 PBEWITHHMACSHA512ANDAES_256
        config.setAlgorithm("PBEWithMD5AndDES");
        // 設定應用於獲取加密金鑰的雜湊迭代次數
        config.setKeyObtentionIterations("1000");
        // 設定要請求加密演算法的安全提供程式的名稱
        config.setProviderName("SunJCE");
        // 設定 salt 鹽的生成器
        config.setSaltGeneratorClassName("org.jasypt.salt.RandomSaltGenerator");
        // 設定 IV 生成器
        config.setIvGeneratorClassName("org.jasypt.iv.RandomIvGenerator");
        // 設定字串輸出的編碼形式,支援 base64 和 hexadecimal
        config.setStringOutputType("base64");
        return config;
    }

    /**
     * 通過 {@link PooledPBEStringEncryptor} 進行加密密
     *
     * @param salt 鹽值
     * @param message 需要加密的內容
     * @return 加密後的內容
     */
    public static String encrypt(String salt, String message) {
        PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
        SimpleStringPBEConfig pbeConfig = generatePBEConfig(salt);
        // 生成加密配置
        encryptor.setConfig(pbeConfig);
        System.out.println("----ARGUMENTS-------------------");
        System.out.println("message: " + message);
        System.out.println("salt: " + pbeConfig.getPassword());
        System.out.println("algorithm: " + pbeConfig.getAlgorithm());
        System.out.println("stringOutputType: " + pbeConfig.getStringOutputType());
        // 進行加密
        String cipherText = encryptor.encrypt(message);
        System.out.println("----OUTPUT-------------------");
        System.out.println(cipherText);
        return cipherText;
    }

    public static String decrypt(String salt, String message) {
        PooledPBEStringEncryptor encryptor = new PooledPBEStringEncryptor();
        // 設定解密配置
        encryptor.setConfig(generatePBEConfig(salt));
        // 進行解密
        return encryptor.decrypt(message);
    }

    public static void main(String[] args) {
        // 隨機生成一個 salt 鹽值
        String salt = UUID.randomUUID().toString().replace("-", "");
        // 進行加密
        encrypt(salt, "message");
    }
}

如何使用

直接在 application.yml 配置檔案中新增 Jasypt 配置和生成的密文

jasypt:
  encryptor:
    password: salt # salt 鹽值,需要和加密時使用的 salt 一致
    algorithm: PBEWithMD5AndDES # 加密演算法,需要和加密時使用的演算法一致
    string-output-type: hexadecimal # 密文格式,,需要和加密時使用的輸出格式一致
spring:
  datasource:
    druid:
      username: root
      password: ENC(cipherText) # Jasypt 密文格式:ENC(密文)

salt 鹽值也可以通過 JVM 引數進行設定,例如:-Djasypt.encryptor.password=salt

啟動後,Jasypt 會先根據配置將 ENC(密文) 進行解密,然後設定到 Spring 環境中

後續會繼續新增如何實現動態資料來源的相關內容