Configuration of the Dubbo Maven Plugin

Mon, 01 Jan 0001 00:00:00 +0000

This article mainly explains the configuration of the Dubbo Maven Plugin.

The current Dubbo Maven Plugin supports the following features:

Dubbo Maven Plugin For Protobuf: Generates Stub code for Dubbo service interfaces
Dubbo Maven Plugin For Native Image: Generates necessary Metadata information for Native Image based on AOT mechanism

Dubbo Maven Plugin For Protobuf

How to use Dubbo Maven Plugin to generate Protobuf Stub code

1. Write the .proto file

greeter.proto

Configuration Working Principle

Mon, 01 Jan 0001 00:00:00 +0000

This article mainly explains the APIs and working principles related to Dubbo configuration, learning about Dubbo’s multiple configuration sources, the specific configuration methods for each source, and the priority and coverage relationships between different configuration sources.

Implementation Principles

To better manage various configurations, Dubbo abstracts a structured configuration component set, dividing the components by purpose to control behaviors in different scopes.

Component Name	Description	Scope	Is Configuration Required
application	Specifies application name and other application-level related information	Only one allowed per application	Required
service	Declares a normal interface or implementation class as a Dubbo service	Can have 0 to multiple services in an application	At least one service/reference
reference	Declares a normal interface as a Dubbo service	Can have 0 to multiple references in an application	At least one service/reference
protocol	RPC protocol to be exposed and related configurations like port number	Multiple allowed in an application, a protocol can apply to a group of services & references	Optional, default is dubbo
registry	Registry type, address, and related configurations	Multiple allowed in an application, a registry can apply to a group of services & references	Required
config-center	Configuration center type, address, and related configurations	Multiple allowed in an application, shared by all services	Optional
metadata-report	Metadata center type, address, and related configurations	Multiple allowed in an application, shared by all services	Optional
consumer	Default configuration shared between references	Multiple allowed in an application, a consumer can apply to a group of references	Optional
provider	Default configuration shared between services	Multiple allowed in an application, a provider can apply to a group of services	Optional
monitor	Monitoring system type and address	Only one allowed in an application	Optional
metrics	Configuration related to data collection module	Only one allowed in an application	Optional
ssl	Configuration related to ssl/tls secure links, etc.	Only one allowed in an application	Optional
method	Method-level configuration	Sub-configuration of service and reference	Optional
argument	Argument configuration for a method	Sub-configuration of method	Optional

From the perspective of implementation principles, all configuration items in Dubbo will ultimately be assembled into URLs, using URLs as carriers during subsequent startup and RPC calls to control framework behaviors.

Mon, 01 Jan 0001 00:00:00 +0000

aliases:

/en/docs3-v2/java-sdk/reference-manual/config/properties/
/en/docs3-v2/java-sdk/reference-manual/config/properties/
/en/overview/mannual/java-sdk/advanced-features-and-usage/performance/dump/
/en/overview/mannual/java-sdk/advanced-features-and-usage/performance/lazy-connect/
/en/overview/mannual/java-sdk/advanced-features-and-usage/performance/simplify-registry-data/
/en/overview/mannual/java-sdk/advanced-features-and-usage/performance/stickiness/
/en/overview/mannual/java-sdk/advanced-features-and-usage/service/delay-publish/
/en/overview/mannual/java-sdk/advanced-features-and-usage/service/preflight-check/
/en/overview/mannual/java-sdk/advanced-features-and-usage/service/registry-only/
/en/overview/mannual/java-sdk/advanced-features-and-usage/service/service-downgrade/
/en/overview/mannual/java-sdk/advanced-features-and-usage/service/subscribe-only/ description: Contains all configuration components supported by Dubbo and all configuration items supported by each configuration component. linkTitle: Configuration Manual title: Configuration Reference Manual type: docs weight: 6

JVM (-D) Parameters

