SpringBoot整合MyBatis-Plus+Druid快速构建项目骨架

目录

一、框架介绍

MyBatis-Plus

Mybatis-plus-generator

Druid

二、项目构建

1 创建SpringBoot工程

2 添加项目依赖

3 修改SpringBoot配置文件

4 项目结构

5 新建CodeGenerator.java代码生成类

6 创建DruidConfig.java连接池配置类

7 测试

8 小结


上一篇文章我们知道了SpringBoot整合H2数据库,至于为什么要使用数据库?没有别的原因,只是因为公司电脑安装的MySql竟然跑不起来,所以这里使用H2,其作为一个Java开发的嵌入式数据库,可直接嵌入项目中。下面我们就开始一步一步进行整合。

一、框架介绍

MyBatis-Plus

  • 增强版的MyBatis;通过简单的配置,即可快速进行CRUD操作;自带代码生成、分页插件。

Mybatis-plus-generator

  • MyBatis-Plus 的代码生成器,可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。

Druid

  • alibaba开源的数据库连接池,号称Java语言中最好的数据库连接池。

二、项目构建

1 创建SpringBoot工程

这里还是使用IDEA快速创建SpringBoot项目,具体步骤见上一篇文章:SpringBoot整合H2数据库

2 添加项目依赖

在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 https://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.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ssymon.study</groupId>
    <artifactId>spring-boot-study</artifactId>
    <version>1.0</version>
    <name>spring-boot-study</name>
    <description>Study Spring Boot Demo</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <mybatis-plus.version>3.3.2</mybatis-plus.version>
        <h2database.version>1.4.200</h2database.version>
        <lombok.version>1.18.12</lombok.version>
        <hutool.version>5.3.5</hutool.version>
        <swagger2.version>2.9.2</swagger2.version>
        <druid.version>1.1.22</druid.version>

        <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
        <maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
        <maven-surefire-plugin.version>2.18.1</maven-surefire-plugin.version>
    </properties>

    <dependencies>
        <!--  spring-boot start  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <!--  h2 数据库  -->
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <version>${h2database.version}</version>
        </dependency>
        <!--  lombok  -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
            <optional>true</optional>
        </dependency>
        <!--  swagger  -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <!--  mybatis-plus  -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>
        <!--  alibaba druid 连接池  -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>${druid.version}</version>
        </dependency>
        <!--  hutool 工具类库  -->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>${hutool.version}</version>
        </dependency>
    </dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
            </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-resources-plugin</artifactId>
                <version>${maven-resources-plugin.version}</version>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>${maven-compiler-plugin.version}</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>${maven-surefire-plugin.version}</version>
                <configuration>
                    <skipTests>true</skipTests><!--默认关掉单元测试 -->
                    <testFailureIgnore>true</testFailureIgnore>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>aliyun</id>
            <name>aliyun-maven</name>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        </repository>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://maven.aliyun.com/repository/spring</url>
        </repository>
        <repository>
            <id>central</id>
            <name>maven-central</name>
            <url>http://central.maven.org/maven2/</url>
        </repository>
    </repositories>
</project>

 

3 修改SpringBoot配置文件

在application.properties配置文件中添加Druid,MyBatis-Plus相关配置

# 应用配置 根据自己需要配置
spring.application.name=spring-boot-study
server.servlet.context-path=/sb-study
server.port=8080

# DataSource Config
spring.datasource.driver-class-name=org.h2.Driver
# DATABASE_TO_LOWER=TRUE;-要求数据库名称小写  CASE_INSENSITIVE_IDENTIFIERS=TRUE;-要求对字段的大小写不敏感
spring.datasource.url=jdbc:h2:D:/symon/project/db/sbstudy;CASE_INSENSITIVE_IDENTIFIERS=TRUE;
spring.datasource.username=symon
spring.datasource.password=123456
# 指定Schema (DDL)脚本
spring.datasource.schema=classpath:db/schema.sql
# 指定Data (DML)脚本
spring.datasource.data=classpath:db/data.sql
# 指定schema要使用的Platform
spring.datasource.platform=h2
# 是否启用h2控制台
spring.h2.console.enabled=true
# 配置h2控制台访问地址,http://localhost:8080/h2
spring.h2.console.path=/h2

