feat: springboot mybatis plus 的应用

Author: zihong

README.md

@@ -147,5 +147,11 @@ SpringBoot 使用Gradle做依赖管理时，配置打包docker镜像的DEMO
 #### SpringBoot-Thrift-Client(Thrift  实现远程服务调用 客戶端)
 SpringBoot基于Thrift实现RPC客户端
 
+#### SpringBoot-Mybatis-Plus
+SpringBoot 集成Mybatis Plus，内置乐观锁，crud，自动填充示例
+
+#### SpringBoot-Alibaba-Sentinel
+SpringBoot 使用 Alibaba开源监控平台 sentinel 示例
+
 #### SpringBoot-Utils 
 各项目的依赖模块，存放一些工具类

SpringBoot-Mybatis-Plus/.gitignore

@@ -0,0 +1,32 @@
+HELP.md
+.gradle
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**
+!**/src/test/**
+
+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+out/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/

SpringBoot-Mybatis-Plus/README.md

@@ -0,0 +1,22 @@
+### SpringBoot 集成 Mybatis Plus 示例
+
+#### 简介
+MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。  
+#### 特性
+ 
+     无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
+     损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
+     强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
+     支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
+     支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
+     支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
+     支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
+     内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
+     内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
+     分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
+     内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
+     内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
+
+
+详情可参考Mybatis plus 官网，链接：  
+https://mp.baomidou.com/guide/quick-start.html  

SpringBoot-Mybatis-Plus/build.gradle

@@ -0,0 +1,9 @@
+dependencies {
+    compile project(':SpringBoot-Utils')
+    compile 'com.baomidou:mybatis-plus-boot-starter:3.0.1'
+    //代码生成器
+    compile 'com.baomidou:mybatis-plus-generator:3.0.1'
+    compile group: 'mysql', name: 'mysql-connector-java', version: '5.1.46'
+    compile 'org.apache.velocity:velocity-engine-core:2.1'
+    testCompile group: 'org.springframework.boot', name: 'spring-boot-starter-test', version: '2.0.4.RELEASE'
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/CodeGenerator.java

@@ -0,0 +1,130 @@
+package com.dashuai.learning.mybatisplus;
+
+import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
+import com.baomidou.mybatisplus.core.toolkit.StringPool;
+import com.baomidou.mybatisplus.core.toolkit.StringUtils;
+import com.baomidou.mybatisplus.generator.AutoGenerator;
+import com.baomidou.mybatisplus.generator.InjectionConfig;
+import com.baomidou.mybatisplus.generator.config.*;
+import com.baomidou.mybatisplus.generator.config.po.TableInfo;
+import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Scanner;
+
+public class CodeGenerator {
+    /**
+     * <p>
+     * 读取控制台内容
+     * </p>
+     */
+    public static String scanner(String tip) {
+        Scanner scanner = new Scanner(System.in);
+        System.out.println("请输入" + tip + "：");
+        if (scanner.hasNext()) {
+            String ipt = scanner.next();
+            if (StringUtils.isNotEmpty(ipt)) {
+                return ipt;
+            }
+        }
+        throw new MybatisPlusException("请输入正确的" + tip + "！");
+    }
+
+    public static void main(String[] args) {
+        // 代码生成器
+        AutoGenerator mpg = new AutoGenerator();
+
+        // 全局配置
+        GlobalConfig gc = new GlobalConfig();
+        String projectPath = System.getProperty("user.dir");
+        gc.setOutputDir(projectPath + "/SpringBoot-Mybatis-Plus/src/main/java");
+        gc.setAuthor("zoey");
+        gc.setOpen(false);
+        // gc.setSwagger2(true); 实体属性 Swagger2 注解
+        mpg.setGlobalConfig(gc);
+
+        // 数据源配置
+        DataSourceConfig dsc = new DataSourceConfig();
+        dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8");
+        // dsc.setSchemaName("public");
+        dsc.setDriverName("com.mysql.jdbc.Driver");
+        dsc.setUsername("root");
+        dsc.setPassword("root");
+        mpg.setDataSource(dsc);
+
+        // 包配置
+        PackageConfig pc = new PackageConfig();
+        pc.setModuleName(scanner("模块名"));
+        pc.setParent("com.dashuai.learning.mybatisplus");
+        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 + "/SpringBoot-Mybatis-Plus/src/main/resources/mapper/" + pc.getModuleName()
+                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
+            }
+        });
+        /*
+        cfg.setFileCreate(new IFileCreate() {
+            @Override
+            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
+                // 判断自定义文件夹是否需要创建
+                checkDir("调用默认方法创建的目录");
+                return false;
+            }
+        });
+        */
+        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.setSuperEntityClass("com.dashuai.learning.mybatisplus.common.BaseEntity");
+        strategy.setEntityLombokModel(true);
+        strategy.setRestControllerStyle(true);
+        // 公共父类
+//        strategy.setSuperControllerClass("com.dashuai.learning.mybatisplus.common.BaseController");
+        // 写于父类中的公共字段
+        strategy.setSuperEntityColumns("id");
+        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
+        strategy.setControllerMappingHyphenStyle(true);
+        strategy.setTablePrefix(pc.getModuleName() + "_");
+        mpg.setStrategy(strategy);
+//        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
+        mpg.execute();
+    }
+
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/MybatisPlusApplication.java

