欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页  >  IT编程

springBoot+MybatisPlus 整合及API简单优化实现

程序员文章站 2022-06-19 14:38:14
这里写自定义目录标题SpringBoot+MybatisPlus整合API返回类型简单优化SpringBoot+MybatisPlus整合首先idea生成搭建普通的springboot项目，配置自己需要的包，下面是我的pom文件 供参考。话不多说直接上代码先看一下整体目录结构下面是代码pom.xml

这里写自定义目录标题

SpringBoot+MybatisPlus整合

首先idea生成搭建普通的springboot项目，配置自己需要的包，下面是我的pom文件 供参考。话不多说直接上代码
先看一下整体目录结构
springBoot+MybatisPlus 整合及API简单优化实现
下面是代码
pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.2.12.BUILD-SNAPSHOT</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.springBoot</groupId>
	<artifactId>SpringBootTest</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>SpringBootTest</name>
	<description>Demo project for Spring Boot</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-data-jdbc</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-thymeleaf</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>
		<!-- https://mvnrepository.com/artifact/com.baomidou/mybatisplus-spring-boot-starter -->
		<!-- mybatis plus 代码生成器 -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>3.2.0</version>
		</dependency>
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-generator</artifactId>
			<version>3.3.2</version>
		</dependency>
		<dependency>
			<groupId>org.freemarker</groupId>
			<artifactId>freemarker</artifactId>
			<version>2.3.28</version>
		</dependency>
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>1.2.47</version>
		</dependency>

		<!-- 修改文件热加载-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-devtools</artifactId>
			<scope>runtime</scope>
			<optional>true</optional>
		</dependency>

		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<optional>true</optional>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

	<repositories>
		<repository>
			<id>spring-milestones</id>
			<name>Spring Milestones</name>
			<url>https://repo.spring.io/milestone</url>
		</repository>
		<repository>
			<id>spring-snapshots</id>
			<name>Spring Snapshots</name>
			<url>https://repo.spring.io/snapshot</url>
			<snapshots>
				<enabled>true</enabled>
			</snapshots>
		</repository>
	</repositories>
	<pluginRepositories>
		<pluginRepository>
			<id>spring-milestones</id>
			<name>Spring Milestones</name>
			<url>https://repo.spring.io/milestone</url>
		</pluginRepository>
		<pluginRepository>
			<id>spring-snapshots</id>
			<name>Spring Snapshots</name>
			<url>https://repo.spring.io/snapshot</url>
			<snapshots>
				<enabled>true</enabled>
			</snapshots>
		</pluginRepository>
	</pluginRepositories>

</project>

application.properties 文件(也可用yml文件 都一样)

server.port=8081
#数据库配置
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url= jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
#设置开启热部署
spring.devtools.restart.enabled=true 
#重启目录
spring.devtools.restart.additional-paths= src/main/java  
spring.devtools.restart.exclude= WEB-INF/** 
#MybatisPlus配置
mybatis-plus.configuration.map-underscore-to-camel-case=true
mybatis-plus.configuration.auto-mapping-behavior=full
mybatis-plus.configuration.log-impl= org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus.mapper-locations=classpath*:mapper/*Mapper.xml
# 逻辑删除配置
# 删除前
mybatis-plus.global-config.db-config.logic-delete-value=1
# 删除后
mybatis-plus.global-config.db-config.logic-not-delete-value=0

首先数据库创建一张表

CREATE TABLE `mybatis_plus_user` (
  `id` int(20) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) DEFAULT NULL,
  `address` varchar(255) DEFAULT NULL,
  `brithday` varchar(255) DEFAULT NULL,
  `sex` varchar(255) DEFAULT NULL,
  `deleted` int(2) DEFAULT NULL,
  `CREATE_TIME` datetime DEFAULT NULL,
  `UPDATE_TIME` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

MybatisPlus代码生成工具

package com.springBoot.SpringBootTest.util;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.Scanner;

/**
 * 自动生成mybatisplus的相关代码
 */
