四十九、Swagger和任务 - 《Java 入门即巅峰》

集成Swagger
任务

集成Swagger

Swagger简介

前后端分离

前端 -> 前端控制层、视图层
后端 -> 后端控制层、服务层、数据访问层
前后端通过API进行交互
前后端相对独立且松耦合

产生的问题

前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

解决方案

首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险

Swagger

号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档与API 定义同步更新
直接运行，在线测试API
支持多种语言（如：Java，PHP等）
官网：https://swagger.io/

SpringBoot集成Swagger

步骤：

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

3、编写HelloController，测试确保运行成功！

4、要使用Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration
@EnableSwagger2      // 开启Swagger2
public class SwaggerConfig {
    // 配置docket以配置Swagger具体参数
    @Bean
    public Docket docket(Environment environment){
        // 设置要显示的Swagger 环境
        // Profiles profiles = Profiles.of("dev","test");
        // 通过environment.acceptsProfiles 判断是否处在自己设定的环境当中
        // boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("少帅")
                .apiInfo(apiInfo())
                .enable(true) // enable是否启动Swagger, 如果为False, 则Swagger 不能再浏览器中访问
                .select()
                // RequestHandlerSelectors, 配置要扫描接口的方式
                // basePackage: 指定要扫描的包
                // any(): 扫描全部
                // none(): 不扫描
                // withClassAnnotation: 扫描类上的注解，参数是一个注解的反射对象
                // withMethodAnnotation： 扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.shuai.controller"))
                // paths()。 过滤什么路径
                // .paths(PathSelectors.ant("/shuai/**"))
                .build();
    }
    @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");
    }
    // 配置Swagger信息 = apiInfo
    private ApiInfo apiInfo(){
        // 作者信息
        Contact contact = new Contact("少帅", "https://www.cnblogs.com/shaoshuai2126/", "2895788257@qq.com");
        return new ApiInfo(
                "小帅玩编程",  // 标题
                "每天努力亿点点", // 描述
                "V1.0",   // 版本
                "https://www.cnblogs.com/shaoshuai2126/",  // 组织链接
                contact,  // 联系人信息
                "Apache 2.0",  // 许可
                "http://www.apache.org/licenses/LICENSE-2.0",  // 许可链接
                new ArrayList()  // 扩展
        );
    }
}

5、访问测试：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；

实体配置

1、新建一个实体类

@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    private String username;
    @ApiModelProperty("密码")
    private String password;
}

2、编写HelloController

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(){
        return "hello";
    }
    // 只要我们的接口中，返回值存在实体类，他就会被扫描到Swagger中！
    @PostMapping("/user")
    public User user(){
        return new User();
    }
    // ApiOperation接口，不是放在类上的，是方法
    @ApiOperation("hello2方法")
    @GetMapping("/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello"+username;
    }
    @ApiOperation("postt方法")
    @GetMapping("/postt")
    public User postt(@ApiParam("用户信息") User user){
        return user;
    }
}

拓展：其他皮肤

我们可以导入不同的包实现不同的皮肤定义：

1、默认的访问 http://localhost:8080/swagger-ui.html

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

2、bootstrap-ui 访问 http://localhost:8080/doc.html

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
   <groupId>com.github.xiaoymin</groupId>
   <artifactId>swagger-bootstrap-ui</artifactId>
   <version>1.9.1</version>
</dependency>

3、Layui-ui 访问 http://localhost:8080/docs.html

<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
   <groupId>com.github.caspar-chen</groupId>
   <artifactId>swagger-ui-layer</artifactId>
   <version>1.1.3</version>
</dependency>

4、mg-ui 访问 http://localhost:8080/document.html

<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
   <groupId>com.zyplayer</groupId>
   <artifactId>swagger-mg-ui</artifactId>
   <version>1.0.6</version>
</dependency>

任务

一、异步任务

1、在项目主入口开启注解

@EnableAsync  // 开启异步注解功能

2、在service文件夹下创建AsyncService类

@Service
public class AsyncService {
    // 告诉Spring这是一个异步的方法
    @Async
    public void hello(){
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("数据正在处理....");
    }
}

3、编写一个AsyncController的类

@RestController
public class AsyncController {
    @Autowired
    AsyncService asyncService;
    @RequestMapping("/hello")
    public String hello(){
        asyncService.hello();  // 停止三秒，转圈~
        return "ok";
    }
}

二、邮件任务

1、开启qq邮箱的pop3服务

2、在application中写入有邮件发送的配置

3、测试发送邮件（上网上查找格式，代码格式基本上固定）

三、定时任务

1、在项目主入口开启注解

@EnableScheduling  // 开启定时功能的注解

2、在service文件夹下创建AsyncService类

@Service
public class ScheduledService {
    // 在特定的时间执行这个方法~  Timer
    // cron 表达式(不会的可以上网上查找，都是的)
    // 秒 分 时 日 月 周几~
    /*
            30 09 22 * * ?    每天22点09分30秒 执行一次
            30 0/5 10,18 * * ？ 每天10点和18点，每隔五分钟执行一次
            0 15 10 ？ * 1-6    每个月的周一到周六 10.15分钟执行一次
    */
    @Scheduled(cron = "30 09 22 * * ?")
    public void hello(){
        System.out.println("hello,你被执行了~");
    }
}