org.apache.dubbo.config.annotation

Annotation Type DubboService

@Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
 @Inherited
public @interface DubboService

Class-level annotation used for declaring Dubbo service.

1. Using with java config bean:

This usage is recommended.
It is more flexible on bean methods than on implementation classes, and is more compatible with Spring.

 @Configuration
 class ProviderConfiguration {

     @Bean
     @DubboService(group="demo")
     public DemoService demoServiceImpl() {
         return new DemoServiceImpl();
     }
 }
 

2. Using on implementation class of service:

 @DubboService(group="demo")
 public class DemoServiceImpl implements DemoService {
     ...
 }
 

This usage causes the implementation class to rely on the Dubbo module.

Since:

2.7.7

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	accesslog Access log for the service, default value is empty string
int	actives Maximum active requests allowed, default value is -1
String	application Deprecated. This attribute was deprecated, use bind application/module of spring ApplicationContext
boolean	async Whether to enable async invocation, default value is false
String	cache Specify cache implementation for service invocation, legal values include: lru, threadlocal, jcache
int	callbacks The callback instance limit peer connection
String	cluster Cluster strategy, legal values include: failover, failfast, failsafe, failback, forking you can use ClusterRules.FAIL_FAST ……
int	connections Maximum connections service provider can accept, default value is -1 - connection is shared
int	delay Delay time for service registration, default value is -1
boolean	deprecated Whether the service is deprecated, default value is false
String	document Service doc, default value is empty string
boolean	dynamic Whether the service is dynamic, default value is true
int	executes Maximum concurrent executes for the service, default value is -1 - no limits
String	executor bean name of service executor(thread pool), used for thread pool isolation between services
boolean	export Whether to export service, default value is true
boolean	exportAsync Weather the service is export asynchronously
String[]	filter Filters for service invocation
String	group Service group, default value is empty string
Class<?>	interfaceClass Interface class, default value is void.class
String	interfaceName Interface class name, default value is empty string
String	layer Service layer, default value is empty string
String[]	listener Listeners for service exporting and unexporting
String	loadbalance Load balance strategy, legal values include: random, roundrobin, leastactive you can use LoadbalanceRules.RANDOM ……
String	local Deprecated.
Method[]	methods methods support
String	mock Service mock name, use interface name + Mock if not set
String	module Module spring bean name
String	monitor Monitor spring bean name
String	onconnect Callback method name when connected, default value is empty string
String	ondisconnect Callback method name when disconnected, default value is empty string
String	owner Service owner, default value is empty string
String[]	parameters Customized parameter key-value pair, for example: {key1, value1, key2, value2}
String	path Service path, default value is empty string
String	payload Payload max length.
String[]	protocol Protocol spring bean names
String	provider Provider spring bean name
String	proxy How the proxy is generated, legal values include: jdk, javassist
boolean	register Whether to register the service to register center, default value is true
String[]	registry Registry spring bean name
int	retries Service invocation retry times
String	scope the scope for referring/exporting a service, if it's local, it means searching in current JVM only.
boolean	sent Whether the async request has already been sent, the default value is false
String	stub Service stub name, use interface name + Local if not set
String	tag Service tag name
int	timeout Timeout value for service invocation, default value is -1
String	token Service token, default value is empty string
String	validation Whether to use JSR303 validation, legal values are: true, false
String	version Service version, default value is empty string
int	weight Service weight value, default value is -1

Element Detail

interfaceClass

public abstract Class<?> interfaceClass

Interface class, default value is void.class

Default:

void.class

interfaceName

public abstract String interfaceName

Interface class name, default value is empty string

Default:

""

version

public abstract String version

Service version, default value is empty string

Default:

""

group

public abstract String group

Service group, default value is empty string

Default:

""

path

public abstract String path

Service path, default value is empty string

Default:

""

export

public abstract boolean export

Whether to export service, default value is true

Default:

true

token

public abstract String token

Service token, default value is empty string

Default:

""

deprecated

public abstract boolean deprecated

Whether the service is deprecated, default value is false

Default:

false

dynamic

public abstract boolean dynamic

Whether the service is dynamic, default value is true

Default:

