springboot和swagger2以及定时器

  1   正文

1. springboot整合swagger2
2. springboot整合定时器

   2   springboot整合swagger2

        2.1  什么是swagger2

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

        2.2  为什么是swagger2

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

        2.3  如何使用接口文档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
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("小石666")
                .apiInfo(getInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.syp.controller"))
                .build();
        return docket;
    }

    private ApiInfo getInfo(){
        Contact DEFAULT_CONTACT = new Contact("小石","http://www.baidu.com","120@qq.com");
        ApiInfo apiInfo=new ApiInfo("小石1104",
                "小石的doc页面", "1.1.0",
                "http://www.jd.com",
                DEFAULT_CONTACT, "小石科技", "http://www.aaa.com",
                new ArrayList<VendorExtension>());

        return apiInfo;

    }
}

        （3）访问swagger在线文档

localhost:8080/swagger-ui.html

localhost:8080/doc.html

        2.4  swagger中常用的注解

使用swagger注解对接口参数加以说明。

@Api（tags=""）====使用在controller类上

@ApiOperation(value="")====接口方法上 接口方法加以说明

@ApiParam(value = "",name = "",required = true)

@ApiModel====实体类

@ApiModelProperty===>实体类的属性说明

 3   springboot整合定时器-quartz

在线Cron表达式生成器Cron表达式在线生成器,方便的在线生成各类Cron表达式，并可以将Cron表达式的可视化双向解析和生成.https://www.pppet.net/         (1)  引入quartz依赖

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

        (2)  配置定时器任务

@Component //交于spring容器该类对象
public class QuarzConfig {

    @Autowired
    private UserMapper userMapper;

    @Scheduled(cron = "0/5 * * * * ? ")
    public void show(){
        //1.查询过期的订单
        List<User> users = userMapper.selectList(null);
        System.out.println(users);
        //2.删除过期的订单
    }
}

         (3)  开启定时器注解驱动

@Configuration
@MapperScan("com.syp.mapper")
@EnableScheduling //开启定时器注解
public class MybatisPlusConfig {

    /**
     * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

}