spring boot整合定时器和swagger

勤奋上进的兔子

已于 2023-05-07 18:32:54 修改

阅读量166

点赞数

分类专栏： spring boot 文章标签： spring boot java

于 2022-11-18 15:20:39 首次发布

本文链接：https://blog.csdn.net/qq_55648724/article/details/127922762

版权

spring boot 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

文章目录

前言

笔记

一、定时器配置

1.引入依赖

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

2.编写定时器配置类

@Component
public class MyQuartz {


    /**
     * 定时器规则要加注解
     */
    //@Scheduled(cron = "1/1 * * * * ?")
    public void testQuartz(){
        System.out.println("启动定时器");
    }
}

3.在主启动类函数上添加

//@EnableScheduling 开启定时器

二、swagger的配置与实现

1.引入依赖

   <!--swagger启动器整合spring boot-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>

        <!--swagger图形化界面-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2.编写配置类



import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
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;

/**
 * @author ：
 * @date ：Created in 2022/11/18 10:10
 * @description：swagger配置类
 * @modified By：
 * @version:1.0
 */
@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {


    //配置docket以配置Swagger具体参数
    @Bean
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                //组名
                .groupName("nineGroup")
                //api信息
                .apiInfo(getInfo())
                //选择哪些生成api接口---根据请求路径选择  (2)根据包名选择
                .select()
                //根据请求路径选择
                //.paths(Predicates.and(PathSelectors.regex("/student/.*")))
                //        (2)根据包名选择
                .apis(RequestHandlerSelectors.basePackage("com.xxx.controller"))
                .build()
                ;

        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("孔子", "http://www.xx.com", "kongzi@qq.com");
        ApiInfo info = new ApiInfo("学生管理API", "学生管理系统api", "2.0", "http://www.xxx.com",
                DEFAULT_CONTACT, "教育领导", "http://www.teach.com", new ArrayList<VendorExtension>());
        return info;
    }
}

3.如何应用

swagger常用的注解

@Api：修饰整个类，描述Controller的作用

@ApiOperation：描述一个类的一个方法，或者说一个接口

@ApiImplicitParam：一个请求参数

@ApiImplicitParams：多个请求参数

@ApiModel：用对象来接收参数

@ApiModelProperty：用对象接收参数时，描述对象的一个字段

1.定义实体类

@Data
@ApiModel(value = "Student",description="学生实体")
public class Student {

    @ApiModelProperty(value = "编号",required=true)
    private Integer id;

    @ApiModelProperty(value = "学生名",required=true)
    private String name;

    @ApiModelProperty(value = "年龄",required=true)
    private Integer age;

    @ApiModelProperty(value = "地址",required=true)
    private String address;


}

2.实现控制层的swagger注解版

@RestController
@RequestMapping("/student")
@Api(tags = "学生模块说明")
public class StudentController {

    @Autowired
    private StudentService studentService;

    @DeleteMapping("/delete")
    @ApiOperation(value="学生信息删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name="id",value="学生编号",required=true,dataType="int",paramType="query")
    })
    public Result delete(Integer id){
      return   studentService.delete(id);
    }


    @PostMapping("/add")
    @ApiOperation(value="学生信息添加")
    public Result add(@RequestBody Student student){
        return studentService.add(student);
    }

    @PutMapping("/update")
    @ApiOperation(value="学生信息更新")
    public Result update(@RequestBody Student student){
        return studentService.update(student);
    }

    @GetMapping("/select")
    @ApiOperation(value="学生信息查询")
    @ApiImplicitParams({
            @ApiImplicitParam(name="currentPage",value="分几页",required=true,dataType="int",paramType="query"),
            @ApiImplicitParam(name="pageSize",value="每页几条数据",required=true,dataType="int",paramType="query")
    })
    public Result selectAll(Integer currentPage, Integer pageSize){
        return studentService.SelectAll(currentPage, pageSize);
    }


}

4.最后运行spring boot项目，浏览器打开http://localhost:port/doc.html 就能看到图形化界面