JVM Parameter	Example Value	Description
dubbo.{config-name}.{property}	-Ddubbo.application.name=“dubbo-demo” -Ddubbo.registry.address=“nacos://host:port” -Ddubbo.protocol.port=“20880” ……	Dubbo supports specifying all configuration items in the JVM parameter format. Here, `config` refers to items such as application, registry, protocol, and `property` refers to specific properties within each configuration item.
dubbo.resolve.file	-Ddubbo.resolve.file=/home/ken/…/dubbo-resolve.properties	Specifies the direct connection URL for each interface in the file, e.g., org.apache.dubbo.demo.DemoService=tri://127.0.0.1:50051/org.apache.dubbo.demo.DemoService?xxx=xxx
org.graalvm.nativeimage.imagecode		https://github.com/oracle/graal/blob/master/sdk/src/org.graalvm.nativeimage/src/org/graalvm/nativeimage/ImageInfo.java
dubbo.properties.file	-Ddubbo.properties.file=foo.properties	Specifies the properties configuration file path, which can be an absolute path or a classpath-relative path. Default value is `dubbo.properties`.
dubbo.jstack-dump.max-line	-Ddubbo.jstack-dump.max-line=20	Dubbo supports automatic printing of the call stack. This parameter controls the number of stack lines, e.g., only the first 20 lines will be printed.
dubbo.json-framework.prefer	-Ddubbo.json-framework.prefer=gson	Sets the specific implementation of JSON serialization in the framework. Currently available implementations are `fastjson2`, `fastjson`, `gson`, `jackson`. The framework automatically finds the available implementation in decreasing order of preference.
dubbo.network.interface.ignored	-Ddubbo.network.interface.ignored=eth1,eth2	In multi-network card environments, used when you need to manually control the network card address registered with the registry. It is used to exclude certain network cards.
dubbo.network.interface.preferred	-Ddubbo.network.interface.preferred=eth0	In multi-network card environments, used to specify a particular network card for registration with the registry.
sun.rmi.transport.tcp.responseTimeout	-Dsun.rmi.transport.tcp.responseTimeout=5000	Sets the timeout for RMI protocol, in milliseconds.
env		Specific parameter for Apollo configuration center.
app.id		Specific parameter for Apollo configuration center.
apollo.cluster		Specific parameter for Apollo configuration center.
apollo.meta		Specific parameter for Apollo configuration center.
dubbo.mapping.cache.filePath	-Ddubbo.mapping.cache.filePath=~/.dubbo/mapping/	Sets the cache file for `interface-application` mapping, usually for service discovery. The file’s absolute path address.
dubbo.mapping.cache.fileName	-Ddubbo.mapping.cache.fileName=dubbo-mapping	Sets the cache file for `interface-application` mapping, usually for service discovery. The file name; the final file will be stored as `dubbo-mapping.dubbo.cache`.
dubbo.mapping.cache.entrySize	-Ddubbo.mapping.cache.maxFileSize=300	Sets the maximum number of entries in the `interface-application` mapping cache file, usually for service discovery.
dubbo.mapping.cache.maxFileSize	-Ddubbo.mapping.cache.maxFileSize=104857600	Sets the maximum space for the `interface-application` mapping cache file, usually for service discovery, in bytes.
dubbo.meta.cache.filePath	-Ddubbo.meta.cache.filePath=~/.dubbo/meta/	Sets the cache file for `metadata` cache, usually for service discovery. The file’s absolute path address.
dubbo.meta.cache.fileName	-Ddubbo.meta.cache.fileName=dubbo-meta	Sets the cache file for `metadata` cache, usually for service discovery. The file name; the final file will be stored as `dubbo-meta.dubbo.cache`.
dubbo.meta.cache.entrySize	-Ddubbo.meta.cache.maxFileSize=300	Sets the maximum number of entries in the `metadata` cache file, usually for service discovery.
dubbo.meta.cache.maxFileSize	-Ddubbo.meta.cache.maxFileSize=104857600	Sets the maximum space for the `metadata` cache file, usually for service discovery, in bytes.
dubbo.application.use-secure-random-request-id	-Ddubbo.application.use-secure-random-request-id=true	Sets the rule for generating the request ID for each RPC call. If not set, an incremental value will be used.
dubbo.protocol.default-close-timeout	-Ddubbo.protocol.default-close-timeout=10000	Sets the TCP server shutdown wait time, in milliseconds.
dubbo.protocol.default-heartbeat	-Ddubbo.protocol.default-heartbeat=10000	Sets the interval for initiating heartbeat, in milliseconds.
dubbo.hessian.allowNonSerializable		Allows serialization of classes that do not implement the `Serializable` interface, effective for Hessian serialization.
dubbo.application.hessian2.whitelist	-Ddubbo.application.hessian2.whitelist=true	Enables a whitelist mechanism for Hessian serialization. If set to true, it will continue to configure the following allow rules; otherwise, it will configure the deny rules.
dubbo.application.hessian2.allow	-Ddubbo.application.hessian2.allow=org.apache.dubbo.;com.company.	If true, configures allow rules (refer to the documentation for more details).
dubbo.application.hessian2.deny	-Ddubbo.application.hessian2.deny=org.apache.dubbo.;io.commons.	If false, configures deny rules (refer to the documentation for more details).
dubbo.application.manual-register	-Ddubbo.application.manual-register=true	When set, all services will not be automatically registered to the registry until the user calls `online` or other commands to manually complete registration.
dubbo.compact.enable
dubbo.migration-file.enable	-Ddubbo.migration-file.enable=true	Whether to enable rule file reading during migration to application-level address discovery.
dubbo.migration.file	-Ddubbo.migration.file=dubbo-migration.yaml	Specifies the path to the rule file for migrating to application-level address discovery, which can be an absolute or classpath-relative path. Default value is `dubbo-migration.yaml`.
dubbo.application.logger	-Ddubbo.application.logger=slf4j	Sets the logging component used by the Dubbo framework. After setting, Dubbo’s own logs will be printed here (does not affect application logs). Currently supported components are `slf4j`, `log4j`, `log4j2`, etc. Ensure that the corresponding component dependency is added to the application.
dubbo.properties.file	-Ddubbo.properties.file=foo.properties	Specifies the properties configuration file path, which can be an absolute or classpath-relative path. Default value is `dubbo.properties`.

