Spring中使用通用Mapper

搭建Spring整合Mybatis環境

1、創建項目

創建一個Maven工程即可，我們不需要整合SpringMVC，所以不需要web工程。

2、導入依賴

在pom.xml中導入Spring的相關依賴、Mybatis、數據庫依賴、以及通用Mapper。

<dependencies>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.5</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>1.3.2</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.2.8.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>5.2.8.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.2.8.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.5</version>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
    </dependency>

    <!-- 通用mapper -->
    <dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper</artifactId>
        <version>4.1.5</version>
    </dependency>

    <!-- log4j日志 -->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
        <version>1.6.6</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.30</version>
    </dependency>

    <!--c3p0連接池-->
    <dependency>
        <groupId>com.mchange</groupId>
        <artifactId>c3p0</artifactId>
        <version>0.9.5.2</version>
    </dependency>

    <!--junit單元測試-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
</dependencies>

3、配置Spring整合Mybatis環境

• 配置mysql連接信息jdbc.properties。

jdbc.user=root
jdbc.password=root123
jdbc.url=jdbc:mysql://localhost:3306/k0503db?useUnicode=true&characterEncoding=utf8
jdbc.driver=com.mysql.jdbc.Driver

• 創建Mybatis的配置文件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>

</configuration>

• 創建Spring的配置文件applicationContext.xml，整合Mybatis，配置聲明式事務等。

<?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:aop="http://www.springframework.org/schema/aop"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">
	
	<!-- 配置數據源 -->
	<context:property-placeholder location="classpath:jdbc.properties"/>

	<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
		<property name="user" value="${jdbc.user}"/>
		<property name="password" value="${jdbc.password}"/>
		<property name="jdbcUrl" value="${jdbc.url}"/>
		<property name="driverClass" value="${jdbc.driver}"/>
	</bean>

	<!-- 整合MyBatis -->
	<bean id="sqlSessionFactoryBean" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="configLocation" value="classpath:mybatis-config.xml"/>
		<property name="dataSource" ref="dataSource"/>
	</bean>
	
	<!-- 整合通用Mapper所需要做的配置修改： -->
	<!-- 原始全類名：org.mybatis.spring.mapper.MapperScannerConfigurer -->
	<!-- 通用Mapper使用：tk.mybatis.spring.mapper.MapperScannerConfigurer -->
	<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
		<property name="basePackage" value="com.coydone.mapper"/>
	</bean>

	<!-- 配置Service自動掃描的包 -->
	<context:component-scan base-package="com.coydone.service"/>

	<!-- 配置聲明式事務 -->
	<bean id="dataSourceTransactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
		<property name="dataSource" ref="dataSource"/>
	</bean>

	<aop:config>
		<aop:advisor advice-ref="txAdvice" pointcut="execution(* *..*Service.*(..))"/>
	</aop:config>

	<tx:advice id="txAdvice" transaction-manager="dataSourceTransactionManager">
		<tx:attributes>
			<tx:method name="get*" read-only="true"/>
			<tx:method name="add*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
			<tx:method name="delete*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
			<tx:method name="update*" rollback-for="java.lang.Exception" propagation="REQUIRES_NEW"/>
		</tx:attributes>
	</tx:advice>
</beans>

4、配置log4j日志

由於我們要查看sql語句的執行，所以我們可以配置log4j的控制台日志輸出，方便我們跟蹤sql。

• 在pom文件中導入log4j的依賴。
• 在resources下創建log4j.properties文件。

log4j.rootLogger=DEBUG,myConsole
log4j.appender.myConsole=org.apache.log4j.ConsoleAppender
log4j.appender.myConsole.ImmediateFlush=true
log4j.appender.myConsole.Target=System.out
log4j.appender.myConsole.layout=org.apache.log4j.PatternLayout
log4j.appender.myConsole.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

log4j.logger.com.mchange.v2=ERROR

5、測試整合環境

package com.coydone.test;

import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

public class MapperTest {
    private ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
    @Test
    public void test() throws SQLException {
        DataSource dataSource = ac.getBean(DataSource.class);
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }
}

通用Mapper介紹

官方代碼地址：https://gitee.com/free

官方文檔：https://gitee.com/free/Mapper/wikis/pages?sort_id=208199&doc_id=10514

我們使用通用Mapper后，在mapper中我們對於單表的CRUD無需在xml配置文件中進行編寫。雖然MBG可以自動生成xml文件，但是MBG生成的xml比較混亂，不利於代碼的維護。使用通用Mapper后，只需實現通用Mapper的接口，就可以使用它內置的對單表的CRUD方法。

配置通用Mapper

• 在pom文件中導入通用mapper的依賴。
• 在Spring的配置文件中將mapper配置掃描的信息org.mybatis.spring.mapper.MapperScannerConfigurer中的org改為tk。

