Spring WebFlux 工作原理分析 - 1.准备例子项目

概述

本系列文章用来分析Spring WebFlux的工作原理，这是第一篇。在这篇文章中，我们参考Spring官方教程构建一个基于Spring Boot的WebFlux例子应用，用于随后的原理分析。

这里构建例子项目所参考的Spring教程是:Building a Reactive RESTful Web Service。该文档中提到了使用gradle,maven,IDE三种构架该项目的方式，这里我们采用了maven这种方式。该项目主要包含如下文件 :

1. pom.xml – maven项目文件
2. practice.webflux.Application – java文件，Spring Boot应用入口程序
3. practice.webflux.GreetingHandler – java文件，基于WebFlux的请求处理组件
4. practice.webflux.GreetingRouter – java文件，路由配置,配置URL pattern和请求处理组件GreetingHandler的映射关系

编译打包并运行该项目应用 :

mvn clean package
java -jar target\webflux-1.0-SNAPSHOT.jar

效果如下 :

1. 应用作为一个Web服务启动，使用服务端口8080;
2. 通过浏览器访问http://localhost:8080/hello得到响应Hello, Spring!。

该系列文章将基于以上例子，主要分析如下两个过程 :

1. 应用程序启动过程
2. 请求处理过程

通过以上分析，我们将主要解答以下问题 :

1. 路由配置何时被加载 ?
2. 请求如何被处理 ?
   1. 请求参数解析过程是怎样的 ？
   2. 返回值是如何写入到响应的 ?

例子项目的源代码

1. pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>practice</groupId>
    <artifactId>webflux</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-webflux</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>io.projectreactor</groupId>
            <artifactId>reactor-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2. Application.java

package practice.webflux;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;


@SpringBootApplication
public class Application {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}

3. GreetingHandler.java

package practice.webflux;

import org.springframework.http.MediaType;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import reactor.core.publisher.Mono;


@Component
public class GreetingHandler {

    public Mono<ServerResponse> hello(ServerRequest request) {
        return ServerResponse.ok().contentType(MediaType.TEXT_PLAIN)
                .body(BodyInserters.fromObject("Hello, Spring!"));
    }
}

4. GreetingRouter.java

package practice.webflux;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.web.reactive.function.server.RequestPredicates;
import org.springframework.web.reactive.function.server.RouterFunction;
import org.springframework.web.reactive.function.server.RouterFunctions;
import org.springframework.web.reactive.function.server.ServerResponse;


@Configuration
public class GreetingRouter {

    @Bean
    public RouterFunction<ServerResponse> route(GreetingHandler greetingHandler) {
        return RouterFunctions
                .route(RequestPredicates.GET("/hello")
                .and(RequestPredicates.accept(MediaType.TEXT_PLAIN)), greetingHandler::hello);
    }
}