• SpringBoot笔记之Swagger

    Swagger

    1. Swagger

    学习目标：

    • 了解Swagger的概念及作用
    • 掌握在项目中集成Swagger自动生成API文档

    1.1 Swagger简介

    前后端分离

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

    产生的问题

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

    解决方案

    • 首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险
    • 早些年制定word计划文档
    • 前后端分离：前端测试后端接口：postman
      后端提供接口，需要实时更新最新的消息及改动！

    Swagger

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

    1.2 Springboot集成Swagger

    SpringBoot集成Swagger => springfox，两个jar包

    • Springfox-swagger2
    • swagger-springmvc

    使用Swagger

    要求：jdk 1.8+ 否则swagger2无法运行

    步骤：

    1. 新建一个SpringBoot-web项目

    2. 添加Maven依赖

      
<dependency>
   <groupId>io.springfoxgroupId>
   <artifactId>springfox-swagger2artifactId>
   <version>2.9.2version>
dependency>

<dependency>
   <groupId>io.springfoxgroupId>
   <artifactId>springfox-swagger-uiartifactId>
   <version>2.9.2version>
dependency>

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12

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

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

      @Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

      • 1
      • 2
      • 3
      • 4

    5. 访问测试 ：http://localhost:8080/swagger-ui.html ，可以看到swagger的界面；
      在这里插入图片描述
      注意：
      如果启动报错：

       Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException

      • 1

      在application.yml添加：

      spring.mvc.pathmatch.matching-strategy: ANT_PATH_MATCHER

      • 1

    1.2.2 配置Swagger

    1. Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swagger，通过Docket对象接管了原来默认的配置

      @Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

      • 1
      • 2
      • 3
      • 4

    2. 可以通过apiInfo()属性配置文档信息

      //配置文档信息
 private ApiInfo apiInfo(){
    Contact contact = new Contact("联系人姓名", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
    return new ApiInfo(
            "Swagger学习",                          // 标题
            "学习演示如何配置Swagger",               // 描述
            "v1.0",                                // 版本
            "http://terms.service.url/组织链接",    // 组织链接
            contact,                               // 联系人信息
            "Apache 2.0 许可",                     // 许可
            "许可链接",                            // 许可连接
            new ArrayList<>()                     // 扩展
    );
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14

    3. Docket 实例关联上 apiInfo()

      @Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

      • 1
      • 2
      • 3
      • 4

    4. 测试运行 在这里插入图片描述

    1.2.3 配置扫描接口

    1. 构建Docket时通过select()方法配置怎么扫描接口。

      @Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.xawl.controller"))
      .build();
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8

    2. 重启项目测试，由于我们配置根据包的路径扫描接口，所以我们只能看到一个类

      在这里插入图片描述

    3. 除了通过包路径配置扫描接口外，还可以通过配置其他方式扫描接口

      //都是RequestHandlerSelectors下的方法
any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描，如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描，如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口
paths(PathSelectors.ant("/xawl/**"))  //过滤什么路径：过滤/xawl下的所有路径

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9

    4. 除此之外，我们还可以配置接口扫描过滤

      @Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.xawl.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/user开头的接口
      .paths(PathSelectors.ant("/user/**"))
      .build();
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10

    5. PathSelectors的可选值

      any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

      • 1
      • 2
      • 3
      • 4

    1.2.4 配置Swagger开关

    可以指定相应的环境是否开启swagger功能

    1. 通过enable()方法配置是否启用swagger，如果是false，swagger将不能在浏览器中访问了

      @Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11

    2. 动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

      @Bean
public Docket docket(Environment environment) {
   // 设置要显示swagger的环境
   Profiles of = Profiles.of("dev", "test");
   // 判断当前是否处于该环境
   // 通过 enable() 接收此参数判断是否要显示
   boolean flag = environment.acceptsProfiles(of);
   
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(flag) //配置是否启用Swagger，如果是false，在浏览器将无法访问
      .select()// 通过.select()方法，去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
      .paths(PathSelectors.ant("/kuang/**"))
      .build();
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14
      • 15
      • 16
      • 17

    3. 可以在项目中增加一个dev的配置文件查看效果！

    1.2.5 配置API分组

    1. 如果没有配置分组，默认是default。通过groupName()方法即可配置分组：

      @Bean
public Docket docket(Environment environment) {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
      .groupName("hello") // 配置分组
       // 省略配置....
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6

    2. 重启项目查看分组
      在这里插入图片描述

    3. 如何配置多个分组？配置多个分组只需要配置多个docket即可：

      @Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12

    4. 重启项目查看即可
      在这里插入图片描述

    1.2.6 实体配置

    1. 新建一个实体类

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

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7

    2. 只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

      @RequestMapping("/getUser")
public User getUser(){
   return new User();
}

      • 1
      • 2
      • 3
      • 4

    3. 重启查看测试
      在这里插入图片描述

      注：并不是因为@ApiModel这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而@ApiModel和@ApiModelProperty这两个注解只是为实体添加注释的。

      @ApiModel: 为类添加注释

      @ApiModelProperty: 为类属性添加注释

    1.3 常用注解

    Swagger的所有注解定义在io.swagger.annotations包下

    常用注解：

    Swagger注解简单说明
    @Api(tags = “xxx模块说明”)作用在模块类上
    @ApiOperation(“xxx接口说明”)作用在接口方法上
    @ApiModel(“xxxPOJO说明”)作用在模型类上：如VO、BO
    @ApiModelProperty(value = “xxx属性说明”,hidden = true)作用在类方法和属性上，hidden属性为true可以隐藏该属性
    @ApiParam(“xxx参数说明”)作用在参数、方法和字段上，类似@ApiModelProperty

    我们也可以给请求的接口配置一些注释

    @ApiOperation("这是一个接口")
@PostMapping("/guo")
@ResponseBody
public String guo(@ApiParam("这个名字会被返回")String username){
   return username;
}

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6

    这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

    相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

    Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑 二来也可以节省运行时内存。

    总结：

    1. 给swagger中添加注释
    2. 修改页面的标题等内容
    3. 简单的操作一些请求测试

    2. 任务

    2.1 异步任务

    所谓异步，在某些功能实现时可能要花费一定的时间，但是为了不影响客户端的体验，选择异步执行

    案例：

    1. 首先创建一个service：

      @Service
public class AsyncService {

    public void hello(){
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("数据正在传输...");
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12

    2. Controller:

      @RestController
public class AsyncController {

    @Autowired
    AsyncService asyncService;

    @RequestMapping("/async")
    public String async(){
        asyncService.hello();
        return "ok";
    }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12

      这样在执行/async请求时，网站会延时三秒再显示ok，后台数据也会三秒后显示数据正在传输

      在这里插入图片描述

    想要做到前端快速响应我们的页面，后台去慢慢的传输数据，就要用到springboot自带的功能

    1. 想办法告诉spring我们的异步方法是异步的，所以要在方法上添加注解

          @Async
    public void hello(){
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("数据正在传输...");
    }

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9

    2. 去springboot主程序中开启异步注解功能

      @EnableAsync
@SpringBootApplication
public class SwaggerDemoApplication {

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

}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9

    3. 重启即可

    2.2 邮件任务

    邮件发送，在我们的日常开发中，也非常的多，Springboot也帮我们做了支持

    • 邮件发送需要引入spring-boot-start-mail
    • SpringBoot 自动配置MailSenderAutoConfiguration
    • 定义MailProperties内容，配置在application.yml中
    • 自动装配JavaMailSender
    • 测试邮件发送

    测试：

    1. 引入pom依赖

      <dependency>
   <groupId>org.springframework.bootgroupId>
   <artifactId>spring-boot-starter-mailartifactId>
dependency>

      • 1
      • 2
      • 3
      • 4

      看它引入的依赖，可以看到 jakarta.mail

      <dependency>
   <groupId>com.sun.mailgroupId>
   <artifactId>jakarta.mailartifactId>
   <version>1.6.4version>
   <scope>compilescope>
dependency>

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6

    2. 查看自动配置类：MailSenderAutoConfiguration

      在这里插入图片描述

      ok我们点进去，看到里面存在bean，JavaMailSenderImpl
      在这里插入图片描述

      然后我们去看下配置文件

      @ConfigurationProperties(
   prefix = "spring.mail"
)
public class MailProperties {
   private static final Charset DEFAULT_CHARSET;
   private String host;
   private Integer port;
   private String username;
   private String password;
   private String protocol = "smtp";
   private Charset defaultEncoding;
   private Map<String, String> properties;
   private String jndiName;
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14

    3. 配置文件：

      spring.mail.username=你的邮箱
spring.mail.password=你的邮箱授权码
spring.mail.host=smtp.163.com
# qq需要配置ssl，其他邮箱不需要
spring.mail.properties.mail.smtp.ssl.enable=true

      • 1
      • 2
      • 3
      • 4
      • 5

      首先你需要去邮箱网站开启POP3/SMTP

      qq邮箱->设置->账户
      在这里插入图片描述

    4. Spring单元测试

      @SpringBootTest
class SwaggerDemoApplicationTests {

    @Autowired
    JavaMailSenderImpl mailSender;

    @Test
    public void contextLoads() {
        //邮件设置1：一个简单的邮件
        SimpleMailMessage message = new SimpleMailMessage();
        message.setSubject("这是一个测试邮件发送标题");
        message.setText("这是一个测试邮件发送内容");

        message.setTo("1873172950@qq.com");
        message.setFrom("1873172950@qq.com");
        mailSender.send(message);
    }
    
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14
      • 15
      • 16
      • 17
      • 18
      • 19

      发送一个较为复杂的邮件：

      @Test
public void contextLoads2() throws MessagingException {
   //邮件设置2：一个复杂的邮件
   MimeMessage mimeMessage = mailSender.createMimeMessage();
   MimeMessageHelper helper = new MimeMessageHelper(mimeMessage, true);

   helper.setSubject("通知-明天来开班会");
   helper.setText("今天 7:30来开会",true);

   //发送附件
   helper.addAttachment("1.jpg",new File("绝对路径地址"));
   helper.addAttachment("2.jpg",new File(""));

   helper.setTo("1873172950@qq.com");
   helper.setFrom("1873172950@qq.com");

   mailSender.send(mimeMessage);
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14
      • 15
      • 16
      • 17
      • 18

    5. 配置文件 application.yml

      server:
  port: 8081
spring.mvc.pathmatch.matching-strategy: ANT_PATH_MATCHER
spring:
  mail:
    username: 1873172950@qq.com
    password: yanvypbjwqqbcjjf # 这个为开启pop3服务时的密码
    host: smtp.qq.com
# 开启加密验证
# spring.mail.properties.mail.stmp.ssl.enable: true

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10

      查看邮箱，邮件接收成功！

      我们只需要使用Thymeleaf进行前后端结合即可开发自己网站邮件收发功能了！

    2.3 定时任务

    项目开发中经常需要执行一些定时任务，比如需要在每天凌晨的时候，分析一次前一天的日志信息，Spring为我们提供了异步执行任务调度的方式，提供了两个接口。

    • TaskExecutor接口
    • TaskScheduler接口

    两个注解：

    • @EnableScheduling
    • @Scheduled

    cron表达式：
    在这里插入图片描述
    在这里插入图片描述

    测试步骤：

    1. 创建一个ScheduledService

      我们里面存在一个hello方法，他需要定时执行，怎么处理呢？

      @Service
public class ScheduledService {
   
   //秒   分   时     日   月   周几
   //0 * * * * MON-FRI
   //注意cron表达式的用法；
   @Scheduled(cron = "0 * * * * 0-7")
   public void hello(){
       System.out.println("hello.....");
  }
}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11

    2. 这里写完定时任务之后，我们需要在主程序上增加@EnableScheduling 开启定时任务功能

      @EnableAsync //开启异步注解功能
@EnableScheduling //开启基于注解的定时任务
@SpringBootApplication
public class SpringbootTaskApplication {

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

}

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10

    3. 我们来详细了解下cron表达式；

      cron表达式

    4. 常用表达式

      （1）0/2 * * * * ?   表示每2秒 执行任务
（1）0 0/2 * * * ?   表示每2分钟 执行任务
（1）0 0 2 1 * ?   表示在每月的1日的凌晨2点调整任务
（2）0 15 10 ? * MON-FRI   表示周一到周五每天上午10:15执行作业
（3）0 15 10 ? 6L 2002-2006   表示2002-2006年的每个月的最后一个星期五上午10:15执行作
（4）0 0 10,14,16 * * ?   每天上午10点，下午2点，4点
（5）0 0/30 9-17 * * ?   朝九晚五工作时间内每半小时
（6）0 0 12 ? * WED   表示每个星期三中午12点
（7）0 0 12 * * ?   每天中午12点触发
（8）0 15 10 ? * *   每天上午10:15触发
（9）0 15 10 * * ?     每天上午10:15触发
（10）0 15 10 * * ?   每天上午10:15触发
（11）0 15 10 * * ? 2005   2005年的每天上午10:15触发
（12）0 * 14 * * ?     在每天下午2点到下午2:59期间的每1分钟触发
（13）0 0/5 14 * * ?   在每天下午2点到下午2:55期间的每5分钟触发
（14）0 0/5 14,18 * * ?     在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
（15）0 0-5 14 * * ?   在每天下午2点到下午2:05期间的每1分钟触发
（16）0 10,44 14 ? 3 WED   每年三月的星期三的下午2:10和2:44触发
（17）0 15 10 ? * MON-FRI   周一至周五的上午10:15触发
（18）0 15 10 15 * ?   每月15日上午10:15触发
（19）0 15 10 L * ?   每月最后一日的上午10:15触发
（20）0 15 10 ? * 6L   每月的最后一个星期五上午10:15触发
（21）0 15 10 ? * 6L 2002-2005   2002年至2005年的每月的最后一个星期五上午10:15触发
（22）0 15 10 ? * 6#3   每月的第三个星期五上午10:15触发

      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 7
      • 8
      • 9
      • 10
      • 11
      • 12
      • 13
      • 14
      • 15
      • 16
      • 17
      • 18
      • 19
      • 20
      • 21
      • 22
      • 23
      • 24
  • 相关阅读:
    【SQLite】环境安装
    51单片机仿真软件 Proteus 8 Pro 安装步骤
    腾讯Coding的持续部署模块的使用。
    基于JSP的民宿酒店预约管理系统【数据库设计、源码、开题报告】
    【CSS】画个三角形或圆形或环
    【vue3】：Excel导入导出解决方案
    TLSF——一种高效的内存池实现
    前后端分离的项目——图书管理系统（下）
    在springboot中整合mybatis配置流程！
    对象的构造和析构
  • 原文地址：https://blog.csdn.net/qq_45609369/article/details/126399736