org.apache.dubbo.config.annotation

注释类型 Reference

@Documented
 @Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD,ANNOTATION_TYPE})
public @interface Reference

Reference

可选元素概要

可选元素

限定符和类型	可选元素和说明
int	actives Maximum active requests allowed, default value is 0
String	application Application spring bean 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, legal values include: failover, failfast, failsafe, failback, forking
int	connections Maximum connections service provider can accept, default value is 0 - connection is shared
String	consumer Consumer spring bean 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
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, legal values include: random, roundrobin, leastactive
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	protocol Protocol spring bean names
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 spring bean name
int	retries Service invocation retry times
boolean	sent Whether the async request has already been sent, the default value is false
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

public abstract Class<?> interfaceClass

Interface class, default value is void.class

默认值:

void.class

interfaceName

public abstract String interfaceName

Interface class name, default value is empty string

默认值:

""

version

public abstract String version

Service version, default value is empty string

默认值:

""

group

public abstract String group

Service group, default value is empty string

默认值:

""

url

public abstract String url

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

默认值:

""

client

public abstract String client

Client transport type, default value is "netty"

默认值:

""

generic

public abstract boolean generic

Whether to enable generic invocation, default value is false

默认值:

false

injvm

public abstract boolean injvm

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

默认值:

true

check

public abstract boolean check

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

默认值:

true

init

public abstract boolean init

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

默认值:

false

lazy

public abstract boolean lazy

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

默认值:

false

stubevent

public abstract boolean stubevent

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

另请参阅:

Constants.STUB_EVENT_METHODS_KEY

默认值:

false

reconnect

public abstract 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

另请参阅:

Constants.DEFAULT_RECONNECT_PERIOD

默认值:

""

sticky

public abstract boolean sticky

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

另请参阅:

Constants.DEFAULT_CLUSTER_STICKY

默认值:

false

proxy

public abstract String proxy

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

默认值:

""

stub

public abstract String stub

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

默认值:

""

cluster

public abstract String cluster

Cluster strategy, legal values include: failover, failfast, failsafe, failback, forking

默认值:

""

connections

public abstract int connections

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

默认值:

0

callbacks

public abstract int callbacks

The callback instance limit peer connection

另请参阅:

Constants.DEFAULT_CALLBACK_INSTANCES

默认值:

0

onconnect

public abstract String onconnect

Callback method name when connected, default value is empty string

默认值:

""

ondisconnect

public abstract String ondisconnect

Callback method name when disconnected, default value is empty string

默认值:

""

owner

public abstract String owner

Service owner, default value is empty string

默认值:

""

layer

public abstract String layer

Service layer, default value is empty string

默认值:

""

retries

public abstract int retries

Service invocation retry times

另请参阅:

Constants.DEFAULT_RETRIES

默认值:

2

loadbalance

public abstract String loadbalance

Load balance strategy, legal values include: random, roundrobin, leastactive

另请参阅:

Constants.DEFAULT_LOADBALANCE

默认值:

""

async

public abstract boolean async

Whether to enable async invocation, default value is false

默认值:

false

actives

public abstract int actives

Maximum active requests allowed, default value is 0

默认值:

0

sent

public abstract boolean sent

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

默认值:

false

mock

public abstract String mock

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

默认值:

""

validation

public abstract String validation

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

默认值:

""

timeout

public abstract int timeout

Timeout value for service invocation, default value is 0

默认值:

0

cache

public abstract String cache

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

默认值:

""

filter

public abstract String[] filter

Filters for service invocation

另请参阅:

Filter

默认值:

{}

listener

public abstract String[] listener

Listeners for service exporting and unexporting

另请参阅:

ExporterListener

默认值:

{}

parameters

public abstract String[] parameters

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

默认值:

{}

application

public abstract String application

Application spring bean name

默认值:

""

module

public abstract String module

Module spring bean name

默认值:

""

consumer

public abstract String consumer

Consumer spring bean name

默认值:

""

monitor

public abstract String monitor

Monitor spring bean name

默认值:

""

registry

public abstract String[] registry

Registry spring bean name

默认值:

{}

protocol

public abstract String protocol

Protocol spring bean names

默认值:

""

tag

public abstract String tag

Service tag name

默认值:

""

methods

public abstract Method[] methods

methods support

返回:

默认值:

{}