true

accesslog

public abstract String accesslog

Access log for the service, default value is empty string

Default:

""

executes

public abstract int executes

Maximum concurrent executes for the service, default value is -1 - no limits

Default:

-1

register

public abstract boolean register

Whether to register the service to register center, default value is true

Default:

true

weight

public abstract int weight

Service weight value, default value is -1

Default:

-1

document

public abstract String document

Service doc, default value is empty string

Default:

""

delay

public abstract int delay

Delay time for service registration, default value is -1

Default:

-1

local

public abstract String local

Deprecated.

See Also:

stub()

Default:

""

stub

public abstract String stub

Service stub name, use interface name + Local if not set

Default:

""

cluster

public abstract String cluster

Cluster strategy, legal values include: failover, failfast, failsafe, failback, forking you can use ClusterRules.FAIL_FAST ……

Default:

""

proxy

public abstract String proxy

How the proxy is generated, legal values include: jdk, javassist

Default:

""

connections

public abstract int connections

Maximum connections service provider can accept, default value is -1 - connection is shared

Default:

-1

callbacks

public abstract int callbacks

The callback instance limit peer connection

see org.apache.dubbo.common.constants.CommonConstants.DEFAULT_CALLBACK_INSTANCES

Default:

-1

onconnect

public abstract String onconnect

Callback method name when connected, default value is empty string

Default:

""

ondisconnect

public abstract String ondisconnect

Callback method name when disconnected, default value is empty string

Default:

""

owner

public abstract String owner

Service owner, default value is empty string

Default:

""

layer

public abstract String layer

Service layer, default value is empty string

Default:

""

retries

public abstract int retries

Service invocation retry times

See Also:

CommonConstants.DEFAULT_RETRIES

Default:

-1

loadbalance

public abstract String loadbalance

Load balance strategy, legal values include: random, roundrobin, leastactive you can use LoadbalanceRules.RANDOM ……

Default:

""

async

public abstract boolean async

Whether to enable async invocation, default value is false

Default:

false

actives

public abstract int actives

Maximum active requests allowed, default value is -1

Default:

-1

sent

public abstract boolean sent

Whether the async request has already been sent, the default value is false

Default:

false

mock

public abstract String mock

Service mock name, use interface name + Mock if not set

Default:

""

validation

public abstract String validation

Whether to use JSR303 validation, legal values are: true, false

Default:

""

timeout

public abstract int timeout

Timeout value for service invocation, default value is -1

Default:

-1

cache

public abstract String cache

Specify cache implementation for service invocation, legal values include: lru, threadlocal, jcache

Default:

""

filter

public abstract String[] filter

Filters for service invocation

See Also:

Filter

Default:

{}

listener

public abstract String[] listener

Listeners for service exporting and unexporting

See Also:

ExporterListener

Default:

{}

parameters

public abstract String[] parameters

Customized parameter key-value pair, for example: {key1, value1, key2, value2}

Default:

{}

application

@Deprecated
public abstract String application

Deprecated. This attribute was deprecated, use bind application/module of spring ApplicationContext

Application spring bean name

Default:

""

module

public abstract String module

Module spring bean name

Default:

""

provider

public abstract String provider

Provider spring bean name

Default:

""

protocol

public abstract String[] protocol

Protocol spring bean names

Default:

{}

monitor

public abstract String monitor

Monitor spring bean name

Default:

""

registry

public abstract String[] registry

Registry spring bean name

Default:

{}

tag

public abstract String tag

Service tag name

Default:

""

methods

public abstract Method[] methods

methods support

Returns:

Default:

{}

scope

public abstract String scope

the scope for referring/exporting a service, if it's local, it means searching in current JVM only.

See Also:

org.apache.dubbo.rpc.Constants#SCOPE_LOCAL, org.apache.dubbo.rpc.Constants#SCOPE_REMOTE

Default:

""

exportAsync

public abstract boolean exportAsync

Weather the service is export asynchronously

Default:

false

executor

public abstract String executor

bean name of service executor(thread pool), used for thread pool isolation between services

Returns:

Default:

""

payload

public abstract String payload

Payload max length.

Default:

""