springboot整合mybatis plus

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/rhx_1989/article/details/89183946

1.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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.9.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>11</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>2.0.1</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.16</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.1.0</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.1.0</version>
        </dependency>

        <!-- 模板引擎 -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.1</version>
        </dependency>

        <!--用于编译jsp-->
        <dependency>
            <groupId>org.apache.tomcat.embed</groupId>
            <artifactId>tomcat-embed-jasper</artifactId>
            <scope>provided</scope>
        </dependency>

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

    <build>
        <resources>
            <resource>
                <directory>src/main/webapp</directory>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>11</source>
                    <target>11</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2.根据数据库表自动生成代码

执行CodeGenerator类中main方法后，会在E://MP_CODE目录下生成对应的文件，将文件拷贝到项目目录中即可。

package com.example.mp;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.extension.incrementer.OracleKeyGenerator;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;
import java.util.List;


public class CodeGenerator {
    //指定文件保存地址
    private static final String out_dir = "E://MP_CODE";
    //作者
    private static final String author = "renhaoxiang";
    //模块名
    private static final String module_name = "sys";
    //数据库 表名
    private static final String table_name = "test";
    //数据库 ID 主键策略
    private static final IdType id_type = IdType.AUTO;
    //表对应的基类名，注意首字母大写
    private static final String entity_name = "Test";

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        //获取项目主路径
        //String projectPath = System.getProperty("user.dir") + "/src/main/java";
        //java文件路径 projectPath
        gc.setOutputDir(out_dir);
        //是否覆盖文件
        gc.setFileOverride(true);
        //是否开启 activeRecord 模式，实体类只需继承 Model 类，即可直接调用相关方法，实现基本 CRUD 操作
        //User user = new User(); user.insert();
        //gc.setActiveRecord(true);
        //文件创建人
        gc.setAuthor(author);
        //是否打开输出目录GlobalConfiguration
        gc.setOpen(false);
        //实体类名
        gc.setEntityName(entity_name);
        //Controller类文件 %s会自动填充表实体属性
        gc.setControllerName(entity_name+"Controller");
        //Service接口类文件名
        gc.setServiceName(entity_name+"Service");
        //Service接口实现类文件名
        gc.setServiceImplName(entity_name+"ServiceImpl");
        //Mapper类文件名
        gc.setMapperName(entity_name+"Mapper");
        //XML SQL配置文件名
        gc.setXmlName(entity_name+"Mapper");
        //XML ResultMap
        gc.setBaseResultMap(true);
        //XML columList
        gc.setBaseColumnList(true);
        //XML 二级缓存
        gc.setEnableCache(false);
        //自定义ID类型
        gc.setIdType(id_type);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //包名 默认com.baomidou
        pc.setParent("com.example.demo.core");
        //自定义模块名 默认null
        pc.setModuleName(module_name);
        //自定义实体类包名
        pc.setEntity("entity");
        //自定义控制器包名，默认 controller
        pc.setController("controller");
        //自定义Service接口类包名
        pc.setService("service");
        //自定义Service接口实现类包名
        pc.setServiceImpl("service.impl");
        //自定义Mapper类包名
        pc.setMapper("mapper");
        //自定义xml sql配置文件类包名
        pc.setXml("mapper.xml");
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        //全局大写命名 默认false
        //strategy.setCapitalMode(true);
        //数据库表名映射到实体的命名策略
        strategy.setNaming(NamingStrategy.underline_to_camel);
        //数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //【实体】是否为lombok模型（默认 false），需要lombok包支持
        strategy.setEntityLombokModel(true);
        //【实体】是否为构建者模型（默认 false）
        //public User setName(String name) {this.name = name; return this;}
        strategy.setEntityBuilderModel(true);
        //【实体】是否生成字段常量（默认 false）
        //public static final String ID = "test_id";
        //strategy.setEntityColumnConstant(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(false);
        //需要生成的表，多个使用英文逗号分割，允许正则表达式
        strategy.setInclude(table_name);
        //排除生成的表
        //strategy.setExclude("");
        //驼峰转连字符
        strategy.setControllerMappingHyphenStyle(true);
        //自定义实体，公共字段
        //strategy.setSuperEntityColumns("id");
        //表前缀
        //strategy.setTablePrefix(pc.getModuleName() + "_");
        //Boolean类型字段是否移除is前缀处理
        strategy.setEntityBooleanColumnRemoveIsPrefix(true);
        //自定义需要填充的字段
        //如 每张表都有一个创建时间、修改时间
        //而且这基本上就是通用的了，新增时，创建时间和修改时间同时修改
        //修改时，修改时间会修改，
        //虽然像Mysql数据库有自动更新几只，但像ORACLE的数据库就没有了，
        //使用公共字段填充功能，就可以实现，自动按场景更新了。
        /*List<TableFill> tableFillList = new ArrayList<TableFill>(){
            {
                add(new TableFill("create_time", FieldFill.INSERT));
                add(new TableFill("modified_time", FieldFill.INSERT_UPDATE));
            }
        };
        strategy.setTableFillList(tableFillList);*/
        //自定义实体类父类
        //strategy.setSuperEntityClass("com.baomidou.demo.common.base.BsBaseEntity");
        //自定义 controller 父类
        //strategy.setSuperControllerClass("com.baomidou.demo.TestController");
        //自定义 service 父类
        //strategy.setSuperServiceClass("com.baomidou.demo.common.base.BsBaseService");
        //自定义 service 实现类父类
        //strategy.setSuperServiceImplClass("com.baomidou.demo.common.base.BsBaseServiceImpl");
        //自定义 mapper 父类
        //strategy.setSuperMapperClass("com.baomidou.demo.common.base.BsBaseMapper");
        mpg.setStrategy(strategy);

        // 执行生成
        mpg.execute();
    }

}

3.注意事项

（1）将原生SqlSessionFactoryBean更换为Mybatis-plus的MybatisSqlSessionFactoryBean

<bean id="sqlSessionFactory" name="sqlSessionFactoryName" 
        class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="typeAliasesPackage" value="com.example.demo.core.*" />
        <property name="configLocation" value="classpath:spring/mybatis-config.xml"/>
        <property name="mapperLocations" value="classpath*:com/example/demo/core/**/mapper/xml/*.xml" />
</bean>

（2）代码中使用了lombok，如果要调用实体类的getter、setter方法，需要手动添加，或者安装lombok的插件。