所有超级接口:

Comparable<Prioritized>, Prioritized

所有已知实现类:

AbstractServiceDiscovery, DNSServiceDiscovery, FileSystemServiceDiscovery, KubernetesServiceDiscovery, MulticastServiceDiscovery, MultipleServiceDiscovery, NacosServiceDiscovery, SelfHostMetaServiceDiscovery, XdsServiceDiscovery, ZookeeperServiceDiscovery
```
@SPI("zookeeper")
public interface ServiceDiscovery
extends Prioritized
```
The common operations of Service Discovery

从以下版本开始:

2.7.5

字段概要
- 从接口继承的字段 org.apache.dubbo.common.lang.Prioritized
  COMPARATOR, MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

方法概要

所有方法实例方法抽象方法默认方法
修饰符和类型	方法	说明
`default void`	`addServiceInstancesChangedListener(ServiceInstancesChangedListener listener)`	Add an instance of `ServiceInstancesChangedListener` for specified service
`default ServiceInstancesChangedListener`	`createListener(Set<String> serviceNames)`
`void`	`destroy()`	Destroy the `ServiceDiscovery`
`default void`	`dispatchServiceInstancesChangedEvent(String serviceName)`
`default void`	`dispatchServiceInstancesChangedEvent(String serviceName, String... otherServiceNames)`
`default void`	`dispatchServiceInstancesChangedEvent(String serviceName, List<ServiceInstance> serviceInstances)`
`default void`	`dispatchServiceInstancesChangedEvent(ServiceInstancesChangedEvent event)`
`default int`	`getDefaultPageSize()`	Get the default size of pagination query
`default long`	`getDelay()`
`default Map<String,Page<ServiceInstance>>`	`getInstances(Iterable<String> serviceNames, int offset, int requestSize)`	batch-get all `service instances` by the specified service names
`default List<ServiceInstance>`	`getInstances(String serviceName)`	Gets all `service instances` by the specified service name.
`default Page<ServiceInstance>`	`getInstances(String serviceName, int offset, int pageSize)`	Gets the `pagination` of `service instances` by the specified service name.
`default Page<ServiceInstance>`	`getInstances(String serviceName, int offset, int pageSize, boolean healthyOnly)`	Get the `pagination` of `service instances` by the specified service name.
`ServiceInstance`	`getLocalInstance()`
`Set<String>`	`getServices()`	Gets all service names
`default URL`	`getUrl()`
`void`	`initialize(URL registryURL)`	Initializes the `ServiceDiscovery`
`boolean`	`isDestroy()`
`void`	`register(ServiceInstance serviceInstance)`	Registers an instance of `ServiceInstance`.
`default void`	`removeServiceInstancesChangedListener(ServiceInstancesChangedListener listener)`	unsubscribe to instances change event.
`String`	`toString()`	A human-readable description of the implementation
`void`	`unregister(ServiceInstance serviceInstance)`	Unregisters an instance of `ServiceInstance`.
`void`	`update(ServiceInstance serviceInstance)`	Updates the registered `ServiceInstance`.

从接口继承的方法 org.apache.dubbo.common.lang.Prioritized
compareTo, getPriority

- 方法详细资料
  - initialize
```
void initialize(URL registryURL)
         throws Exception
```
    Initializes the ServiceDiscovery
    
    参数:
    
    registryURL - the url to connect service registry
    
    抛出:
    
    Exception - If met with error
  - destroy
```
void destroy()
      throws Exception
```
    Destroy the ServiceDiscovery
    
    抛出:
    
    Exception - If met with error
  - isDestroy
```
boolean isDestroy()
```
  - register
```
void register(ServiceInstance serviceInstance)
       throws RuntimeException
```
    Registers an instance of ServiceInstance.
    
    参数:
    
    serviceInstance - an instance of ServiceInstance to be registered
    
    抛出:
    
    RuntimeException - if failed
  - update
```
void update(ServiceInstance serviceInstance)
     throws RuntimeException
```
    Updates the registered ServiceInstance.
    
    参数:
    
    serviceInstance - the registered ServiceInstance
    
    抛出:
    
    RuntimeException - if failed
  - unregister
```
void unregister(ServiceInstance serviceInstance)
         throws RuntimeException
```
    Unregisters an instance of ServiceInstance.
    
    参数:
    
    serviceInstance - an instance of ServiceInstance to be unregistered
    
    抛出:
    
    RuntimeException - if failed
  - getDefaultPageSize
```
default int getDefaultPageSize()
```
    Get the default size of pagination query
    
    返回:
    
    the default value is 100
  - getServices
```
Set<String> getServices()
```
    Gets all service names
    
    返回:
    
    non-null read-only Set
  - getInstances
```
default List<ServiceInstance> getInstances(String serviceName)
                                    throws NullPointerException
```
    Gets all service instances by the specified service name.
    
    参数:
    
    serviceName - the service name
    
    返回:
    
    non-null List
    
    抛出:
    
    NullPointerException - if serviceName is null
  - getInstances