<!-- 整合通用Mapper所需要做的配置修改： -->
<!-- 原始全類名：org.mybatis.spring.mapper.MapperScannerConfigurer -->
<!-- 通用Mapper使用：tk.mybatis.spring.mapper.MapperScannerConfigurer -->
<bean class="tk.mybatis.spring.mapper.MapperScannerConfigurer">
    <property name="basePackage" value="com.coydone.mapper"/>
</bean>

使用通用Mapper

1、創建與數據庫表對應的實體類。

考慮到基本數據類型在 Java 類中都有默認值，會導致 MyBatis 在執行相關操作 時很難判斷當前字段是否為 null，所以在 MyBatis 環境下使用 Java 實體類時盡量不要使用基本數據類型，都使用對應的包裝類型。

public class Student implements Serializable {
    private Integer xh;
    private String name;
    private Integer age;
    private String sex;
    private Date birthday;
    private Integer state;
    private String address;
    private Integer gid;//年級編號
    //省略getter()、setter()、無參構造、有參構造、toString()方法
}

2、編寫實體類對應的mapper接口，只需繼承通用Mapper的Mapper接口即可。

/**
 * 具體操作數據庫的mapper接口，它需要繼承通用mapper的Mapper<T>的接口。
 * T表示我們操作數據庫實體的類型
 */
public interface StudentMapper extends Mapper<Student> {
}

3、編寫service層及其實現。

public interface StudentService {
    Student getOne(Student student);
}
@Service
public class StudentServiceImpl implements StudentService {
    @Autowired
    private StudentMapper studentMapper;

    @Override
    public Student getOne(Student student) {
        return studentMapper.selectOne(student);
    }
}

4、在測試類中測試通用Mapper提供的基本方法。

public class StudentMapperTest {
    private ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
    private StudentService studentService = ac.getBean(StudentService.class);
    @Test
    public void testSelectOne() {
        //1.創建封裝查詢條件的實體類對象
        Student student = new Student(null,"亞索",23,null,null,null,null,null);
        //2.執行查詢
        Student student1 = studentService.getOne(student);
        //3.打印
        System.out.println(student1);
    }
}

常用注解

@Table

作用：建立實體類和數據庫表之間的對應關系。

默認規則：實體類類名首字母小寫作為表名。Student類→student表。

用法：在@Table 注解的 name 屬性中指定目標數據庫表的表名。

@Table(name = "student")
public class Student implements Serializable {}

@Column

作用：建立實體類字段和數據庫表字段之間的對應關系。

默認規則： 實體類字段：駝峰式命名；數據庫表字段：使用“_”區分各個單詞。

用法：在@Column 注解的 name 屬性中指定目標字段的字段名 。

@Column(name = "birthday")
private Date birthday;

@Id

通用 Mapper 在執行xxxByPrimaryKey(key)方法時，有兩種情況。

情況 1：沒有使用@Id注解明確指定主鍵字段。

之所以會生成上面這樣的WHERE子句是因為通用Mapper將實體類中的所有字段都拿來放在一起作為聯合主鍵。

情況 2：使用@Id 主鍵明確標記和數據庫表中主鍵字段對應的實體類字段。

@Id
private Integer xh;

@GeneratedValue

作用：讓通用 Mapper 在執行 insert 操作之后將數據庫自動生成的主鍵值回寫到實體類對象中。

自增主鍵用法：（MySQL數據庫）

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer xh;

序列主鍵用法：（Oracle數據庫）

@Id
@GeneratedValue(
    strategy = GenerationType.IDENTITY,
    generator = "select SEQ_ID.nextval from dual")
private Integer id;

@Transient

一般情況下，實體中的字段和數據庫表中的字段是一一對應的，但是也有很多情況我們會在實體中增加一些額外的屬性，這種情況下，就需要使用 @Transient 注解來告訴通用 Mapper 這不是表中的字段。

默認情況下，只有簡單類型（基本類型的包裝類）會被自動認為是表中的字段（可以通過配置中的useSimpleType控制）。

常用方法

1、selectOne()

使用非空的值生成 WHERE 子句，在條件表達式中使用“=”進行比較，要求必須返回一個實體類結果，如果有多個，則會拋出異常。

2、xxxByPrimaryKey()

需要使用@Id主鍵明確標記和數據庫表主鍵字段對應的實體類字段，否則通用 Mapper 會將所有實體類字段作為聯合主鍵。

3、xxxSelective()

非主鍵字段如果為 null 值，則不加入到 SQL 語句中。

QBC查詢

QBC是Query By Criteria 的簡稱，Criteria 是 Criterion 的復數形式。意思是：規則、標准、准則。在 SQL 語句中相當於查詢條件。 QBC 查詢是將查詢條件通過 Java 對象進行模塊化封裝。

示例：

