Mybatis-Plus的使用方法(一) 安装和使用代码生成

最新推荐文章于 2024-02-26 16:56:15 发布
最新推荐文章于 2024-02-26 16:56:15 发布
阅读量1.2k 收藏 1
点赞数
分类专栏： java 文章标签： mybatis-plus java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41354631/article/details/90258699
版权

问题引发:

       我们在做后台管理系统时,是否经常会遇到这样的问题:这么多的模块....真的多吗?很多的模块下边基本都是一些简单的对于单表的增删改查,呢这些重复的工作我们是否需要继续写呢,每次当我们做一个后台管理系统时,相对于单表的CURD都是一直写mapper层,service层,controller层? NO,这样会浪费我们的开发时间,非常的浪费.好在互联网上有很多的好心人,将这些繁琐的事情封装了起来,请看Mybatis-Plus

解决问题:

Mybatis-Plus 官方简介

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

愿景

我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

#特性

  • 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
  • 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
  • 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
  • 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
  • 支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库
  • 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
  • 支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动
  • 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
  • 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
  • 支持关键词自动转义：支持数据库关键词（order、key......）自动转义，还可自定义关键词
  • 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
  • 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
  • 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
  • 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
  • 内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

#框架结构

framework

使用:

本章节只说代码生成器的使用:

1 创建springboot项目(略):

2 添加maven依赖:

<!--MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.1.1</version>
</dependency>

<!-- 添加 模板引擎 依赖，MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎-->
<!--Velocity（默认） -->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.1</version>
</dependency>

这里我们使用默认的配置,如果需要使用其他配置,请自行查看.

编码配置 :

  这一点说实话有点不爽,代码生成的配置是在java代码中写的,官方也没有看见xml配置之类的,没有办法,为了自己方便,只好将配置封装一下,只需要修改配置就可以了,这样的话,扩展性可能会有些差,一些配置写死了基本上就必须是这样的了,如果需要自行扩展的话,可以自己去扩展,

配置常量定义类:

package com.learn;

/**
 * @author ##
 * @Description 代码生成相关常量
 * @Date19-5-15 下午5:26
 * @Version V1.0
 **/
public interface GeneratorConstants {

    /**
     * 是否支持AR模式,这个配置需要自行百度
     */
    final String ACTIVE_RECORD = "ACTIVE_RECORD";

    /**
     * 作者信息
     */
    final String AUTHOR = "AUTHOR";
    /**
     * 生成文件目录
     */
    final String OUTPUT_DIR = "OUTPUT_DIR";

    /**
     * 文件是否覆盖 默认值false
     */
    final String FILE_OVEERRIDE = "FILE_OVEERRIDE";

    /**
     * 开启swagger2 模式
     *
     */
    final String SWAGGER2 = "SWAGGER2";
    /**
     * 是否打开输出目录 默认值true
     */
    final String ISOPEN = "ISOPEN";

    /**
     * 主键策略
     */
    final String ID_TYPE = "ID_TYPE";

    /**
     * 设置生成的service接口
     */
    final String SERVICE_NAME = "SERVICE_NAME";

    /**
     * 设置是否生成基本的ResultMap
     */
    final String BASE_RESULT_MAP = "BASE_RESULT_MAP";

    /**
     * 设置是否生成基本的SQL片段
     */
    final String BASE_COLUMN_LSIT = "BASE_COLUMN_LSIT";


    /**
     * 设置数据库类型
     */
    final String DB_TYPE = "DB_TYPE";

    /**
     * 驱动类名
     */
    final String DB_DRIVER_NAME = "DB_DRIVER_NAME";
    /**
     * db url
     */
    final String DB_URL = "DB_URL";
    /**
     * db username
     */
    final String DB_USERNAME = "DB_USERNAME";
    /**
     * db password
     */
    final String DB_PASSWORD = "DB_PASSWORD";

    /**
     * 全局大写命名
     */
    final String CAPITALMODE = "CAPITALMODE";
    /**
     * 是否支持lombok
     */
    final String LOMBOK = "LOMBOK";

    /**
     *  数据库表映射到实体的命名策略
     */
    final String NAMING = "NAMING";

    /**
     * 生成的表
     */
    final String INCLUDE = "INCLUDE";

    /**
     * 父包名称
     */
    final String PACKAGE_PARENT="PACKAGE_PARENT";

