springboot內建mybatis及mybatis generator工具使用

前言

mybatis是一個半自動化的orm架構，所謂半自動化就是mybaitis隻支援資料庫查出的資料映射到pojo類上，而實體到資料庫的映射需要自己編寫sql語句實作，相較于hibernate這種完全自動化的架構我更喜歡mybatis，mybatis非常靈活，可以随心所欲的編寫自己的sql語句來實作複雜的資料庫操作，還會有一種暢酣淋漓的編寫sql語句的潇灑感，但是以前的mybaits需要一大堆的配置檔案，以及各種mapper和dao和實體的關聯，導緻使用mybatis還是不夠簡潔，後來mybatis也發現了這個弊端，開發了mybatis generator工具來自動化生成實體類、mapper配置檔案、dao層代碼來減輕開發工作量，在後期也是實作了抛棄mapper配置檔案基于注解的開發模式，直到現在，mybatis看spring boot這麼火熱，也開發了一套基于spring boot的模式：mybatis-spring-boot-starter。

spring boot簡約輕巧的風格正在逐漸被越來越多的廠商及開發者所認可，包括阿裡的開源RPC架構dubbo也準備開發一套對spring boot應用的支援（dubbo-spring-boot-starter啟動配置子產品）

正文

springboot與mybatis內建

首先還是從http://start.spring.io/ 上初始化一個項目下來，然後在pom.xml檔案中加入mybatis啟動項（由于mybatis-spring-boot-starter依賴了spring-boot-starter，是以可以不用再添加spring-boot-starter了）以及mysql及web依賴

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.1</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

在application.properties中配置資料源及mybatis配置：

spring.application.name=spring-boot-config
server.port=8080
server.context-path=/

#mybatis.config-location=classpath:mybatis-config.xml
#mybatis mapper檔案的位置
mybatis.mapper-locations=classpath*:mapper/**/*.xml
#掃描pojo類的位置,在此處指明掃描實體類的包，在mapper中就可以不用寫pojo類的全路徑名了
mybatis.type-aliases-package=com.cuit
jdbc.type=mysql
spring.datasource.url=jdbc:mysql://localhost:3306/demo
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

可以通過mybatis.config-location屬性來指定mybatis的配置檔案的位置，簡單起見這裡使用預設配置就不用指定了，接下來分别在資料庫中建立user表，并插入一些資料

分别建立pojo類和dao接口對應mapper檔案

public class User{
    private String id;

    private String name;

    private String sex;

    private int age;

}

@Mapper//加上該注解才能使用@MapperScan掃描到
public interface UserDao {

    User getUserById(@Param("id") int id);

    int updateUser(@Param("user") User user);

    int insertUser(@Param("user") User user);

    int deleteUserById(@Param("id") int id);
}

對應的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.cuit.springboot.dao.UserDao">

    <select id="getUserById" resultType="User">
        SELECT
              ID as id,
              NAME as name,
              SEX as sex,
              AGE as age
        FROM user
        WHERE ID = #{id}
    </select>
    <update id="updateUser">
        UPDATE user
        SET NAME = #{user.name},
            SEX = #{user.sex},
            AGE = #{user.age}
        WHERE ID = #{user.id}
    </update>
    <insert id="insertUser">
        INSERT INTO
            user(id, name, sex, age)
            VALUES (
                #{user.id},
                #{user.name},
                #{user.sex},
                #{user.age}
            )
    </insert>
    <delete id="deleteUserById">
        DELETE user WHERE ID = #{id}
    </delete>

</mapper>

在啟動類上加上@MapperScan注解,掃描指定包下的dao類：

@ComponentScan("com.cuit")
@MapperScan("com.cuit")
public class SpringBootApplicationStarter {
    ...
}

最後寫個Controller方法用于測試：

@RestController
public class HelloController {

    @Autowired
    private UserDao userDao;

    @RequestMapping("/hello")
    public User hello(){
        User user = userDao.getUserById(1);
        System.out.println(user);
        return user;
    }

}

在浏覽器中輸入http://localhost:8080/hello 可以看到已經查到資料了，sprigboot與mybatis簡單內建就完成了。

使用注解方式

當我們需要一個很簡單的DML功能時，如果去建立mapper檔案并編寫一堆語句的時候也許會顯得很麻煩，這個時候就可以通過注解的方式簡化配置，建立一個UserAnnotationDao通過注解的方式來實作增删改查:

@Mapper
public interface UserAnnotationDao {

    @Select("SELECT * FROM user WHERE id = #{id}")
    @Results({
            @Result(property = "id", column = "id"),
            @Result(property = "name", column = "name"),
            @Result(property = "sex", column = "sex"),
            @Result(property = "age", column = "age")
    })
    User getUserById(int id);

    @Select("SELECT * FROM user")
    @Results({
            @Result(property = "id", column = "id"),
            @Result(property = "name", column = "name"),
            @Result(property = "sex", column = "sex"),
            @Result(property = "age", column = "age")
    })
    List<User> queryAll();

    @Update("UPDATE user SET NAME = #{user.name}, SEX = #{user.sex}, AGE = #{user.age} WHERE ID = #{user.id}")
    int updateUser(User user);

    @Insert("INSERT INTO user(id, name, sex, age) VALUES (#{user.id}, #{user.name}, #{user.sex}, #{user.age})")
    int insertUser(User user);

    @Delete("DELETE user WHERE ID = #{id}")
    int deleteUserById(int id);
}

使用注解自後就不需要mapper檔案了，分别測試這幾個方法均能正确執行，使用注解和使用xml的方式都差不多，通常情況下，如果沒有複雜的連接配接查詢，我們可以使用注解的方式，當設計到複雜的sql還是使用xml的方式更好掌控一些，是以通常情況下兩種方式都會使用，根據sql的複雜程度選擇不同的方式來提高開發效率。