@Test
public void testSelectByExample() {
    //目標：WHERE (age > ? AND age< ? ) OR (gid = 1)
    //1.創建 Example 對象
    Example example = new Example(Student.class);

    // i.設置排序信息
    //example.orderBy("xh").asc().orderBy("age").desc();
    //ii.設置“去重”
    //example.setDistinct(true);
    //iii.設置 select 字段
    //example.selectProperties("name","age");

    //2.通過 Example 對象創建 Criteria 對象
    Example.Criteria criteria01 = example.createCriteria();
    Example.Criteria criteria02 = example.createCriteria();

    //3.在兩個 Criteria 對象中分別設置查詢條件
    // property 參數：實體類的屬性名
    // value 參數：實體類的屬性值
    criteria01.andGreaterThan("age", 20).andLessThan("age", 40);
    criteria02.andEqualTo("gid", 1);

    //4.使用 OR 關鍵詞組裝兩個 Criteria 對象
    example.or(criteria02);

    //5.執行查詢
    List<Student> students = studentService.selectByExample(example);
    for (Student student : students) {
        System.out.println(student);
    }
}

通用Mapper幫我們生成的SQL：

逆向工程

通用Mapper逆向工程在碼雲上的官方文檔：https://gitee.com/free/Mapper/wikis/pages?sort_id=236560&doc_id=10514

1、在pom文件中配置依賴和插件

<dependencies>
    <dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper</artifactId>
        <version>4.1.5</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.5</version>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.6</version>
            <configuration>
                <configurationFile>
                    ${basedir}/src/main/resources/generator/generatorConfig.xml
                </configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>5.1.47</version>
                </dependency>
                <dependency>
                    <groupId>tk.mybatis</groupId>
                    <artifactId>mapper</artifactId>
                    <version>4.1.5</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

2、在resources/generator下創建MGB的配置文件：generatorConfig.xml。

<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!-- 引入外部屬性文件 -->
    <properties resource="config.properties"/>

    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!-- 配置通用mapperMBG相關信息 -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            <property name="caseSensitive" value="true"/>
        </plugin>

        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.url}"
                        userId="${jdbc.user}"
                        password="${jdbc.password}">
        </jdbcConnection>

        <!--實體類存放位置-->
        <javaModelGenerator targetPackage="com.coydone.entity"
                            targetProject="src/main/java"/>

        <!--mapper.xml文件存放位置-->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources"/>

        <!--mapper接口存放位置-->
        <javaClientGenerator targetPackage="com.coydone.mapper"
                             targetProject="src/main/java"
                             type="XMLMAPPER"/>

        <!-- 根據數據庫表生成Java文件的相關規則 -->
        <!-- tableName="%"表示數據庫中所有表都參與逆向工程，此時使用默認規則 -->
        <!-- 默認規則：table_dept→TableDept -->
        <!-- 不符合默認規則時需要使用tableName和domainObjectName兩個屬性明確指定 -->
        <table tableName="student" domainObjectName="Student">
            <!-- 配置主鍵生成策略 -->
            <generatedKey column="xh" sqlStatement="Mysql" identity="true" />
        </table>
        <table tableName="grade" domainObjectName="Grade">
            <generatedKey column="gid" sqlStatement="Mysql" identity="true" />
        </table>
    </context>
</generatorConfiguration>

3、配置MBG配置文件中依賴的數據庫連接信息配置：config.properties。

# 數據庫連接信息
jdbc.driverClass = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://localhost:3306/k0503db
jdbc.user = root
jdbc.password = root123

#c3p0
jdbc.maxPoolSize=50
jdbc.minPoolSize=10
jdbc.maxStatements=100
jdbc.testConnection=true

# mapper
mapper.plugin = tk.mybatis.mapper.generator.MapperPlugin
mapper.Mapper = tk.mybatis.mapper.common.Mapper

4、在Maven中運行MBG插件。

5、測試

public static void main(String[] args) {
    SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();
    InputStream inputStream = MBGTest.class.getClassLoader().getResourceAsStream("mybatis-config.xml");
    SqlSessionFactory sqlSessionFactory = builder.build(inputStream);
    SqlSession sqlSession = sqlSessionFactory.openSession();
    
    //安照java的方式整合通用mapper
    //創建MapperHelper對象
    MapperHelper mapperHelper = new MapperHelper();
    //通過MapperHelper對象對原生的Mybatis的Configuration對象進行處理
    Configuration configuration = sqlSession.getConfiguration();
    mapperHelper.processConfiguration(configuration);

    StudentMapper studentMapper = sqlSession.getMapper(StudentMapper.class);
    List<Student> students = studentMapper.selectAll();
    for (Student student : students) {
        System.out.println(student);
    }
}

二級緩存

1、在mybatis的配置文件中配置開啟二級緩存。

<!--開啟二級緩存-->
<settings>
    <setting name="cacheEnabled" value="true"/>
</settings>

2、在 XxxMapper接口上使用@CacheNamespace注解。

@CacheNamespace
public interface StudentMapper extends Mapper<Student> {
}

3、XxxMapper接口對應的實體類支持序列化。即實現Serializable接口。

public class Student implements Serializable {}