Soul源码解析（12）-Soul网关SpringCloud插件源码分析

最新推荐文章于 2021-08-06 17:06:41 发布

Kminjava

最新推荐文章于 2021-08-06 17:06:41 发布

阅读量165

点赞数

分类专栏： Soul网关文章标签： java spring 网关 spring cloud

本文链接：https://blog.csdn.net/qq_38314459/article/details/113309322

版权

Soul网关专栏收录该内容

19 篇文章 2 订阅

订阅专栏

一、目标

分析SpringCloud插件源码，理清插件的设计思路和运作原理。

二、内容

上一节内容，我们一起体验了Soul网关SpringCloud插件的使用。这一节内容，就让我们一起来看一下SpringCloud插件。

2.1 springCloud 服务注册到网关

先看 SoulSpringCloudClientConfiguration，这是Soul网关SpringCloud插件的配置类

@Configuration
public class SoulSpringCloudClientConfiguration {
    
   //SpringCloud客户端bean后处理器
    @Bean
    public SpringCloudClientBeanPostProcessor springCloudClientBeanPostProcessor(final SoulSpringCloudConfig soulSpringCloudConfig, final Environment env) {
        return new SpringCloudClientBeanPostProcessor(soulSpringCloudConfig, env);
    }
	//Context寄存器监听
    @Bean
    public ContextRegisterListener contextRegisterListener(final SoulSpringCloudConfig soulSpringCloudConfig, final Environment env) {
        return new ContextRegisterListener(soulSpringCloudConfig, env);
    }
    
    //soul网关配置类，负责加载服务配置文件关于soul-admin注册url等相关信息
    @Bean
    @ConfigurationProperties(prefix = "soul.springcloud")
    public SoulSpringCloudConfig soulSpringCloudConfig() {
        return new SoulSpringCloudConfig();
    }
}

2.1.1 springCloudClientBeanPostProcessor方法解析

在soulSpringCloudConfig加载完成之后，会注入到上面的springCloudClientBeanPostProcessor方法中：

 @Bean
    public SpringCloudClientBeanPostProcessor springCloudClientBeanPostProcessor(final SoulSpringCloudConfig soulSpringCloudConfig, final Environment env) {
        return new SpringCloudClientBeanPostProcessor(soulSpringCloudConfig, env);
    }

接下来看一下SpringCloudClientBeanPostProcessor这个类，这个类实现了Spring里面的BeanPostProcessor接口，重写了postProcessAfterInitialization方法。

postProcessAfterInitialization方法：在任何bean初始化回调之后，将此BeanPostProcessor应用于给定的新bean实例。bean将已经被属性值填充。返回的bean实例可能是原始bean的包装器。

对于FactoryBean，将为FactoryBean实例和FactoryBean创建的对象调用此回调（从Spring2.0开始）。后处理器可以通过相应的FactoryBean检查bean实例来决定是应用于FactoryBean还是应用于创建的对象，或者两者都应用。

实例化aw触发短路后，也将调用此回调areBeanPostProcessor.postProcessBeforeInstantiation方法；

里面的核心处理方法如下，会去调用RegisterUtils.doRegister()方法。postProcessBeforeInstantiation方法会扫描带有SoulSpringCloudClient注解的方法，之后发起真正的注册。

...
SoulSpringCloudClient clazzAnnotation = AnnotationUtils.findAnnotation(bean.getClass(), SoulSpringCloudClient.class);
            if (Objects.nonNull(clazzAnnotation)) {
                if (clazzAnnotation.path().indexOf("*") > 1) {
                    String finalPrePath = prePath;
                    executorService.execute(() -> RegisterUtils.doRegister(buildJsonParams(clazzAnnotation, finalPrePath), url,
                            RpcTypeEnum.SPRING_CLOUD));
                    return bean;
                }
                prePath = clazzAnnotation.path();
            }
...

RegisterUtils.doRegister()方法如下，将之前组装的相关配置信息传递给soul-admin，该类方法是所有插件客户端的通用注册方法

public static void doRegister(final String json, final String url, final RpcTypeEnum rpcTypeEnum) {
        try {
            String result = OkHttpTools.getInstance().post(url, json);
            if (AdminConstants.SUCCESS.equals(result)) {
                log.info("{} client register success: {} ", rpcTypeEnum.getName(), json);
            } else {
                log.error("{} client register error: {} ", rpcTypeEnum.getName(), json);
            }
        } catch (IOException e) {
            log.error("cannot register soul admin param, url: {}, request body: {}", url, json, e);
        }
    }

buildJsonParams()方法如下，组成json格式的参数：

private String buildJsonParams(final SoulSpringCloudClient soulSpringCloudClient, final String prePath) {
        String contextPath = config.getContextPath();
        String appName = env.getProperty("spring.application.name");
        String path = contextPath + prePath + soulSpringCloudClient.path();
        String desc = soulSpringCloudClient.desc();
        String configRuleName = soulSpringCloudClient.ruleName();
        String ruleName = ("".equals(configRuleName)) ? path : configRuleName;
        SpringCloudRegisterDTO registerDTO = SpringCloudRegisterDTO.builder()
                .context(contextPath)
                .appName(appName)
                .path(path)
                .pathDesc(desc)
                .rpcType(soulSpringCloudClient.rpcType())
                .enabled(soulSpringCloudClient.enabled())
                .ruleName(ruleName)
                .build();
        return OkHttpTools.getInstance().getGson().toJson(registerDTO);
    }

2.1.2 contextRegisterListener

ContextRegisterListener 类实现了Spring里面的ApplicationListener接口，重写了onApplicationEvent方法：

public void onApplicationEvent(final ContextRefreshedEvent contextRefreshedEvent) {
        if (!registered.compareAndSet(false, true)) {
            return;
        }
        if (config.isFull()) {
            RegisterUtils.doRegister(buildJsonParams(), url, RpcTypeEnum.SPRING_CLOUD);
        }
    }