第五章 springboot + mybatis

springboot集成了springJDBC與JPA，但是沒有集成mybatis，所以想要使用mybatis就要自己去集成。集成方式相當簡單。

1、項目結構

 

2、pom.xml

        <!-- 與數據庫操作相關的依賴 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>

        <!-- 使用數據源 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.0.14</version>
        </dependency>
        
        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        
        <!-- mybatis -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.2.8</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.2.2</version>
         </dependency>            

說明：

• spring-boot-starter-jdbc：引入與數據庫操作相關的依賴，例如daoSupport等

• druid：阿里巴巴的數據源
• mysql-connector-java：mysql連接jar，scope為runtime
• mybatis + mybatis-spring：mybatis相關jar

 

3、application.properties

jdbc.driverClassName = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://xxx:3306/mytestdb?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=utf-8
jdbc.username = root
jdbc.password = vvvxxx

mybatis.typeAliasesPackage=com.xxx.firstboot.domain  
mybatis.mapperLocations=classpath:mapper/*.xml

說明：

• mybatis.typeAliasesPackage：指定domain類的基包，即指定其在*Mapper.xml文件中可以使用簡名來代替全類名（看后邊的UserMapper.xml介紹）

• mybatis.mapperLocations：指定*Mapper.xml的位置

 

4、com.xxx.firstboot.common.MyBatisConfig

作用：mybatis與springboot集成的入口

package com.xxx.firstboot.common;

import java.util.Properties;

import javax.sql.DataSource;

import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import com.alibaba.druid.pool.DruidDataSourceFactory;

/**
 * springboot集成mybatis的基本入口
 * 1）創建數據源
 * 2）創建SqlSessionFactory
 */
@Configuration    //該注解類似於spring配置文件
@MapperScan(basePackages="com.xxx.firstboot.mapper")
public class MyBatisConfig {
    
    @Autowired
    private Environment env;
    
    /**
     * 創建數據源
     * @Primary 該注解表示在同一個接口有多個實現類可以注入的時候，默認選擇哪一個，而不是讓@autowire注解報錯 
     */
    @Bean
    //@Primary
    public DataSource getDataSource() throws Exception{
        Properties props = new Properties();
        props.put("driverClassName", env.getProperty("jdbc.driverClassName"));
        props.put("url", env.getProperty("jdbc.url"));
        props.put("username", env.getProperty("jdbc.username"));
        props.put("password", env.getProperty("jdbc.password"));
        return DruidDataSourceFactory.createDataSource(props);
    }

    /**
     * 根據數據源創建SqlSessionFactory
     */
    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource ds) throws Exception{
        SqlSessionFactoryBean fb = new SqlSessionFactoryBean();
        fb.setDataSource(ds);//指定數據源(這個必須有，否則報錯)
        //下邊兩句僅僅用於*.xml文件，如果整個持久層操作不需要使用到xml文件的話（只用注解就可以搞定），則不加
        fb.setTypeAliasesPackage(env.getProperty("mybatis.typeAliasesPackage"));//指定基包
        fb.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(env.getProperty("mybatis.mapperLocations")));//指定xml文件位置
        
        return fb.getObject();
    }

}

說明：

• 類上邊添加兩個
  • @Configuration注解（該注解類似於spring的配置文件）
  • @MapperScan注解，指定掃描的mapper接口所在的包
• 在該類中，注入了Environment實例，使用該實例可以去讀取類路徑下application.properties文件中的內容，讀取文件內容的三種方式，見第二章 第二個spring-boot程序
• 在該類中，使用druid數據源定義了數據源Bean，spring-boot默認使用的是tomcat-jdbc數據源，這是springboot官方推薦的數據源（性能和並發性都很好）
• 根據數據源生成SqlSessionFactory
  • 值得注意的是，數據源是必須指定的，否則springboot啟動不了
  • typeAliasesPackage和mapperLocations不是必須的，如果整個項目不需要用到*Mapper.xml來寫SQL的話（即只用注解就可以搞定），那么不需要配
• @Primary注解：指定在同一個接口有多個實現類可以注入的時候，默認選擇哪一個，而不是讓@Autowire注解報錯（一般用於多數據源的情況下）

這樣之后，在項目中再使用springboot就和在ssm中（配置完成后）使用一樣了。

 

5、com.xxx.firstboot.mapper.UserMapper

package com.xxx.firstboot.mapper;

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Param;

import com.xxx.firstboot.domain.User;

public interface UserMapper {
    
