Register the service with the ProviderAPI#registerInstance method (#685)

* publish spring event named ConfigChangeSpringEvent when the configuration is changed

* update changelog

* register the service with the ProviderAPI#registerInstance method

* update changelog

* delete PolarisDiscoveryProperties#getHeartbeatEnabled

Co-authored-by: Haotian Zhang <928016560@qq.com>

CHANGELOG.md

@@ -2,4 +2,5 @@
 ---
 
 - [Optimize:optimize SpringValueProcessor.](https://github.com/Tencent/spring-cloud-tencent/pull/668)
+- [Optimize: Register the service with the ProviderAPI#registerInstance method.](https://github.com/Tencent/spring-cloud-tencent/pull/685)
 - [Optimize:optimize spring annotation.](https://github.com/Tencent/spring-cloud-tencent/pull/688)

spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/PolarisDiscoveryProperties.java

@@ -84,12 +84,6 @@ public class PolarisDiscoveryProperties {
 	@Value("${spring.cloud.polaris.discovery.register:#{true}}")
 	private Boolean registerEnabled;
 
-	/**
-	 * If heartbeat enabled.
-	 */
-	@Value("${spring.cloud.polaris.discovery.heartbeat.enabled:#{true}}")
-	private Boolean heartbeatEnabled = true;
-
 	/**
 	 * Heartbeat interval ( 0 < interval <= 60).
 	 * Time unit: second. Default: 5.
@@ -108,15 +102,6 @@ public class PolarisDiscoveryProperties {
 	 */
 	private Long serviceListRefreshInterval = 60000L;
 
-
-	public boolean isHeartbeatEnabled() {
-		return heartbeatEnabled;
-	}
-
-	public void setHeartbeatEnabled(Boolean heartbeatEnabled) {
-		this.heartbeatEnabled = heartbeatEnabled;
-	}
-
 	public String getNamespace() {
 		return namespace;
 	}
@@ -206,7 +191,7 @@ public class PolarisDiscoveryProperties {
 	}
 
 	public Integer getHeartbeatInterval() {
-		if (this.heartbeatEnabled && (this.heartbeatInterval <= 0 || this.heartbeatInterval > 60)) {
+		if (this.heartbeatInterval <= 0 || this.heartbeatInterval > 60) {
 			heartbeatInterval = DEFAULT_REGISTRY_HEARTBEAT_TIME_INTERVAL;
 		}
 		return heartbeatInterval;
@@ -228,10 +213,6 @@ public class PolarisDiscoveryProperties {
 		this.registerEnabled = registerEnabled;
 	}
 
-	public Boolean getHeartbeatEnabled() {
-		return heartbeatEnabled;
-	}
-
 	@Override
 	public String toString() {
 		return "PolarisDiscoveryProperties{" +
@@ -244,7 +225,6 @@ public class PolarisDiscoveryProperties {
 				", port=" + port +
 				", enabled=" + enabled +
 				", registerEnabled=" + registerEnabled +
-				", heartbeatEnabled=" + heartbeatEnabled +
 				", heartbeatInterval=" + heartbeatInterval +
 				", healthCheckUrl='" + healthCheckUrl + '\'' +
 				", serviceListRefreshInterval=" + serviceListRefreshInterval +

spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/registry/PolarisServiceRegistry.java

@@ -68,7 +68,7 @@ public class PolarisServiceRegistry implements ServiceRegistry<PolarisRegistrati
 		this.polarisDiscoveryHandler = polarisDiscoveryHandler;
 		this.staticMetadataManager = staticMetadataManager;
 
-		if (polarisDiscoveryProperties.isHeartbeatEnabled()) {
+		if (StringUtils.isNotBlank(polarisDiscoveryProperties.getHealthCheckUrl())) {
 			this.heartbeatExecutor = Executors
 					.newSingleThreadScheduledExecutor(new NamedThreadFactory("polaris-heartbeat"));
 		}
@@ -95,26 +95,27 @@ public class PolarisServiceRegistry implements ServiceRegistry<PolarisRegistrati
 		instanceRegisterRequest.setRegion(staticMetadataManager.getRegion());
 		instanceRegisterRequest.setZone(staticMetadataManager.getZone());
 		instanceRegisterRequest.setCampus(staticMetadataManager.getCampus());
-		if (null != heartbeatExecutor) {
-			instanceRegisterRequest.setTtl(polarisDiscoveryProperties.getHeartbeatInterval());
-		}
+		instanceRegisterRequest.setTtl(polarisDiscoveryProperties.getHeartbeatInterval());
 		instanceRegisterRequest.setMetadata(registration.getMetadata());
 		instanceRegisterRequest.setProtocol(polarisDiscoveryProperties.getProtocol());
 		instanceRegisterRequest.setVersion(polarisDiscoveryProperties.getVersion());
 		try {
 			ProviderAPI providerClient = polarisDiscoveryHandler.getProviderAPI();
-			InstanceRegisterResponse instanceRegisterResponse = providerClient.register(instanceRegisterRequest);
-			registration.setInstanceId(instanceRegisterResponse.getInstanceId());
-			LOGGER.info("polaris registry, {} {} {}:{} {} register finished", polarisDiscoveryProperties.getNamespace(),
-					registration.getServiceId(), registration.getHost(), registration.getPort(),
-					staticMetadataManager.getMergedStaticMetadata());
-
-			if (null != heartbeatExecutor) {
+			InstanceRegisterResponse instanceRegisterResponse;
+			if (StringUtils.isBlank(polarisDiscoveryProperties.getHealthCheckUrl())) {
+				instanceRegisterResponse = providerClient.registerInstance(instanceRegisterRequest);
+			}
+			else {
+				instanceRegisterResponse = providerClient.register(instanceRegisterRequest);
 				InstanceHeartbeatRequest heartbeatRequest = new InstanceHeartbeatRequest();
 				BeanUtils.copyProperties(instanceRegisterRequest, heartbeatRequest);
 				// Start the heartbeat thread after the registration is successful.
 				heartbeat(heartbeatRequest);
 			}
+			registration.setInstanceId(instanceRegisterResponse.getInstanceId());
+			LOGGER.info("polaris registry, {} {} {}:{} {} register finished", polarisDiscoveryProperties.getNamespace(),
+					registration.getServiceId(), registration.getHost(), registration.getPort(),
+					staticMetadataManager.getMergedStaticMetadata());
 		}
 		catch (Exception e) {
 			LOGGER.error("polaris registry, {} register failed...{},", registration.getServiceId(), registration, e);
@@ -188,24 +189,19 @@ public class PolarisServiceRegistry implements ServiceRegistry<PolarisRegistrati
 		heartbeatExecutor.scheduleWithFixedDelay(() -> {
 			try {
 				String healthCheckEndpoint = polarisDiscoveryProperties.getHealthCheckUrl();
-				// First determine whether health-check-url is configured.
-				// If configured, the service instance health check needs to be executed
-				// first.
 				// If the health check passes, the heartbeat will be reported.
 				// If it does not pass, the heartbeat will not be reported.
-				if (StringUtils.isNotBlank(healthCheckEndpoint)) {
-					if (!healthCheckEndpoint.startsWith("/")) {
-						healthCheckEndpoint = "/" + healthCheckEndpoint;
-					}
-
-					String healthCheckUrl = String.format("http://%s:%s%s", heartbeatRequest.getHost(),
-							heartbeatRequest.getPort(), healthCheckEndpoint);
-
-					if (!OkHttpUtil.get(healthCheckUrl, null)) {
-						LOGGER.error("backend service health check failed. health check endpoint = {}",
-								healthCheckEndpoint);
-						return;
-					}
+				if (!healthCheckEndpoint.startsWith("/")) {
+					healthCheckEndpoint = "/" + healthCheckEndpoint;
+				}
+
+				String healthCheckUrl = String.format("http://%s:%s%s", heartbeatRequest.getHost(),
+						heartbeatRequest.getPort(), healthCheckEndpoint);
+
+				if (!OkHttpUtil.get(healthCheckUrl, null)) {
+					LOGGER.error("backend service health check failed. health check endpoint = {}",
+							healthCheckEndpoint);
+					return;
 				}
 
 				polarisDiscoveryHandler.getProviderAPI().heartbeat(heartbeatRequest);

spring-cloud-starter-tencent-polaris-discovery/src/test/java/com/tencent/cloud/polaris/PolarisDiscoveryPropertiesTest.java

@@ -37,10 +37,6 @@ public class PolarisDiscoveryPropertiesTest {
 	public void testGetAndSet() {
 		PolarisDiscoveryProperties polarisDiscoveryProperties = new PolarisDiscoveryProperties();
 
-		// HeartbeatEnabled
-		polarisDiscoveryProperties.setHeartbeatEnabled(true);
-		assertThat(polarisDiscoveryProperties.isHeartbeatEnabled()).isTrue();
-
 		// HeartbeatEnabled
 		polarisDiscoveryProperties.setHeartbeatInterval(200);
 		assertThat(polarisDiscoveryProperties.getHeartbeatInterval()).isEqualTo(5);
@@ -103,7 +99,6 @@ public class PolarisDiscoveryPropertiesTest {
 						+ ", port=9091"
 						+ ", enabled=true"
 						+ ", registerEnabled=true"
-						+ ", heartbeatEnabled=true"
 						+ ", heartbeatInterval=20"
 						+ ", healthCheckUrl='/health'"
 						+ ", serviceListRefreshInterval=1000}");