0
0

提升开发效率的必备技能：Spring集成Mybatis和PageHelper详解

引言

在Web应用程序开发中，数据持久化和分页查询是两个非常重要的环节。MyBatis是一个优秀的持久化框架，而PageHelper则是Spring平台上一个轻量级的分页插件。然而，在实际的开发过程中，我们经常需要将这两个框架进行整合，以实现更高效的开发效率。本文将详细介绍如何将Spring与MyBatis集成，以及如何将PageHelper集成到Spring项目中，从而帮助我们更好地应对实际开发中的挑战。

一、Spring集成MyBatis

1.1.pom依赖

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <maven.compiler.plugin.version>3.7.0</maven.compiler.plugin.version>

    <!--添加jar包依赖-->
    <!--1.spring 5.0.2.RELEASE相关-->
    <spring.version>5.0.2.RELEASE</spring.version>
    <!--2.mybatis相关-->
    <mybatis.version>3.4.5</mybatis.version>
    <!--mysql-->
    <mysql.version>5.1.44</mysql.version>
    <!--pagehelper分页jar依赖-->
    <pagehelper.version>5.1.2</pagehelper.version>
    <!--mybatis与spring集成jar依赖-->
    <mybatis.spring.version>1.3.1</mybatis.spring.version>
    <!--3.dbcp2连接池相关 druid-->
    <commons.dbcp2.version>2.1.1</commons.dbcp2.version>
    <commons.pool2.version>2.4.3</commons.pool2.version>
    <!--4.log日志相关-->
    <log4j2.version>2.9.1</log4j2.version>
    <!--5.其他-->
    <junit.version>4.12</junit.version>
    <servlet.version>4.0.0</servlet.version>
    <lombok.version>1.18.2</lombok.version>
</properties>

