1. springboot整合swagger2
2. springboot整合定时器
1. springboot整合swagger2
1.1 什么是swagger2
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档 . 接口: controller相应的路径方法
目前的项目基本都是前后端分离,后端为前端提供接口的同时,还需同时提供接口的说明文档。但我们的代码总是会根据实际情况来实时更新,这个时候有可能会忘记更新接口的说明文档,造成一些不必要的问题。
1.2 使用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>
1.3 创建 swagger2 的配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docket(){
Docket docket = new Docket(DocumentationType.SWAGGER_2).groupName("pm").apiInfo(getInfo())
.select().apis(RequestHandlerSelectors.basePackage("pjx.springboot3.controller")//生成接口文档
).build();
return docket;
}
private ApiInfo getInfo(){
Contact DEFAULT_CONTACT = new Contact("平家祥", "www.bilibili.com", "799388990@qq.com");
ApiInfo apiInfo = new ApiInfo("4.12作业","4.12作业","4.12","www.bilibili.com",
DEFAULT_CONTACT,"aaa","www.baidu.com",new ArrayList<VendorExtension>());
return apiInfo;
}
}
1.4 访问在线文档
http://localhost:8080/doc.html
1.5 swagger 的常用注解
使用swagger注解对接口参数加以说明。
@Api(tags="")====使用在controller类上
@ApiOperation(value="")====在controller层 接口方法加以说明
@ApiParam(value = "",name = "",required = true) 对controller中的属性说明 required是否为必须的 defaultValue 设置默认值
@ApiModel====在pojo层中 实体类
@ApiModelProperty===>实体类的属性说明
2. springboot整合定时器
2.1 引入定时器的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
2.2 配置定时器类 交给 spring管理
自动生成 cron 的网站 https://cron.qqe2.com/
@Component //交于spring容器该类对象
public class QuarzConfig {
@Autowired
private StudentMapper mapper;
@Scheduled(cron = "0/5 * * * * ? ")
public void show(){
//1.查询过期的订单
List<Student> studentList = mapper.selectList(null);
System.out.println(studentList);
//2.删除过期的订单
}
}
2.3 在主函数开启定时器注解
@SpringBootApplication
@MapperScan(basePackages = "pjx.springboot3.mapper")
@EnableScheduling //开启定时器注解
public class Springboot3Application {
public static void main(String[] args) {
SpringApplication.run(Springboot3Application.class, args);
}
}