【學習】整合springboot2.0 和 mybatis，實現基本的CRUD

前言：

本文是在自己整合springboot 2.0 和mybatis時的過程和踩得坑。

先附上github地址：https://github.com/yclxt/springboot-mybatis.git

環境/版本：

工具： Intellij IDEA 2018.3

JDK: 1.8

Springboot: 2.0.4.RELEASE

Mybatis : 1.3.2

由於本人是初學者，對druid 和handle Page 不太熟悉，所以只是按照網上的配置加了上去，等了解后會在之后的博客中提出。

 

創建及整合：

Step1:用IDEA創建一個Spring Initializr 項目，按如圖所示配置。

 

 

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.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.4</version>
        </dependency>


        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.datatype</groupId>
            <artifactId>jackson-datatype-joda</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.module</groupId>
            <artifactId>jackson-module-parameter-names</artifactId>
        </dependency>
        <!-- 分頁插件 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>
        <!-- alibaba的druid數據庫連接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.9</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>

            <!-- mybatis generator 自動生成代碼插件 -->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <configuration>
                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
            </plugin>
        </plugins>
    </build>


</project>

可以根據需要自行添加刪除。

 

Step2：創建數據庫表

 

CREATE TABLE `user` (
  `Id` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(50) DEFAULT NULL,
  `gender` varchar(4) DEFAULT NULL,
  `age` int(3) DEFAULT NULL,
  PRIMARY KEY (`Id`)
) ENGINE=InnoDB AUTO_INCREMENT=1003 DEFAULT CHARSET=utf8;

 

Step3：使用generator-mybatis工具反向生產實體類，dao及相關xml文件：

 在resource中新建xml文件:generatorConfig.xml，記得修改信息以滿足自己的項目。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
    <!-- 數據庫驅動:選擇你的本地硬盤上面的數據庫驅動包-->
    <classPathEntry  location="E:\maven\repository\mysql\mysql-connector-java\5.1.41\mysql-connector-java-5.1.41.jar"/>
    <context id="DB2Tables"  targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自動生成的注釋 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--數據庫鏈接URL，用戶名、密碼 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/mydb" userId="root" password="123">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成模型的包名和位置-->
        <javaModelGenerator targetPackage="com.example.demo.entity" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成映射文件的包名和位置-->
        <sqlMapGenerator targetPackage="mapping" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 生成DAO的包名和位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.entityMapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成的表 tableName是數據庫中的表名或視圖名 domainObjectName是實體類名-->
        <table tableName="user" domainObjectName="User" enableCountByExample="false"
               enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
        </table>
    </context>
</generatorConfiguration>

點擊工具欄上的Run——EditConfigrations,選擇maven（沒有則點擊左上角+號），填寫如圖信息並OK.

 

選擇運行名稱，點擊運行。

 

這樣就可以得到 實體類，dao 及對應的xml文件

Step4：添加service、controller

 UserService.java

package com.example.demo.Service;

import com.example.demo.entity.User;

import java.util.List;

public interface UserService {

    int addUser(User user);

    User findUserById(Integer Id);

    List<User> getAllUsers();//UserMapper.xml中記得添加這個方法

    int updateUser(User user);

    int deleteUserById(Integer Id);

}

 

UserServiceImpl.java

package com.example.demo.Service.impl;

import com.example.demo.Service.UserService;
import com.example.demo.entity.User;
import com.example.demo.entityMapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;
import org.springframework.stereotype.Service;

import java.util.List;

@Service(value = "userService")
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public int addUser(User user) {
        return userMapper.insert(user);
    }

    @Override
    public User findUserById(Integer Id) {
        return userMapper.selectByPrimaryKey(Id);
    }

    @Override
    public List<User> getAllUsers() {
        return userMapper.selectAllUsers();
    }

    @Override
    public int updateUser(User user) {
        return userMapper.updateByPrimaryKey(user);
    }

    @Override
    public int deleteUserById(Integer Id) {
        return userMapper.deleteByPrimaryKey(Id);
    }
}

UserController.java

package com.example.demo.controller;

import com.example.demo.Service.UserService;
import com.example.demo.entity.User;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@Controller
@RequestMapping(value = "user")
public class UserController {

