[Java] Spring Boot 集成 MyBatis Pl

2022-06-28 本文已影响0人巨馍蘸酱

MyBatis-Plus

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。^[1]

润物无声只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
效率至上只需简单配置，即可快速进行单表 CRUD 操作，从而节省大量时间。
丰富功能代码生成、自动分页、逻辑删除、自动填充等功能一应俱全。

pox.xml

    <dependencies>
        ...

        <!-- mybatis-plus 组件 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!-- mybatis plus 代码生成器依赖 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!-- mybatis plus 代码生成器模板，MyBatis-Plus 支持 Velocity（默认）、Freemarker -->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
        <!-- MySQL驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.28</version>
            <scope>runtime</scope>
        </dependency>
        <!--
        SpringBoot整合druid-spring-boot-starter
        省去配置文件或者@Configuration来配置，直接将配置写在 application.yml
        http://localhost:8081/xxx/druid/index.html
        -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.22</version>
        </dependency>
    </dependencies>

application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/hah_db?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC
    username: root
    password: 12345678
    driver-class-name: com.mysql.cj.jdbc.Driver
    # 数据库访问配置, 使用druid数据源(默认数据源是HikariDataSource)
    type: com.alibaba.druid.pool.DruidDataSource

配置

package com.example.verder.mybatisplus;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@Configuration
@EnableTransactionManagement
@MapperScan("com.example.mapper")
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));

        // 乐观锁
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

代码生成

package com.example.verder.mybatisplus;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.fill.Column;
import org.springframework.boot.system.ApplicationHome;
import org.springframework.util.ClassUtils;
import org.springframework.util.ResourceUtils;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.net.URLDecoder;
import java.util.*;

/**
 * @author dk
 * @create 2022-06-28 3:28 PM
 */
public class MybatisPlusGenerator {

    /// 获取项目路径
    public static void getPath() {

        List<String> paths = new ArrayList<>();

        try {
            //第四种
            String path = ResourceUtils.getURL("classpath:").getPath();
            paths.add("ResourceUtils: " + path);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }

        try {
            //第一种
            File path = new File(ResourceUtils.getURL("classpath:").getPath());
            if (!path.exists()) {
                path = new File("");
            }
            paths.add("File(ResourceUtils): " + path.getAbsolutePath());
            paths.add("File(ResourceUtils): " + path.getPath());
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }

        //第二种
        String userDir = System.getProperty("user.dir");
        paths.add("user.dir: " + userDir);

        try {
            //第三种
            URL classLoaderResource = ClassUtils.getDefaultClassLoader().getResource("");
            paths.add("ClassLoader: " + classLoaderResource.getPath());
            paths.add("ClassLoader: " + URLDecoder.decode(classLoaderResource.getPath(), "utf-8"));
        } catch (UnsupportedEncodingException e) {
            e.printStackTrace();
        }

//        //第五种  spring boot打jar包，建议使用第五种
//        ApplicationHome applicationHome = new ApplicationHome(getClass());
//        File jarFile = applicationHome.getSource();
//        paths.add("ApplicationHome: " + jarFile.getPath());
//        paths.add("ApplicationHome: " + jarFile.getAbsolutePath());
//        paths.add("ApplicationHome: " + jarFile.getParent());


        //第六种  spring boot打jar包或者不打包，都可以使用的，建议区分系统以完善路径 本种也建议使用
        Properties properties = System.getProperties();
        paths.add("Properties(os.name): " + properties.getProperty("os.name"));
        paths.add("Properties(user.dir): " + properties.getProperty("user.dir"));

        for (String str : paths) {
            System.out.println(str);
        }
    }

    /// 生成代码
    public static void main(String[] args) {
        getPath();

        String dbUrl = "jdbc:mysql://127.0.0.1:3306/haha_db?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=UTC";
        // String driverName = "com.mysql.cj.jdbc.Driver"; // ("com.mysql.jdbc.Driver");
        String dbUsername = "root";
        String dbPassword = "12345678";

        String projectPath = System.getProperty("user.dir");
        String globalConfigOutputDir = projectPath + "/src/main/java";
        String globalConfigAuthor = "dk";
        String packageConfigParent = "com.example";

        // https://www.mybatis-plus.com/guide/generator-new.html
        DataSourceConfig.Builder dataSourceConfigBuilder = new DataSourceConfig.Builder(dbUrl, dbUsername, dbPassword);
        FastAutoGenerator fastAutoGenerator = FastAutoGenerator.create(dataSourceConfigBuilder);
        fastAutoGenerator
                .globalConfig(builder -> {
                    builder
                            .enableSwagger() // 开启 swagger 模式
                            .author(globalConfigAuthor)
                            .outputDir(globalConfigOutputDir);
                })
                .packageConfig(builder -> {
                    builder.parent(packageConfigParent)
                            .controller("api.controller");
                })
                // 策略配置
                .strategyConfig((scanner, builder) -> {
                            builder.addInclude(getTables(scanner.apply("请输入表名，多个英文逗号分隔？所有输入 all")))
                                    .controllerBuilder() // controller 策略配置
                                    .enableRestStyle() // 开启生成@ RestController 控制器
                                    .enableHyphenStyle() // 开启驼峰转连字符
                                    .entityBuilder() // 实体策略配置
                                    .enableLombok() // 开启 lombok 模型
                                    .addTableFills(
                                            new Column("create_time", FieldFill.INSERT)
                                    ).build();
                        })
                // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                //.templateEngine(new FreemarkerTemplateEngine())
                .execute();
    }