    /**
     * mapper层包名
     */
    final String PACKAGE_MAPPER="PACKAGE_MAPPER";
    /**
     * service 包名
     */
    final String PACKAGE_SERVICE="PACKAGE_SERVICE";
    /**
     * controller 包名
     */
    final String PACKAGE_CONTROLLER="PACKAGE_CONTROLLER";
    /**
     * 实体bean 包名
     */
    final String PACKAGE_ENTITY="PACKAGE_ENTITY";
    /**
     * xml 后缀
     */
    final String PACKAGE_MAPPERXML="PACKAGE_MAPPERXML";

}

在resource 目录下新建一个generator.properties

#是否支持AR模式
ACTIVE_RECORD=true
#作者信息
AUTHOR=##
#生成文件目录
OUTPUT_DIR=/opt/export/data/logdemo/learning-mybatis-plus/src/main/java
#文件是否覆盖默认值false
FILE_OVEERRIDE=true
#开启swagger2模式
SWAGGER2=false
#是否打开输出目录默认值true
ISOPEN=false
#主键策略
#    AUTO(0),
#    NONE(1),
#    INPUT(2),
#    ID_WORKER(3),
#    UUID(4),
#    ID_WORKER_STR(5);
ID_TYPE=AUTO
#设置生成的service接口
SERVICE_NAME=%sService
#设置lombok
LOMBOK=true
#设置是否生成基本的ResultMap
BASE_RESULT_MAP=true
#设置是否生成基本的SQL片段
BASE_COLUMN_LSIT=true
#设置数据库类型
DB_TYPE=MYSQL
#驱动类名
DB_DRIVER_NAME=com.mysql.cj.jdbc.Driver
#dburl
DB_URL=jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf8&serverTimezone=CTT
#dbusername
DB_USERNAME=root
#dbpassword
DB_PASSWORD=root
#全局大写命名
CAPITALMODE=true
#数据库表映射到实体的命名策略 详情看NamingStrategy
NAMING=underline_to_camel
#生成的表
INCLUDE=user
#父包名称
PACKAGE_PARENT=com.learn
#mapper层包名
PACKAGE_MAPPER=mapper
#service包名
PACKAGE_SERVICE=service
#controller包名
PACKAGE_CONTROLLER=controller
#实体bean包名
PACKAGE_ENTITY=bean
#xml后缀
PACKAGE_MAPPERXML=mapper

提供一个解析properties的工具类

 private static final Logger logger = LoggerFactory.getLogger(PropertiesUtil.class);

    private static Properties prop = new Properties();

    static {
        InputStream in = PropertiesUtil.class.getClassLoader().getResourceAsStream("generator.properties");
        try {

            prop.load(new InputStreamReader(in, "utf-8"));
        } catch (Exception e) {
            logger.error("读取 properties出错:" + e);
        }
    }

    /**
     * 获取String 参数
     */
    public static String getProperty(String key) {

        try {
            String value = prop.getProperty(key);
            return value;
        } catch (Exception e) {
            logger.error("获取" + key + "的value出错" + e);
            return null;
        }

    }

    /**
     * 获取数组参数
     *
     * @param key
     * @return
     */
    public static String[] getStringArrProperties(String key) {
        try {

            String value = prop.getProperty(key);
            String[] split = value.split(",");
            if (split.length >=1){
                return split;

            }else {
                throw new RuntimeException("表配置不可为空,请检查include配置");
            }


        } catch (Exception e) {
            logger.error("获取" + key + "的value出错" + e);
            return null;
        }
    }


    /**
     * 获取数组参数
     *
     * @param key
     * @return
     */
    public static Boolean getBooleanValue(String key) {
        try {
            String result = prop.getProperty(key);
            return Boolean.parseBoolean(result);
        } catch (Exception e) {
            logger.error("获取" + key + "的value出错" + e);
            return null;
        }
    }



    /**
     * 获取枚举类型参数
     */
    public    T   getENUMValue(String key,Class clazz) {
        try {
            String result = prop.getProperty(key);

            T t = (T) Enum.valueOf(clazz, result);
            return t;

        } catch (Exception e) {
            logger.error("获取" + key + "的value出错" + e);
            return null;
        }
    }

代码生成的配置:

