mybatis-plus 1 —— 整合 Springboot、代码自动生成

最新推荐文章于 2022-07-14 00:00:00 发布
最新推荐文章于 2022-07-14 00:00:00 发布
阅读量185 收藏
点赞数
分类专栏： java 文章标签： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42189048/article/details/108414539
版权

mybatis-plus 1 —— 整合 Springboot、代码自动生成

前言

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。本文将其与 Springboot 整合，并演示一些 MP 好用的特性

版本

Springboot：2.3.3.RELEASE
MP：3.4.0

整合示例

先体会一段整合示例，初步了解 MP

依赖

	<dependencies>
        <!-- springboot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

		<!-- MP -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.0</version>
        </dependency>
    </dependencies>

	<!-- 自动生成 -->
	<dependency>
	    <groupId>com.baomidou</groupId>
	    <artifactId>mybatis-plus-generator</artifactId>
	    <version>3.4.2</version>
	</dependency>
	<!-- 模板引擎 -->
	<dependency>
		<groupId>org.freemarker</groupId>
		<artifactId>freemarker</artifactId>
		<version>2.3.30</version>
	</dependency>

引入 Springboot 和 MP 依赖

配置文件

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/copy_test?characterEncoding=utf-8
    username: test
    password: test

本地 Mysql 库测试，创建一张 user 表，字段见 实体类

相关类

// 实体类
@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

// Mapper 接口，继承 BaseMapper
// 不同于传统的 mybatis，不用写任何代码
public interface UserMapper extends BaseMapper<User> {

}

// 启动类，指定 MapperScan
@SpringBootApplication
@MapperScan("com.xsn.mapper")
public class Application {

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

}

定义 user 表对应的 实体类，创建 UserMapper 类，不用写其他代码

测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class Test1 {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }
}

结果：
User(id=1, name=1, age=1, email=1)
User(id=2, name=2, age=2, email=2)

不用写任何代码，我们就实现了 查询

代码生成

MP 提供了很多好用的特性，比如我们可以通过简单的 配置类，生成对应的实体类、Service 等代码。我们在 MP官网 提供的示例配置类基础上稍加改动，举例生成 user 表相关代码

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

    // 读取控制台内容
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        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();

        // 因为本人搭建的测试过程是多 moudle 的，这个地方手动指定了 具体 moudle
        String projectPath = System.getProperty("user.dir") + "/services/mybatis-plus";

        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("xsn");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://192.168.137.101:3306/copy_test?characterEncoding=utf-8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("test");
        dsc.setPassword("test");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.xsn");
        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/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        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("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        // strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        // strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

直接运行 main 方法，生成对应代码到指定模块（包路径）下

代码生成
生成效果如下
代码生成
其中包括 controller service mapper 和对应的 Mapper.xml


====================controller=========================

@RestController
@RequestMapping("/test/user")
public class UserController {

}

====================service=========================

public interface IUserService extends IService<User> {

}
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {

}

====================entity=========================

@Data
@EqualsAndHashCode(callSuper = false)
// 自己添加无参构造
@NoArgsConstructor
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

	// id 自增，我们也可以指定 INPUT NONE 等
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    private String name;

    private Integer age;

    private String email;

	// 自己添加的构造方法
    public User(String name, Integer age, String email) {
        this.name = name;
        this.age = age;
        this.email = email;
    }
}

====================mapper=========================

// 跟我们在 整合示例demo 中声明的一样
public interface UserMapper extends BaseMapper<User> {

}

总结

此章节介绍了 MP 和 Springboot 的整合，以及 代码生成 的特性，这可以为我们的开发提供极大的便利。下一章节我们介绍 MP 对 CRUD 的封装，也是 MP 的核心部分

下一篇：mybatis-plus 2 —— CRUD 封装的使用

