程序包 org.apache.dubbo.config.annotation

注释类型 DubboReference

@Documented
@Retention(RUNTIME)
@Target({FIELD,METHOD,ANNOTATION_TYPE})
public @interface DubboReference

An annotation used for referencing a Dubbo service

从以下版本开始:

2.7.7

可选元素概要

可选元素

修饰符和类型	可选元素	说明
int	actives	Maximum active requests allowed, default value is 0
String	application	Application associated name
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
boolean	check	Check if service provider is available during boot up, default value is true
String	client	Client transport type, default value is "netty"
String	cluster	Cluster strategy, you can use ClusterRules.FAIL_FAST ……
int	connections	Maximum connections service provider can accept, default value is 0 - connection is shared
String	consumer	Consumer associated name
String[]	filter	Filters for service invocation
boolean	generic	Whether to enable generic invocation, default value is false
String	group	Service group, default value is empty string
String	id	The id
boolean	init	Whether eager initialize the reference bean when all properties are set, default value is false
boolean	injvm	When enable, prefer to call local service in the same JVM if it's present, default value is true
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
boolean	lazy	Whether to make connection when the client is created, the default value is false
String[]	listener	Listeners for service exporting and unexporting
String	loadbalance	Load balance strategy, you can use LoadbalanceRules.RANDOM ……
String	merger	Service merger
Method[]	methods	methods support
String	mock	Service mock name, use interface name + Mock if not set
String	module	Module associated name
String	monitor	Monitor associated 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	protocol	The communication protocol of Dubbo Service
String[]	providedBy	declares which app or service this interface belongs to
String	proxy	How the proxy is generated, legal values include: jdk, javassist
String	reconnect	Whether to reconnect if connection is lost, if not specify, reconnect is enabled by default, and the interval for retry connecting is 2000 ms
String[]	registry	Registry associated name
int	retries	Service invocation retry times
boolean	sent	Whether the async request has already been sent, the default value is false
String[]	services	已过时。 using providedBy()
boolean	sticky	Whether to stick to the same node in the cluster, the default value is false
String	stub	Service stub name, use interface name + Local if not set
boolean	stubevent	Export an stub service for event dispatch, default value is false.
String	tag	Service tag name
int	timeout	Timeout value for service invocation, default value is 0
String	url	Service target URL for direct invocation, if this is specified, then registry center takes no effect.
String	validation	Whether to use JSR303 validation, legal values are: true, false
String	version	Service version, default value is empty string

元素详细资料

interfaceClass

Class<?> interfaceClass

Interface class, default value is void.class

默认值:

void.class

interfaceName

String interfaceName

Interface class name, default value is empty string

默认值:

""

version

String version

Service version, default value is empty string

默认值:

""

group

String group

Service group, default value is empty string

默认值:

""

url

String url

Service target URL for direct invocation, if this is specified, then registry center takes no effect.

默认值:

""

client

String client

Client transport type, default value is "netty"

默认值:

""

generic

boolean generic

Whether to enable generic invocation, default value is false

默认值:

false

injvm

boolean injvm

When enable, prefer to call local service in the same JVM if it's present, default value is true

默认值:

true

check

boolean check

Check if service provider is available during boot up, default value is true

默认值:

true

init

boolean init

Whether eager initialize the reference bean when all properties are set, default value is false

默认值:

false

lazy

boolean lazy

Whether to make connection when the client is created, the default value is false

默认值:

false

stubevent

boolean stubevent

Export an stub service for event dispatch, default value is false.

see org.apache.dubbo.rpc.Constants#STUB_EVENT_METHODS_KEY

默认值:

false

reconnect

String reconnect

Whether to reconnect if connection is lost, if not specify, reconnect is enabled by default, and the interval for retry connecting is 2000 ms

see org.apache.dubbo.remoting.Constants#DEFAULT_RECONNECT_PERIOD

默认值:

""

sticky

boolean sticky

Whether to stick to the same node in the cluster, the default value is false

see Constants#DEFAULT_CLUSTER_STICKY

默认值:

false

proxy

String proxy

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

默认值:

""

stub

String stub

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

默认值:

""

cluster

String cluster

Cluster strategy, you can use ClusterRules.FAIL_FAST ……

默认值:

""

connections

int connections

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

默认值:

0

callbacks

int callbacks

The callback instance limit peer connection

see org.apache.dubbo.rpc.Constants#DEFAULT_CALLBACK_INSTANCES

默认值:

0

onconnect

String onconnect

Callback method name when connected, default value is empty string

默认值:

""

ondisconnect

String ondisconnect

Callback method name when disconnected, default value is empty string

默认值:

""

owner

String owner

Service owner, default value is empty string

默认值:

""

layer

String layer

Service layer, default value is empty string

默认值:

""

retries

int retries

Service invocation retry times

see Constants#DEFAULT_RETRIES

默认值:

2

loadbalance

String loadbalance

Load balance strategy, you can use LoadbalanceRules.RANDOM ……

默认值:

""

async

boolean async

Whether to enable async invocation, default value is false

默认值:

false

actives

int actives

Maximum active requests allowed, default value is 0

默认值:

0

sent

boolean sent

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

默认值:

false

mock

String mock

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

默认值:

""

validation

String validation

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

默认值:

""

timeout

int timeout

Timeout value for service invocation, default value is 0

默认值:

0

cache

String cache

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

默认值:

""

filter

String[] filter

Filters for service invocation

see Filter

默认值:

{}

listener

String[] listener

Listeners for service exporting and unexporting

see ExporterListener

默认值:

{}

parameters

String[] parameters

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

默认值:

{}

application

String application

Application associated name

默认值:

""

module

String module

Module associated name

默认值:

""

consumer

String consumer

Consumer associated name

默认值:

""

monitor

String monitor

Monitor associated name

默认值:

""

registry

String[] registry

Registry associated name

默认值:

{}

protocol

String protocol

The communication protocol of Dubbo Service

返回:

the default value is ""

从以下版本开始:

2.6.6

默认值:

""

tag

String tag

Service tag name

默认值:

""

merger

String merger

Service merger

默认值:

""

methods

Method[] methods

methods support

默认值:

{}

id

String id

The id

返回:

default value is empty

从以下版本开始:

2.7.3

默认值:

""

services

String[] services

已过时。

using providedBy()

返回:

The service names that the Dubbo interface subscribed

从以下版本开始:

2.7.8

另请参阅:

RegistryConstants.SUBSCRIBED_SERVICE_NAMES_KEY

默认值:

{}

providedBy

String[] providedBy

declares which app or service this interface belongs to

另请参阅:

RegistryConstants.PROVIDED_BY

默认值:

{}