Environment Variables

Environment Variable	Example Value	Description
DUBBO_{CONFIG-NAME}.{PROPERTY}	DUBBO_APPLICATION_NAME=“dubbo-demo” DUBBO_REGISTRY_ADDRESS=“nacos://host:port” DUBBO_PROTOCOL_PORT=“20880” ……	Dubbo supports specifying all configuration items as environment variables. `CONFIG-NAME` refers to items such as application, registry, protocol, and `PROPERTY` refers to specific properties within each item.
DUBBO_DEFAULT_SERIALIZATION	DUBBO_DEFAULT_SERIALIZATION=“hessian2”	Sets the default serialization method for the framework, e.g., `hessian2`, `fastjson2`, `msgpack`.
DUBBO2_COMPACT_ENABLE	DUBBO2_COMPAT_ENABLE=“true”
DUBBO_ENV_KEYS	DUBBO_LABELS=“tag1=value1; tag2=value2”	`tag1=value1` will be reported as an additional parameter to the URL, serving as a system environment variable for instance tagging, etc.
DUBBO_LABELS	DUBBO_ENV_KEYS=“DUBBO_TAG1, DUBBO_TAG2”	Dubbo will read `DUBBO_TAG1`, `DUBBO_TAG2` environment variables, and report values such as `DUBBO_TAG1=value` as additional parameters to the URL.
POD_NAMESPACE		Specifies the namespace for Kubernetes Service scenarios.
CLUSTER_DOMAIN		Specifies the cluster name for Kubernetes Service scenarios, default is `default`.
DUBBO_IP_TO_REGISTRY	DUBBO_IP_TO_REGISTRY=30.123.45.187	Specifies the IP address to register in the registry URL.
DUBBO_PORT_TO_REGISTRY	DUBBO_PORT_TO_REGISTRY=20880	Specifies the port number to register in the registry URL.
DUBBO_{PROTOCOL}_PORT_TO_REGISTRY	DUBBO_DUBBO_IP_TO_REGISTRY=30.123.45.187 DUBBO_TRI_IP_TO_REGISTRY=30.123.45.187	Specifies the IP address to register in the registry URL, and can specify different IPs for different protocols.
DUBBO_{PROTOCOL}_PORT_TO_REGISTRY	DUBBO_DUBBO_PORT_TO_REGISTRY=20880 DUBBO_TRI_PORT_TO_REGISTRY=50051	Specifies the port number to register in the registry URL, and can specify different ports for different protocols.
DUBBO_IP_TO_BIND	DUBBO_IP_TO_BIND=30.123.45.187	Specifies the IP address for TCP binding.
DUBBO_PORT_TO_BIND	DUBBO_PORT_TO_BIND=20880	Specifies the port for TCP binding.
DUBBO_{PROTOCOL}_IP_TO_BIND	DUBBO_DUBBO_IP_TO_BIND=30.123.45.187 DUBBO_TRI_IP_TO_BIND=30.123.45.187	Specifies the IP address for TCP binding, and can specify different IPs for different protocols.
DUBBO_{PROTOCOL}_PORT_TO_BIND	DUBBO_DUBBO_PORT_TO_BIND=20880 DUBBO_TRI_PORT_TO_BIND=50051	Specifies the port for TCP binding, and can specify different ports for different protocols.
dubbo.properties.file	dubbo.properties.file=foo.properties	Specifies the properties configuration file path, which can be an absolute or classpath-relative path. Default value is `dubbo.properties`.
dubbo.migration.file	dubbo.migration.file=dubbo-migration.yaml	Specifies the migration rule file path for application-level address discovery, which can be an absolute or classpath-relative path. Default value is `dubbo-migration.yaml`.

Configuration Manual

Regardless of whether you are using Spring Boot, XML, annotations, or APIs to write Dubbo applications, you can refer to the table below to understand the specific meaning of each configuration item.

Configuration Manual on Apache Dubbo

Configuration of the Dubbo Maven Plugin

Dubbo Maven Plugin For Protobuf

How to use Dubbo Maven Plugin to generate Protobuf Stub code

1. Write the .proto file

Configuration Working Principle

Implementation Principles

JVM (-D) Parameters

Environment Variables

Configuration Manual