Build parameter reference

Distinguish between template coordinates, engineering coordinates, general application parameters and RPC-specific parameters.

Template and project coordinates

parametersmeaningExample
archetypeGroupIdTemplate groupIdcom.lodsve.archetype
archetypeArtifactIdWhich template to chooselodsve-archetype-quickstart
archetypeVersiontemplate versionRelease version 1.0.3 or locally installed 1.0.4-SNAPSHOT
groupIdNew project groupIdcom.example
artifactIdNew project artifactIddemo-app
versionNew project version1.0.0-SNAPSHOT
interactiveModeWhether to confirm interactivelyAutomated use false

Common parameters required by templates

parametersmeaningMetadata defaultsApplicable template
packageJava base packageNot providedAll
bootVersionGenerate the Lodsve Boot parent version of the POMNot providedAll
authorAuthorNot providedAll
portApplication listening port8080Except RPC API
contextPathServlet context path/Except RPC API

Explicitly pass in all necessary parameters when generating batches. bootVersion will not upgrade the Java source code in the template or automatically migrate historical configurations.

RPC specific parameters

parametersApplicable templatemeaning
serverAppNameRPC APIspring.application.name on the server side, used for Feign service name
serverContextPathRPC APIServer context path
apiGroupIdRPC Server / ClientThe groupId of the shared API project
apiArtifactIdRPC Server / ClientArtifactId of the shared API project
apiVersionRPC Server / ClientSharing the version of the API project

The package of the three RPC templates should be consistent, or the reference package name should be adjusted uniformly after generation; they need to share the same set of API types. The service name and context path declared by the API must be consistent with the actual configuration of the server.

Basis

The above default values come from the META-INF/maven/archetype-metadata.xml of each module, rather than treating the example values in the README as default values.

Template repository and metadata

Architecture diagram