SpringBoot集成Mybatis Generator自动生成MySQL访问相关文件

在本地MySQL数据库中创建了一个air_conditioner数据库,只有一个devices表,这个表包含三个字段:device_id、type、position,本文将尝试访问这个数据库。创建数据库的脚本放在文末给出的git中了。

1、pom文件加入mybatis依赖

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.2.0</version>
        </dependency>

2、pom文件加入mybatis generator插件配置

            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <executions>
                    <execution>
                        <id>Generate MyBatis Artifacts</id>
                        <goals>
                            <goal>generate</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <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.35</version>
                    </dependency>
                    <dependency>
                        <groupId>org.mybatis.generator</groupId>
                        <artifactId>mybatis-generator-core</artifactId>
                        <version>1.3.2</version>
                    </dependency>
                </dependencies>
            </plugin>

3、编写配置文件generatorConfig.xml

这个文件定义了mybatis generator如何生成model、dao、mapper,详见官方文档。把这个文件存放在步骤2中指定的位置:src/main/resources/mybatis-generator/

<?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>
    <!-- 引入配置文件 -->
    <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="MyBatis3" defaultModelType="flat">
        <property name="autoDelimitKeywords" value="true" />
        <property name="beginningDelimiter" value="`" />
        <property name="endingDelimiter" value="`" />
        <property name="javaFileEncoding" value="utf-8" />
        <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.quiterr.model" 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.quiterr.dao" targetProject="${project}" type="XMLMAPPER" >
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>
        <table tableName="devices" 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>

4、编写mybatisGeneratorinit.properties

这个文件保存了一些generatorConfig.xml会用到的配置信息,比如项目的目录、数据库的连接信息,这些信息也可以直接放在generatorConfig.xml中,但这样可读性差一些。

#Mybatis Generator configuration
project =src/main/java
resources=src/main/resources
jdbc_driver =com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/air_conditioner
jdbc_user=root
jdbc_password=123456

5、生成dao、model、mapper文件

在数据库建好之后,在编写业务代码之前,就该生成这些文件了,在maven的生命周期里似乎没有一个合适的阶段用来执行这个操作。其实只需要在CMD中运行一行命令即可:
call mvn mybatis-generator:generate -e

6、配置dao、mapper的路径

a、配置dao的路径
可以在生成的每个dao文件里添加@mapper注解,如:

@Mapper
public interface DevicesMapper {
    /**
     * This method was generated by MyBatis Generator.
     * This method corresponds to the database table devices
     *
     * @mbggenerated
     */
    int countByExample(DevicesExample example);
//后边的代码省略

也可以在App类添加@MapperScan注解,如:

@SpringBootApplication
@EnableScheduling
@MapperScan("com.quiterr.dao")
@EnableConfigurationProperties({AirConditionerSettings.class})
public class App {

    public static void main(String args[]){
        SpringApplication.run(App.class);
    }
}

b、配置mapper的路径
在application.properties里加一行:
mybatis.mapper-locations=classpath:mappers/*.xml
ps:model的路径不用配置,在mapper文件里面已有

7、访问数据库

在model目录下,mybatis generator为每一个表生成了一个example文件,通过这个文件提供了一种“面向对象”的数据库查询,总之不用自己写sql语句了。

//mybatis generator生成的example文件
public class DevicesExample {
    /**
     * This field was generated by MyBatis Generator.
     * This field corresponds to the database table devices
     *
     * @mbggenerated
     */
    protected String orderByClause;

    /**
     * This field was generated by MyBatis Generator.
     * This field corresponds to the database table devices
     *
     * @mbggenerated
     */
    protected boolean distinct;
//后面的代码省略

要查询数据库,首先,注入dao:

@Autowired
DevicesMapper devicesMapper;

然后像这样:

        //从数据库查询各类设备的数量
        String pos="机房";
        DevicesExample devicesExample = new DevicesExample();
        DevicesExample.Criteria criteria = devicesExample.createCriteria();
        criteria.andPositionEqualTo(pos);
        List<Devices> deviceList = devicesMapper.selectByExample(devicesExample);

本文源码:https://github.com/quiterr/mybatis-generator-test.git
官方文档:http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容