Mybatis与spring集成 & Aop整合pagehelper插件

版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文链接： https://blog.csdn.net/qq_44641053/article/details/101315506

Mybatis与spring集成

1、导入pom依赖

• 1.1 添加 spring 相关依赖 (5.0.2.RELEASE)

    		spring-core
    		spring-beans
    		spring-context
    		spring-orm
    		spring-tx
    		spring-aspects
    		spring-web
  

• 1.2 添加 Mybatis 相关依赖

    		mybatis核心：mybatis(3.4.5)
    		Mybatis分页：pagehelper(5.1.2)
  

• 1.3 spring 整合 mybatis(1.3.1)

    		mybatis-spring
  

• 1.4 添加dbcp2连接池

    		commons-dbcp2(2.1.1)
    		commons-pool2(2.4.3)
  

• 1.5 添加日志配置(2.9.1)

    		log4j-core
    		log4j-api
    		log4j-web
  

• 1.6 其他

    		junit(4.12)
    		javax.servlet-api(4.0.0)
    		lombok(1.18.2)
  

  注：使用mybatis-generator插件，pom文件添加支持

  pom.xml

  
  <?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>com.dj</groupId>
    <artifactId>ssm</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
  
    <name>ssm Maven Webapp</name>
    <!-- FIXME change it to the project's website -->
    <url>http://www.example.com</url>
  
    <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <maven.compiler.source>1.7</maven.compiler.source>
      <maven.compiler.target>1.7</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-core</artifactId>
        <version>${spring.version}</version>
      </dependency>
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-beans</artifactId>
        <version>${spring.version}</version>
      </dependency>
      <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>
  
  
    <build>
      <finalName>ssm</finalName>
      <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>
      <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
        <plugins>
          <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>
        </plugins>
      </pluginManagement>
    </build>
  </project>
  
  

---

2、创建spring配置文件applicationContext

2.1 注解式开发

开启注解

			   <!--1. 注解式开发 -->
			   <!-- 注解驱动 -->
			   <context:annotation-config/>
			   <!-- 用注解方式注入bean，并指定查找范围：com.dj.ssm及子子孙孙包-->
			   <context:component-scan base-package="com.dj.ao"/>

2.2 引入外部 jdbc 配置文件

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

2.3 配置 dbcp2 数据库连接池

2.4 spring 和 mybatis整合

2.5 注解式事物配置

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

2.6 开启动态代理

			<aop:aspectj-autoproxy/>

applicationContext.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">

    <!--  整合mybatis框架  -->
    <import resource="applicationContext-mybatis.xml"></import>
</beans>

applicationContext-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.dj.ssm及子子孙孙包-->
    <context:component-scan base-package="com.dj"/>

    <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/dj/**/mapper/*.xml"/>
        <!-- 指定别名 -->
        <property name="typeAliasesPackage" value="com/dj/**/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/dj/ssm/**/mapper下的所有XxxMapper接口(其实就是DAO接口)，并实现这些接口，-->
    <!--   即可直接在程序中使用dao接口，不用再获取sqlsession对象-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--basePackage 属性是映射器接口文件的包路径。-->
        <!--你可以使用分号或逗号 作为分隔符设置多于一个的包路径-->
        <property name="basePackage" value="com/dj/**/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>

---

3、注解式开发

 				   @Repository：将DAO类声明为Bean
				   @Service：通常作用在业务层
				   @Constroller：通常作用在控制层，将在Spring MVC中使用
				   @Component：是一个泛化的概念，仅仅表示spring中的一个组件（Bean），可以作用在任何层次
				   @Scope：模式声明（singleton|prototype）
				   @Autowired：将自动在代码上下文与其匹配（默认是类型匹配）的Bean，并自动注入到相应的地方
				   @Resource：
				   1）@Resource后面没有任何内容，默认通过name属性去匹配bean，找不到再按type去匹配
				   2）指定了name或者type则根据指定的类型去匹配bean
				   3）指定了name和type则根据指定的name和type去匹配bean，任何一个不匹配都将报错
				
				   问题：
				   @Autowired和@Resource两个注解的区别：
				   
				   1）@Autowired默认按照byType方式进行bean匹配，@Resource默认按照byName方式进行bean匹配
				   2）@Autowired是Spring的注解，@Resource是J2EE的注解，这个看一下导入注解的时候这两个注解的包名就一清二楚了
				   Spring属于第三方的，J2EE是Java自己的东西，因此，建议使用@Resource注解，以减少代码和Spring之间的耦合。
				
				   @Transactional
				   注：注解式事务比以前的声明式事务要稍微麻烦，要写的东西比较多多

---

4、Spring Test+Junit完美组合

4.1 在工程的pom文件中增加spring-test的依赖

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

4.2 创建BaseTestCase，并在该类上加上两个注解

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

4.3 使用idean的junit插件(JUnitGenerator V2.0)生成测试用例

			   注1：还需要修改相关配置，详情参考资料：“IDEA Junit4配置.mht”
			   注2：快捷键，Ctrl + Shift + T

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

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

SpringBaseTest

package com.dj;

import com.dj.model.Article;
import com.dj.util.PageBean;
import org.junit.Before;
import org.junit.runner.RunWith;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