@@ -0,0 +1,15 @@
+package com.dashuai.learning.mybatisplus;
+
+import org.mybatis.spring.annotation.MapperScan;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+@MapperScan("com.dashuai.learning.mybatisplus.user.mapper")
+public class MybatisPlusApplication {
+
+    public static void main(String[] args) {
+        SpringApplication.run(MybatisPlusApplication.class, args);
+    }
+
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/config/MyMetaObjectHandler.java

@@ -0,0 +1,32 @@
+package com.dashuai.learning.mybatisplus.config;
+
+import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
+import org.apache.ibatis.reflection.MetaObject;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.stereotype.Component;
+
+import java.util.Date;
+
+/**
+ * Created in 2019.12.12
+ * 配置自动填充
+ *
+ * @author Liaozihong
+ */
+@Component
+public class MyMetaObjectHandler implements MetaObjectHandler {
+    private static final Logger LOGGER = LoggerFactory.getLogger(MyMetaObjectHandler.class);
+
+    @Override
+    public void insertFill(MetaObject metaObject) {
+        LOGGER.info("start insert fill ....");
+        this.setFieldValByName("createAt", new Date(), metaObject);
+    }
+
+    @Override
+    public void updateFill(MetaObject metaObject) {
+        LOGGER.info("start update  fill ....");
+        this.setFieldValByName("updateAt", new Date(), metaObject);
+    }
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/config/MybatisPlusConfig.java

@@ -0,0 +1,32 @@
+package com.dashuai.learning.mybatisplus.config;
+
+import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
+import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class MybatisPlusConfig {
+    /**
+     * 乐观锁配置，记得需要使用乐观锁的实体添加@Version，系统会自动帮你添加version
+     *
+     * @return
+     */
+    @Bean
+    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
+        return new OptimisticLockerInterceptor();
+    }
+
+    /**
+     * 可配置多租户信息等
+     *
+     * @return
+     */
+    @Bean
+    public PaginationInterceptor paginationInterceptor() {
+        PaginationInterceptor page = new PaginationInterceptor();
+        //设置方言类型
+        page.setDialectType("mysql");
+        return page;
+    }
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/user/controller/UserController.java

@@ -0,0 +1,18 @@
+package com.dashuai.learning.mybatisplus.user.controller;
+
+
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * <p>
+ * 前端控制器
+ * </p>
+ *
+ * @author zoey
+ * @since 2019-12-12
+ */
+@RestController
+public class UserController {
+
+}
+

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/user/entity/User.java

@@ -0,0 +1,53 @@
+package com.dashuai.learning.mybatisplus.user.entity;
+
+import com.baomidou.mybatisplus.annotation.FieldFill;
+import com.baomidou.mybatisplus.annotation.TableField;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.Version;
+import lombok.Data;
+import lombok.experimental.Accessors;
+
+import java.util.Date;
+
+/**
+ * <p>
+ *
+ * </p>
+ *
+ * @author zoey
+ * @since 2019-12-12
+ */
+@Accessors(chain = true)
+@Data
+public class User {
+
+    private static final long serialVersionUID = 1L;
+
+
+    @TableId
+    private Long id;
+    /**
+     * 姓名
+     */
+    private String name;
+
+    /**
+     * 年龄
+     */
+    private Integer age;
+
+    /**
+     * 邮箱
+     */
+    private String email;
+
+    @TableField(fill = FieldFill.INSERT)
+    private Date createAt;
+
+    @TableField(fill = FieldFill.UPDATE)
+    private Date updateAt;
+
+    @Version
+    private Integer version;
+
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/user/mapper/UserMapper.java

@@ -0,0 +1,17 @@
+package com.dashuai.learning.mybatisplus.user.mapper;
+
+import com.baomidou.mybatisplus.core.mapper.BaseMapper;
+import com.dashuai.learning.mybatisplus.user.entity.User;
+
+/**
+ * <p>
+ * Mapper 接口
+ * </p>
+ *
+ * @author zoey
+ * @since 2019-12-12
+ */
+public interface UserMapper extends BaseMapper<User> {
+
+
+}

SpringBoot-Mybatis-Plus/src/main/java/com/dashuai/learning/mybatisplus/user/service/IUserService.java

@@ -0,0 +1,16 @@
+package com.dashuai.learning.mybatisplus.user.service;
+
+import com.baomidou.mybatisplus.extension.service.IService;
+import com.dashuai.learning.mybatisplus.user.entity.User;
+
+/**
+ * <p>
+ * 服务类
+ * </p>
+ *
+ * @author zoey
+ * @since 2019-12-12
+ */
+public interface IUserService extends IService<User> {
+
+}