    @Autowired
    private UserService userService;

    @ResponseBody
    @RequestMapping(value = "/add")
    public int addUser(User user){
        return userService.addUser(user);
    }

    @ResponseBody
    @RequestMapping(value = "/all", produces = {"application/json;charset=UTF-8"})
    public List<User> getAllUsers(){
        return userService.getAllUsers();
    }

    @ResponseBody
    @RequestMapping(value = "/update")
    public int updateUser(User user){
        return userService.updateUser(user);
    }
    @ResponseBody
    @RequestMapping(value = "/")
    public User getOneUser(Integer Id){
        return userService.findUserById(Id);
    }
    @ResponseBody
    @RequestMapping(value = "/delete")
    public int deleteUser(Integer Id){
        return userService.deleteUserById(Id);
    }
}

 

 

Step5：配置application.properties/application.yml

本文使用yml； properties是將參數寫成K = V的形式，而yml則是樹狀結構，更加清晰。

 application.yml:

server:
  port: 8080


spring:
  datasource:
    name: mysql_test
    type: com.alibaba.druid.pool.DruidDataSource
    #druid相關配置
    druid:
      #監控統計攔截的filters
      filters: stat
      driver-class-name: com.mysql.jdbc.Driver
      #基本屬性
      url: jdbc:mysql://127.0.0.1:3306/mydb?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
      username: root
      password: 123
      #配置初始化大小/最小/最大
      initial-size: 1
      min-idle: 1
      max-active: 20
      #獲取連接等待超時時間
      max-wait: 60000
      #間隔多久進行一次檢測，檢測需要關閉的空閑連接
      time-between-eviction-runs-millis: 60000
      #一個連接在池中最小生存的時間
      min-evictable-idle-time-millis: 300000
      validation-query: SELECT 'x'
      test-while-idle: true
      test-on-borrow: false
      test-on-return: false
      #打開PSCache，並指定每個連接上PSCache的大小。oracle設為true，mysql設為false。分庫分表較多推薦設置為false
      pool-prepared-statements: false
      max-pool-prepared-statement-per-connection-size: 20

mybatis:
  mapper-locations: classpath:mapping/*.xml
  type-aliases-package: com.example.demo.entity

#pagehelper
pagehelper:
  helperDialect: mysql
  reasonable: true
  supportMethodsArguments: true
  params: count=countSql
  returnPageInfo: check

 

Step6：啟動項目，測試CRUD功能。

這里只展示查詢，其余請自行嘗試。

 

 

最終的項目結構：

 

 

其他注意點：

關於實體類（User.java） 要加上@Mapper注解，並在啟動類（DemoApplication.java）添加 @MapperScan(basePackages = "com.example.demo.entityMapper" ) 注解，此處不貼代碼，讀者可以查看git上的源碼。

 

遇到的問題：

Q1:在generator反向生成時，generatorConfig.xml 中的http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd 不能識別導致生成失敗。

A1:在IDEA的File—setting中，找到Languages&Frameworks—Schemas and DTDs，右側的External Schemas and DTDs窗口中點擊添加按鈕，然后url上把鏈接粘貼上 。

 

 

Q2:遇到org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name *******（省略）

A2:檢查注解是否正確；

檢查yml文件，是否將mybatis作為樹狀結構的父節點（頂頭寫）；（樓主遇到的狀況）

如果是properties文件遇到該問題，檢查參數是否正確；

 

Q3: 遇到org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)

A3:檢查yml關於mybatis的配置，mapper-locations 后的路徑是否和resource下存放xxMapper.xml的路徑相同。

這個問題的相關解決方法在下面的參考來源Q3中有。

 

 

參考來源：Q1：https://blog.csdn.net/gaoqiang1112/article/details/78273776

Q3: https://blog.csdn.net/softwarehe/article/details/8889206

 https://www.jianshu.com/p/5cd772c07041

 

 =========================2018/08/16更新===================
添加熱部署功能：https://www.cnblogs.com/sprinkle/p/7058630.html

這是本人第一次寫博客，如有問題請提出，謝謝教正。