mybatis-plus 简介、安装、配置（1）【just Like】

目录

#特性

#框架结构

#安装

#配置

#代码生成器

#添加依赖

#切换模板引擎

#自定义模板引擎

---

(下一篇) 16 条 yyds 的代码规范

40 个 SpringBoot 常用注解

---

 

MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架。MyBatis 避免了几乎所有的 JDBC 代码和手工设置参数以及抽取结果集。MyBatis 使用简单的 XML 或注解来配置和映射基本体，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。而MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。   

---

#特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

• 损耗小：启动即会自动注入基本 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 注入攻击

---

#框架结构

#安装

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

• JDK 8+

• Maven or Gradle

• JDK7 以及下的请参考 MP2.0 版本，地址：2.0 文档

  #Release

  #Spring Boot

• Maven：

  
      com.baomidou
      mybatis-plus-boot-starter
      starter-latest-version
  

  Gradle：

  compile group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: 'starter-latest-version'

• #Spring MVC

  Maven:

  
      com.baomidou
      mybatis-plus
      latest-version
  

  Gradle：

• ​compile group: 'com.baomidou', name: 'mybatis-plus', version: 'latest-version'

  WARNING

  引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题。

#配置

Spring Boot 工程：

• 配置 MapperScan 注解

• @SpringBootApplication
  @MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
  public class Application {
  
      public static void main(String[] args) {
          SpringApplication.run(QuickStartApplication.class, args);
      }
  
  }

  Spring MVC 工程：

• 配置 MapperScan

• 调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory

• 通常来说，一般的简单工程，通过以上配置即可正常使用 MyBatis-Plus，具体可参考以下项目：Spring Boot 快速启动示例、Spring MVC 快速启动示例。

  同时 MyBatis-Plus 提供了大量的个性化配置来满足不同复杂度的工程，大家可根据自己的项目按需取用，详细配置请参考配置一文

  #代码生成器

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

• // 演示例子，执行 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();
          String projectPath = System.getProperty("user.dir");
          gc.setOutputDir(projectPath + "/src/main/java");
          gc.setAuthor("jobob");
          gc.setOpen(false);
          mpg.setGlobalConfig(gc);
  
          // 数据源配置
          DataSourceConfig dsc = new DataSourceConfig();
          dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
          // dsc.setSchemaName("public");
          dsc.setDriverName("com.mysql.jdbc.Driver");
          dsc.setUsername("root");
          dsc.setPassword("密码");
          mpg.setDataSource(dsc);
  
          // 包配置
          PackageConfig pc = new PackageConfig();
          pc.setModuleName(scanner("模块名"));
          pc.setParent("com.baomidou.ant");
          mpg.setPackageInfo(pc);
  
          // 自定义配置
          InjectionConfig cfg = new InjectionConfig() {
              @Override
              public void initMap() {
                  // to do nothing
              }
          };
          List focList = new ArrayList<>();
          focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
              @Override
              public String outputFile(TableInfo tableInfo) {
                  // 自定义输入文件名称
                  return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                          + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
              }
          });
          cfg.setFileOutConfigList(focList);
          mpg.setCfg(cfg);
          mpg.setTemplate(new TemplateConfig().setXml(null));
  
          // 策略配置
          StrategyConfig strategy = new StrategyConfig();
          strategy.setNaming(NamingStrategy.underline_to_camel);
          strategy.setColumnNaming(NamingStrategy.underline_to_camel);
          strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
          strategy.setEntityLombokModel(true);
          strategy.setRestControllerStyle(true);
          strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
          strategy.setInclude(scanner("表名"));
          strategy.setSuperEntityColumns("id");
          strategy.setControllerMappingHyphenStyle(true);
          strategy.setTablePrefix(pc.getModuleName() + "_");
          mpg.setStrategy(strategy);
          mpg.setTemplateEngine(new FreemarkerTemplateEngine());
          mpg.execute();
      }
  
  }

• #添加依赖

• MP 3.0.3 之后移除了自动模板引擎依赖，需要手动添加对应引擎的依赖坐标如下：

• 
  
      org.apache.velocity
      velocity-engine-core
      最新版本
  
  
  
  
      org.freemarker
      freemarker
      最新版本
  
  

  #切换模板引擎

• // 切换为 freemarker 模板引擎
  mpg.setTemplateEngine(new FreemarkerTemplateEngine());

  #自定义模板引擎

  请继承类↓

  com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine

• 关于扩展和核心功能可登陆 MyBatis-Plus 或 期待下次为您解析，有问题可留言，感谢关注。

• 推荐一个优秀开源框架：iBase4J ，希望开源帮助大家提升，嗨，朋友，任重道远！祝你成功！

 

 

 五年从程序员到架构师！这是我见过史上最好的程序员职业规划

(下一篇) 16 条 yyds 的代码规范

40 个 SpringBoot 常用注解

别慌，在Java面试的时候，面试官会这样问关于框架的问题？

想要实时关注更多干货好文，扫描下图关注或微信搜索【万言尽书上】关注公众公众号：