mybatis generator工具的使用

在前言中說到，mybatis也發現了我們需要重複的去建立pojo類、mapper檔案以及dao類并且需要配置它們之間的依賴關系可能會很麻煩，是以mybtis提供了一個mybatis generator工具來幫我們自動建立pojo類、mapper檔案以及dao類并且會幫我們配置好它們的依賴關系，而我們隻需要關系我們的業務邏輯直接使用就行了。

要使用mybatis generator工具需要在pom.xml檔案中添加一個generator的maven工具：

<build>
      <plugins>
           <plugin>
               <groupId>org.mybatis.generator</groupId>
               <artifactId>mybatis-generator-maven-plugin</artifactId>
               <version>1.3.2</version>
               <executions>
                   <execution>
                       <id>Generate MyBatis Artifacts</id>
                       <phase>deploy</phase>
                       <goals>
                           <goal>generate</goal>
                       </goals>
                   </execution>
               </executions>
               <configuration>
                   <!-- generator 工具配置檔案的位置 -->
                   <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
                   <verbose>true</verbose>
                   <overwrite>true</overwrite>
               </configuration>
               <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.34</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>
               </dependencies>
           </plugin>
           <plugin>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-maven-plugin</artifactId>
               <configuration>
                   <classifier>exec</classifier>
               </configuration>
           </plugin>
       </plugins>
   </build>

上面指定了mybatis generator工具配置檔案的位置，在這個位置建立一個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>
    <!--執行generator插件生成檔案的指令： call mvn mybatis-generator:generate -e -->
    <!-- 引入配置檔案 -->
    <properties resource="mybatis-generator/mybatisGeneratorinit.properties"/>
    <!--classPathEntry:資料庫的JDBC驅動,換成你自己的驅動位置 可選 -->
    <!--<classPathEntry location="D:\generator_mybatis\mysql-connector-java-5.1.24-bin.jar" /> -->

    <!-- 一個資料庫一個context -->
    <!--defaultModelType="flat" 大資料字段，不分表 -->
    <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <!-- 自動識别資料庫關鍵字，預設false，如果設定為true，根據SqlReservedWords中定義的關鍵字清單；
        一般保留預設值，遇到資料庫關鍵字（Java關鍵字），使用columnOverride覆寫 -->
        <property name="autoDelimitKeywords" value="true" />
        <!-- 生成的Java檔案的編碼 -->
        <property name="javaFileEncoding" value="utf-8" />
        <!-- beginningDelimiter和endingDelimiter：指明資料庫的用于标記資料庫對象名的符号，比如ORACLE就是雙引号，MYSQL預設是`反引号； -->
        <property name="beginningDelimiter" value="`" />
        <property name="endingDelimiter" value="`" />

        <!-- 格式化java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />

        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />

        <!-- 注釋 -->
        <commentGenerator >
            <property name="suppressAllComments" value="false"/><!-- 是否取消注釋 -->
            <property name="suppressDate" value="true" /> <!-- 是否生成注釋代時間戳-->
        </commentGenerator>

        <!-- jdbc連接配接 -->
        <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />
        <!-- 類型轉換 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自動轉化以下類型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成實體類位址 -->
        <javaModelGenerator targetPackage="com.cuit.springboot.gentry" targetProject="${project}" >
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成mapxml檔案 -->
        <sqlMapGenerator targetPackage="mappers" targetProject="${resources}" >
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- 生成mapxml對應client，也就是接口dao -->
        <javaClientGenerator targetPackage="com.cuit.springboot.gdao" targetProject="${project}" type="XMLMAPPER" >
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <!-- table可以有多個,每個資料庫中的表都可以寫一個table，tableName表示要比對的資料庫表,也可以在tableName屬性中通過使用%通配符來比對所有資料庫表,隻有比對的表才會自動生成檔案 -->
        <table tableName="user" enableCountByExample="true" enableUpdateByExample="true" enableDeleteByExample="true" enableSelectByExample="true" selectByExampleQueryId="true">
            <property name="useActualColumnNames" value="false" />
            <!-- 資料庫表主鍵 -->
            <generatedKey column="id" sqlStatement="Mysql" identity="true" />
        </table>
    </context>
</generatorConfiguration>

在同目錄下建立mybatisGeneratorinit.properties檔案：

#Mybatis Generator configuration
#dao類和實體類的位置
project =src/main/java
#mapper檔案的位置
resources=src/main/resources
#根據資料庫中的表生成對應的pojo類、dao、mapper
jdbc_driver =com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/demo
jdbc_user=root
jdbc_password=123456

到此，整個配置就完成了，既然該工具的作用是将資料庫中的表生成對應的實體、dao類和mapper檔案，那麼首先需要建立資料庫表，當資料庫表建立好後在pom.xml檔案所在的目錄執行如下指令：

mvn mybatis-generator:generate1

然後就可以看到在指定目錄下已經生成了對應的檔案，關于mybatis generator的更多詳細的配置可以參考這篇文章：參考這裡…

springboot內建mybatis及mybatis generator工具使用

前言

正文

繼續閱讀

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

微服務-性能壓測\緩存redis和分布式鎖redisson和SpringCache

Spring資料和Redis

MyBatis學習筆記Mybatis學習筆記（maven、Idea版）

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

java 8 Lamda 求 List 中 Bigdecimal類型的各種值求最大值求最小值求和求平均值

(SpringBoot)日志種類：log、monitor、access、out、gc、backup

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法

用mybatis的generator插件在項目中自動生成dao及entity

從mybatis到mybatis plus(mp)