    @Insert("INSERT INTO tb_user(username, password) VALUES(#{username},#{password})")
    public int insertUser(@Param("username") String username, @Param("password")  String password);
    
    /**
     * 插入用戶，並將主鍵設置到user中
     * 注意：返回的是數據庫影響條數，即1
     */
    public int insertUserWithBackId(User user);
}

說明：該接口中有兩個方法，

• 一個普通插入：直接用注解搞定
• 一個插入返回主鍵：需要使用xml來搞定

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

<!-- 指定工作空間，要與接口名相同，源代碼沒有去看，猜測應該是通過"這里的namespace.下邊方法的id"來定位方法的 -->
<mapper namespace="com.xxx.firstboot.mapper.UserMapper">
    
    <!-- 若不需要自動返回主鍵，將useGeneratedKeys="true" keyProperty="id"去掉即可(當然如果不需要自動返回主鍵，直接用注解即可) -->
    <insert id="insertUserWithBackId" parameterType="User" useGeneratedKeys="true" keyProperty="id" >
       <![CDATA[
       INSERT INTO tb_user 
       (
           username,
           password
       )
       VALUES
       (
           #{username, jdbcType=VARCHAR},
           #{password, jdbcType=VARCHAR}
       )
       ]]>
   </insert>
    
</mapper>

 

6、com.xxx.firstboot.dao.UserDao

package com.xxx.firstboot.dao;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;

import com.xxx.firstboot.domain.User;
import com.xxx.firstboot.mapper.UserMapper;

@Repository
public class UserDao {
    
    @Autowired
    private UserMapper userMapper;
    
    public int insertUser(String username, String password){
        return userMapper.insertUser(username, password);
    }
    
    public int insertUserWithBackId(User user){    
        return userMapper.insertUserWithBackId(user);
    }
    
}

 

7、com.xxx.firstboot.service.UserService

package com.xxx.firstboot.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.xxx.firstboot.dao.UserDao;
import com.xxx.firstboot.domain.User;

@Service
public class UserService {
    
    @Autowired
    private UserDao userDao;
    
    public boolean addUser(String username, String password){
        return userDao.insertUser(username, password)==1?true:false;
    }
    
    public User addUserWithBackId(String username, String password){
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        userDao.insertUserWithBackId(user);//該方法后，主鍵已經設置到user中了
        return user;
    }
    
}

 

8、com.xxx.firstboot.controller.UserController

package com.xxx.firstboot.web;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.xxx.firstboot.domain.User;
import com.xxx.firstboot.service.UserService;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

@RestController
@RequestMapping("/user")
@Api("userController相關api")
public class UserController {

    @Autowired
    private UserService userService;
    
    @ApiOperation("添加用戶")
    @ApiImplicitParams({
        @ApiImplicitParam(paramType="query",name="username",dataType="String",required=true,value="用戶的姓名",defaultValue="zhaojigang"),
        @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用戶的密碼",defaultValue="wangna")
    })
    @ApiResponses({
        @ApiResponse(code=400,message="請求參數沒填好"),
        @ApiResponse(code=404,message="請求路徑沒有或頁面跳轉路徑不對")
    })
    @RequestMapping(value="/addUser",method=RequestMethod.POST)
    public boolean addUser(@RequestParam("username") String username, 
                           @RequestParam("password") String password) {
        return userService.addUser(username,password);
    }
    
    @ApiOperation("添加用戶且返回已經設置了主鍵的user實例")
    @ApiImplicitParams({
        @ApiImplicitParam(paramType="query",name="username",dataType="String",required=true,value="用戶的姓名",defaultValue="zhaojigang"),
        @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用戶的密碼",defaultValue="wangna")
    })
    @ApiResponses({
        @ApiResponse(code=400,message="請求參數沒填好"),
        @ApiResponse(code=404,message="請求路徑沒有或頁面跳轉路徑不對")
    })
    @RequestMapping(value="/addUserWithBackId",method=RequestMethod.POST)
    public User addUserWithBackId(@RequestParam("username") String username, 
                                     @RequestParam("password") String password) {
        return userService.addUserWithBackId(username, password);
    }
}

 

測試：

進入項目的pom.xml文件所在目錄，執行"mvn spring-boot:run"（這是最推薦的spring-boot的運行方式），另外一種在主類上右擊-->"run as"-->"java application"不常用

 

參考自：

http://www.111cn.net/jsp/Java/93604.htm ：springboot+mybatis+多數據源

http://blog.csdn.net/xiaoyu411502/article/details/48164311：springboot+mybatis+讀寫分離（其實讀寫分離就是兩個數據源對兩個庫進行操作）