分页显示数据(spring与mybatis集成版)

Hi ~o(*￣▽￣*)ブ大家好呀！ 我是【小阿飞_】😜

本期文章中我将用spring与mybatis集成并结合spring中AOP的相关技术，实现在控制台分页显示出数据

来看看具体是怎么实现的叭👇

1. 引入依赖包

以下是制作这个功能可能会用到的依赖包，大家可以根据自己需要来进行引入🙂

<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>
    <slf4j.version>1.7.7</slf4j.version>
    <jcl-over-slf4j.version>1.7.7</jcl-over-slf4j.version>
    <log4j2.version>2.9.1</log4j2.version>
    <log4j2.disruptor.version>3.2.0</log4j2.disruptor.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>5.3.18</version>
    </dependency>
   <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-orm</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-aspects</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis-spring</artifactId>
      <version>2.0.6</version>
    </dependency>
    <!-- 连接池 -->
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-dbcp2</artifactId>
      <version>2.1.1</version>
    </dependency>
    <dependency>
      <groupId>org.apache.commons</groupId>
      <artifactId>commons-pool2</artifactId>
      <version>2.4.3</version>
    </dependency>
    <dependency>
      <groupId>org.mybatis</groupId>
      <artifactId>mybatis</artifactId>
      <version>3.5.6</version>
    </dependency>
    <dependency>
      <groupId>com.belerweb</groupId>
      <artifactId>pinyin4j</artifactId>
      <version>2.5.0</version>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.22</version>
      <scope>provided</scope>
    </dependency>
    <!-- ********************** 日志配置Slf4j + Log4j2 ********************** -->
    <!-- slf4j核心包 -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jcl-over-slf4j</artifactId>
      <version>${jcl-over-slf4j.version}</version>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.10</version>
    </dependency>
    <!--用于与slf4j保持桥接 -->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-slf4j-impl</artifactId>
      <version>${log4j2.version}</version>
      <exclusions>
        <exclusion>
          <artifactId>slf4j-api</artifactId>
          <groupId>org.slf4j</groupId>
        </exclusion>
      </exclusions>
    </dependency>
    <!--核心log4j2jar包 -->
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-api</artifactId>
      <version>${log4j2.version}</version>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</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>
      <scope>runtime</scope>
    </dependency>
    <!--需要使用log4j2的AsyncLogger需要包含disruptor -->
    <dependency>
      <groupId>com.lmax</groupId>
      <artifactId>disruptor</artifactId>
      <version>${log4j2.disruptor.version}</version>
    </dependency>
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.44</version>
    </dependency>
    <!-- 分页帮助类 -->
    <dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper</artifactId>
      <version>5.1.2</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

2. 集成配置文件

集成配置文件

applicationContext-base.xml用于spring与mybatis的集成，将文件放到resource目录下，文件代码如下（对应的作用请仔细看注释）