# Druid连接池配置
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
# 初始化大小,最小,最大
spring.datasource.initialSize=5
spring.datasource.minIdle=10
spring.datasource.maxActive=20
# 配置获取连接等待超时的时间
spring.datasource.maxWait=60000
# 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
spring.datasource.timeBetweenEvictionRunsMillis=60000
# 配置一个连接在池中最小生存的时间,单位是毫秒
spring.datasource.minEvictableIdleTimeMillis=300000
spring.datasource.validationQuery=select 1
spring.datasource.testWhileIdle=true
spring.datasource.testOnBorrow=false
spring.datasource.testOnReturn=false
# 打开PSCache,并且指定每个连接上PSCache的大小
spring.datasource.poolPreparedStatements=true
spring.datasource.maxPoolPreparedStatementPerConnectionSize=20
# 配置监控统计拦截的filters,去掉后监控界面sql无法统计,'wall'用于防火墙
spring.datasource.filters=stat,wall,slf4j
# 通过connectProperties属性来打开mergeSql功能;慢SQL记录
spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

# MyBatis-Plus配置
mybatis-plus.mapper-locations=classpath:mapper/*.xml

 

4 项目结构

提前创建好相关代码文件的包,下图是我创建的项目简单结构

5 新建CodeGenerator.java代码生成类

代码生成类用来快速生成xml、mapper、entity、service、controller等类

具体配置详见:https://mp.baomidou.com/guide/generator.html

public class CodeGenerator {

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

        String tableNames = "student";

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = "D:/symon/project/spring-boot-study";//项目目录
        gc.setOutputDir(projectPath + "/src/main/java");//生成文件的输出目录
        gc.setAuthor("symon");//开发人员
        gc.setOpen(false);
        gc.setBaseColumnList(true);
        gc.setBaseResultMap(true);
        gc.setServiceName("%sService");//生成service名称
        gc.setFileOverride(true);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:h2:D:/symon/project/db/sbstudy;CASE_INSENSITIVE_IDENTIFIERS=TRUE;");
        dsc.setDriverName("org.h2.Driver");
        dsc.setUsername("symon");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.ssymon.study.springbootstudy");
        pc.setController("controller");
        pc.setMapper("dao");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        pc.setEntity("entity");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        //String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
                return projectPath + "/src/main/resources/mapper/" + tableInfo.getXmlName() + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setEntityTableFieldAnnotationEnable(true);
        strategy.setChainModel(true);//实体类是否为链式模型  @Accessors(chain = true)
        strategy.setRestControllerStyle(true);
        strategy.setInclude(tableNames.split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setCapitalMode(true);
        mpg.setStrategy(strategy);

        mpg.execute();
    }
}

执行main函数之前先启动一下项目确保表已创建,执行main函数之后所生成的文件如下图,可以说是非常方便了。

6 创建DruidConfig.java连接池配置类

配置数据源,配置后台访问,配置filter

@Configuration
public class DruidConfig {

    @Bean
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource getDataSource(){
        return new DruidDataSource();
    }
    //配置Druid的监控
    //1、配置一个管理后台的Servlet
    @Bean
    public ServletRegistrationBean statViewServlet(){
        ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
        Map<String,String> initParams = new HashMap<>();
        initParams.put("loginUsername","symon");
        initParams.put("loginPassword","123456");
        initParams.put("allow","");// IP白名单 (没有配置或者为空,则允许所有访问)
        initParams.put("deny","");// IP黑名单 (存在共同时,deny优先于allow)
        initParams.put("resetEnable","false");
        bean.setInitParameters(initParams);
        return bean;
    }
    //2、配置一个web监控的filter
    @Bean
    public FilterRegistrationBean webStatFilter(){
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new WebStatFilter());
        Map<String,String> initParams = new HashMap<>();
        initParams.put("exclusions","*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*");// 忽略资源
        bean.setInitParameters(initParams);
        bean.setUrlPatterns(Arrays.asList("/*"));
        return  bean;
    }
}

7 测试

写一个简单的查询接口来测试整合是否成功

① 在代码生成器生成的controller中添加简单的查询逻辑

@RestController
@RequestMapping("/student")
public class StudentController {

    @Autowired
    private StudentService studentService;

    @GetMapping("/listAll")
    public List<Student> list() {
        return studentService.list();
    }
}

② 启动类中添加mapper接口扫描路径

@SpringBootApplication
//mapper接口扫描路径
@MapperScan("com.ssymon.study.springbootstudy.dao")
public class SpringBootStudyApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBootStudyApplication.class, args);
    }
}

③ 在IDEA中启动项目,启动成功之后:

访问h2后台:http://localhost:8080/sb-study/h2,登录成功即可查看数据库相关信息

访问druid后台:http://localhost:8080/sb-study/druid,登陆之后即可查看连接池相关信息

通过浏览器或postman访问刚刚写的测试接口:http://localhost:8080/sb-study/student/listAll,结果如下

8 小结

自此SpringBoot整合MyBatis-Plus+Druid就结束了,我们可以发现,通过代码生成器生成的service和mapper已经继承了简单的CRUD方法,正如MyBatis-Plus官网所说:为简化开发而生。

MyBatis-plus官网:https://mp.baomidou.com/

  • 3
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 3
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值