SpringDocConfiguration

最新推荐文章于 2025-06-09 14:24:00 发布

青春1314

最新推荐文章于 2025-06-09 14:24:00 发布

阅读量750

点赞数 8

CC 4.0 BY-SA版权

分类专栏： 010 work 文章标签： java 开发语言

本文链接：https://blog.youkuaiyun.com/qingcyb/article/details/134780570

010 work 专栏收录该内容

81 篇文章

订阅专栏

本文介绍了SpringDocConfiguration类如何在SpringBoot应用中集成Swagger，利用Nacos的DiscoveryClient动态获取服务实例的SwaggerURL，实现在API文档更新时自动注册和刷新。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

import com.alibaba.nacos.client.naming.event.InstancesChangeEvent;
import com.alibaba.nacos.common.notify.Event;
import com.alibaba.nacos.common.notify.NotifyCenter;
import com.alibaba.nacos.common.notify.listener.Subscriber;
import com.alibaba.nacos.common.utils.StringUtils;
import lombok.RequiredArgsConstructor;
import org.springdoc.core.AbstractSwaggerUiConfigProperties;
import org.springdoc.core.SwaggerUiConfigProperties;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.context.annotation.Configuration;
import java.util.Set;
import java.util.stream.Collectors;


@Configuration(proxyBeanMethods = false)
@RequiredArgsConstructor
@ConditionalOnProperty(name = "springdoc.api-docs.enabled", matchIfMissing = true)
public class SpringDocConfiguration implements InitializingBean {

   private final SwaggerUiConfigProperties swaggerUiConfigProperties;

   private final DiscoveryClient discoveryClient;

   /**
    * 在初始化后调用的方法，用于注册SwaggerDocRegister订阅器
    */
   @Override
   public void afterPropertiesSet() {
      SwaggerDocRegister swaggerDocRegister = new SwaggerDocRegister(swaggerUiConfigProperties, discoveryClient);
      // 手动调用一次，避免监听事件掉线问题
      swaggerDocRegister.onEvent(null);
      NotifyCenter.registerSubscriber(swaggerDocRegister);
   }

}

/**
 * Swagger文档注册器，继承自Subscriber<InstancesChangeEvent>
 */
@RequiredArgsConstructor
class SwaggerDocRegister extends Subscriber<InstancesChangeEvent> {

   private final SwaggerUiConfigProperties swaggerUiConfigProperties;

   private final DiscoveryClient discoveryClient;

   /**
    * 事件回调方法，处理InstancesChangeEvent事件
    * @param event 事件对象
    */
   @Override
   public void onEvent(InstancesChangeEvent event) {
      Set<AbstractSwaggerUiConfigProperties.SwaggerUrl> swaggerUrlSet = discoveryClient.getServices()
         .stream()
         .flatMap(serviceId -> discoveryClient.getInstances(serviceId).stream())
         .filter(instance -> StringUtils.isNotBlank(instance.getMetadata().get("spring-doc")))
         .map(instance -> {
            AbstractSwaggerUiConfigProperties.SwaggerUrl swaggerUrl = new AbstractSwaggerUiConfigProperties.SwaggerUrl();
            swaggerUrl.setName(instance.getServiceId());
            swaggerUrl.setUrl(String.format("/%s/v3/api-docs", instance.getMetadata().get("spring-doc")));
            return swaggerUrl;
         })
         .collect(Collectors.toSet());

      swaggerUiConfigProperties.setUrls(swaggerUrlSet);
   }

   /**
    * 订阅类型方法，返回订阅的事件类型
    * @return 订阅的事件类型
    */
   @Override
   public Class<? extends Event> subscribeType() {
      return InstancesChangeEvent.class;
   }

}