swagger

最新推荐文章于 2023-02-03 20:25:31 发布

Al_0922

最新推荐文章于 2023-02-03 20:25:31 发布

阅读量164

点赞数

分类专栏： springboot 文章标签： java

本文链接：https://blog.csdn.net/Al_0922/article/details/119255816

版权

springboot 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

1.集成swagger

swagger简介

前后端分离

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

产生的问题

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

解决方案

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

Swagger

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

2、SpringBoot集成

1.首先导入两个jar包，添加依赖

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


        <!-- 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>

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

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

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

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

3、配置Swagger

1. Swagger实例Bean是Docket，所以通过配置Docket实例来配置Swaggger。

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

2. 可以通过apiInfo()属性配置文档信息，一个docket()方法可以对应一个文档

//配置文档信息
    private ApiInfo apiInfo(){
        Contact contact = new Contact("hejinjie","https://blog.csdn.net/Al_0922?spm=1000.2115.3001.5343","hejinjie@ewell.cc");
        return new ApiInfo("swagger学习",
                "学习如何配置swagger",//描述
                "v1.0",//版本
                "https://blog.csdn.net/Al_0922?spm=1000.2115.3001.5343",//组织链接
                contact,//联系人信息
                "Apach2.0 许可",//许可
                "许可链接",//许可连接
                new ArrayList<>()//扩展
                );
    }

3. Docket 实例关联上 apiInfo()

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

4. 重启项目，访问测试 http://localhost:8080/swagger-ui.html 看下效果；

4、配置扫描接口

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

@Bean
    public Docket docket(){//配置docket以配置swagger的具体参数
   
        //apiInfo(apiInfo():docket实例关联上apiInfo
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("hejinjie")
                .select()
                //requestHandlerSelector:配置要扫描接口的方式
                //basePackage:指定要扫描的包
                //any:扫描全部
                //none:不扫描 
                //withClassAnnotation:扫描类上的注解，参数是一个注解的反射对象
                //withMethodAnnotation:扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.hejinjie.controller"))
                // 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口
				.paths(PathSelectors.ant("/kuang/**"))
                .build();
    }

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

5.配置开关Swagger

1.通过enable()方法配置是否启用swagger，如果false，则不启用，swagger就不能在浏览器中访问了
2. 如何动态配置当项目处于test、dev环境时显示swagger，处于prod时不显示？

@Bean
    public Docket docket(Environment environment){//配置docket以配置swagger的具体参数
        /*--------------动态配置项目环境----------------*/
        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev","pro");
        //获取项目的环境
        boolean b = environment.acceptsProfiles(profiles);
        System.out.println(b);

        /*-------------------------------------------------------*/
        //apiInfo(apiInfo():docket实例关联上apiInfo
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("hejinjie")
                .enable(b)//enable:是否启动swagger,如果为false表示不能在浏览器中访问。
                .select()
              
                .apis(RequestHandlerSelectors.basePackage("com.hejinjie.controller"))
                //.path():过滤什么路径
                .build();
    }

6、配置API分组

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

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

2. 重启项目查看分组
3. 如何配置多个分组？配置多个分组只需要配置多个docket即可：


    @Bean
    public Docket docket2(Environment environment){
        return new Docket(DocumentationType.SWAGGER_2).groupName("hejinjie1");
    }

    @Bean
    public Docket docket3(Environment environment){
        return new Docket(DocumentationType.SWAGGER_2).groupName("hejinjie2");
    }

    @Bean
    public Docket docket4(Environment environment){
        return new Docket(DocumentationType.SWAGGER_2).groupName("hejinjie3");
    }

    @Bean
    public Docket docket5(Environment environment){
        return new Docket(DocumentationType.SWAGGER_2).groupName("hejinjie4");
    }

    @Bean
    public Docket docket(Environment environment){//配置docket以配置swagger的具体参数
        /*--------------动态配置项目环境----------------*/
        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev","pro");
        //获取项目的环境
        boolean b = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("hejinjie")
                .enable(b)//enable:是否启动swagger,如果为false表示不能在浏览器中访问。
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hejinjie.controller"))
                //.path():过滤什么路径
                .build();
    }

7、实体配置

1. 新建一个实体类

@Data
@ApiModel("用户实体")
public class User {
    @ApiModelProperty("姓名")
    private String name;
    @ApiModelProperty("年龄")
    private int age;
    @ApiModelProperty("邮箱")
    private String email;
}

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

@PostMapping(value = "/user")
    public User user(){
        return new User();
    }

在这里插入图片描述

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

8、常用注解

在这里插入图片描述
我们也可以给请求的接口配置一些注释

    @ApiOperation("Hello控制类")
    @PostMapping("/hejinjie")
    public String hello2(@ApiParam("用户名") String username){
        return "hello"+username;
    }

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！
相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档
(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，
可以说基本就不需要人为操作了。

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

2.异步任务

1. 创建一个service包
2. 创建一个类AsyncService
异步处理还是非常常用的，比如我们在网站上发送邮件，后台会去发送邮件，此时前台会造成响应
不动，直到邮件发送完毕，响应才会成功，所以我们一般会采用多线程的方式去处理这些任务。
编写方法，假装正在处理数据，使用线程设置一些延时，模拟同步等待的情况；

@Service
public class AsyncService {
public void hello(){
try {
Thread.sleep(3000);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("数据处理中....");
}
}

3. 编写controller包
4. 编写AsyncController类
我们去写一个Controller测试一下

@RestController
public class AsyncController {
@Autowired
AsyncService asyncService;
@GetMapping("/hello")
public String hello(){
asyncService.hello();
return "success";
}
}

5. 访问http://localhost:8080/hello进行测试，3秒后出现success，这是同步等待的情况。

问题：我们如果想让用户直接得到消息，就在后台使用多线程的方式进行处理即可，但是每次都需
要自己手动去编写多线程的实现的话，太麻烦了，我们只需要用一个简单的办法，在我们的方法上
加一个简单的注解即可，如下：

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

SpringBoot就会自己开一个线程池，进行调用！但是要让这个注解生效，我们还需要在主程序上添
加一个注解@EnableAsync ，开启异步注解功能；

@EnableAsync //开启异步注解功能
@SpringBootApplication
public class SpringbootTaskApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootTaskApplication.class, args);
}
}

定时任务

。。。

Al_0922

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
swagger

1.集成swaggerswagger简介前后端分离前端 -> 前端控制层、视图层后端 -> 后端控制层、服务层、数据访问层前后端通过API进行交互前后端相对独立且松耦合产生的问题前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发解决方案首先定义schema [ 计划的提纲 ]，并实时跟踪最新的API，降低集成风险Swagger号称世界上最流行的API框架Restful Api 文档在线自动生成器 => API 文档与A
复制链接

扫一扫