熟悉语言和开发工具上基础快速使用框架构建应用是个机械工作，5分钟完成开发准备工作，没有冗余动作。
目录
准备工作
后端开发需要数据持久化，数据库使用mysql，这也是生产环境大部分的选择，本地开发如果没有mysql可以直接在idea上创建h2数据库，具体创建方式可以参考：使用IDEA创建H2数据库_断浮的博客-CSDN博客_idea配置h2数据库
开发框架搭建
spring初始化
https://start.spring.com 这个地址实际中不快，改用https://start.aliyun.com ，选择它好处是：依赖选择时分类，非常的详细，而且生成的maven-pom文件有版本管理（基于统一的spring-boot版本号基础上扩展其他依赖包），不然需要自己分类管理，并且生成的项目中yaml有注释。
常规依赖
往下走选择这几个组件，作用分别是：
spring web，最主要的依赖，基于spring的web后端开发所有包都会自动引用
mysql driver 是mysql驱动，如果没有本地mysql，可以使用h2，idea可以创建h2
spring configuration-processor 依赖写配置文件会有提示；
lombok 完成自动getter setter 还有hashcode等类处理功能；
spring-boot-devtools 能提供热部署能力；
mybatis-plus 完成dao层处理，在mybatis基础上优化，极大简化数据库操作；
freemarker模板引擎用于mybaits-plus自动代码生成器，默认是velocity
security用于登录相关用户验证和鉴权；
Fastjson和commons lang进行是基本的处理包；
其他依赖
在此基础上增加其他依赖的准则是提高开发效率，让工具更加趁手，根据开发经验最好集成以下几个辅助工具：
swagger2和swagger-ui，两个都必须加，用户接口的梳理和规范化；
swagger-boostrap-ui，一个国产的api管理工具，界面更友好；
mybatis-plus-join，mybatis plus的一个多表关联插件，在写多表查询很简单；
mybatis-plus-generator，mybatis-plus的代码生成器；
mybatis-plus-extension，mybatis的分页扩展；
因为我们上面选择的spring-boot的2.3.7，其他依赖是我们手动要增加的，直接在pom中增加：
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>com.github.yulichang</groupId>
<artifactId>mybatis-plus-join</artifactId>
<version>1.2.2</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.5</version>
</dependency>
<!--velocity模板引擎-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-extension</artifactId>
<version>3.4.2</version>
</dependency>到此为止，直接在主类DemoApplication.class上ctrl+shift+F10就可以运行这个工程了，如果不纠结后续的开发标准化，那么框架搭建就结束了。纯粹的后端开发是很简单的，如果在别人规划基础上搞开发，就是机械的写方法和实现。
规范化开发
完成搭建和使用还是有很大距离的，目前为止我们没有开发1行代码，工程却可以运行，但必然不是我们想要的运行方式和结果，依赖也没有真正地发挥作用，每个包的使用需要学习成本，比如security集成进来后会为我们分配用户名和密码，如果不进行修改和适配，接口会被拦截，swagger2需要进行拦截器配置才可以自动扫描接口，mybatis的代码生成器也需要进行个性化配置，此部分都可以定义为规范化开发工作。
目录结构
目录规划目的是代码管理层面的统一，这个是所有使用的基础：
client：第三方集成和调用，一般用feign
config：放拦截器比如security，mybatis和swagger都是对Http请求的拦截和处理；
controller：请求的入口
entity：POJO类，建议跟数据库对象一一对应，使用mybatis-plus可以绑定表，非常方便；
framework：次级管理目录，将其他异常，常量，请求体，响应体封装统一放置管理；
mapper：数据库操作的mapper存放位置；
service：请求的实现方法；
utils：工具类，这个地方会存很多通用和专用的工具；
VO：面向展示层的封装体；
依赖适配
目录规划好后，就要进行依赖适配，因为增加的几个依赖包都有各自的最佳实践或者正确使用姿势，具体而言就是security，mybatis-plus和swagger2的拦截配置，security因为要重写很多方法，这里先不详细介绍，可以直接在xml里面配置其登录名和密码，登录后进行其他依赖配置。
spring.security.user.name=root
spring.security.user.password=123456
关于security框架本身其复杂度高，后续可以参考之前的博客做完整适配：SpringBoot实践（二十六）：Security实现Vue-Element-Admin登录拦截(适合单体应用)_A叶子叶的博客-CSDN博客_springsecurity路由拦截
mybatis有分页器和自动填充的配置要自定义，这里也可以不写；swagger2和最定义UI需要进行配置才会生效，swagger2的配置类：
@Configuration
@EnableSwagger2
public class Swagger2 {
// 配置扫描的包
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.quick.start.demo.controller")).paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("测试Swagger的API.")
// 创建人信息
.contact(new Contact("yzg", "https://blog.csdn.net/yezonggang", "717818895@qq.com"))
// 版本号
.version("2.0")
// 描述
.description("描述")
.build();
}
}两个UI界面的对比如下：
代码生成器
mybatis-plus代码生成器单独讲因为这个工具能够节省很多时间，在进行项目开发前关系库应该首先被设计出来，也就是表结构，按照范式要求进行设计后代码开发，表对应entity，mapper映射和实现类都可以被mp标准化输出；
package com.quick.start.demo;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.apache.commons.lang3.StringUtils;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
class CodeGeneratorTest {
public static final String FILE_NAME_MODEL = "%sEntity";
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.isNotBlank(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("yzg");
gc.setOpen(false);
// 支持swagger2
gc.setSwagger2(true);
// pojo类后接Entity
gc.setEntityName("%sEntity");
gc.setFileOverride(true);
gc.setEnableCache(true);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://10.10.10.10:3306/security?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8");
dsc.setSchemaName("security");
dsc.setDbType(DbType.MYSQL);
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("1q2w!Q@W");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
//pc.setModuleName(scanner("模块名"));
pc.setParent("com.quick.start.demo");
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/"
+ "/" + 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.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
//strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
//strategy.setSuperEntityColumns("id");
//strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
// 根据表名的_下划线命名成类名
strategy.setTablePrefix(pc.getModuleName() + "_");
strategy.setInclude("role"); // 需要生成的表
//strategy.setExclude(new String[]{"test"}); // 排除生成的表
// 开启tableFileld就是表名对应关系
strategy.setEntityTableFieldAnnotationEnable(true);
//strategy.setTablePrefix(new String[] { "SYS_" });// 此处可以修改为您的表前缀
strategy.setEntityLombokModel(true);
//strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
strategy.setEnableSqlFilter(true);
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}代码自动化生成，非常地便利：
以RoleEntity.class为例：
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("role")
@ApiModel(value="RoleEntity对象", description="")
public class RoleEntity implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Long id;
@TableField("name")
private String name;
@TableField("code")
private String code;
@TableField("des")
private String des;
}响应体封装
响应体建议要封装一层，因为直接返回dataHttpServletResponse是不符合生产规范的，提前捕获，定义，返回正常或有问题的数据才是规范的；
@Data
@NoArgsConstructor
public class ResponseData implements Serializable {
private final static String SUCCESS = "success";
private final static String ERROR = "error";
private final static String WARN = "warn";
private int code;
private String msg ;
private Object data;
public ResponseData(int code, String msg, Object data) {
this.code = code;
this.msg = msg;
this.data = data;
}
public ResponseData(String msg, Object data) {
this.msg = msg;
this.data = data;
}
public static ResponseData success(Object data){
return new ResponseData(200,SUCCESS,data);
}
public static ResponseData fail(Object data){
return new ResponseData(200,ERROR,data);
}
public static ResponseData fail(ApiError apiError){
return new ResponseData(apiError.getErrorCode(),apiError.getErrorMsg(),apiError.getErrorName());
}
}github代码
GitHub - yezonggang/demo20220905real: 最新整理的spirngboot开发脚手架，开发框架