1 mybatis-plus概述

1.1 官方地址
https://baomidou.com/
image.png

2 搭建mybatis-plus 环境

2.1 pom.xm导包

控制包版本

  1.     <properties>
  2.         <java.version>1.8</java.version>
  3.         <mybatis-plus-version>3.4.3.4</mybatis-plus-version>
  4.         <mybatis-plus-generator-version>3.5.1</mybatis-plus-generator-version>
  5.         <fastjson-version>1.2.47</fastjson-version>
  6.         <freemarker.version>2.3.28</freemarker.version>
  7.         <swagger2.version>2.9.2</swagger2.version>
  8.     </properties>

导入包

  1. <!--        mysql数据库驱动-->
  2.         <dependency>
  3.             <groupId>mysql</groupId>
  4.             <artifactId>mysql-connector-java</artifactId>
  5.             <scope>runtime</scope>
  6.         </dependency>
  7.         <!-- mybatis plus 代码生成器 -->
  8.         <dependency>
  9.             <groupId>com.baomidou</groupId>
  10.             <artifactId>mybatis-plus-generator</artifactId>
  11.             <version>${mybatis-plus-generator-version}</version>
  12.         </dependency>
  13. <!--        mybatis plus 依赖包-->
  14.         <dependency>
  15.             <groupId>com.baomidou</groupId>
  16.             <artifactId>mybatis-plus-boot-starter</artifactId>
  17.             <version>${mybatis-plus-version}</version>
  18.         </dependency>
  20. <!--        fastjson,阿里json包-->
  21.         <dependency>
  22.             <groupId>com.alibaba</groupId>
  23.             <artifactId>fastjson</artifactId>
  24.             <version>${fastjson-version}</version>
  25.         </dependency>
  27. <!--        freemarker模板引擎-->
  28.         <dependency>
  29.             <groupId>org.freemarker</groupId>
  30.             <artifactId>freemarker</artifactId>
  31.             <version>${freemarker.version}</version>
  32.         </dependency>
  34. <!--        swagger文档依赖包-->
  35.         <dependency>
  36.             <groupId>io.springfox</groupId>
  37.             <artifactId>springfox-swagger2</artifactId>
  38.             <version>${swagger2.version}</version>
  39.         </dependency>
  40.         <dependency>
  41.             <groupId>io.springfox</groupId>
  42.             <artifactId>springfox-swagger-ui</artifactId>
  43.             <version>${swagger2.version}</version>
  44.         </dependency>

2.2 新建application.yml，并且配置如下

  1. server:
  2.   port: 8081
  3.   servlet:
  4.     context-path: /
  6. spring:
  7.   datasource:
  8.     driver-class-name: com.mysql.cj.jdbc.Driver
  9.     url: jdbc:mysql://127.0.0.1:3306/cundao?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true
  10.     username: root
  11.     password: 123456
  12.   jackson:
  13.     date-format: yyyy-MM-dd HH:mm:ss
  14.     time-zone: GMT+8
  15.     serialization:
  16.       write-dates-as-timestamps: false
  18. mybatis-plus:
  19.   configuration:
  20.     map-underscore-to-camel-case: true
  21.     auto-mapping-behavior: full
  22.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  23.   mapper-locations: classpath*:mapper/**/*Mapper.xml
  24.   global-config:
  25.     # 逻辑删除配置
  26.     db-config:
  27.       # 删除前
  28.       logic-not-delete-value: 1
  29.       # 删除后
  30.       logic-delete-value: 0
  32. # 开发环境配置
  33. #Swagger 展示设置  生产环境关闭
  34. swagger:
  35.   enable: true
  36.   title: 后台管理 APIs
  37.   package: com.alpaak.hellospringboot.controller
  38.   version: 1.0.0

2.3 mybatisplus分页插件MybatisPlusConfig

  1. package com.alpaak.hellospringboot.config;
  3. import com.baomidou.mybatisplus.annotation.DbType;
  4. import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
  5. import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
  6. import org.mybatis.spring.annotation.MapperScan;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  10. //Spring boot方式
  11. @Configuration
  12. @MapperScan("com.alpaak.hellospringboot.mapper")
  13. public class MybatisPlusConfig {
  15.     // 旧版
  16. //    @Bean
  17. //    public PaginationInterceptor paginationInterceptor() {
  18. //        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
  19. //        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
  20. //        // paginationInterceptor.setOverflow(false);
  21. //        // 设置最大单页限制数量，默认 500 条，-1 不受限制
  22. //        // paginationInterceptor.setLimit(500);
  23. //        // 开启 count 的 join 优化,只针对部分 left join
  24. //        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
  25. //        return paginationInterceptor;
  26. //    }
  28.     // 最新版
  29.     @Bean
  30.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
  31.         MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
  32.         interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
  33.         return interceptor;
  34.     }
  36. }

