WebFlux整合MongoDB+WebFlux集成swagger2

MongoDB是一个基于分布式文件存储的数据库。由C++语言编写。旨在为WEB应用提供可扩展的高性能数据存储解决方案。它的特点是高性能、易部署、易使用，存储数据非常方便。MongoDB服务端可运行在Linux、Windows或mac os x平台，支持32位和64位应用，默认端口为27017。下载地址：MongoDB官网下载，官方文档：MongoDB中文网

MongoDB在Sringboot中的应用：Webflux+MongoDB整合，搭建项目需要引入依赖包如下：

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-mongodb-reactive</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-webflux</artifactId>
		</dependency>

webmvc和webflux比较：
webmvc和webflux作为spring framework的两个重要模块，代表了两个IO模型，阻塞式和非阻塞式。
1.webmvc是基于servlet的阻塞式模型（一般称为oio），一个请求到达服务器后会单独分配一个线程去处理请求，如果请求包含IO操作，线程在IO操作结束之前一直处于阻塞等待状态，这样线程在等待IO操作结束的时间就浪费了。
2.webflux是基于reactor的非阻塞模型(一般称为nio)，同样，请求到达服务器后也会分配一个线程去处理请求，如果请求包含IO操作，线程在IO操作结束之前不再是处于阻塞等待状态，而是去处理其他事情，等到IO操作结束之后，再通知（得益于系统的机制）线程继续处理请求。

application.properties文件的mongodb连接配置

# MongoDB连接URI
spring.data.mongodb.host=localhost
# MongoDB连接用户名
spring.data.mongodb.username=demo
# MongoDB连接密码
spring.data.mongodb.password=123456
# MongoDB端口号
spring.data.mongodb.port=27017
# MongoDB数据库名称
spring.data.mongodb.database=mongoDB
#springboot应用端口号
server.port=8090
#springboot应用名称
spring.application.name=fluxSystem

Springboot启动类代码如下：

@EnableWebFlux
@SpringBootApplication(scanBasePackages="com.webflux")
//启动WebFlux中MongoDB的JPA接口
@EnableReactiveMongoRepositories(basePackages="com.webflux.persistence.repo")
public class InitApplication  {
    public static void main(String[] args) {
        SpringApplication.run(InitApplication.class, args);
    }
}

响应式编程特点：
（1）响应式编程操作中，Reactor 是满足 Reactive 规范框架
（2）Reactor 有两个核心类，Mono 和 Flux，这两个类实现接口 Publisher（发布者），提供丰富操作符。
Flux 对象实现发布者，返回 N 个元素；
Mono 实现发布者，返回 0 或者 1 个元素
（3）Flux 和 Mono 都是数据流的发布者，使用 Flux 和 Mono 都可以发出三种数据信号：
元素值，错误信号，完成信号，错误信号和完成信号都代表终止信号，终止信号用于告诉
订阅者数据流结束了，错误信号终止数据流同时把错误信息传递给订阅者

Webflux整合MongoDB使用的就是响应式编程，它的底层使用的是JPA规范的hibernate框架，我们在使用dao层时需要继承ReactiveMongoRepository类，它的所有方法最终是继承至ReactiveCrudRepository，它们之间的继承关系如下图：

打开ReactiveCrudRepository这个类，我们就会发现很多数据库操作方法都写在这里，如果我们要自定义查询，可以按照这样写

@Repository
public interface UserRepository extends ReactiveMongoRepository<User, Long> {
	/**
     * 自定义函数名需要符合JPA命名规范
     * @param userName 用户名
     */
    public Mono<User> findByUsernameAndPassword(String username,String password);
}

JPA命名规范：find表示查询，findBy+字段名首字母大写，and表示多条件查询,Like 表示模糊查询，NotEquals表示 !=，NotLike 表示 not like 等等。如需要排序则使用OrderBy+字段名首字母大写+Desc
服务端controller层代码：

@RestController 
public class UserController {
		@PostMapping("/user/login/{username}/{password}")
	public Mono<UserVo> findByUserName(@PathVariable String username,@PathVariable String password)
	{
		return userService.login(username,password).map(u -> translate(u));
	}
	//分布式调用需要把持久层对象User转控制层对象UserVo
	private UserVo translate(User user) {
		UserVo userVo = new UserVo();
		userVo.setUsername(user.getUsername());
		userVo.setPassword(user.getPassword());
		userVo.setId(user.getId());
		return userVo;
	}
}

下面开始WebFlux集成Swagger2
webflux集成swagger2至少需要3.0.0以上版本，依赖添加如下：

    <properties>
        <swagger.version>3.0.0</swagger.version>
    </properties>
<!-- webflux集成swagger -->
		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-boot-starter</artifactId>
			<version>${swagger.version}</version>
		</dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-spring-webflux</artifactId>
            <version>${swagger.version}</version>
        </dependency>

需要有swagger配置，并开启@EnableOpenApi注解

@EnableOpenApi
@Configuration
public class SwaggerConfig
{
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.webflux.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数
    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder()
                //页面标题
                .title("WebFlux整合MongoDB框架搭建")
                //描述
                .description("WebFlux整合MongoDB")
                //条款地址
                .termsOfServiceUrl("https://blog.csdn.net/")
                //联系地址
                .contact(new Contact("csdn的博客", "https://blog.csdn.net/qq_43248715/article/details/127423499", ""))
                .version("1.0")
                .build();
    }
}

webflux配置文件中需要添加swagger路径代码：

@Configuration
@EnableWebFlux
public class WebfluxConfig implements  WebFluxConfigurer{

	@Override
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
		// TODO Auto-generated method stub
		registry.addResourceHandler("/swagger-ui/**")
        .addResourceLocations("classpath:/META-INF/resources/webjars/springfox-swagger-ui/")
        .resourceChain(false);
	}
}

每个control层使用@Tag注解标注接口内容和描述，方法名上使用@Operation注解标注方法接口名

@Tag(description = "用户管理接口",name = "用户管理")
@RestController
@RequestMapping("/user")
public class UserController {
	@Autowired
	private UserService userService;

    @Operation(description = "用户登录接口")
    @PostMapping("/login/{username}/{password}")
	public Mono<UserVo> findByUserName(@PathVariable String username,@PathVariable String password)
	{
		... ...
	}

打开浏览器swagger首页

进入swagger标注的Controller的方法中，点击Execute进行测试，如下图：

测试结果如下图：

Code返回200表示返回正常，测试成功！！
以上是webflux整合mongoDB+webflux集成Swagger2的全部内容，希望大家有所收获，然后点个赞，加个关注