【自研网关系列】请求服务模块和客户端模块实现

news2024/10/6 17:17:53

🌈Yu-Gateway：：基于 Netty 构建的自研 API 网关，采用 Java 原生实现，整合 Nacos 作为注册配置中心。其设计目标是为微服务架构提供高性能、可扩展的统一入口和基础设施，承载请求路由、安全控制、流量治理等核心网关职能。

🌈项目代码地址：https://github.com/YYYUUU42/YuGateway-master

如果该项目对你有帮助，可以在 github 上点个 ⭐ 喔 🥰🥰

🌈自研网关系列：可以点开专栏，参看完整的文档

1、模块说明

2、请求服务模块

3、客户端

4、实现流程

1、模块说明

这个模块式是测试网关HTTP请求服务模块，后续需要开发过滤器链的功能，这个模块主要就是测试功能，毕竟是驴是马，还是需要拿出来溜一下才知道，网关的性能也是需要测试才知道如何的

2、请求服务模块

主要就是 controller 层发送请求，里面核心的是 @ApiService 和 @ApiInvoker 注解，在客户端实现

/**
 * @author yu
 * @date 2024-04-14
 */
@RestController
@ApiService(serviceId = "backend-http-server", protocol = ApiProtocol.HTTP, patternPath = "/http-server/**")
@Slf4j
public class HttpController {

	@Autowired
	private ApiProperties apiProperties;

	@ApiInvoker(path = "/http-server/ping")
	@GetMapping("/http-server/ping")
	public String ping() {
		log.info("{}", apiProperties);
		return "pong";
	}
}

3、客户端

主要类说明

ApiAnnotationScanner 是注解扫描类，扫描 ApiService、ApiInvoker 注解

ApiClientAutoConfiguration：自动装配

AbstractClientRegisterManager：抽象客户端注册管理器，支持多种协议，方便后续扩展

SpringMVCClientRegisterManager：SpringMVC 客户端注册管理器

4、实现流程

这里依旧用 debug 的方式来讲解流程，总体的执行流程如下

1、Spring Boot应用启动，读取 META-INF/spring.factories文件，查找所有的自动配置类。在您的项目中，spring.factories文件指定了ApiClientAutoConfiguration作为自动配置类。

2、Spring Boot创建并初始化 ApiClientAutoConfiguration 类。在ApiClientAutoConfiguration类的初始化过程中，会执行其中的 @Bean 方法，例如 springMVCClientRegisterManager()，并将其返回值注册为Spring容器中的bean。

在applicant.yml 配置文件中写入配置，将配置传入到 springMVCClientRegisterManager() 中

3、SpringMVCClientRegisterManager类的构造方法被执行，它继承了AbstractClientRegisterManager。在AbstractClientRegisterManager的构造方法中，初始化了 ApiProperties 和 RegisterCenter

这里会先父类的构造函数

public SpringMVCClientRegisterManager(ApiProperties apiProperties) {
    super(apiProperties);
}

依旧是用 spi 的方式将配置注册到 Nacos 中

protected AbstractClientRegisterManager(ApiProperties apiProperties) {
    this.apiProperties = apiProperties;
    //初始化注册中心对象
    ServiceLoader<RegisterCenter> serviceLoader = ServiceLoader.load(RegisterCenter.class);
    //获取注册中心实现 如果没有就报错
    registerCenter = serviceLoader.findFirst().orElseThrow(() -> {
        log.error("not found RegisterCenter impl");
        return new RuntimeException("not found RegisterCenter impl");
    });
    //注册中心初始化代码
    registerCenter.init(apiProperties.getRegisterAddress(), apiProperties.getEnv());
}

4、Spring Boot 继续初始化其他的 bean。如果 AbstractClientRegisterManager 有其他的初始化方法，那么这些方法将会被执行。这里没有其他的 bean，所以直接到下一步

5、当Spring Boot应用启动时，SpringMVCClientRegisterManager 的 onApplicationEvent 方法将会被调用，因为它实现了 ApplicationListener<ApplicationEvent> 接口。在 onApplicationEvent 方法中，它会检查传入的事件是否是 ApplicationStartedEvent 。如果是，那么它会调用 doRegisterSpringMvc方法，进行服务的注册。

@Override
public void onApplicationEvent(ApplicationEvent applicationEvent) {
    //监听spring启动事件
    if (applicationEvent instanceof ApplicationStartedEvent) {
        try {
            //执行具体的springmvc项目注册
            doRegisterSpringMvc();
        } catch (Exception e) {
            log.error("doRegisterSpringMvc error", e);
            throw new RuntimeException(e);
        }
        log.info("springmvc api started");
    }
}

6、在doRegisterSpringMvc方法中，首先获取所有的RequestMappingHandlerMapping，然后遍历所有的请求处理映射器，获取所有的HandlerMethod。对于每一个HandlerMethod，扫描服务得到服务定义信息，然后创建服务实例，最后调用register方法进行服务的注册。

服务的实例和定义