public class GeneratorCodeConfig {

    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("test"); //作者名称
        gc.setOpen(false);
        //实体属性 Swagger2 注解
        gc.setSwagger2(false);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
//        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.springBoot");
        pc.setEntity("SpringBootTest.entity");
        pc.setMapper("SpringBootTest.mapper");
        pc.setService("SpringBootTest.service");
        pc.setServiceImpl("SpringBootTest.service.impl");
        pc.setController("SpringBootTest.controller");
        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("调用默认方法创建的目录");
                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.baomidou.mybatisplus.extension.activerecord.Model");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);

        strategy.setEntityLombokModel(true);
        // 公共父类
//        strategy.setSuperControllerClass("com.baomidou.ant.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();
    }
}

这样我们就生成了简单的项目代码，生成代码之后我们发现properties文件和生成的实体bean中存在 deleted、createTime、updataTime几个字段。这里简单介绍写下mybatisPlus的自动填充、物理和逻辑删除。

  1. 自动填充
    实际开发中会都会有创建时间、更新时间两个字段同时这两个字段操作都是需要自动化的。下面我们看一下mybatisPlus中是怎么做的。

实体类中字段属性需要加上注解 springBoot+MybatisPlus 整合及API简单优化实现
处理器中添加即可
springBoot+MybatisPlus 整合及API简单优化实现
这里我们把deleted也设置了删除标记自动化，值对应在properties文件中的配置的值

下面我们做下简单测试

package com.springBoot.SpringBootTest.controller;


import com.springBoot.SpringBootTest.entity.MybatisPlusUser;
import com.springBoot.SpringBootTest.entity.ResponseResult;
import com.springBoot.SpringBootTest.service.IMybatisPlusUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author 
 * @since 2020-12-29
 */
@RestController
@RequestMapping("/mybatis-plus-user")
@ResponseResult
public class MybatisPlusUserController {

    @Autowired
    private IMybatisPlusUserService mybatisPlusUserService;
    
    @RequestMapping(value = "/getUser")
    public MybatisPlusUser getUser(){
        MybatisPlusUser mybatisPlusUser = new MybatisPlusUser();
        mybatisPlusUser.setAddress("北京市");
        mybatisPlusUser.setBrithday("2020-12-12");
        mybatisPlusUser.setName("张三");
        mybatisPlusUser.setSex("男");
        mybatisPlusUserService.save(mybatisPlusUser);
        return mybatisPlusUserService.getById(1);
    }
}

访问http://localhost:8001/mybatis-plus-user/getUser
springBoot+MybatisPlus 整合及API简单优化实现
mybatisPlus其他使用方法以后有时间更新学习

API返回类型简单优化

我们在定义api返回类型时候，会返回一个状态码 一个提示信息 还有业务数据。但有时候需要增加状态码 或者只需要 业务数据信息 不需要其他的，这个时候总是改代码就比较麻烦。在这里就简单一个优化思路供大家参考，希望不足与冲突之后 欢迎指正！
做之前需要关注**@ControllerAdvice、ResponseBodyAdvice** 类和注解 用来统一处理返回值/响应体

  1. 定义一个标记 区别方法返回值是否需要包装
    springBoot+MybatisPlus 整合及API简单优化实现
  2. 封装改造一个拦截器，判断返回值是否需要包装
    springBoot+MybatisPlus 整合及API简单优化实现
  3. 重写返回数据以及出现异常时候的处理
    springBoot+MybatisPlus 整合及API简单优化实现
  4. 在需要的Controller上面加上注解即可
    springBoot+MybatisPlus 整合及API简单优化实现

欢迎指正！！！

本文地址：https://blog.csdn.net/weixin_39413375/article/details/111993364

相关标签： 开发软件 java spring boot spring

上一篇： M21F4 视频数据采集终端的技术应用

下一篇： XML轻松学习手册(五):XML语法

推荐阅读