<?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-3.2.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">
    <!--1. 注解式开发 -->
    <!--1) 注解驱动,用于激活已经在spring容器中注册过的bean上面的注解-->
    <!--<context:annotation-config/>-->
    <!-- 2) 用注解方式注入bean，并指定查找范围：com.zking.oa及子子孙孙包，使用了该注解后，context:annotation-config注解可以省略 -->
    <context:component-scan base-package="com.zking"/>

    <!--2. 引入外置jdbc配置文件 -->
    <!-- 第一种方式
    <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="location" value="classpath:jdbc.properties"/>
    </bean>
    -->
    <!-- 第二种方式，比第一种方式更简洁，第一种方式更好理解一些
    ignore-unresolvable="true"一定要加，不然spring会认为你只需引入这一个配置文件
    -->
    <context:property-placeholder location="classpath:jdbc.properties" ignore-unresolvable="true"/>
    <!--3. dbcp2数据库连接池配置-->
    <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"/>
        <!-- mysql 8小时问题的解决参数，维持连接不关闭 -->
        <property name="testWhileIdle" value="true"></property>
        <property name="validationQuery" value="select 1"></property>
    </bean>
    <!--4. spring和MyBatis整合 -->
    <!--4.1) 创建sqlSessionFactory-->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 指定数据源：就是上面配好的连接池 -->
        <property name="dataSource" ref="dataSource"/>
        <!-- 指定mybatis核心配置文件 -->
        <!-- <property name="configLocation" value="classpath:mybatis.cfg.xml"/>-->
        <!-- 自动扫描XxxMapping.xml文件，**表示迭代查找 -->
        <property name="mapperLocations" value="classpath:/mapper/**/*.xml"/>
        <!-- 分页插件：这里是mysql语句生成的分页 -->
        <property name="plugins">
            <list>
                <bean class="com.github.pagehelper.PageInterceptor">
                    <property name="properties">
                        <!-- config params as the following -->
                        <value>
                            helperDialect=mysql
                        </value>
                    </property>
                </bean>
            </list>
        </property>
    </bean>
    <!--4.2) 自动扫描com/zking/oa/**/mapper下的所有XxxMapper接口(其实就是DAO接口)，并实现这些接口-->
    <!--   即可直接在程序中使用dao接口，不用再获取sqlsession对象-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--basePackage 属性是映射器接口文件的包路径。-->
        <!--你可以使用分号或逗号 作为分隔符设置多于一个的包路径-->
        <property name="basePackage" value="com/zking/**/mapper"/>
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
    </bean>
    <!--5. 声明式事务配置开始 -->
    <!--1) 开启自动代理 -->
    <aop:aspectj-autoproxy/>
    <!--2) 事务管理器 -->
    <bean id="transactionManager"
          class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource"/>
    </bean>
    <!-- 注解式事务 -->
    <tx:annotation-driven transaction-manager="transactionManager"/>
</beans>

备注：集成配置文件

1、开启注解式开发

1、 context:annotation-config/: 用于激活那些已经在spring容器里注册过的bean上面的注解，使用该注解相当于传统方式：

<!--@Autowired-->
<bean />

<!--@ Resource 、@ PostConstruct、@ PreDestroy等注解-->
<bean />

<!--@PersistenceContext注解-->
<bean />

<!--@Required-->
<bean />

context:annotation-config/是配置上述注解的简化配置方式，但是如果我们需要使用@Component, @Service, @Controller等注解则只使用该配置无效。该注解只能对已经注册的bean起作用，对于还没有在spring容器中注册的bean并不起作用。

2、<context:component-scan base-package=”XX.XX”/>：该配置除了具有上面提到的context:annotation-config/注解提到的作用，同时还具有自动将带有@Component, @Service, @Controller,@Repository等注解的对象注册到spring容器中的作用。如果同时使用了这两个配置则context:annotation-config/配置忽略，不会重复注册。对于使用注解式开发该配置必须有。

3、开启注解式事务
<tx:annotation-driven transaction-manager="transactionManager"/>： manager属性指定的是事务管理器，配置详见完整上面的配置文件

2、spring引入外部配置文件

<!--2. 引入外置jdbc配置文件 -->
<!-- 第一种方式<bean >
      <property name="location" value="classpath:jdbc.properties"/></bean>
-->
<!-- 第二种方式，比第一种方式更简洁，第一种方式更好理解一些 --><context:property-placeholder location="classpath:jdbc.properties"/>

3、数据库连接池

dbcp连接池，配置详见上面的配置文件

4、spring整合mybatis

sqlSessionFactory的配置，配置详见上面的配置文件

5、自动代理

<aop:aspectj-autoproxy/>：自动为spring容器中那些配置@aspectJ切面的bean创建代理。依然由AnnotationAwareAspectJAutoProxyCreator进行自动代理的创建，该配置用来隐藏具体的实现细节

<aop:aspectj-autoproxy/>有一个proxy-target-class属性，当该属性默认为false，表示使用jdk动态代理来织入增强，如果为true则表示使用CGLIB进行织入增强，不管配置的是true还是false，当目标类没有声明接口时，spring都会自动使用CGLIB进行织入增强

3. 注解式开发的几个常用注解