public static void main(String[] args) {

        //========全局配置===========
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setActiveRecord(PropertiesUtil.getBooleanValue(GeneratorConstants.ACTIVE_RECORD))

                .setAuthor(PropertiesUtil.getProperty(GeneratorConstants.AUTHOR))

                .setOutputDir(PropertiesUtil.getProperty(GeneratorConstants.OUTPUT_DIR))

                .setFileOverride(PropertiesUtil.getBooleanValue(GeneratorConstants.FILE_OVEERRIDE))

                .setIdType(new PropertiesUtil<IdType>().getENUMValue(GeneratorConstants.ID_TYPE, IdType.class))

                .setServiceName(PropertiesUtil.getProperty(GeneratorConstants.SERVICE_NAME))

                .setBaseResultMap(PropertiesUtil.getBooleanValue(GeneratorConstants.BASE_RESULT_MAP))

                .setBaseColumnList(PropertiesUtil.getBooleanValue(GeneratorConstants.BASE_COLUMN_LSIT));

        //========数据源配置===========
        DataSourceConfig dataSourceConfig = new DataSourceConfig();

        dataSourceConfig.setDbType(new PropertiesUtil<DbType>().getENUMValue(GeneratorConstants.DB_TYPE, DbType.class))

                .setDriverName(PropertiesUtil.getProperty(GeneratorConstants.DB_DRIVER_NAME))

                .setUrl(PropertiesUtil.getProperty(GeneratorConstants.DB_URL))

                .setUsername(PropertiesUtil.getProperty(GeneratorConstants.DB_USERNAME))

                .setPassword(PropertiesUtil.getProperty(GeneratorConstants.DB_PASSWORD));


        StrategyConfig strategyConfig = new StrategyConfig();

        String[] tableNames = PropertiesUtil.getStringArrProperties(GeneratorConstants.INCLUDE);

        strategyConfig.setCapitalMode(PropertiesUtil.getBooleanValue(GeneratorConstants.CAPITALMODE))

                .setNaming(new PropertiesUtil<NamingStrategy>().getENUMValue(GeneratorConstants.NAMING, NamingStrategy.class))

                .setEntityLombokModel(PropertiesUtil.getBooleanValue(GeneratorConstants.LOMBOK))

                .setInclude(tableNames);


        //========包配置===========
        PackageConfig packageConfig = new PackageConfig();
        packageConfig
                .setParent(PropertiesUtil.getProperty(GeneratorConstants.PACKAGE_PARENT))
                .setMapper(PropertiesUtil.getProperty(GeneratorConstants.PACKAGE_MAPPER))
                .setService(PropertiesUtil.getProperty(GeneratorConstants.PACKAGE_SERVICE))
                .setController(PropertiesUtil.getProperty(GeneratorConstants.PACKAGE_CONTROLLER))
                .setEntity(PropertiesUtil.getProperty(GeneratorConstants.PACKAGE_ENTITY))
                .setXml(PropertiesUtil.getProperty(GeneratorConstants.PACKAGE_MAPPERXML));


        //========自动生成配置,将之前的配置全部加入===========
        AutoGenerator autoGenerator = new AutoGenerator();


        autoGenerator.setGlobalConfig(globalConfig)
                .setDataSource(dataSourceConfig)
                .setStrategy(strategyConfig)
                .setPackageInfo(packageConfig);
        autoGenerator.execute();
    }

生成完成:

controller需要我们自己写,service 和Mapper 以及Bean都是现成的,

附录:

官方文档地址说明:

https://mp.baomidou.com/guide/#%E7%89%B9%E6%80%A7