```
default Page<ServiceInstance> getInstances(String serviceName,
                                           int offset,
                                           int pageSize)
                                    throws NullPointerException,
                                           IllegalArgumentException
```
    Gets the pagination of service instances by the specified service name. It's equal to getInstances(String, int, int, boolean) with healthyOnly == true
    
    参数:
    
    serviceName - the service name
    
    offset - the offset of request , the number "0" indicates first page
    
    pageSize - the number of request, the max value indicates the range is unlimited
    
    返回:
    
    non-null Page object
    
    抛出:
    
    NullPointerException - if serviceName is null
    
    IllegalArgumentException - if offset or pageSize is negative number
    
    UnsupportedOperationException - if not supported
  - getInstances
```
default Page<ServiceInstance> getInstances(String serviceName,
                                           int offset,
                                           int pageSize,
                                           boolean healthyOnly)
                                    throws NullPointerException,
                                           IllegalArgumentException,
                                           UnsupportedOperationException
```
    Get the pagination of service instances by the specified service name. If healthyOnly == true, filter healthy instances only.
    
    参数:
    
    serviceName - the service name
    
    offset - the offset of request , the number "0" indicates first page
    
    pageSize - the number of request, the max value indicates the range is unlimited
    
    healthyOnly - if true , filter healthy instances only
    
    返回:
    
    non-null Page object
    
    抛出:
    
    NullPointerException - if serviceName is null
    
    IllegalArgumentException - if offset or pageSize is negative number
    
    UnsupportedOperationException - if not supported
  - getInstances
```
default Map<String,Page<ServiceInstance>> getInstances(Iterable<String> serviceNames,
                                                             int offset,
                                                             int requestSize)
                                                      throws NullPointerException,
                                                             IllegalArgumentException
```
    batch-get all service instances by the specified service names
    
    参数:
    
    serviceNames - the multiple service names
    
    offset - the offset of request , the number "0" indicates first page
    
    requestSize - the number of request, the max value indicates the range is unlimited
    
    返回:
    
    non-null read-only Map whose key is the service name and value is the pagination of service instances
    
    抛出:
    
    NullPointerException - if serviceName is null
    
    IllegalArgumentException - if offset or requestSize is negative number
    
    UnsupportedOperationException - if not supported
  - dispatchServiceInstancesChangedEvent
```
default void dispatchServiceInstancesChangedEvent(String serviceName)
```
  - dispatchServiceInstancesChangedEvent
```
default void dispatchServiceInstancesChangedEvent(String serviceName,
                                                  String... otherServiceNames)
```
  - dispatchServiceInstancesChangedEvent
```
default void dispatchServiceInstancesChangedEvent(String serviceName,
                                                  List<ServiceInstance> serviceInstances)
```
  - dispatchServiceInstancesChangedEvent
```
default void dispatchServiceInstancesChangedEvent(ServiceInstancesChangedEvent event)
```
  - addServiceInstancesChangedListener
```
default void addServiceInstancesChangedListener(ServiceInstancesChangedListener listener)
                                         throws NullPointerException,
                                                IllegalArgumentException
```
    Add an instance of ServiceInstancesChangedListener for specified service
    Default, Current method will be invoked by the ServiceDiscoveryRegistry on the subscription, this method is used to trigger or adapt the vendor's change notification mechanism typically, like Zookeeper Watcher, Nacos EventListener. If the registry observes the change, It's suggested that the implementation could invoke dispatchServiceInstancesChangedEvent(String) method or variants
    
    参数:
    
    listener - an instance of ServiceInstancesChangedListener
    
    抛出:
    
    NullPointerException
    
    IllegalArgumentException
  - removeServiceInstancesChangedListener
```
default void removeServiceInstancesChangedListener(ServiceInstancesChangedListener listener)
                                            throws IllegalArgumentException
```
    unsubscribe to instances change event.
    
    参数:
    
    listener -
    
    抛出:
    
    IllegalArgumentException
  - createListener
```
default ServiceInstancesChangedListener createListener(Set<String> serviceNames)
```
  - getUrl
```
default URL getUrl()
```
  - getLocalInstance
```
ServiceInstance getLocalInstance()
```
  - getDelay
```
default long getDelay()
```
  - toString
```
String toString()
```
    A human-readable description of the implementation
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    The description.

接口 ServiceDiscovery

字段概要

从接口继承的字段 org.apache.dubbo.common.lang.Prioritized

方法概要

从接口继承的方法 org.apache.dubbo.common.lang.Prioritized

方法详细资料

initialize

destroy

isDestroy

register

update

unregister

getDefaultPageSize

getServices

getInstances

getInstances

getInstances

getInstances

dispatchServiceInstancesChangedEvent

dispatchServiceInstancesChangedEvent

dispatchServiceInstancesChangedEvent

dispatchServiceInstancesChangedEvent

addServiceInstancesChangedListener

removeServiceInstancesChangedListener

createListener

getUrl

getLocalInstance

getDelay

toString