mybatis 與 spring 集成

mybatis 與 spring 集成

添加相關依賴

1.1 添加spring相關依賴(5.0.2.RELEASE)
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.Tang</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.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>

  <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>

        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

創建spring配置文件applicationContext

註解式開發，開啓註解

1、註解驅動

<context:annotation-config/>

2、用註解方式注入bean，並指定查找範圍：com.javaxl.ssm及子子孫孫包

<context:component-scan base-package="com.javaxl.ssm"/>

3、引入外部jdbc配置文件

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

4、配置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"/>
    </bean>

5、spring和mybatis整合

6、註解式事物配置

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

7、開啓動態代理

<aop:aspectj-autoproxy/>

註解式開發（解讀）

@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兩個註解的區別：
   相當於之前spring、hibernate時代中的set注入，省去set、get方法
   1）@Autowired默認按照byType方式進行bean匹配，@Resource默認按照byName方式進行bean匹配
   2）@Autowired是Spring的註解，@Resource是J2EE的註解，這個看一下導入註解的時候這兩個註解的包名就一清二楚了
   Spring屬於第三方的，J2EE是Java自己的東西，因此，建議使用@Resource註解，以減少代碼和Spring之間的耦合。

   @Transactional
   注：個人感覺註解式事務比以前的聲明式事務更加麻煩，要寫的東西更多

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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.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.Tang及子子孫孫包-->
    <context:component-scan base-package="com.Tang"/>

    <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/Tang/**/mapper/*.xml"/>
        <!-- 指定別名 -->
        <property name="typeAliasesPackage" value="com/Tang/**/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/Tang/**/mapper下的所有XxxMapper接口(其實就是DAO接口)，並實現這些接口，-->
    <!--   即可直接在程序中使用dao接口，不用再獲取sqlsession對象-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--basePackage 屬性是映射器接口文件的包路徑。-->
        <!--你可以使用分號或逗號 作爲分隔符設置多於一個的包路徑-->
        <property name="basePackage" value="com/Tang/**/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>

測試

BookService

package com.Tang.service;

import com.Tang.model.Book;
import com.Tang.util.PageBean;

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

/**
 * @author Tang
 */
public interface BookService {
    int deleteByPrimaryKey(Integer bid);

    int insert(Book record);

    int insertSelective(Book record);

    Book selectByPrimaryKey(Integer bid);

    int updateByPrimaryKeySelective(Book record);

    int updateByPrimaryKey(Book record);

    List<Map> aaaa(Map map, PageBean pageBean);

    List<Map> listPager(Map map, PageBean pageBean);

}

BookServiceImpl

package com.Tang.service.impl;

import com.Tang.mapper.BookMapper;
import com.Tang.model.Book;
import com.Tang.service.BookService;
import com.Tang.util.PageBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

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

/**
 * @author Tang
 */
@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookMapper bookMapper;

    @Override
    public int deleteByPrimaryKey(Integer bid) {
        return bookMapper.deleteByPrimaryKey(bid);
    }

    @Override
    public int insert(Book record) {
        return bookMapper.insert(record);
    }

    @Override
    public int insertSelective(Book record) {
        return bookMapper.insertSelective(record);
    }

    @Override
    public Book selectByPrimaryKey(Integer bid) {
        return bookMapper.selectByPrimaryKey(bid);
    }

    @Override
    public int updateByPrimaryKeySelective(Book record) {
        return bookMapper.updateByPrimaryKeySelective(record);
    }

    @Override
    public int updateByPrimaryKey(Book record) {
        return bookMapper.updateByPrimaryKey(record);
    }

    @Override
    public List<Map> aaaa(Map map, PageBean pageBean) {
        return bookMapper.aaaa(map);
    }

    @Override
    public List<Map> listPager(Map map, PageBean pageBean) {
        return bookMapper.aaaa(map);
    }
}

創建BaseTestCase，並在該類上加上兩個註解
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={“classpath:applicationContext.xml”})

SpringBaseTest

package com.Tang;

import com.Tang.model.Book;
import com.Tang.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 Tang
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:applicationContext.xml"})
public class SpringBaseTest {
    protected Book book;
    protected PageBean pageBean;

    @Before
    public void init(){
        book = new Book();
        pageBean = new PageBean();
    }
}

bookserviceimplTest

package com.Tang.service.impl;

import com.Tang.SpringBaseTest;
import com.Tang.model.Book;
import com.Tang.service.BookService;
import com.Tang.util.PageBean;
import com.Tang.util.StringUtils;
import org.junit.Before;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;

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

/**
 * @author Tang
 */
public class BookServiceImplTest extends SpringBaseTest {

    @Autowired
    private BookService bookService;

    @Test
    public void insert() {
        book.setBid(1);
        book.setBname("ssm");
        book.setPrice(333f);
        this.bookService.insert(book);

    }

    @Test
    public void selectByPrimaryKey() {
        Book book = bookService.selectByPrimaryKey(10006);
        System.out.println(book);
    }

}

效果：

優化分頁

使用AOP編程解決分頁代碼重複的問題

PagerAspect

package com.Tang;

import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.Tang.util.PageBean;
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 Tang
 *
 * 處理* *..*Service.*Pager這個方法，只要調用這個方法，就能夠達到分頁的效果
 *
 *  PageHelper.start()
 * 調用目標方法之前
 *  處理結果集
 *
 *  .*Pager(map.pagebean)
 * *pager(map.bname)
 *
 */
@Component
@Aspect
public class PagerAspect {
    @Around("execution(* *..*Service.*Pager(..))")
    public Object invoke(ProceedingJoinPoint args)throws Throwable{
//        判斷符合條件的方法中是否包含pagebean參數
        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(pageBean != null && pageBean.isPagination()){
            PageInfo pageInfo = new PageInfo((List) list);
            pageBean.setTotal(pageInfo.getTotal()+"");
        }

        return list;
    }
}

接口實現

    @Override
    public List<Map> aaa(Map map, PageBean pageBean) {
        return bookMapper.listPager(map);
    }

    @Override
    public List<Map> listPager(Map map, PageBean pageBean) {
        return bookMapper.listPager(map);
    }

測試

    @Test
    public void listPager() {
        Map map = new HashMap();
        map.put("bname", StringUtils.toLikeStr("聖墟"));
        pageBean.setPage(3);
        List<Map> aaaa = this.bookService.listPager(map, pageBean);
        for (Map m : aaaa) {
            System.out.println(m);
        }

    }

listPager 查詢符合條件的前10條及效果