正在打杂的Java小白
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis-plus 达梦 代码生成
06-10
提供修改数据库地址后可直接使用的代码，提供达梦7的驱动包 提供所需maven以来 驱动包放置仓库位置等
（二）Mybatis-Plus的安装配置
一只蚊子学Java
09-25 2249
上一篇文章我们认识了Mybatis-Plus，这篇文章我们一起学习Mybatis-Plus在项目中怎么使用。 项目结构如下： src ├─main │ ├─java │ │ └─com │ │ └─example │ │ └─mybatisplus │ │ └─config │ ...
MyBatisPlus入门详细教程
一步一个脚印，踏实努力，向着目标前进
06-05 614
MyBatisPlus是MyBatis的增强工具，提供了很多便捷的功能，例如自动生成代码、分页查询、乐观锁、逻辑删除等。
MyBatis-Plus使用
最新发布
2301_79957017的博客
02-26 1080
mybatis—plus
orm框架 MyBatis-Plus（Spring boot + Gradle）安装与入门【2022年】
与恶龙缠斗良久终成恶龙
03-04 4368
orm 框架Mybatis-plus入门学习记录
【后端】MyBatis-Plus 体系（二）
柠檬小帽的博客 - 计算机全栈体系
03-04 1220
常用注解
MyBatis-Plus 笔记
Cybenko
06-17 3938
目录 一、MyBatis-Plus 1、简介 2、使用 SpringBoot 快速使用 MyBatis-Plus 二、Mybatis-Plus 常用操作 1、配置日志 2、简单认识一下常用注解 3、代码生成器 4、自动填充数据功能 5、逻辑删除 6、分页插件的使用 7、乐观锁的实现 三、Mybatis-Plus CRUD 操作简单了解一下 1、Mapper 接口方法（CRUD）简单了解一下 2、Service 接口方法（CRUD）简单了解一下 3、条件构造器（Wrapper，定
mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip
07-20
mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip mybatis-plus最新代码生成器项目源码 ：mybatis-plus-generator.zip ...
mybatis-plus快速逆向生成代码
03-07
0.解压后查看说明文档。 1.pom.xml中增加对应引入包 2.复制FastAutoGeneratorTest.java到自己的项目中 然后更改引入包路径 3.更改数据库源 4.更改生成代码路径 5.执行main方法
mybatis-plus-generator-ui:对mybatis-plus-generator进行封装，通过Web UI快速生成兼容的Spring boot，mybatis-plus框架的各类业务代码
03-20
提供一致的Web UI用于生成兼容mybatis-plus框架的相关功能代码，包括Entity，Mapper，Mapper.xml，Service，Controller等，可以自定义模板以及各种输出参数，也可以通过SQL查询语句直接生成代码。 使用方法 ♡maven...
MyBatis-Plus入门+MyBatis-Plus文档手册 中文pdf高清版.rar
11-09
mybatis在持久层框架中还是比较火的，一般项目都是基于ssm。虽然mybatis可以直接在xml中...《MyBatis-Plus入门文档》主要介绍了MyBatis-Plus入门使用，以及关于mybatis-plus的更多介绍及特性，感兴趣的可以下载学习一下
eclipse插件mybatis逆向生成插件MyBatis Generator
10-24
myeclipse或eclipse mybatis逆向生成插件 MyBatis Generator
MyBatis Plus详细教程
热门推荐
code_xiaotian的博客
04-15 13万+
详细介绍了mybatisplus的各个功能，简单又好用！
Mybatis-Plus入门教程详解
qq_44723773的博客
07-07 3536
官网地址：https://baomidou.com下面介绍Lombok常用的几个注解： @Getter / @Setter@ToString@EqualsAndHashCode@NoArgsConstructor @RequiredArgsConstructor @AllArgsConstructor@Data 2.4 Mybatis-Plus中的条件构造器 QueryWrapper中重要方法总结如下：有以下场景： 三、代码生成器（旧） 在pom.xml文件中加入以下依赖 CodeGenarator代码..
Mybatis-Plus学习
Crush_zyf的博客
09-16 920
MyBatisPlus概述 为什么要学习它呢？MyBatisPlus可以节省我们大量工作时间，所有的CRUD代码它都可以自动化完成！ JPA 、 tk-mapper、MyBatisPlus 简介 MyBatis 本来就是简化 JDBC 操作的！ 官网.，MybatisPlus，简化 MyBatis ！ 特性 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作， BaseMapper 强大的 CRUD
Mybatis-plus (教程来自尚硅谷视频)
weixin_46033096的博客
06-02 1535
该篇的内容来自尚硅谷的视频，有个人理解在内并无完全跟尚硅谷相同
同事问我飞速代码背后的秘密，我望着他笑着拿出了MybatisPlus~
wdj_yyds的博客
05-14 1902
1. Mybatis 存在的痛点 我们知道 MyBatis 是一个基于 java 的持久层框架，它内部封装了 jdbc，极大提高了我们的开发效率。 但是使用 Mybatis 开发也有很多痛点： 每个 Dao 接口都需要自己定义一堆增删改查方法。 /** * @Desc: UserDao 接口 * @Author: 公众号：知否技术 * @date: 下午7:43 2022/5/7 */ public interface UserDao { // 获取所有用户信息 List..
MyBatis-plus在eclipse中的使用详解
weixin_36708538的博客
11-26 1万+
MyBatis-plus在eclipse中的使用详解
mybatis_plus使用教程
拱白菜的猪的博客
07-09 3987
mybatis_plus是mybatis的升级版，类似于JPA，可以很方便很高效的完成日常开发。为简化开发提高效率而生。 官网：https://mp.baomidou.com/ 一. MP的简单搭建 1. 引入依赖：基于springboot <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter&l..
使用mybatis-plus-generator进行代码自动生成的方法
09-01
可以使用 MyBatis-Plus 提供的启动类 `MybatisPlusGenerator` 或者使用 maven 插件 `mybatis-plus-generator-maven-plugin` 来执行代码生成。 5. 在生成的代码中会包含基本的 CRUD 操作方法，例如插入、更新、查询...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值