注解	作用
@Respository	用于注解数据库访问层的bean
@Service	用于注解业务层bean
@Controller	用于访问控制层bean
@Component	用于注解一个组件，可以替代上几个注解，但从可读性上上面的几个更好理解其作用
@Autowired	依赖注入的注解，spring的特有实现，默认按类型装配，默认情况下必须要求依赖对象必须存在，如果要允许null值，可以设置它的required属性为false，如：@Autowired(required=false)，如果我们想使用名称装配可以结合@Qualifier注解进行使用。示例：@Autowired() @Qualifier("baseDao")
@Resource	这个注解属于J2EE，默认按名称进行装配，名称可以通过name属性进行指定，如果没有指定name属性，当注解写在字段上时，默认取字段名进行安装名称查找，如果name属性一旦指定，就只会按照名称进行装配，示例：@Resource(name="baseDao")
@Transactional	注解方法或类需要进行事务控制，使用该注解需要在spring中配置开启事务注解，并配置事务管理器
@Scope	控制对象在spring容器中的生命周期，默认为singleton，其他的值有prototype, request, session, global session

4. spring-test

依赖包

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-test</artifactId>
    <version>${spring.version}</version>
</dependency>

相关的注解

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath*:ApplicationContext*.xml"})

在执行单元测试时,为了避免产生脏数据,可将测试单元设置成事务回滚

@Rollback(value = true|false)//true回滚事务，false提交事务
@Transactional(transactionManager = "transactionManager") 

示例：

5. 使用拦截器简化分页实现

先完成好实体类、mapper层、service层相关的简单代码操作

实体类：学生类(略)

mapper层👇

public interface IStudentMapper {
    List<Student> listStuntent(Student student);
}

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.zking.mapper.IStudentMapper">
    <sql id="studentBaseSql">
         select id, sname, score, clazz from student
    </sql>
    <select id="listStuntent" resultType="com.zking.model.Student">
        <include refid="studentBaseSql"></include>
        <where>
            <if test="sname != null and sname !=''">
                and sname like concat('%',#{sname},'%')
            </if>
            <if test="sid != null">
                and id = #{id}
            </if>
        </where>
    </select>
</mapper>

service层

接口中的代码：略，实现类👇

@Service
public class StudentService implements IStudentService {
    @Autowired
    private IStudentMapper studentMapper;
    //service层才传入分页对象
    @Override
    public List<Student> listStudentPage(Student student, PageBean pageBean) {
        //原来有分页代码1
        return studentMapper.listStuntent(student);
        //原来有分页代码2
        //现在封装到了aop中，环绕通知
    }
}

拦截器中封装分页代码👇

@Component
@Aspect
public class PagingAOP {
    //ProceedingJoinPoint环绕通知特有参数
    @Around("execution(* com.zking..*.*Page(..))")  //切入点
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        //拿到所拦截的方法的所有参数
        Object[] args = joinPoint.getArgs();
        //局部变量初始化
        PageBean pageBean = null;
        for (Object arg : args) {
            //如果有需要分页的参数,instanceof判断类型
            if(arg instanceof PageBean){
                pageBean = (PageBean)arg;
                //如果需要分页
                if(pageBean !=null && pageBean.isPagination()){
                    //设置当前页数和每页显示数
                    PageHelper.startPage(pageBean.getPage(), pageBean.getRows());
                }
            }
        }
        //执行目标方法
        Object rs = joinPoint.proceed();
        //设置分页总数
        if(pageBean !=null && pageBean.isPagination()){
            PageInfo info = new PageInfo((List)rs);
            pageBean.setTotal(Long.valueOf(info.getTotal()).intValue());
        }
        return rs;
    }
}

测试类代码👇

测试结果👇

总结：spring常用解

• @Service用于标注业务层组件
• @Controller用于标注控制层组件（如struts中的action）
• @Repository用于标注数据访问组件，即DAO组件
• @Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注。
• @Aspect：切面
• @Pointcut：定义需要切面的地方，表达式参数（https://blog.csdn.net/elim168/article/details/78150438）
• @annotation：当执行的方法上拥有指定的注解时生效。
• @After
• @Before
• @Around