/**
 * @author dj
 * @company xxx公司
 * @create 2019- 09 - 24 - 11:51
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class SpringBaseTest {

    protected Article article;
    protected PageBean pageBean;

    @Before
    public void init(){
        article = new Article();
        pageBean = new PageBean();
    }

}

---

Aop整合pagehelper插件

使用AOP编程解决分页代码重复的问题

注意：记得开动态代理

语法结构： execution(方法修饰符 方法返回值 方法所属类 匹配方法名 ( 方法中的形参表 ) 方法申明抛出的异常 )

					"*"  ：代表一个任意类型的参数；
					“..”：代表零个或多个任意类型的参数。

5、修改分页代码

AOP注解式开发步骤：

• 在项目中导入aop所需要的jar包

• 在自己的spring核心配置文件中加入aop的命名空间

• 创建一个java类，把这个类声明为切面类，在头部信息加入注解@Aspect，Spring会把这种类(切面)当作一个特殊的Bean

• 在头部信息中加入注解@Component，将这个类放入容器中

• 基于切面的方法，编写自己的业务逻辑代码，先定义切点"execution(* *…*Service.*Pager(…))"，哪些方法需要执行这些方法
  

• 编写切面的前置方法，执行目标方法前拦截到的方法，在目标方法之前通知，该方法只需要一个连接点JoinPoint，即可获取拦截目标方法以及请求参数等

• 编写切面的后置方法，在目标方法执行后的通知，不管是否抛异常，这个方法始终被执行，与前置方法一样，只需要一个连接点

• 编写切面的环绕通知方法，只需要携带ProceedingJoinPoint参数，ProceedingJoinPoint类型的参数可以决定是否执行目标函数，环绕通知必须有返回值

• 在spring核心配置文件中声明aspect的代理对象，初始化spring容器的时候，spring自动对切点生成代理对象

• 保存代码，运行，调用监听的接口方法即可

AOP分页实现“PageBeanAspect.java”
@Around(“execution(* *…*Service.*pager(…))”)
public Object invoke(ProceedingJoinPoint args)

PageAspect

package com.dj;

import com.dj.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 dj
 * @company xxx公司
 * @create 2019- 09 - 24 - 21:22
 * 处理 * *..*Service.*Pager(..)这个方法，只要调用这个方法，就能够达到分页的效果
 * PageHelper.start()
 * 调用目标方法之前
 * 处理结果集
 *
 * .*Pager(map.pagebean)
 * *page(map,title)
 *
 */
@Component
@Aspect
public class PageAspect {

    @Around("execution(* *..*Service.*Pager(..))")
    public Object invoke(ProceedingJoinPoint args) throws Throwable{
        //判断符合条件的方法中是否包含pageBean函数
        Object[] params = args.getArgs();
        PageBean pageBean = null;
        for (Object p:params){
            if(p instanceof PageBean){
                pageBean = (PageBean)p;
                break;
            }
        }
        if (pageBean != null && pageBean.isPagination()){
            PageHelper.startPage(pageBean.getPage(),pageBean.getRows());
        }
        Object list = args.proceed(params);
        if (pageBean != null && pageBean.isPagination()){
            PageInfo pageInfo = new PageInfo((List) list);
            pageBean.setTotal(pageInfo.getTotal()+"");
        }

        return null;
    }
}

DBCP

dbcp是apache上的一个java 连接池项目

现在分成了3个大版本，不同的版本要求的JDK不同：

DBCP 2 compiles and runs under Java 7 only (JDBC 4.1)
DBCP 1.4 compiles and runs under Java 6 only (JDBC 4)
DBCP 1.3 compiles and runs under Java 1.4-5 only (JDBC 3)

---

ArticleServiceImplTest

package com.dj.service.impl;

import com.dj.SpringBaseTest;
import com.dj.model.Article;
import com.dj.service.ArticleService;
import com.dj.util.StringUtil;
import org.apache.ibatis.reflection.SystemMetaObject;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.HashMap;
import java.util.List;
import java.util.Map;


/**
 * @author dj
 * @company xxx公司
 * @create 2019- 09 - 24 - 18:01
 */
public class ArticleServiceImplTest extends SpringBaseTest {

    @Autowired
    private ArticleService articleService;


    @Test
    public void insert() {
        article.setId(172);
        article.setTitle("魔道祖师");
        article.setBody("忘羡的爱情故事");
        this.articleService.insert(article);
    }

    @Test
    public void selectByPrimaryKey() {
        Article a = this.articleService.selectByPrimaryKey(12);
        System.out.println(a);
    }

    @Test
    public void aa() {
        Map map = new HashMap();
        map.put("title", StringUtil.toLikeStr("的"));
        List<Map> aa = this.articleService.aa(map, pageBean);
        for (Map m : aa){
            System.out.println(m);
        }
    }

    @Test
    public void listPage() {
        Map map = new HashMap();
        map.put("title", StringUtil.toLikeStr("的"));
        pageBean.setPage(2);
        List<Map> aa = this.articleService.aa(map, pageBean);
        for (Map m : aa){
            System.out.println(m);
        }
    }

    @Test
    public void insert1() {
    }

    @Test
    public void selectByPrimaryKey1() {
    }
}