feat: support use database as a registry

apollo-adminservice/src/main/java/com/ctrip/framework/apollo/adminservice/controller/RegistryController.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2022 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.adminservice.controller;
+
+import com.ctrip.framework.apollo.biz.entity.Registry;
+import com.ctrip.framework.apollo.biz.service.RegistryService;
+import java.time.Duration;
+import java.util.List;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/registry")
+@ConditionalOnBean(RegistryService.class)
+public class RegistryController {
+
+  @Autowired
+  private RegistryService registryService;
+
+  @PostMapping("/clear/instances")
+  public List<Registry> clearInstances() {
+    return this.registryService.deleteTimeBefore(Duration.ofMinutes(10));
+  }
+}

apollo-adminservice/src/main/resources/application-database-discovery.properties

@@ -0,0 +1,20 @@
+#
+# Copyright 2022 Apollo Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+eureka.client.enabled=false
+
+apollo.registry.client.enabled=true
+apollo.registry.client.label=default
+

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/entity/Registry.java

@@ -0,0 +1,136 @@
+/*
+ * Copyright 2022 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.biz.entity;
+
+import com.ctrip.framework.apollo.biz.registry.ServiceInstance;
+import java.time.LocalDateTime;
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.PrePersist;
+import javax.persistence.Table;
+
+/**
+ * use database as a registry instead of eureka, zookeeper, consul etc.
+ * <p>
+ * persist {@link ServiceInstance}
+ */
+@Entity
+@Table(name = "Registry")
+public class Registry {
+
+  @Id
+  @GeneratedValue(strategy = GenerationType.IDENTITY)
+  @Column(name = "Id")
+  private long id;
+
+  @Column(name = "ServiceName", nullable = false)
+  private String serviceName;
+
+  /**
+   * @see ServiceInstance#getUri()
+   */
+  @Column(name = "Uri", nullable = false)
+  private String uri;
+
+  /**
+   * @see ServiceInstance#getLabel()
+   */
+  @Column(name = "Label", nullable = false)
+  private String label;
+
+  @Column(name = "DataChange_CreatedTime", nullable = false)
+  private LocalDateTime dataChangeCreatedTime;
+
+  /**
+   * modify by heartbeat
+   */
+  @Column(name = "DataChange_LastTime", nullable = false)
+  private LocalDateTime dataChangeLastModifiedTime;
+
+  @PrePersist
+  protected void prePersist() {
+    if (this.dataChangeCreatedTime == null) {
+      dataChangeCreatedTime = LocalDateTime.now();
+    }
+    if (this.dataChangeLastModifiedTime == null) {
+      dataChangeLastModifiedTime = dataChangeCreatedTime;
+    }
+  }
+
+  @Override
+  public String toString() {
+    return "Registry{" +
+        "id=" + id +
+        ", serviceName='" + serviceName + '\'' +
+        ", uri='" + uri + '\'' +
+        ", label='" + label + '\'' +
+        ", dataChangeCreatedTime=" + dataChangeCreatedTime +
+        ", dataChangeLastModifiedTime=" + dataChangeLastModifiedTime +
+        '}';
+  }
+
+  public long getId() {
+    return id;
+  }
+
+  public void setId(long id) {
+    this.id = id;
+  }
+
+  public String getServiceName() {
+    return serviceName;
+  }
+
+  public void setServiceName(String serviceName) {
+    this.serviceName = serviceName;
+  }
+
+  public String getUri() {
+    return uri;
+  }
+
+  public void setUri(String uri) {
+    this.uri = uri;
+  }
+
+  public String getLabel() {
+    return label;
+  }
+
+  public void setLabel(String label) {
+    this.label = label;
+  }
+
+  public LocalDateTime getDataChangeCreatedTime() {
+    return dataChangeCreatedTime;
+  }
+
+  public void setDataChangeCreatedTime(LocalDateTime dataChangeCreatedTime) {
+    this.dataChangeCreatedTime = dataChangeCreatedTime;
+  }
+
+  public LocalDateTime getDataChangeLastModifiedTime() {
+    return dataChangeLastModifiedTime;
+  }
+
+  public void setDataChangeLastModifiedTime(LocalDateTime dataChangeLastModifiedTime) {
+    this.dataChangeLastModifiedTime = dataChangeLastModifiedTime;
+  }
+}

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/registry/DatabaseDiscoveryClient.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.biz.registry;
+
+import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloRegistryDiscoveryProperties;
+import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloRegistryClientProperties;
+import java.util.List;
+
+public interface DatabaseDiscoveryClient {
+
+  /**
+   * find by {@link ApolloRegistryClientProperties#getServiceName()},
+   * then filter by label if {@link ApolloRegistryDiscoveryProperties#isFilterByLabel()} is true.
+   */
+  List<ServiceInstance> getInstances(String serviceName);
+}

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/registry/DatabaseDiscoveryClientImpl.java

