1. 程式人生 > >Mybatis與Spring整合(一)Mapper介面代理的方式操作SQL語句

Mybatis與Spring整合(一)Mapper介面代理的方式操作SQL語句

一、建立maven工程

建立一個普通的maven工程,基於web

專案目錄:

二、建立資料庫與表

DROP TABLE IF EXISTS `books`;
CREATE TABLE `books` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '編號',
  `title` varchar(100) NOT NULL COMMENT '書名',
  `price` double(10,2) DEFAULT NULL COMMENT '價格',
  `publishDate` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '出版日期',
  PRIMARY KEY (`id`),
  UNIQUE KEY `title` (`title`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of books
-- ----------------------------
INSERT INTO `books` VALUES ('1', 'Java程式設計思想', '98.50', '2005-01-02 00:00:00');
INSERT INTO `books` VALUES ('2', 'HeadFirst設計模式', '55.70', '2010-11-09 00:00:00');
INSERT INTO `books` VALUES ('3', '第一行Android程式碼', '69.90', '2015-06-23 00:00:00');
INSERT INTO `books` VALUES ('4', 'C++程式設計思想', '88.50', '2004-01-09 00:00:00');
INSERT INTO `books` VALUES ('5', 'HeadFirst Java', '55.70', '2013-12-17 00:00:00');
INSERT INTO `books` VALUES ('6', '瘋狂Android', '19.50', '2014-07-31 00:00:00');

三、新增依賴包

<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.wqc</groupId>
    <artifactId>BookStore</artifactId>
    <version>0.0.1</version>
    <packaging>war</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring.version>4.3.9.RELEASE</spring.version>
    </properties>

    <dependencies>
        <!--Spring框架核心庫 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!-- aspectJ AOP 織入器 -->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.9</version>
        </dependency>
        <!--mybatis-spring介面卡 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.0</version>
        </dependency>
        <!--Spring java資料庫訪問包,在本例中主要用於提供資料來源 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!--mysql資料庫驅動 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>
        <!--log4j日誌包 -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.6.1</version>
        </dependency>
        <!-- mybatis ORM框架 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.1</version>
        </dependency>
        <!-- JUnit單元測試工具 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
        </dependency>
        <!--c3p0 連線池 -->
        <dependency>
            <groupId>c3p0</groupId>
            <artifactId>c3p0</artifactId>
            <version>0.9.1.2</version>
        </dependency>
        <!-- jstl -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
    </dependencies>
</project>

有了c3p0為啥要spring-jdbc?這個就是連線池和資料來源的區別....

四、新建POJO實體層

為了實現與資料庫中的books表進行關係對映新建一個Book類

public class Book {
	
    private int id;
    private String title;
    private double price;
    private Date publishDate;

    public Book(int id, String title, double price, Date publishDate) {
        this.id = id;
        this.title = title;
        this.price = price;
        this.publishDate = publishDate;
    }
    public Book() {
    }
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getTitle() {
        return title;
    }
    public void setTitle(String title) {
        this.title = title;
    }
    public double getPrice() {
        return price;
    }
    public void setPrice(double price) {
        this.price = price;
    }
    public Date getPublishDate() {
        return publishDate;
    }
    public void setPublishDate(Date publishDate) {
        this.publishDate = publishDate;
    }
    
}

五、新建MyBatis SQL Mapper介面(對映層)

採用mapper介面與xml結束的形式完成關係與物件間的對映,在介面中定義一些資料訪問的方法,在xml檔案中定義實現資料訪問需要的sql指令碼。

public interface BookDAO {
	
    public List<Book> getAllBooks();
    
    public Book getBookById(@Param("id") int id);
    
    public int add(Book entity);
    
    public int delete(int id);
    
    public int update(Book entity);

}

六、為MyBatis ORM建立的對映檔案BookMapper.xml

(命名儘量都遵循一個規則,便於掃描,這裡約定以實體名+Mapper)

<?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.wqc.mapper.BookDAO">

	<!--user結果對映-->
    <resultMap id="Book" type="com.wqc.model.Book">
        <result column="id" property="id"/>
        <result column="title" property="title"/>
        <result column="price" property="price"/>
        <result column="publishDate" property="publishDate"/>
    </resultMap>
    
    <!--id應該是介面中的方法,結果型別如沒有配置別名則應該使用全名稱 -->
    <!--獲得所有圖書 -->
    <select id="getAllBooks" resultMap="Book">
        select id,title,price,publishDate from books
    </select>
    <!--獲得圖書物件通過編號 -->
    <select id="getBookById" resultMap="Book">
        select id,title,price,publishDate from books where id=#{id}
    </select>
    <!-- 增加 -->
    <insert id="add">
        insert into books(title,price,publishDate)
        values(#{title},#{price},#{publishDate})
    </insert>
    <!-- 刪除 -->
    <delete id="delete">
        delete from books where id=#{id}
    </delete>
    <!-- 更新 -->
    <update id="update">
        update books set title=#{title},price=#{price},publishDate=#{publishDate}
        where id=#{id}
    </update>
</mapper>

七、完成Spring整合MyBatis配置

7.1、在原始碼的根目錄下新建 jdbc.properties檔案,用於存放資料庫連線資訊,檔案內容如下:

#mysql jdbc
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/spring_mybatis?useUnicode=true&characterEncoding=UTF-8
jdbc.uid=root
jdbc.pwd=123456

7.2、在原始碼的根目錄下新建 applicationContext.xml檔案,用於整合MyBatis與Spring,該檔案是整個專案的控制中心,非常關鍵,具體的內容如下:

<?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:p="http://www.springframework.org/schema/p"
    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">


    <!--1 容器自動掃描IOC元件  -->
    <context:component-scan base-package="com.wqc"></context:component-scan>

    <!--2 引入屬性檔案,在配置中佔位使用 -->
    <context:property-placeholder location="classpath*:jdbc.properties" />

    <!--3 配置C3P0資料來源 -->
    <bean id="datasource" class="com.mchange.v2.c3p0.ComboPooledDataSource" destroy-method="close">
        <!--驅動類名 -->
        <property name="driverClass" value="${jdbc.driver}" />
        <!-- url -->
        <property name="jdbcUrl" value="${jdbc.url}" />
        <!-- 使用者名稱 -->
        <property name="user" value="${jdbc.uid}" />
        <!-- 密碼 -->
        <property name="password" value="${jdbc.pwd}" />
        <!-- 當連線池中的連線耗盡的時候c3p0一次同時獲取的連線數  -->
        <property name="acquireIncrement" value="5"></property>
        <!-- 初始連線池大小 -->
        <property name="initialPoolSize" value="10"></property>
        <!-- 連線池中連線最小個數 -->
        <property name="minPoolSize" value="5"></property>
        <!-- 連線池中連線最大個數 -->
        <property name="maxPoolSize" value="20"></property>
    </bean>
    
    <!--4 會話工廠bean sqlSessionFactoryBean -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 資料來源 -->
        <property name="dataSource" ref="datasource"></property>
        <!-- 別名 -->
        <property name="typeAliasesPackage" value="com.wqc.model"></property>
        <!-- sql對映檔案路徑 -->
        <property name="mapperLocations" value="classpath*:mapper/*Mapper.xml"></property>
    </bean>
    
    <!--5 自動掃描物件關係對映 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!--指定會話工廠,如果當前上下文中只定義了一個則該屬性可省去 -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
        <!-- 指定要自動掃描介面的基礎包,實現介面 -->
        <property name="basePackage" value="com.wqc.mapper"></property>
    </bean>
    
    <!--6 宣告式事務管理 -->
    <!--定義事物管理器,由spring管理事務 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="datasource"></property>
    </bean>
    <!--支援註解驅動的事務管理,指定事務管理器 -->
    <tx:annotation-driven transaction-manager="transactionManager"/>
    
    <!--7 aspectj支援自動代理實現AOP功能 ,非必要 -->
    <aop:aspectj-autoproxy proxy-target-class="true"></aop:aspectj-autoproxy>
</beans>

這個xml中共有7處配置,第7處配置非必要,另外關於事務管理可以選擇AOP攔截式事務管理。 

八、建立服務層

 建立BookService服務類,完成圖書管理業務,有些專案中也叫業務層,這裡我們叫服務層,具體實現如下:

package com.wqc.service;

import java.util.List;
import javax.annotation.Resource;

import org.apache.ibatis.annotations.Param;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.wqc.model.Book;
import com.wqc.mapper.BookDAO;

@Service
public class BookService{

    @Resource
    BookDAO bookdao;
    
    public List<Book> getAllBooks() {
        return bookdao.getAllBooks();
    }
    
    public Book getBookById(int id){
        return bookdao.getBookById(id);
    }
    
    public int add(Book entity) throws Exception {
        if(entity.getTitle()==null||entity.getTitle().equals("")){
            throw new Exception("書名必須不為空");
        }
        return bookdao.add(entity);
    }
    
    @Transactional
    public int add(Book entity1,Book entityBak){
        int rows=0;
        rows=bookdao.add(entity1);
        rows=bookdao.add(entityBak);
        return rows;
    }

    public int delete(int id) {
        return bookdao.delete(id);
    }
    
    /**
     * 多刪除
     */
    public int delete(String[] ids){
        int rows=0;
        for (String idStr : ids) {
            int id=Integer.parseInt(idStr);
            rows+=delete(id);
        }
        return rows;
    }

    public int update(Book entity) {
        return bookdao.update(entity);
    }

}

服務層不只是一個dao的接力棒,認為他可有可無,其實是因為我們現在的的示例中沒有涉及到更多的複雜業務,所以顯得比較空,實現開發可能有更多的業務邏輯要在這裡處理。另外給bookdao成員變數註解為自動裝配,service類註解為IOC元件。

九、JUnit測試服務類

為了確保服務類中的每個方法正確,先使用JUnit進行單元測試,測試程式碼如下:

這裡也可以採用註解的方式來測試,在測試類上加:

不過先要引入:spring-test jar包才能使用這兩個註解

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("/application.xml")

TestBookService.java:

package com.wqc.test;

import static org.junit.Assert.*;
import java.util.Date;
import java.util.List;
import org.junit.BeforeClass;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import com.wqc.model.Book;
import com.wqc.service.BookService;

public class TestBookService {

    static BookService bookservice;
    
    @BeforeClass
    public static void before(){
        ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext.xml");
        bookservice=ctx.getBean(BookService.class);
    }
    
    @Test
    public void testGetAllBooks() {
        List<Book> books=bookservice.getAllBooks();
        assertNotNull(books);
    }

    @Test
    public void testAdd() {
        Book entity=new Book(0, "Hibernate 第七版", 78.1, new Date());
        try {
            assertEquals(1, bookservice.add(entity));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Test
    public void testDeleteInt() {
        assertEquals(1, bookservice.delete(9));
    }

    @Test
    public void testDeleteStringArray() {
        String[] ids={"7","11","12"};
        assertEquals(3, bookservice.delete(ids));
    }

    @Test
    public void testUpdate() {
        Book entity=new Book(7, "Hibernate 第二版", 79.1, new Date());
        try {
            assertEquals(1, bookservice.update(entity));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    
    @Test
    public void testGetBookById()
    {
        assertNotNull(bookservice.getBookById(1));
    }
    
    @Test
    public void testAddDouble(){
        //因為書名相同,新增第二本會失敗,用於測試事務
        Book entity1=new Book(0, "Hibernate 第八版", 78.1, new Date());
        Book entity2=new Book(0, "Hibernate 第八版", 78.1, new Date());
        assertEquals(2, bookservice.add(entity1, entity2));
    }
}

執行測試用例,測試通過...