SpringBoot整合Swagger2+定时器

Swagger 2 是一个强大的 API 文档生成和测试工具，它通过标准化的 JSON 描述格式简化了 API 的设计、开发和维护过程，提供了自动文档生成、代码框架生成、交互式测试界面以及版本控制等功能，同时支持广泛的编程语言和开发框架，拥有丰富的社区和插件生态，极大地提高了 API 开发的效率和质量。

Springboot 整合 Swagger2

首先说一下，本次整合用的 SpringBoot 版本是 2.0，因为 SpringBoot3.0 整合不了 Swagger2，原因是 swagger 的依赖底层用的是 javax 依赖包，而 spring boot 3.x 版本都是 jakarta 依赖包，一般是把 spring boot2.5 以下就可以了，但是想要 2.5 版本以上 spring boot 启动就会出报错。

1. 项目结构

2. swagger2 依赖

<!--引入swagger2依赖-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>
        <!--图形化依赖-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

3 . 创建 swagger2 配置类

@Configuration
public class SwaggerConfig {
 
    //创建swagger实例
    @Bean
    public Docket docket() {
        Docket docket=
                new Docket(DocumentationType.SWAGGER_2)
                        .apiInfo(getInfo())//设置接口文档的信息
                        .select()
                        .apis(RequestHandlerSelectors.basePackage("com.ykq.controller")) //指定为那些路径下得到类生成接口文档
                        .build()
                ;
 
        return docket;
    }
 
    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("李四", "http://www.ldw.com", "110@qq.com");
        ApiInfo DEFAULT = new ApiInfo("用户管理系统API", "该系统中的接口专门操作用户的", "v1.0", "http://www.baidu.com",
                DEFAULT_CONTACT, "与相似", "http://www.jd.com", new ArrayList<VendorExtension>());
        return DEFAULT;
    }
}

4. 开启 swagger 的注解驱动

5. 访问 swagger 接口文档

第一种: http://localhost:8080/swagger-ui.html

第二种: http://localhost:8080/doc.html

点击需要测试的接口方法，如图：

查看结果：

6. swagger2 常用注解

@Api(tags=“”)：使用在接口类上，对接口类的说明

@ApiOperation(value=""): 接口方法上，对接口方法的说明

@ApiImplicitParams(
@ApiImplicitParam(name=“参数名”,value="参数说明",require="是否必写",dataType="数据类型")
) : 接口方法所有参数的概述

@ApiModel(value=""): 使用在实体类上，对实体类的说明

@ApiModelProperty(value=""): 使用在实体类属性上，对属性的说明

SpringBoot 整合定时器

1. 定时器简介

定时器到 Spring Boot 应用中是为了实现自动化的任务调度，提高应用效率，简化开发流程，并通过高度可配置的执行计划满足不同场景的需求。它支持易于测试的代码结构，增强应用的可扩展性，并与 Spring 生态无缝集成。

2. 引入定时器依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-quartz</artifactId>
        </dependency>

3. 创建一个定时业务类

@Configuration
public class MyQuartzConfig {
 
    //定时业务代码
    //定义定时规则
    @Scheduled(cron = "0/5 * * * * ?")
    public void show(){
        System.out.println("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
        //发生短信 或者删除oss冗余文件  或者取消订单
    }
}

4. 开启定时器注解驱动

5. cron: 表达式

Cron 表达式是一个字符串，用于表达时间和日期的重复模式，通常用于配置定时任务的执行计划。Cron 表达式由六个或七个字段组成，每个字段代表一个时间单位。

以下是一些 Cron 表达式的示例：

0 * * * * ?: 在每个小时的整点执行。
0 0/30 * * * ?: 每隔 30 分钟执行一次。
0 0 9-17 * * ?: 在每天的上午 9 点到下午 5 点之间，每小时的整点执行。
0 0 8,14 * * ?: 每天的上午 8 点和下午 2 点执行。
0 0/5 14 * * ?: 在每天下午 2 点到 3 点之间，每 5 分钟执行一次。
0 0-5 14 * * ?: 在每天下午 2 点开始的前 5 分钟内，每分钟执行一次。
0 0 9 ? * 1-5: 在每个工作日上午 9 点执行。

这里是一个生成 Cron 表达式的网址，个人感觉还不错！

Cron - 在线 Cron 表达式生成器

Swagger2 简介

1. 什么是 Swagger2

2. 为什么使用 Swagger2