    // 处理 all 情况
    protected static List<String> getTables(String tables) {
        return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
    }
}

Druid (druid-spring-boot-starter)

SpringBoot 整合 druid-spring-boot-starter, 省去配置文件或者 @Configuration 来配置，直接将配置写在 application.yml

访问 http://localhost:8081/xxx/druid/index.html 看效果

pom.xml

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.22</version>
</dependency>

application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/gushici?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC
    username: root
    password: 12345678
    driver-class-name: com.mysql.cj.jdbc.Driver
    # 数据库访问配置, 使用druid数据源(默认数据源是HikariDataSource)
    type: com.alibaba.druid.pool.DruidDataSource
    # 链接池配置
    druid:
      # 连接池配置：大小，最小，最大
      initial-size: 5
      min-idle: 5
      max-active: 20
      # 连接等待超时时间
      max-wait: 30000
      # 配置检测可以关闭的空闲连接，间隔时间
      time-between-eviction-runs-millis: 60000
      # 配置连接在池中的最小生存时间
      min-evictable-idle-time-millis: 300000
      # 检测连接是否有，有效得select语句
      validation-query: select '1' from dual
      # 申请连接的时候检测，如果空闲时间大于time-between-eviction-runs-millis，执行validationQuery检测连接是否有效，建议配置为true，不影响性能，并且保证安全性。
      test-while-idle: true
      # 申请连接时执行validationQuery检测连接是否有效，建议设置为false，不然会会降低性能
      test-on-borrow: false
      # 归还连接时执行validationQuery检测连接是否有效，建议设置为false，不然会会降低性能
      test-on-return: false
      # 是否缓存preparedStatement，也就是PSCache  官方建议MySQL下建议关闭   个人建议如果想用SQL防火墙 建议打开
      # 打开PSCache，并且指定每个连接上PSCache的大小
      pool-prepared-statements: true
      max-open-prepared-statements: 20
      max-pool-prepared-statement-per-connection-size: 20
      # 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙防御sql注入，stat监控统计,logback日志
      filters: stat,wall
      # Spring监控AOP切入点，如x.y.z.service.*,配置多个英文逗号分隔
      #aop-patterns: com.springboot.servie.*
      # lowSqlMillis用来配置SQL慢的标准，执行时间超过slowSqlMillis的就是慢
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
      # WebStatFilter监控配置
      web-stat-filter:
        enabled: true
        # 添加过滤规则：那些访问拦截统计
        url-pattern: /*
        # 忽略过滤的格式：哪些不拦截，不统计
        exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
      # StatViewServlet配置（Druid监控后台的Servlet映射配置，因为SpringBoot项目没有web.xml所在在这里使用配置文件设置）
      stat-view-servlet:
        enabled: true
        # 配置Servlet的访问路径：访问路径为/druid/**时，跳转到StatViewServlet，会自动转到Druid监控后台
        url-pattern: /druid/*
        # 是否能够重置数据
        reset-enable: false
        # 设置监控后台的访问账户及密码
        login-username: admin
        login-password: 123456
        # IP白名单：允许哪些主机访问，默认为“”任何主机
        # allow: 127.0.0.1
        # IP黑名单：禁止IP访问，（共同存在时，deny优先于allow）
        # deny: 192.168.1.218
      # 配置StatFilter
      filter:
        stat:
          log-slow-sql: true

鸣谢

https://www.mybatis-plus.com/guide/generator-new.html

https://www.mybatis-plus.com/guide ↩

[Java] Spring Boot 集成 MyBatis Pl

MyBatis-Plus

pox.xml

application.yml

配置

代码生成

Druid (druid-spring-boot-starter)

pom.xml

application.yml

鸣谢

猜你喜欢

热点阅读