小水牛...
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot整合Mybatis实现自动生成代码
m0_45270667的博客
10-31 815
MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的 POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。 相信大家对MyBatis都不陌生，在实际开发应用中，应用的比较多，它常常与SpringBoot框架，Spring框架 进行整合，进而开发相关的网站以及服务。
SpringBoot整合Mybatis-plus自动生成
MG斜阳的博客
09-29 169
SpringBoot整合Mybatis-plus自动生成整合Mybatis-plus1.配置dependency2.编写yml配置文件3.开启mapper接口扫描，添加分页插件4.代码生成 整合Mybatis-plus 官网：https://mp.baomidou.com/guide/install.html 1.配置dependency 因为涉及到代码生成，所以我们还需要导入页面模板引擎，这里我们用的是freemarker。 <dependency> <groupId>c
springboot集成mybatis-plus自动生成代码
马尾与发圈
04-19 1659
springboot集成mybatis-plus自动生成代码 1.导包 <!--mybatis-plus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> ...
Springboot整合Mybatis Plus自动生成代码、分页、条件查询warpper
老王的博客
06-30 1576
前提先要有数据库的表 一.引入依赖 <!--mybatis-plus--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.1.0</version&g
springboot整合mybatis-plus，代码自动生成
cf
10-08 6870
Mybatis-Plus（简称MP）是一个 Mybatis 的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生   特性   无侵入：Mybatis-Plus 在 Mybatis 的基础上进行扩展，只做增强不做改变，引入 Mybatis-Plus 不会对您现有的 Mybatis 构架产生任何影响，而且 MP 支持所有 Mybatis 原生的特性 依赖少：仅...
在线问题反馈模块实战(二):封装代码自动生成类文件器
**My Coding Family**
07-14 360
在线问题反馈模块实战教学，等你来白嫖，非常详细，适合新手小白学习。
MyBatis Plus代码生成器配置
积木
05-23 1068
学了这么久的SSM，学到Mybatis plus 我傻掉了 SQL不用写，代码生成器。（要我何用） 好吧 赶快详细注释一波 public static void main(String[] args) { // 代码生成器 AutoGenerator mpg = new AutoGenerator(); // 全局配置 GlobalConfig gc = new GlobalConfig(); String projec
MyBatis-plus+达梦数据库实现自动生成代码的示例
09-07
在本示例中，我们将讨论如何结合 MyBatis-Plus 和达梦数据库（DM Database）实现自动生成代码的功能。 首先，让我们来看看配置方面。在 Spring Boot 项目中，我们需要在 POM 文件中添加必要的依赖。除了 Spring ...
mybatis-plus 达梦 代码生成
06-10
标题"mybatis-plus 达梦 代码生成"表明了本文将要讨论的是如何使用Mybatis-Plus框架结合达梦数据库来自动生成代码。Mybatis-Plus是Mybatis的一个增强工具，它在Mybatis的基础上做了很多简化操作，如自动CRUD（创建、...
mybatis-plus代码生成器模版代码
最新发布
08-17
本资源包含的是Mybatis-Plus的代码生成器模板代码，用于自动生成符合项目规范的Java实体类、Mapper接口及XML配置文件，提高开发效率。 代码生成器是开发中的利器，它能够根据数据库表结构快速生成对应的Java代码，...
MyBatis-Plus-Example:SpringBoot整合MyBatis-Plus，源码学习，增删改查，Lamdba支持
05-12
MyBatis-Plus-Example Spring Boot 整合 MyBatis Plus 实例，持续更新！！！ 代码生成器 三方框架版本总览 名称 版本 更新时间 Spring Boot 2.4.2 2021.02.02 MyBatis-Plus 3.4.2 2021.02.02 JavaLib 3.4.2 2021.02....
SpringBoot整合MyBatis-Plus
06-17
这样，我们就完成了SpringBoot与MyBatis-Plus的整合，以及利用代码生成器自动化生成基础代码的过程。 总结一下，SpringBoot整合MyBatis-Plus的关键步骤包括：引入依赖、配置MyBatis-Plus、创建实体类与Mapper接口、...
Mybatis-Plus使用解析
斌
08-02 898
特性 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequen
SpringBoot代码自动生成并集成MybatisPlus
qq_43791139的博客
07-09 429
SpringBoot代码自动生成并集成MybatisPlus 1.application.yml spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/vueblog?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shangha
spring-boot mybatis-plus集成 代码自动生成 和 自定义生成代码 (简单，方便 易理解)
weixin_41371502的博客
06-18 401
mybatis-plus自定义生成代码导包在yml配置mybaits-plus创建CodeGeneration.java类测试看效果图。 前言：之前都是通过配置generatorConfig.xml文件实现自动生成代码，跟plus的基本差不多，只不过plus使用起来更加的方便。 本文章重点讲述第二种方式，自定义生成代码 使用mybatis-plus可以自动帮我们生成通用的 controller,service,dao,mapper 导包 <dependency>
SpringBoot集成MyBatis-Plus自动代码生成器（官方代码生成）
仲夏宁叶香的博客
01-01 6931
文档来源：https://baomidou.gitee.io/mybatis-plus-doc/#/generate-code 最新文档来源：https://mybatis.plus/guide/generator.html 本博客演示的是MyBatis-Plus2.X文档，如需要看最新文档内容的请移步最新文档查看 1. pom文件 <!-- MySQL数据库...
SpringBoot整合MyBatisPlus代码生成器
qq_34333537的博客
04-14 2296
官方例子 https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B 引入依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId&gt...
springBoot 整合mybatisPlus指定各类文件输出位置，springBoot整合p6spy
Jkcaotain的博客
08-24 787
最近使用了一下mybatisPlus（以下简称mp）,在此记录一下其中代码生成器中如何指定各类文件的生成位置（因为mp可以帮助你生成controller、service、serviceImpl、mapper、mapperxml）文件。 好了，话不多说，直接奔入主题。使用PackageConfig 这个对象就可以指定生成的各种文件的位置。一下是我的整个代码生成器内容。 public static void main(String[] args) { ...
mybatis-plus 2 —— CRUD 封装的使用
小水牛的博客
09-08 2331
mybatis-plus 2 —— CRUD 封装的使用前言CRUD 封装WrapperQueryWrapperUpdateWrapperIServicesavegetlistupdatesaveOrUpdateremovepage 前言 上一章节介绍了 MP 和 Springboot 的整合，以及 代码生成 的特性。本章节介绍 MP 对 CRUD 的封装，并结合大量 使用示例 帮助理解 CRUD 封装 MP 帮我们封装了 IService 和 BaseMapper，封装了全面完善的 CRUD 方法，因为我
mybatis-plus分页插件配置springboot
05-31
其中，pageNum 表示当前页码，pageSize 表示每页显示的数据条数，userMapper 是 Mybatis-Plus 自动生成的 Mapper 类。 以上就是 Mybatis-Plus 分页插件配置 Spring Boot 的简单步骤，希望能对你有所帮助。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值