@@ -0,0 +1,127 @@
+/*
+ * Copyright 2022 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.biz.registry;
+
+import com.ctrip.framework.apollo.biz.entity.Registry;
+import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloRegistryDiscoveryProperties;
+import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloRegistryClientProperties;
+import com.ctrip.framework.apollo.biz.service.RegistryService;
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class DatabaseDiscoveryClientImpl implements DatabaseDiscoveryClient {
+
+  private static final Logger log = LoggerFactory.getLogger(DatabaseDiscoveryClientImpl.class);
+
+  private final RegistryService registryService;
+
+  private final ApolloRegistryDiscoveryProperties discoveryProperties;
+
+  private final ServiceInstance self;
+
+  public DatabaseDiscoveryClientImpl(
+      RegistryService registryService,
+      ApolloRegistryDiscoveryProperties discoveryProperties,
+      ServiceInstance self) {
+    this.registryService = registryService;
+    this.discoveryProperties = discoveryProperties;
+    this.self = self;
+  }
+
+  /**
+   * find by {@link ApolloRegistryClientProperties#getServiceName()}
+   */
+  @Override
+  public List<ServiceInstance> getInstances(String serviceName) {
+    final List<Registry> filterByLabel;
+    {
+      List<Registry> all = this.registryService.findByServiceName(serviceName);
+      if (this.discoveryProperties.isFilterByLabel()) {
+        filterByLabel = filterByLabel(all, this.self.getLabel());
+      } else {
+        // get all
+        filterByLabel = all;
+      }
+    }
+    LocalDateTime healthCheckTime = this.registryService.getTimeBeforeSeconds(
+        this.discoveryProperties.getHealthCheckInterval()
+    );
+    final List<Registry> filterByHealthCheck = filterByHealthCheck(filterByLabel, healthCheckTime, serviceName);
+
+    // convert
+    List<ServiceInstance> registrationList = new ArrayList<>(filterByHealthCheck.size());
+    for (Registry registry : filterByHealthCheck) {
+      ApolloRegistryClientProperties registration = convert(registry);
+      registrationList.add(registration);
+    }
+    return registrationList;
+  }
+
+  static ApolloRegistryClientProperties convert(Registry registry) {
+    ApolloRegistryClientProperties registration = new ApolloRegistryClientProperties();
+    registration.setServiceName(registry.getServiceName());
+    registration.setUri(registry.getUri());
+    registration.setLabel(registry.getLabel());
+    return registration;
+  }
+
+  static List<Registry> filterByLabel(List<Registry> list, String label) {
+    if (list.isEmpty()) {
+      return Collections.emptyList();
+    }
+    List<Registry> listAfterFilter = new ArrayList<>(8);
+    for (Registry registry : list) {
+      if (Objects.equals(label, registry.getLabel())) {
+        listAfterFilter.add(registry);
+      }
+    }
+    return listAfterFilter;
+  }
+
+  static List<Registry> filterByHealthCheck(
+      List<Registry> list,
+      LocalDateTime healthCheckTime,
+      String serviceName
+  ) {
+    if (list.isEmpty()) {
+      return Collections.emptyList();
+    }
+    List<Registry> listAfterFilter = new ArrayList<>(8);
+    for (Registry registry : list) {
+      LocalDateTime lastModifiedTime = registry.getDataChangeLastModifiedTime();
+      if (lastModifiedTime.isAfter(healthCheckTime)) {
+        listAfterFilter.add(registry);
+      }
+    }
+
+    if (listAfterFilter.isEmpty()) {
+      log.error(
+          "there is no healthy instance of '{}'. And there are {} unhealthy instances",
+          serviceName,
+          list.size()
+      );
+    }
+
+    return listAfterFilter;
+  }
+
+}

apollo-biz/src/main/java/com/ctrip/framework/apollo/biz/registry/DatabaseServiceRegistry.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2022 Apollo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+package com.ctrip.framework.apollo.biz.registry;
+
+/**
+ * @see org.springframework.cloud.client.serviceregistry.ServiceRegistry
+ */
+public interface DatabaseServiceRegistry {
+
+  /**
+   * register an instance to database
+   */
+  void register(ServiceInstance instance);
+
+  /**
+   * remove an instance from database
+   */
+  void deregister(ServiceInstance instance);
+}