springboot整合swagger2和定时器

1.springboot整合swagger2和定时器

1.1什么是swagger2？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档 . 接口: controller相应的路径方法

1.2为什么使用swagger2？

目前的项目基本都是前后端分离，后端为前端提供接口的同时，还需同时提供接口的说明文档。但我们的代码总是会根据实际情况来实时更新，这个时候有可能会忘记更新接口的说明文档，造成一些不必要的问题。 编写和维护接口文档是每个程序员的职责，根据Swagger2可以快速帮助我们编写最新的API接口文档，再也不用担心开会前仍忙于整理各种资料了，间接提升了团队开发的沟通效率。

1.3swagger2常用注解介绍

swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

• @Api：修饰整个类，描述Controller的作用
• @ApiOperation：描述一个类的一个方法，或者说一个接口
• @ApiParam：单个参数描述
• @ApiModel：用对象来接收参数
• @ApiModelProperty：用对象接收参数时，描述对象的一个字段
• @ApiImplicitParam：一个请求参数
• @ApiImplicitParams：多个请求参数

2.项目中整合Swagger2

2.1：引入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.7.8</version>
        </dependency>

2.2:编写swgger2配置类代码

package com.wzp3.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.VendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * @program: qy163wzp2
 * @description:
 * @author: 王子朋
 * @create: 2023-04-12 14:30
 **/
@Configuration
@EnableSwagger2//开启swagger注解驱动
public class SwaggerConfig {
    @Bean//把方法返回的数据对象 交给spring容器管理
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("qy163wzp")
                .apiInfo(getInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wzp3.controller")) //只为com.ykq.controller包下的类生成接口文档
                .build();
        return docket;
    }
        private ApiInfo getInfo(){
            Contact DEFAULT_CONTACT = new Contact("王子朋", "https://www.baidu.com", "2776029841@qq.com");
            ApiInfo apiInfo=new ApiInfo("志远鸡舍管理系统", "志远鸡舍管理系统", "9.9.9", "https://www.jd.com",
                    DEFAULT_CONTACT, "志远科技", "https://www.aaa.com", new ArrayList<VendorExtension>());
            return apiInfo;
        }




}

2.3使用swagger2测试访问swagger2在线文档

http://ip:port/doc.html

3. springboot整合定时器-quartz

定时器的应用场景
定时取消待支付的订单，以及过节日的时候定时发送推送通知

3.1：如何使用？

1.引入quartz依赖

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

2.配置定时器的相关任务

@Component //交于spring容器该类对象
public class QuarzConfig {
    @Autowired
    private EmpMapper empMapper;
    @Scheduled(cron = "0/5 * * * * ? ")
    public void show(){
        //1.查询过期的订单
        List<Emp> emps = empMapper.selectList(null);
        System.out.println(emps);
        //2.删除过期的订单
    }
}

3.开启定时器注解驱动

@SpringBootApplication
@MapperScan(basePackages = "com.ykq.dao")
@EnableScheduling //开启定时器注解
public class Qy163Springboot03Application {
    public static void main(String[] args) {
        SpringApplication.run(Qy163Springboot03Application.class, args);


    }

}