新建SpringBoot项目并整合MyBatisPlus

之前写过一个傻瓜式的Spring Boot + Vue.js 前后端数据交互，但是后端创建部分的内容自己感觉不够清晰也有点过于繁琐，这里对那一部分内容做了简化，同时引入了CodeGenerater类，可以直接创建数据表对应的类

1. 在Idea上创建Spring项目

引入依赖，Spring Web, Lombok, Spring Boot DevTools, MySQL Driver.

删除多余的不需要的文件，然后再引入MyBatis-Plus（在pom.xml文件中引入以下代码)

<!--mp-->
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.2.0</version>
</dependency>
<!--MyBatis-Plus生成需要模板，freemarker引入模板-->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope>
</dependency>
<!--mp代码生成器-->
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-generator</artifactId><version>3.2.0</version>
</dependency>

用编写好的 application.yml 文件替换 application.properties，因为yml文件相对来说结构更清晰

server:port: 8888
spring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://localhost:3306/my_blog?useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=false&serverTimezone=GMT%2B8username: rootpassword: daydayup
# MyBatis-plus 扫描xml的位置
mybatis-plus:mapper-locations: classpath*:/mapper/**Mapper.xml

2. 创建数据库

创建SQL数据库

创建SQL数据表

3. 引入Mybatis-Plus工具

创建common文件夹(工具文件夹)，添加MybatisPlusConfig Java类

import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;@Configuration
@EnableTransactionManagement
@MapperScan("com.blog_example.my_blog.mapper")
public class MybatisPlusConfig {@Beanpublic PaginationInterceptor paginationInterceptor() {PaginationInterceptor paginationInterceptor = new PaginationInterceptor();return paginationInterceptor;}
}

添加Mybatis-Plus代码生成器(这是MyBatis-Plus官网的代码，可用于生成表对应的类):
CodeGenerator代码地址
我在这个的基础上做了一点小修改再标注了一下需要修改的地方:

public class CodeGenerator {/*** <p>* 读取控制台内容* </p>*/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);// gc.setSwagger2(true); 实体属性 Swagger2 注解mpg.setGlobalConfig(gc);// 数据源配置// !!! 这个地方数据库的url，driver类，用户名，密码需要与application.yml中的一致DataSourceConfig dsc = new DataSourceConfig();dsc.setUrl("jdbc:mysql://localhost:3306/my_blog?useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&useSSL=false&serverTimezone=GMT%2B8");// dsc.setSchemaName("public");dsc.setDriverName("com.mysql.cj.jdbc.Driver");dsc.setUsername("root");dsc.setPassword("daydayup");mpg.setDataSource(dsc);// 包配置// !!! setParent与文件目录一致PackageConfig pc = new PackageConfig();pc.setModuleName(null);pc.setParent("com.blog_example.my_blog");mpg.setPackageInfo(pc);// 自定义配置InjectionConfig cfg = new InjectionConfig() {@Overridepublic void initMap() {// to do nothing}};// 如果模板引擎是 freemarkerString templatePath = "/templates/mapper.xml.ftl";// 如果模板引擎是 velocity// String templatePath = "/templates/mapper.xml.vm";// 自定义输出配置List<FileOutConfig> focList = new ArrayList<>();// 自定义配置会被优先输出focList.add(new FileOutConfig(templatePath) {@Overridepublic String outputFile(TableInfo tableInfo) {// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;}});cfg.setFileOutConfigList(focList);mpg.setCfg(cfg);// 配置模板TemplateConfig templateConfig = new TemplateConfig();templateConfig.setXml(null);mpg.setTemplate(templateConfig);// 策略配置StrategyConfig strategy = new StrategyConfig();strategy.setNaming(NamingStrategy.underline_to_camel);strategy.setColumnNaming(NamingStrategy.underline_to_camel);strategy.setEntityLombokModel(true);strategy.setRestControllerStyle(true);strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));strategy.setControllerMappingHyphenStyle(true);strategy.setTablePrefix(pc.getModuleName() + "_");mpg.setStrategy(strategy);mpg.setTemplateEngine(new FreemarkerTemplateEngine());mpg.execute();}
}

运行CodeGenerator类并输入表名就可以创建对应的类

最后创建Result类，用于将相关参数返回给前端:

@Data
public class Result implements Serializable {private int code; //200是正常，非200是异常private String msg; //返回给前端的信息private Object data; //返回给前端的数据public static Result succ(int code, String msg, Object data) {Result r = new Result();r.setCode(code);r.setMsg(msg);r.setData(data);return r;}public static Result succ(Object data) {return succ(200, "操作成功", data);}public static Result fail(int code, String msg, Object data) {Result r = new Result();r.setCode(code);r.setMsg(msg);r.setData(data);return r;}public static Result fail(String msg, Object data) {return fail(400, msg, data);}public static Result fail(String msg) {return fail(400, msg, null);}
}

4.测试

在UserController类中，实体化Service类用于查询数据库结果，用Result类封装结果并返回到指定URL地址:

@RestController
@RequestMapping("/user")
public class UserController {@AutowiredIUserService userService;@GetMapping("/index")public Result index(){User user = userService.getById(1L);return Result.succ(200,"操作成功",user);}
}

查询到的结果- code: 200, msg: “操作成功”, data: {…}