2.4 mybatisplus自动生成代码MybatisGenerator.java

  1. package com.alpaak.hellospringboot;
  3. import com.baomidou.mybatisplus.generator.FastAutoGenerator;
  4. import com.baomidou.mybatisplus.generator.config.OutputFile;
  5. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  6. import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  8. import java.util.Collections;
  10. /**
  11.  * @Description: 类描述 代码生成器
  12.  * @author: alpaak
  13.  * @date: 2021/12/22 15:30
  14.  * @Since 1.0
  15.  */
  16. public class MybatisGenerator {
  17.     // 本地项目路径 - 要改
  18.     private final static String LOCAL_PATH = "D:\\3-study\\cundao\\hello-springboot";
  19.     // xml包路径
  20.     private final static String MAPPER_XML_PATH = "/src/main/resources/mapper";
  21.     // 包路径
  22.     private final static String PACKAGE_PATH = "/src/main/java";
  24.     //项目包路径
  25.     private final static String PACKAGE_NAME = "com.alpaak.hellospringboot";
  27.     //作者
  28.     private final static String AUTHOR = "alpaak";
  29.     //数据库
  30.     private final static String DATABASE = "cundao";
  31.     //服务器地址
  32.     private final static String DB_HOST = "127.0.0.1:3306";
  33.     //帐号
  34.     private final static String DB_USERNAME = "root";
  35.     //密码
  36.     private final static String DB_PASSWORD = "123456";
  38.     //数据库表 - 通过表成成代码 - 要改
  39.     private final static String[] TABLES = new String[]{
  40.             "user"
  41.     };
  42.     public static void main(String[] args) {
  43.         String dbUrl = "jdbc:mysql://" + DB_HOST + "/" + DATABASE + "?useUnicode=true&characterEncoding=utf8&autoReconnect=true&useSSL=false";
  44.         FastAutoGenerator.create(dbUrl,DB_USERNAME ,DB_PASSWORD)
  45.                 .globalConfig(builder -> {
  46.                     builder.author(AUTHOR) // 设置作者
  47.                             .enableSwagger() // 开启 swagger 模式
  48.                             .fileOverride() // 覆盖已生成文件
  49.                             .outputDir(LOCAL_PATH + PACKAGE_PATH); // 指定输出目录
  50.                 })
  51.                 .packageConfig(builder -> {
  52.                     builder.parent(PACKAGE_NAME) // 设置父包名
  53.                             .moduleName("") // 设置父包模块名
  54.                             .pathInfo(Collections.singletonMap(OutputFile.mapperXml, LOCAL_PATH + MAPPER_XML_PATH)); // 设置mapperXml生成路径
  55.                 })
  56.                 .strategyConfig(builder -> {
  57.                     builder.addInclude(TABLES); // 设置需要生成的表名
  58. //                            .addTablePrefix("t_", "c_"); // 设置过滤表前缀
  59.                 })
  60.                 .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
  61.                 .execute();
  63.     }
  64. }

2.5 测试MybatisGenerator功能

2.5.1 自动生成controller、service、impl、entity、mapper接口、mapper的xml

image.png

2.5.2 类结构

image.png

2.5.3 service接口结构

image.png

2.5.4 service实现类结构

通过官网，可以看到此结构为我们提供了30多个已经实现的方法，任君享用
image.png

2.5.5 mapper接口结构

通过官网，可以看到此结构为我们提供了10多个已经实现的方法，任君享用
image.png

空的UserMapper.xml，提供用户自定义查询
image.png

3 controller接口开发

  1. package com.alpaak.hellospringboot.controller;
  4. import com.alpaak.hellospringboot.entity.User;
  5. import com.alpaak.hellospringboot.modle.qo.CommonQo;
  6. import com.alpaak.hellospringboot.service.IUserService;
  7. import com.baomidou.mybatisplus.core.metadata.IPage;
  8. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  9. import io.swagger.annotations.Api;
  10. import io.swagger.annotations.ApiOperation;
  11. import org.springframework.beans.factory.annotation.Autowired;
  12. import org.springframework.web.bind.annotation.*;
  14. /**
  15.  * <p>
  16.  * 前端控制器
  17.  * </p>
  18.  *
  19.  * @author alpaak
  20.  * @since 2021-12-22
  21.  */
  22. @Api(tags = "用户接口")
  23. @RestController
  24. @RequestMapping("/user")
  25. public class UserController {
  26.     @Autowired
  27.     private IUserService userService;
  29.     @ApiOperation(value = "根据用户id获得用户", notes = "")
  30.     @GetMapping("/getUser")
  31.     public User getUser(Integer id) {
  32.         return userService.getById(id);
  33.     }
  35.     @ApiOperation(value = "分页查询用户", notes = "")
  36.     @GetMapping("/getUserPage")
  37.     public IPage<User> getUserPage(CommonQo qo) {
  38. //        第几页
  39.         int current = qo.getCurrent();
  40. //        当前面
  41.         int size = qo.getSize();
  42.         Page<User> page = new Page<>(current, size);
  43.         return userService.page(page);
  44.     }
  46.     @ApiOperation(value = "保存用户", notes = "")
  47.     @PostMapping("/addUser")
  48.     public String addUser(@RequestBody User user) {
  49.         boolean count = userService.saveOrUpdate(user);
  50.         if (count) {
  51.             return "保存成功";
  52.         } else {
  53.             return "保存失败";
  54.         }
  55.     }
  57.     @ApiOperation(value = "删除用户", notes = "")
  58.     @PostMapping("/delUser")
  59.     public String delUser(Integer id) {
  60.         boolean count = userService.removeById(id);
  61.         if (count) {
  62.             return "删除成功";
  63.         } else {
  64.             return "删除失败";
  65.         }
  66.     }
  67. }

4 运行程序，用swagger测试

4.1 运行main程序

image.png
运行成功日志如下
image.png

4.2 运行swagger

4.2.1 打开swagger

浏览器中黏贴：http://127.0.0.1:8081/swagger-ui.html#/
运行如下：
image.png

4.2.2 使用swagger测试接口

image.png

4.2.3 返回结果：

image.png

4.2.4 swagger的好处

  1. 号称世界上最流行的API框架
  2. RestFul API文档在线生成工具—->>>API文档与API同步更新
  3. 可以直接运行,可以在线测试API接口
  4. 实体对象属性明了

image.png

5 项目源码地址

https://gitee.com/alpaak/hello-springboot.git

使用gitbash命令下载：
git clone https://gitee.com/alpaak/hello-springboot.git