<dependencies>
    <!--1.spring相关-->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-orm</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <!--2.mybatis相关-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>${mybatis.version}</version>
    </dependency>
    <!--mysql-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.version}</version>
    </dependency>
    <!--pagehelper分页插件jar包依赖-->
    <dependency>
        <groupId>com.github.pagehelper</groupId>
        <artifactId>pagehelper</artifactId>
        <version>${pagehelper.version}</version>
    </dependency>
    <!--mybatis与spring集成jar包依赖-->
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>${mybatis.spring.version}</version>
    </dependency>

    <!--3.dbcp2连接池相关-->
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-dbcp2</artifactId>
        <version>${commons.dbcp2.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-pool2</artifactId>
        <version>${commons.pool2.version}</version>
    </dependency>

    <!--4.log日志相关依赖-->
    <!--核心log4j2jar包-->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>${log4j2.version}</version>
    </dependency>
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-api</artifactId>
        <version>${log4j2.version}</version>
    </dependency>
    <!--web工程需要包含log4j-web，非web工程不需要-->
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-web</artifactId>
        <version>${log4j2.version}</version>
    </dependency>

    <!--5.其他-->
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>${junit.version}</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>${servlet.version}</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>${lombok.version}</version>
        <scope>provided</scope>
    </dependency>

</dependencies>

<resources>
    <!--解决mybatis-generator-maven-plugin运行时没有将XxxMapper.xml文件放入target文件夹的问题-->
    <resource>
        <directory>src/main/java</directory>
        <includes>
            <include>**/*.xml</include>
        </includes>
    </resource>
    <!--解决mybatis-generator-maven-plugin运行时没有将jdbc.properites文件放入target文件夹的问题-->
    <resource>
        <directory>src/main/resources</directory>
        <includes>
            <include>jdbc.properties</include>
            <include>*.xml</include>
        </includes>
    </resource>
</resources>

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>${maven.compiler.plugin.version}</version>
    <configuration>
        <source>${maven.compiler.source}</source>
        <target>${maven.compiler.target}</target>
        <encoding>${project.build.sourceEncoding}</encoding>
    </configuration>
</plugin>
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>
    <dependencies>
        <!--使用Mybatis-generator插件不能使用太高版本的mysql驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>
    </dependencies>
    <configuration>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

①将<properties>与<dependencies>标签内容进行替换即可。

②<build>标签内将<pluginManagement>标签删除（解除版本锁定），加入<resources>。

可以确保mybatis-generator-maven-plugin在运行时能够正确地将所需的文件复制到目标文件夹中，避免出现缺少文件或配置错误的问题。

③Maven插件的配置，用于使用MyBatis Generator插件

小贴士：

dbcp2连接池介绍

连接池的主要作用是减少数据库连接的创建和销毁次数，从而提高应用程序的性能。除此之外，连接池还有以下优点：1、简化的编程模式在使用连接池的时候，每一个单独的线程能够像创建了一个自己的 JDBC 连接一样操作，允许用户直接使用JDBC编程技术；2、受控的资源使用如果用户不使用连接池，而是每当线程需要时创建一个新的连接，那么用户的应用程序的资源使用会产生非常大的浪费并且可能会导致高负载下的异常发生；3、减少连接创建时间 。

除了dbcp2以外还有druid、c3p0都是连接池。

lombok介绍

Lombok是一个Java库，能自动插入编辑器并构建工具，简化Java开发。通过添加注解的方式，不需要为类编写getter或eques方法，同时可以自动化日志变量 。Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率 。

1.2.配置文件

将我们的配置文件加入到项目中。

generatorConfig.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!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="jdbc.properties"/>

    <!--指定数据库jdbc驱动jar包的位置-->
    <classPathEntry location="E:\\apache-maven-3.5.0-bin\\mvn_Repository\\mysql\\mysql-connector-java\\5.1.44"/>
    
    <!-- 一个数据库一个context -->
    <context id="infoGuardian">
        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="true"/> <!-- 是否生成注释代时间戳 -->
        </commentGenerator>

        <!-- jdbc连接 -->
        <jdbcConnection driverClass="${jdbc.driver}"
                        connectionURL="${jdbc.url}" userId="${jdbc.username}" password="${jdbc.password}"/>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 01 指定javaBean生成的位置 -->
        <!-- targetPackage：指定生成的model生成所在的包名 -->
        <!-- targetProject：指定在该项目下所在的路径  -->
        <javaModelGenerator targetPackage="com.csdn.xw.model"
                            targetProject="src/main/java">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对model添加构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否针对string类型的字段在set的时候进行trim调用 -->
            <property name="trimStrings" value="false"/>
            <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!-- 02 指定sql映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="com.csdn.xw.mapper"
                         targetProject="src/main/java">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 03 生成XxxMapper接口 -->
        <!-- type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象 -->
        <!-- type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 -->
        <!-- type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
        <javaClientGenerator targetPackage="com.csdn.xw.mapper"
                             targetProject="src/main/java" type="XMLMAPPER">
            <!-- 是否在当前路径下新加一层schema,false路径com.oop.eksp.user.model， true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 配置表信息 -->
        <!-- schema即为数据库名 -->
        <!-- tableName为对应的数据库表 -->
        <!-- domainObjectName是要生成的实体类 -->
        <!-- enable*ByExample是否生成 example类 -->
        <!--<table schema="" tableName="t_book" domainObjectName="Book"-->
        <!--enableCountByExample="false" enableDeleteByExample="false"-->
        <!--enableSelectByExample="false" enableUpdateByExample="false">-->
        <!--&lt;!&ndash; 忽略列，不生成bean 字段 &ndash;&gt;-->
        <!--&lt;!&ndash; <ignoreColumn column="FRED" /> &ndash;&gt;-->
        <!--&lt;!&ndash; 指定列的java数据类型 &ndash;&gt;-->
        <!--&lt;!&ndash; <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> &ndash;&gt;-->
        <!--</table>-->

        <table schema="" tableName="t_mvc_book" domainObjectName="Book"
               enableCountByExample="false" enableDeleteByExample="false"
               enableSelectByExample="false" enableUpdateByExample="false">
            <!-- 忽略列，不生成bean 字段 -->
            <!-- <ignoreColumn column="FRED" /> -->
            <!-- 指定列的java数据类型 -->
            <!-- <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> -->
        </table>

    </context>
</generatorConfiguration>

jdbc.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://47.100.191.44:3308/mybatis_ssm?useUnicode=true&characterEncoding=UTF-8
jdbc.username=123
jdbc.password=123

log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
      
<!-- status : 指定log4j本身的打印日志的级别.ALL< Trace < DEBUG < INFO < WARN < ERROR
    < FATAL < OFF。 monitorInterval : 用于指定log4j自动重新配置的监测间隔时间，单位是s,最小是5s. -->
<Configuration status="WARN" monitorInterval="30">
    <Properties>
        <!-- 配置日志文件输出目录 ${sys:user.home} -->
        <Property name="LOG_HOME">/root/workspace/lucenedemo/logs</Property>
        <property name="ERROR_LOG_FILE_NAME">/root/workspace/lucenedemo/logs/error</property>
        <property name="WARN_LOG_FILE_NAME">/root/workspace/lucenedemo/logs/warn</property>
        <property name="PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} [%t-%L] %-5level %logger{36} - %msg%n</property>
    </Properties>

    <Appenders>
        <!--这个输出控制台的配置 -->
        <Console name="Console" target="SYSTEM_OUT">
            <!-- 控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->
            <ThresholdFilter level="trace" onMatch="ACCEPT"
                             onMismatch="DENY" />
            <!-- 输出日志的格式 -->
            <!-- %d{yyyy-MM-dd HH:mm:ss, SSS} : 日志生产时间 %p : 日志输出格式 %c : logger的名称
                %m : 日志内容，即 logger.info("message") %n : 换行符 %C : Java类名 %L : 日志输出所在行数 %M
                : 日志输出所在方法名 hostName : 本地机器名 hostAddress : 本地ip地址 -->
            <PatternLayout pattern="${PATTERN}" />
        </Console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用 -->
        <!--append为TRUE表示消息增加到指定文件中，false表示消息覆盖指定的文件内容，默认值是true -->
        <File name="log" fileName="logs/test.log" append="false">
            <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
        </File>
        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size， 则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档 -->
        <RollingFile name="RollingFileInfo" fileName="${LOG_HOME}/info.log"
                     filePattern="${LOG_HOME}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch） -->
            <ThresholdFilter level="info" onMatch="ACCEPT"
                             onMismatch="DENY" />
            <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <!-- 基于时间的滚动策略，interval属性用来指定多久滚动一次，默认是1 hour。 modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am. -->
                <!-- 关键点在于 filePattern后的日期格式，以及TimeBasedTriggeringPolicy的interval， 日期格式精确到哪一位，interval也精确到哪一个单位 -->
                <!-- log4j2的按天分日志文件 : info-%d{yyyy-MM-dd}-%i.log -->
                <TimeBasedTriggeringPolicy interval="1"
                                           modulate="true" />
                <!-- SizeBasedTriggeringPolicy:Policies子节点， 基于指定文件大小的滚动策略，size属性用来定义每个日志文件的大小. -->
                <!-- <SizeBasedTriggeringPolicy size="2 kB" /> -->
            </Policies>
        </RollingFile>

        <RollingFile name="RollingFileWarn" fileName="${WARN_LOG_FILE_NAME}/warn.log"
                     filePattern="${WARN_LOG_FILE_NAME}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
            <ThresholdFilter level="warn" onMatch="ACCEPT"
                             onMismatch="DENY" />
            <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="2 kB" />
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
            <DefaultRolloverStrategy max="20" />
        </RollingFile>

        <RollingFile name="RollingFileError" fileName="${ERROR_LOG_FILE_NAME}/error.log"
                     filePattern="${ERROR_LOG_FILE_NAME}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd-HH-mm}-%i.log">
            <ThresholdFilter level="error" onMatch="ACCEPT"
                             onMismatch="DENY" />
            <PatternLayout
                    pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n" />
            <Policies>
                <!-- log4j2的按分钟 分日志文件 : warn-%d{yyyy-MM-dd-HH-mm}-%i.log -->
                <TimeBasedTriggeringPolicy interval="1"
                                           modulate="true" />
                <!-- <SizeBasedTriggeringPolicy size="10 MB" /> -->
            </Policies>
        </RollingFile>

    </Appenders>

    <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效 -->
    <Loggers>
        <!--过滤掉spring和mybatis的一些无用的DEBUG信息 -->
        <logger name="org.springframework" level="INFO"></logger>
        <logger name="org.mybatis" level="INFO"></logger>

        <!-- 第三方日志系统 -->
        <logger name="org.springframework" level="ERROR" />
        <logger name="org.hibernate" level="ERROR" />
        <logger name="org.apache.struts2" level="ERROR" />
        <logger name="com.opensymphony.xwork2" level="ERROR" />
        <logger name="org.jboss" level="ERROR" />

        <!-- 配置日志的根节点 -->
        <root level="all">
            <appender-ref ref="Console" />
            <appender-ref ref="RollingFileInfo" />
            <appender-ref ref="RollingFileWarn" />
            <appender-ref ref="RollingFileError" />
        </root>

    </Loggers>

</Configuration>

在该目录下继续新建两个xml文件spring-context.xml、spring-mybatis.xml，因为我们的spring-context.xml才是核心文件所以要将spring-mybatis.xml导入到核心文件中。

spring-context.xml

 <!--Spring框架与mybatis整合的配置文件加载spring上下文-->
    <import resource="classpath:spring-mybatis.xml"></import>

1.3.Spring整合MyBatis

在没有整合Spring框架的时候，我们所编写的是Mybatis.cfg.xml配置文件，而Spring整合MyBatis后，Mybatis.cfg.xml等同于spring-mybatis.xml，可以直接使用Spring的配置文件来配置MyBatis 。下面我来带领大家一起整合💪💪！！

1.3.1.配置自动扫描JavaBean

1.3.2.配置数据源

1.3.3.配置session工厂

1.3.4.配置mapper扫描接口

1.3.5.配置事物管理器

1.3.6.配置AOP自动代理

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:context="http://www.springframework.org/schema/context" 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.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd">
    <!--1. 注解式开发 -->
    <!-- 注解驱动 -->
    <context:annotation-config/>
    <!-- 用注解方式注入bean，并指定查找范围：com.javaxl.ssm及子子孙孙包-->
    <context:component-scan base-package="com.csdn.xw"/>

    <context:property-placeholder location="classpath:jdbc.properties"/>

    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
          destroy-method="close">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
        <!--初始连接数-->
        <property name="initialSize" value="10"/>
        <!--最大活动连接数-->
        <property name="maxTotal" value="100"/>
        <!--最大空闲连接数-->
        <property name="maxIdle" value="50"/>
        <!--最小空闲连接数-->
        <property name="minIdle" value="10"/>
        <!--设置为-1时，如果没有可用连接，连接池会一直无限期等待，直到获取到连接为止。-->
        <!--如果设置为N（毫秒），则连接池会等待N毫秒，等待不到，则抛出异常-->
        <property name="maxWaitMillis" value="-1"/>
    </bean>

    <!--4. spring和MyBatis整合 -->
    <!--1) 创建sqlSessionFactory-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 指定数据源 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 自动扫描XxxMapping.xml文件，**任意路径 -->
        <property name="mapperLocations" value="classpath*:com/csdn/xw/**/mapper/*.xml"/>
        <!-- 指定别名 -->
        <property name="typeAliasesPackage" value="com/csdn/xw/**/model"/>
        <!--配置pagehelper插件-->
        <property name="plugins">
            <array>
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <value>
                            helperDialect=mysql
                        </value>
                    </property>
                </bean>
            </array>
        </property>
    </bean>

    <!--2) 自动扫描com/javaxl/ssm/**/mapper下的所有XxxMapper接口(其实就是DAO接口)，并实现这些接口，-->
    <!--   即可直接在程序中使用dao接口，不用再获取sqlsession对象-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--basePackage 属性是映射器接口文件的包路径。-->
        <!--你可以使用分号或逗号 作为分隔符设置多于一个的包路径-->
        <property name="basePackage" value="com/csdn/xw/**/mapper"/>
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    </bean>

    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>
    <tx:annotation-driven transaction-manager="transactionManager" />
    <aop:aspectj-autoproxy/>
