feat:add swagger report switch.

Tencent · Sep 26, 2023 · e11117f · e11117f
1 parent 2dac395
commit e11117f
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 29 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,3 +8,4 @@
 - [feat:support service contract reporting.](https://github.com/Tencent/spring-cloud-tencent/pull/1135)
 - [feat: support log path configuration parameters.](https://github.com/Tencent/spring-cloud-tencent/pull/1143)
 - [feat:add swagger exposure filters.](https://github.com/Tencent/spring-cloud-tencent/pull/1144)
+- [feat:add swagger report switch.](https://github.com/Tencent/spring-cloud-tencent/pull/1147)
diff --git a/...is-contract/src/main/java/com/tencent/cloud/polaris/contract/PolarisContractReporter.java b/...is-contract/src/main/java/com/tencent/cloud/polaris/contract/PolarisContractReporter.java
@@ -24,6 +24,7 @@
 
 import com.tencent.cloud.common.util.JacksonUtils;
 import com.tencent.cloud.polaris.PolarisDiscoveryProperties;
+import com.tencent.cloud.polaris.contract.config.PolarisContractProperties;
 import com.tencent.polaris.api.core.ProviderAPI;
 import com.tencent.polaris.api.plugin.server.InterfaceDescriptor;
 import com.tencent.polaris.api.plugin.server.ReportServiceContractRequest;
@@ -53,52 +54,54 @@ public class PolarisContractReporter implements ApplicationListener<ApplicationR
 	private final Logger LOG = LoggerFactory.getLogger(PolarisContractReporter.class);
 	private final ServiceModelToSwagger2Mapper swagger2Mapper;
 	private final DocumentationCache documentationCache;
-	private final String groupName;
+	private final PolarisContractProperties polarisContractProperties;
 
 	private final ProviderAPI providerAPI;
 
 	private final PolarisDiscoveryProperties polarisDiscoveryProperties;
 
 	public PolarisContractReporter(DocumentationCache documentationCache, ServiceModelToSwagger2Mapper swagger2Mapper,
-			String groupName, ProviderAPI providerAPI, PolarisDiscoveryProperties polarisDiscoveryProperties) {
+			PolarisContractProperties polarisContractProperties, ProviderAPI providerAPI, PolarisDiscoveryProperties polarisDiscoveryProperties) {
 		this.swagger2Mapper = swagger2Mapper;
 		this.documentationCache = documentationCache;
-		this.groupName = groupName;
+		this.polarisContractProperties = polarisContractProperties;
 		this.providerAPI = providerAPI;
 		this.polarisDiscoveryProperties = polarisDiscoveryProperties;
 	}
 
 	@Override
 	public void onApplicationEvent(@NonNull ApplicationReadyEvent applicationReadyEvent) {
-		try {
-			Documentation documentation = documentationCache.documentationByGroup(groupName);
-			Swagger swagger = swagger2Mapper.mapDocumentation(documentation);
-			if (swagger != null) {
-				ReportServiceContractRequest request = new ReportServiceContractRequest();
-				request.setName(polarisDiscoveryProperties.getService());
-				request.setNamespace(polarisDiscoveryProperties.getNamespace());
-				request.setService(polarisDiscoveryProperties.getService());
-				request.setProtocol("http");
-				request.setVersion(polarisDiscoveryProperties.getVersion());
-				List<InterfaceDescriptor> interfaceDescriptorList = getInterfaceDescriptorFromSwagger(swagger);
-				request.setInterfaceDescriptors(interfaceDescriptorList);
-				ReportServiceContractResponse response = providerAPI.reportServiceContract(request);
-				LOG.info("Service contract [Namespace: {}. Name: {}. Service: {}. Protocol:{}. Version: {}. API counter: {}] is reported.",
-						request.getNamespace(), request.getName(), request.getService(), request.getProtocol(),
-						request.getVersion(), request.getInterfaceDescriptors().size());
-				if (LOG.isDebugEnabled()) {
-					String jsonValue = JacksonUtils.serialize2Json(swagger);
-					LOG.debug("OpenApi json data: {}", jsonValue);
+		if (polarisContractProperties.isReportEnabled()) {
+			try {
+				Documentation documentation = documentationCache.documentationByGroup(polarisContractProperties.getGroup());
+				Swagger swagger = swagger2Mapper.mapDocumentation(documentation);
+				if (swagger != null) {
+					ReportServiceContractRequest request = new ReportServiceContractRequest();
+					request.setName(polarisDiscoveryProperties.getService());
+					request.setNamespace(polarisDiscoveryProperties.getNamespace());
+					request.setService(polarisDiscoveryProperties.getService());
+					request.setProtocol("http");
+					request.setVersion(polarisDiscoveryProperties.getVersion());
+					List<InterfaceDescriptor> interfaceDescriptorList = getInterfaceDescriptorFromSwagger(swagger);
+					request.setInterfaceDescriptors(interfaceDescriptorList);
+					ReportServiceContractResponse response = providerAPI.reportServiceContract(request);
+					LOG.info("Service contract [Namespace: {}. Name: {}. Service: {}. Protocol:{}. Version: {}. API counter: {}] is reported.",
+							request.getNamespace(), request.getName(), request.getService(), request.getProtocol(),
+							request.getVersion(), request.getInterfaceDescriptors().size());
+					if (LOG.isDebugEnabled()) {
+						String jsonValue = JacksonUtils.serialize2Json(swagger);
+						LOG.debug("OpenApi json data: {}", jsonValue);
+					}
+				}
+				else {
+					LOG.warn("Swagger or json is null, documentationCache keys:{}, group:{}", documentationCache.all()
+							.keySet(), polarisContractProperties.getGroup());
 				}
 			}
-			else {
-				LOG.warn("Swagger or json is null, documentationCache keys:{}, group:{}", documentationCache.all()
-						.keySet(), groupName);
+			catch (Throwable t) {
+				LOG.error("Report contract failed.", t);
 			}
 		}
-		catch (Throwable t) {
-			LOG.error("Report contract failed.", t);
-		}
 	}
 
 	private List<InterfaceDescriptor> getInterfaceDescriptorFromSwagger(Swagger swagger) {

diff --git a/...-contract/src/main/java/com/tencent/cloud/polaris/contract/config/ContractProperties.java b/...-contract/src/main/java/com/tencent/cloud/polaris/contract/config/ContractProperties.java
@@ -47,4 +47,8 @@ public interface ContractProperties {
 	boolean isExposure();
 
 	void setExposure(boolean exposure);
+
+	boolean isReportEnabled();
+
+	void setReportEnabled(boolean reportEnabled);
 }
diff --git a/...ct/src/main/java/com/tencent/cloud/polaris/contract/config/PolarisContractProperties.java b/...ct/src/main/java/com/tencent/cloud/polaris/contract/config/PolarisContractProperties.java
@@ -21,6 +21,7 @@
 
 import javax.annotation.Nullable;
 
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
@@ -53,6 +54,9 @@ public class PolarisContractProperties implements ContractProperties {
 
 	private boolean exposure = true;
 
+	@Value("${spring.cloud.polaris.contract.report.enabled:true}")
+	private boolean reportEnabled = true;
+
 	public PolarisContractProperties(@Nullable ExtendedContractProperties extendContractProperties) {
 		this.extendContractProperties = extendContractProperties;
 	}
@@ -134,4 +138,14 @@ public boolean isExposure() {
 	public void setExposure(boolean exposure) {
 		this.exposure = exposure;
 	}
+
+	@Override
+	public boolean isReportEnabled() {
+		return reportEnabled;
+	}
+
+	@Override
+	public void setReportEnabled(boolean reportEnabled) {
+		this.reportEnabled = reportEnabled;
+	}
 }
diff --git a/.../main/java/com/tencent/cloud/polaris/contract/config/PolarisSwaggerAutoConfiguration.java b/.../main/java/com/tencent/cloud/polaris/contract/config/PolarisSwaggerAutoConfiguration.java
@@ -121,7 +121,7 @@ public Docket polarisDocket(PolarisContractProperties polarisContractProperties)
 	public PolarisContractReporter polarisContractReporter(DocumentationCache documentationCache,
 			ServiceModelToSwagger2Mapper swagger2Mapper, PolarisContractProperties polarisContractProperties,
 			PolarisSDKContextManager polarisSDKContextManager, PolarisDiscoveryProperties polarisDiscoveryProperties) {
-		return new PolarisContractReporter(documentationCache, swagger2Mapper, polarisContractProperties.getGroup(),
+		return new PolarisContractReporter(documentationCache, swagger2Mapper, polarisContractProperties,
 				polarisSDKContextManager.getProviderAPI(), polarisDiscoveryProperties);
 	}
 

diff --git a/...olaris-contract/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...olaris-contract/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -35,6 +35,12 @@
       "type": "java.lang.Boolean",
       "defaultValue": "true",
       "description": "Enable polaris contract exposure or not."
+    },
+    {
+      "name": "spring.cloud.polaris.contract.report.enabled",
+      "type": "java.lang.Boolean",
+      "defaultValue": "true",
+      "description": "Enable polaris contract report or not."
     }
   ]
 }
diff --git a/...mples/polaris-discovery-example/discovery-caller-service/src/main/resources/bootstrap.yml b/...mples/polaris-discovery-example/discovery-caller-service/src/main/resources/bootstrap.yml
@@ -17,6 +17,8 @@ spring:
         health-check-url: /discovery/service/caller/healthCheck
       contract:
         exposure: true
+        report:
+          enabled: false
       stat:
         enabled: true
         port: 28081