springboot整合swagger2及定时器

1.springboot整合swagger2

        1.1swagger2简介

        Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档。

        目前的项目基本都是前后端分离，后端为前端提供接口的同时，还需同时提供接口的说明文档。但我们的代码总是会根据实际情况来实时更新，这个时候有可能会忘记更新接口的说明文档，造成一些不必要的问题。也就是说，swagger就是帮你写接口说明文档的。

        1.2如何使用swagger2

        （1）添加依赖

  <!-- 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）创建swagger2配置类

@Configuration
@EnableSwagger2 //开启swagger注解驱动
public class SwaggerConfig {

    @Bean //把方法返回的数据对象 交于spring容器管理
    public Docket docket(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("QY163")
                .apiInfo(getInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xwh.controller")) //只为com.ykq.controller包下的类生成接口文档
                .build();
        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("wenhao", "http://www.baidu.com", "120@qq.com");
        ApiInfo apiInfo=new ApiInfo("Q心里测试系统API", "QY心里测试系统API", "1.1.0", "http://www.jd.com",
                DEFAULT_CONTACT, "志城科技", "http://www.zhiyuankeji.com", new ArrayList<VendorExtension>());
        return apiInfo;
    }
}

        （3）swagger2常用注解

        @Api 对整个控制层的设置 可以设置tags，tags为数组类型，设置多个会在页面中显示多个控制层

 

        @ApiOperation 给方法添加描述和提示信息 ，其value 属性必须有值

         @ApiParam @ApiImplicitParams，@ApiImplicitParam注解来给参数增加说明

 

        @ApiModel和@ApiModelProperty主要是作用到实体类上当接口中有一个方法的返回值为该对象时就会在文档的model中显示该类的信息

        (4)访问swagger在线文档的两种方式

        http://ip:port/swagger-ui.html

        http://ip:port/doc.html

 2.springboot整合定时器

        2.1quartz简介

        Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目，是完全由java开发的一个开源的任务日程管理系统，“任务进度管理器”就是一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。

        2.2如何使用quartz

        （1）引入quartz依赖

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

        （2）开启定时器注解驱动 

@SpringBootApplication
@MapperScan(basePackages = "com.xwh.mapper")
@EnableSwagger2
public class   Springboot0411Application {

    public static void main(String[] args) {
        SpringApplication.run(Springboot0411Application.class, args);
    }

}

        （3）配置定时器 

@Component //交于spring容器该类对象
public class QuarzConfig {
    @Autowired
    private StudentMapper studentMapper;
    @Scheduled(cron = "0/5 * * * * ? ")
    public void show(){
        //1.查询学生信息
        List<Student> student= studentMapper.selectList(null);
        System.out.println(student);
        
    }
}