</beans>

将代码中的路径改成自己的即可。

1.4.测试

在MyBatis生产的Mapper类上加上@Repository注解，相当有在spring里面做<bean>

bookbizimpl加上@Service注解，属性BookMapper加上@Autowired注解

BookBizImplTest测试类也是如此，并将bookbiz也加上 @Autowired注解

前面我们提到过lombok依赖现在我们就来实操演示一下

Book.java

package com.csdn.xw.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

//set/get/tostring方法
@Data
//有参构造器
@AllArgsConstructor
//空参构造器
@NoArgsConstructor
public class Book {
    private Integer bid;

    private String bname;

    private Float price;

}

现在调用一下查询的方法查看结果

@Test
    public void selectByPrimaryKey() {
        System.out.println(this.bookbiz.selectByPrimaryKeyws(55));
    }

到这里看到结果就说明我们已经将Spring与MyBatis进行整合了。

二、Spring集成PageHeper

我们先来看一下没有集成之前的代码是怎么样的？

BookMapper.xml

<select id="listpager" resultType="com.csdn.xw.model.Book" parameterType="com.csdn.xw.model.Book" >
    select
    <include refid="Base_Column_List" />
    from t_mvc_book
    <if test=" bname!=null">
      where  bname like concat('%',#{bname},'%')
    </if>
  </select>

BookMapper

List<Book> listpager(Book book);

BookBiz

 List<Book> listpager(Book book, PageBean pageBean);

BookBizImpl

 @Override
    public List<Book> listpager(Book book, PageBean pageBean) {
        if(pageBean!=null&&pageBean.isPagination())
            PageHelper.startPage(pageBean.getPage(),pageBean.getRows());
        List<Book> listpager = bookMapper.listpager(book);
        if(pageBean!=null&&pageBean.isPagination()){
            PageInfo<Book> pageInfo = new PageInfo<>(listpager);
            pageBean.setTotal((int) pageInfo.getTotal());
        }
        return listpager;
    }

如果PageBean不为空并且isPagination为true说明要分页，那么就是用PageHeper插件

BookBizImplTest

@Test
    public void listpager() {
        Book book=new Book();
        PageBean pageBean=new PageBean();
        pageBean.setPage(2);
        pageBean.setRows(5);
        book.setBname("斗破");
    this.bookbiz.listpager(book,pageBean).forEach(System.out::println);
    }

这样的代码复用性不是很高而且耦合性比较高，在我们在我们开发过程中是非常不友好的，那么怎么将分页的代码进行优化呢？我们可以用到Spring里面的aop面向切面技术做处理。

2.1.面向切面解决冗余代码

编写一个切面类专门来做分页

PageAspect

package com.csdn.xw.aspect;

import com.csdn.xw.util.PageBean;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

import java.util.List;

/**
 * @author Java方文山
 * @compay csdn_Java方文山
 * @create 2023-08-25-20:33
 */
@Aspect
//代表当前类是切面类
@Component
//代表这个是交给Spring管理
public class PageAspect {

    /**
     * *：返回值
     * *..：无限包
     * *Biz：以Biz结尾的接口名
     * .pager：以pager方法
     * 只要同时匹配上诉四个条件，就会被列为目标对象
     * 上诉配置要生效，代理注释一定要打开：<aop:aspectj-autoproxy/>
     * @param args
     * @return
     * @throws Throwable
     */
    @Around("execution(* *..*Biz.*pager(..))")
    public Object invoke(ProceedingJoinPoint args) throws Throwable {
        Object[] params = args.getArgs();
        PageBean pageBean = null;
        for (Object param : params) {
            if(param instanceof PageBean){
                pageBean = (PageBean)param;
                break;
            }
        }

        if(pageBean != null && pageBean.isPagination())
            PageHelper.startPage(pageBean.getPage(),pageBean.getRows());

        Object list = args.proceed(params);

        if(null != pageBean && pageBean.isPagination()){
            PageInfo pageInfo = new PageInfo((List) list);
            pageBean.setTotal(pageInfo.getTotal()+"");
        }
        return list;
    }

}

小贴士：

这段代码是一个使用AOP（面向切面编程）的示例，它的作用是在执行方法之前和之后添加一些额外的逻辑。具体来说，这段代码定义了一个切面，用于拦截所有使用了Biz.pager()方法的方法。

  1. @Around("execution(* *..*Biz.*pager(..))")：这是一个注解，表示这个切面将会拦截所有使用了Biz.pager()`方法的方法。

  2. public Object invoke(ProceedingJoinPoint args) throws Throwable：这是切面的核心方法，它会在被拦截的方法执行前后执行。ProceedingJoinPoint参数包含了被拦截方法的信息，如方法名、参数等。

  3. Object[] params = args.getArgs();：从ProceedingJoinPoint参数中获取被拦截方法的参数。

  4. PageBean pageBean = null;：声明一个PageBean类型的变量pageBean，用于存储Biz.pager()方法的返回值。

  5. for (Object param : params) { if(param instanceof PageBean){ pageBean = (PageBean)param; break; } }：遍历参数数组，找到第一个PageBean类型的参数，并将其赋值给pageBean。

  6. if(pageBean != null && pageBean.isPagination()) PageHelper.startPage(pageBean.getPage(),pageBean.getRows());：如果pageBean不为空且pageBean的分页属性为true，则使用PageHelper.startPage()方法设置分页信息。

  7. Object list = args.proceed(params);：调用被拦截方法，并将结果赋值给list。

  8. if(null != pageBean && pageBean.isPagination()){ PageInfo pageInfo = new PageInfo((List) list); pageBean.setTotal(pageInfo.getTotal()+""); }：如果pageBean不为空且分页属性为true，则将分页信息设置到pageBean中。

  9. return list;：返回被拦截方法的结果。

下面我注释掉我们刚刚在Impl所写的分页代码试试，看这个切面类会不会捕捉到我们的方法。

**测试结果： **

结果也出来了，说明我们的捕捉成功了。

三、总结

3.1.注解解释

  • @Data: 这个注解是Lombok库提供的，它可以自动为类生成常用的方法，如getter、setter、equals、hashCode等，从而简化了代码编写过程。
  • @AllArgsConstructor: 这个注解是Lombok库提供的，它会自动生成一个包含所有成员变量的构造函数，方便创建对象时初始化所有字段。
  • @**NoArgsConstructor**: 这个注解也是Lombok库提供的，它会自动生成一个无参构造函数，方便创建对象时不进行初始化。
  • @**Repository**: 这个注解是Spring框架提供的，用于标记数据访问组件，即DAO（Data Access Object）层的接口。Spring会自动扫描带有该注解的接口，并将其作为Bean进行管理。
  • @**Service**: 这个注解也是Spring框架提供的，与@Repository类似，用于标记服务层的接口。同样，Spring会自动扫描带有该注解的接口，并将其作为Bean进行管理。
  • @**Autowired**: 这个注解是Spring框架提供的，用于自动注入依赖关系。当使用@Autowired注解在字段、构造函数或方法上时，Spring会自动将匹配的Bean注入到对应的位置。
  • @**RunWith(SpringJUnit4ClassRunner.class)**: 这个注解是JUnit框架提供的，用于指定测试运行器。@RunWith注解可以与不同的测试运行器组合使用，这里使用的是SpringJUnit4ClassRunner，它会加载Spring的配置并执行测试。
  • @**ContextConfiguration(locations={"classpath:spring-context.xml"})**: 这个注解是JUnit框架提供的，用于指定测试运行器的上下文配置。通过指定locations属性，可以告诉测试运行器从指定的文件加载Spring的配置文件。
  • @**Component**: 这个注解是Spring框架提供的，用于标记一个类为Spring的组件。当一个类被标记为@Component时，Spring会自动扫描并将其作为Bean进行管理。

到这里我的分享就结束了，欢迎到评论区探讨交流！！

如果觉得有用的话还请点个赞吧 ♥ ♥

标签： mybatis spring java
本文转载自: https://blog.csdn.net/weixin_74318097/article/details/132495691
版权归原作者 Java方文山 所有， 如有侵权，请联系我们删除。
登录后发布评论

“提升开发效率的必备技能：Spring集成Mybatis和PageHelper详解”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

HIVE安全配置

Ubuntu22.04安装Mysql8.0（在线&离线）

【Linux】：进程信号（再谈信号保存和信号捕捉）

【Kubernetes】(K8S)彻底卸载详细教程

【git】本地更改了，但又想直接从远端拉取覆盖本地（放弃本地更改前行下载）

如何确定kafka与zookeeper版本的对应关系

基于Java Web的图书管理系统的设计与实现—免费源码分享77033

文章导航