一、社区购_V6项目部署
1、新建项目
项目名称-SheQuGouV6(maven项目)
项目使用依赖
2、pom文件内容
<?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>3.1.2</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.zz.yunhe.study</groupId>
<artifactId>SheQuGouV6</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>SheQuGouV6</name>
<description>SheQuGouV6</description>
<properties>
<java.version>17</java.version>
</properties>
<dependencies>
<!-- springboot的4项:parent starter-web starter-test autoconfigure -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>3.1.2</version>
</dependency>
<!-- lombok的依赖项 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<!-- <version>1.18.26</version>-->
<optional>true</optional>
</dependency>
<!--yml格式配置文件的依赖项 -->
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>2.0</version>
</dependency>
<!--springdoc的依赖项:springdoc-openapi-starter-webmvc-ui 和
springdoc-openapi-starter-webmvc-api -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
<version>2.1.0</version>
<exclusions>
<exclusion>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
</exclusion>
</exclusions>
</dependency>
<!-- mybatis-plus的3项 : mysql8.x druid mybatis-plus -->
<!-- <dependency>-->
<!-- <groupId>mysql</groupId>-->
<!-- <artifactId>mysql-connector-java</artifactId>-->
<!-- <scope>runtime</scope>-->
<!-- </dependency>-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version> 1.2.16</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.3.1</version>
</dependency>
<!--工具包依赖项,例如StringUtils、DateUtils、ArrayUtils等 -->
<dependency>
<groupId>commons-lang</groupId>
<artifactId>commons-lang</artifactId>
<version>2.6</version>
</dependency>
<!-- fastjson 依赖项 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>2.0.32</version>
</dependency>
<!-- mybatis-plus逆向工程代码生成器 所需要的两个依赖
generator、velocity(velocity的自定义模板比freemark好用)
以及前面依赖的 mybatis-plus-boot-starter 3.5.3.1 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.3.1</version>
</dependency>
<!-- 使用 velocity 模板 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<!-- jwt令牌依赖项 采用java-jwt 使用比jjwt简便的多 -->
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>4.4.0</version>
</dependency>
<!--互亿无线短信接口依赖项:
xml解析, 经反复测试版本
2.13.4 和 2.14.2可以正常使用, 2.15.2使用方法发生变化,
因为jackson解析XML不是主业,故本例采用前两个版本中的2.14.2 -->
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-xml</artifactId>
<version>2.14.2</version>
</dependency>
<!--支付宝沙箱-->
<dependency>
<groupId>com.alipay.sdk</groupId>
<artifactId>alipay-sdk-java</artifactId>
<version>4.33.39.ALL</version>
<exclusions>
<exclusion>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
</exclusion>
<exclusion>
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk15on</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
</project>
3、yml配置
# API文档配置
springdoc:
api-docs:
enabled: true
# JSON格式的API文档,本格式文档不便于阅读
path: /doc.html
swagger-ui:
# 网页界面格式的API,容易使用,推荐
path: /doc-ui.html
disable-swagger-default-url: on
## 当前项目的端口号
server:
port: 8080
spring:
application:
# 应用的名称,可选配项
name: waimai_V6
# 项目为开发环境,对应配置文件为-xxx-dev.yml
profiles:
active: dev
main:
# 依赖项循环引用
allow-circular-references: true
datasource:
# springboot 2.7.x开始,数据库连接池默认使用com.zaxxer.hikari.HikariDataSource
# HikariDataSource配置中,没有druid选项,建议注释掉
# druid:
driver-class-name: ${shequgou.datasource.driver-class-name}
url: jdbc:mysql://${shequgou.datasource.host}:${shequgou.datasource.port}/${shequgou.datasource.database}?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true
username: ${shequgou.datasource.username}
password: ${shequgou.datasource.password}
# API接口文档Swagger3所需
mvc:
pathmatch:
matching-strategy: ant_path_matcher
mybatis-plus:
configuration:
# 在映射实体或者属性时,将数据库中表名和字段名中的下划线去掉,按照驼峰命名法映射
map-underscore-to-camel-case: true
# 生成SQL日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
4、写个Web测试程序
package cn.zz.yunhe.study.shequgouv6.controller.admin;
import cn.zz.yunhe.study.shequgouv6.common.Result;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/admin/test")
public class Test1 {
@GetMapping
public Result<String> test1(){
return Result.success("测试1已通过");
}
}
5、浏览器访问接口,返回Result结果
返回结果result类:
package cn.zz.yunhe.study.shequgouv6.common;
import lombok.Data;
import java.io.Serializable;
/**
* 响应前端请求时的统一格式
* @version 0.01
* @Author yuch
* @Date 2023-08-10 14:58
*
* @param <T> 泛型参数
*/
@Data
public class Result<T> implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 返回结果的数字类型代码编号: 1成功,0和其它为失败
*/
private Integer code;
/**
* code不等于1时,对应的错误提示
*/
private String msg;
/**
* code等于1时,附加返回的数据包
*/
private T data;
/**
* 构建一个成功无附加数据的返回类
* @return <T> Result<T>
* @param <T> null
*/
public static <T> Result<T> success() {
Result<T> result = new Result<T>();
result.code = 1;
return result;
}
/**
* 构建一个成功并且有附加数据的返回类
* @return <T> Result<T>
* @param <T> object 附加的数据包
*/
public static <T> Result<T> success(T object) {
Result<T> result = new Result<T>();
result.data = object;
result.code = 1;
return result;
}
/**
* 构建一个失败和失败提示信息的返回类
* @return <T> Result<T>
* @param <T> msg 失败提示信息
*/
public static <T> Result<T> error(String msg) {
Result<T> result = new Result<T>();
result.msg = msg;
result.code = 0;
return result;
}
}
二、项目api接口文档
1. 先在主包下创建子包【config】,然后从素材中复制文件SpringDocConfig.java到子包config中【标3】SpringDocConfig;
2. 其实这个配置文件的类名称不是必须为SpringDocConfig【标6】,起决定作用的是前面的注解@Configuration【标7】,告诉SpringBoot这是一个配置文件;
3. 函数【标8】docTitle(),用于生成API文档的标题信息,同样取决定作用的是函数返回类型和对应注解@Bean【标9】;
4. 因为项目分为后台管理端和客户端两个独立的子系统,后台接口也按admin和user两组分别提供,因此API文档也分组编写。对应admin组和对应user组;
1、接口使用的依赖:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.1.0</version>
</dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
<version>2.1.0</version>
<exclusions>
<exclusion>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
</exclusion>
</exclusions>
</dependency>
2、代码:
package cn.zz.yunhe.study.shequgouv6.config;
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 功能描述:在SpringBoot3.1.2中整合SpringDocV3.0API文档
* @version 0.01
* @Author yuch
* @Date 2023-08-21 09:45
* 1.特别注意:
* 1.SpringBoot2.7.x以下/SpringBoot2.7.x以上/3.xx支持的API文档完全不同
* 2.SpringBoot2.7.x以下 支持swaggerV2版
* 3.SpringBoot2.7.x以上 支持swaggerV2版和swaggerV3,
* 但是必须采用过渡版的依赖项springfox-swagger-ui
* 4.SpringBoot3版本只支持SpringDocV3.x,因为版本比较新,使用的人少,官方资料只是简单一带而过,
* 实际编写时,问题较多
* 4.1.例如: SpringDoc跟WebMvcConfigurationSupport冲突,网上几乎没有什么有效的解决方案;
* 5.本例采用SpringBoot3+SpringDocV3
**/
@Configuration
public class SpringDocConfig {
@Bean
public OpenAPI docTitle() {
return new OpenAPI()
.info(new Info().title("社区购外卖项目.开发接口文档")
.description("接口描述:测试阶段")
.version("1.0.0"))
.externalDocs(new ExternalDocumentation().description("")
.url(""));
}
@Bean
public GroupedOpenApi adminApi() {
return GroupedOpenApi.builder()
//分组名
.group("admin")
//扫描路径,将指定路径下有swagger注解的接口添加到本组
.packagesToScan("cn.zz.yunhe.study.shequgouv6.controller.admin")
.build();
}
@Bean
public GroupedOpenApi userApi() {
return GroupedOpenApi.builder()
//分组名
.group("user")
//扫描路径,将指定路径下有swagger注解的接口添加到本组
.packagesToScan("cn.zz.yunhe.study.shequgouv6.controller.admin")
.build();
}
}
测试结果:
三、代码自动生成
1、代码生成模板
2、代码自动生成类
package cn.zz.yunhe.study.shequgouv6.codegenerator;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import java.util.Collections;
/**
* WaiMaiV6版数据库的MyBatis-Plus 代码生成类
* @version 1.0.1
* @Author yuch
* @Date 2023-08-28
**/
public class SheQuGouV6CodeGenerator {
//连接MySQL的配置信息
private static final String DATABASE_NAME = "waimaiv6";
private static final String USER_NAME = "root";
private static final String PASSWORD = "210718WEI";
private static final String URL = "jdbc:mysql://localhost:3306/" + DATABASE_NAME;
//需要逆向工程的表名列表清单
private static final String[] TABLE_NAMES = new String[]{
"t_employee" ,
"t_user" ,
"t_category" ,
"t_dish" ,
"t_flavor" ,
"t_dish_flavor" ,
"t_setmeal" ,
"t_setmeal_dish" ,
"t_address_book" ,
"t_shopping_cart" ,
"t_orders" ,
"t_orders_detail"
};
public static void main(String[] args) {
// 初始化 Velocity 模板引擎配置
//1、数据源配置
FastAutoGenerator.create(URL, USER_NAME, PASSWORD)
//2、全局配置
.globalConfig(SheQuGouV6CodeGenerator::setGlobalConfig)
//3、包配置
.packageConfig(SheQuGouV6CodeGenerator::setPackageConfig)
//4、策略配置
.strategyConfig(SheQuGouV6CodeGenerator::setStrategyConfig)
//5、模板配置
.templateConfig(SheQuGouV6CodeGenerator::setTemplateConfig)
//6.选择模板引擎
.templateEngine(new VelocityTemplateEngine())
//.templateEngine(new FreemarkerTemplateEngine())
//.templateEngine(new BeetlTemplateEngine())
//7、执行
.execute();
}
/**
* 全局配置函数
* @param builder builder
*/
private static void setGlobalConfig(GlobalConfig.Builder builder) {
builder.author("yuch") // 设置作者名
.outputDir(System.getProperty("user.dir") + "/code-generator/src/main/java") //设置输出路径:项目的 java 目录下
.commentDate("yyyy-MM-dd hh:mm") //注释日期
.dateType(DateType.TIME_PACK) //定义生成的实体类中日期的类型 TIME_PACK=LocalDateTime;ONLY_DATE=Date;
//.fileOverride() //覆盖之前的文件
//.enableSwagger() //开启swagger模式,实测时,不过好像只针对entity有效
.disableOpenDir(); //禁止打开输出目录,默认打开
}
/**
* 包配置函数
* @param builder builder
*/
private static void setPackageConfig(PackageConfig.Builder builder) {
builder.parent("cn.zz.yunhe.study.shequgouv6") // 设置父包名
.moduleName("") //设置模块包名
.entity("entity.pojo") //pojo 实体类包名
.service("service") //Service 包名
.serviceImpl("service.impl") // ***ServiceImpl 包名
.mapper("mapper") //Mapper Dao层的包名
.xml("mappers") //Mapper XML层的包名
.controller("controller") //Controller 包名
.pathInfo(Collections.singletonMap(
OutputFile.xml,
System.getProperty("user.dir") + "/code-generator/src/main/resources/mapper"));
//配置 mapper.xml 路径信息:项目的 resources 目录下
}
/**
* 策略配置
* @param builder builder
*/
private static void setStrategyConfig(StrategyConfig.Builder builder) {
builder.addInclude(TABLE_NAMES) // 设置需要生成的数据表名
// 1. 设置过滤表前缀// 增加过滤表后缀
.addTablePrefix("t_" , "b_")
.addTableSuffix("_n")
// 增加过滤字段前缀
.addFieldPrefix("")
// 增加过滤字段后缀
.addFieldSuffix("")
//2、Mapper策略配置
.mapperBuilder()
.superClass(BaseMapper.class) //设置父类
//.enableBaseResultMap() // 建议启用 BaseResultMap生成
//.enableBaseColumnList() // 建议启用 BaseResultMap生成
.enableMapperAnnotation()//开启 @Mapper注解,3.5版本开始
.formatMapperFileName("%sMapper") //格式化 mapper 文件名称
.formatXmlFileName("%sMapper") // 格式化 XML 文件名称,修改为 "%sMapper"
//3、service 策略配置
.serviceBuilder()
.formatServiceFileName("%sService") //格式化 service 接口文件名称,%s进行匹配表名,如 UserService
.formatServiceImplFileName("%sServiceImpl") //格式化 service 实现类文件名称,%s进行匹配表名,如 UserServiceImpl
//4、实体类策略配置
.entityBuilder()
.enableLombok() //开启 Lombok,并默认使用@Data注解
.disableSerialVersionUID() //开启 Serializable 接口,不生产 SerialVersionUID
.logicDeleteColumnName("is_deleted") //逻辑删除字段名
.logicDeletePropertyName("isDeleted")// 逻辑删除属性名(实体)
.naming(NamingStrategy.underline_to_camel) //数据库表映射到实体的命名策略:下划线转驼峰命
.columnNaming(NamingStrategy.underline_to_camel) //数据库表字段映射到实体的命名策略:下划线转驼峰命
.addTableFills(
new Column("create_time" , FieldFill.INSERT),
new Column("update_time" , FieldFill.INSERT_UPDATE),
new Column("create_user" , FieldFill.INSERT),
new Column("update_user" , FieldFill.INSERT_UPDATE)
) //添加表字段填充,"create_time"字段自动填充为插入时间,"update_time"字段自动填充为插入修改时间
.enableTableFieldAnnotation() // 开启生成实体时生成字段注解
//4、Controller策略配置
.controllerBuilder()
.formatFileName("%sController") //格式化 Controller 类文件名称,%s进行匹配表名,如 UserController
.enableRestStyle(); //开启生成 @RestController 控制器
}
/**
* 模板配置函数
* @param builder
*/
private static void setTemplateConfig(TemplateConfig.Builder builder) {
// 实体类使用我们自定义的实体类模板、控制类模板,
// 使用系统自带的模板则注释掉下面两行即可
builder.entity("templates/myEntity.java.vm")
.controller("templates/myController.java.vm")
.service("templates/myService.java.vm")
.serviceImpl("templates/myServiceimpl.java.vm");
}
}
3、接口测试
response body:
{
"code": 1,
"msg": null,
"data": {
"records": [
{
"id": 32,
"categoryId": 101,
"name": "超量午餐",
"price": 54.44,
"status": 1,
"code": "",
"description": "量大实惠,二荤二素",
"image": "p28.png",
"createTime": "2023-07-22T11:26:01",
"updateTime": "2023-07-22T11:26:01",
"createUser": 1001,
"updateUser": 1001,
"isDeleted": 0
},
{
"id": 33,
"categoryId": 102,
"name": "商务午餐",
"price": 54.44,
"status": 1,
"code": "",
"description": "商务套餐,二荤二素一汤",
"image": "p29.png",
"createTime": "2023-07-22T11:26:01",
"updateTime": "2023-07-22T11:26:01",
"createUser": 1001,
"updateUser": 1001,
"isDeleted": 0
},
{
"id": 34,
"categoryId": 102,
"name": "金牌商务午餐",
"price": 54.44,
"status": 1,
"code": "",
"description": "商务套餐,三荤二素一汤带水果",
"image": "p30.png",
"createTime": "2023-07-22T11:26:01",
"updateTime": "2023-07-22T11:26:01",
"createUser": 1001,
"updateUser": 1001,
"isDeleted": 0
}
],
"total": 0,
"size": 3,
"current": 1,
"orders": [],
"optimizeCountSql": true,
"searchCount": true,
"maxLimit": null,
"countId": null,
"pages": 0
}
}
4、整合配置管理WebMvcConfigurationSupport WebMvcConfig
package cn.zz.study.config;
import cn.zz.study.common.JacksonObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.*;
import java.util.List;
/**
* 功能描述:提供webMvcConfigurer的配置
* @version 0.01
* @Author yuch
* @Date 2023-08-19 15:24
* 注意: 很多,见笔记
**/
@Slf4j
//不使用默认的Bean,改用自己创建的替代默认的
@Configuration(proxyBeanMethods = false)
public class WebMvcConfig {
@Bean
public WebMvcConfigurer webMvcConfigurer() {
return new WebMvcConfigurer() {
//项目用途1.未来可以扩展自定义的拦截器
//项目用途2.设置静态资源和资源的映射关系,Swagger的API文档,admin系列、user系列的htnl\css\js\ico等
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
log.info("开始设置静态资源映射...");
//1.解决Swagger生成的API网页不能访问请求
registry.addResourceHandler("/doc.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/doc-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
//2.解决swagger-ui的静态资源无法访问的问题,目前不用,保留,以此纪念走过的弯路
//这一部分是从依赖包org.webjars::swagger-ui:4.18.2中
// registry.addResourceHandler("/swagger-ui/**")
// .addResourceLocations("classpath:/META-INF/resources/webjars/swagger-ui/4.18.2/");
//这一部分是从依赖包springdoc-openapi-starter-webmvc-ui的SwaggerWebMvcConfigurer源代码中翻出来的
// registry.addResourceHandler("/swagger-ui/**")
// .addResourceLocations("classpath:/META-INF/resources/webjars/swagger-ui/");
// registry.addResourceHandler("/swagger-ui*/**").
// addResourceLocations("classpath:/META-INF/resources/webjars/");
// 3.解决普通静态资源无法访问的问题。 等网页部分分离到nginx后,这一步请求就不存在了
registry.addResourceHandler("/**")
.addResourceLocations("classpath:/static/");
registry.addResourceHandler("/admin/**")
.addResourceLocations("classpath:/admin/");
registry.addResourceHandler("/user/**")
.addResourceLocations("classpath:/user/");
//registry.setOrder(0);
}
//项目用途4.扩展Spring MVC框架的消息转化器
@Override
public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
MappingJackson2HttpMessageConverter messageConverter = new MappingJackson2HttpMessageConverter();
//设置对象转化器,底层使用jackson将java对象转为json
messageConverter.setObjectMapper(new JacksonObjectMapper());
//将上面的消息转换器对象追加到mvc框架的转换器集合当中(index设置为0,表示设置在第一个位置,避免被其它转换器接收,从而达不到想要的功能)
//converters.add(0, messageConverter);
//解决SpringDoc文档出现 2.0和3.0错误问题
converters.add(1, messageConverter);
}
};
}
}