4.3.1. build.gradle 的结构
本章节介绍 build.gradle
脚本的结构和主要元素。
- buildscript
- cuba
-
CUBA 特殊的构建逻辑封装在
cuba
Gradle 插件里。CUBA 插件在构建脚本的根节点引用,同时也需要在所有模块的configure
部分使用下面这个语句引用进来:apply(plugin: 'cuba')
cuba 插件的配置在
cuba
部分定义:cuba { artifact { group = 'com.company.sales' version = '0.1' isSnapshot = true } tomcat { dir = "$project.rootDir/build/tomcat" } ide { copyright = '...' classComment = '...' vcs = 'Git' } }
以下是一些可选的参数:
-
artifact
- 这里定义项目工件的分组和版本信息。工件的名称按照settings.gradle
里面设置的模块名称来设置。-
group
- 工件组 -
version
- 工件版本 -
isSnapshot
- 如果设置true
,工件名称会被添加SNAPSHOT
后缀。可以通过命令行参数来覆盖工件的版本,示例:
gradle assemble -Pcuba.artifact.version=1.1.1
-
-
tomcat
- 这部分定义了用来 快速部署的 Tomcat 服务的设置。-
dir
- Tomcat 的 安装目录。 -
port
- Tomcat 监听端口,默认 8080。 -
debugPort
- Java 调试监听端口,默认 8787。 -
shutdownPort
- 监听SHUTDOWN
命令的端口,默认 8005。 -
ajpPort
- AJP 连接器端口,默认 8009。
-
-
ide
- 这部分包含 Studio 和 IDE 的内容-
vcs
- 项目的版本控制系统配置,目前只支持Git
或者svn
。 -
copyright
- 插入到每个源文件开头的版权信息。 -
classComment
- Java 源文件类声明开头插入的注释信息。
-
-
uploadRepository
- 这部分定义了使用uploadArchives
任务上传打包的项目工件目标 仓库的设置。-
url
- 仓库的地址 URL。如果不设置,默认会使用 Haulmont 的仓库地址。 -
user
- 访问仓库的用户名。 -
password
- 访问仓库的密码。也可以通过命令行参数的方式给这个上传仓库的任务提供参数:
gradlew uploadArchives -PuploadUrl=http://myrepo.com/content/repositories/snapshots -PuploadUser=me -PuploadPassword=mypassword
-
-
- dependencies
-
这部分包含了项目中使用的一组应用程序组件。组件通过他们各自的 global 模块来指定。在下面的例子中,使用了三个组件:
com.haulmont.cuba
(cuba 平台组件),com.haulmont.reports
(reports premium 组件) 和com.company.base
(自定义组件):dependencies { appComponent("com.haulmont.cuba:cuba-global:$cubaVersion") appComponent("com.haulmont.reports:reports-global:$cubaVersion") appComponent("com.company.base:base-global:0.1-SNAPSHOT") }
- configure
-
configure
部分包含模块的配置。其中最主要的部分就是声明依赖,示例:configure(coreModule) { dependencies { // standard dependencies using variables defined in the script above compile(globalModule) provided(servletApi) jdbc(hsql) testRuntime(hsql) // add a custom repository-based dependency compile('com.company.foo:foo:1.0.0') // add a custom file-based dependency compile(files("${rootProject.projectDir}/lib/my-library-0.1.jar")) // add all JAR files in the directory to dependencies compile(fileTree(dir: 'libs', include: ['*.jar'])) }
entitiesEnhancing
配置模块用来对实体类进行字节码增强(weaving - 也叫织入),至少需要在 global 模块声明这个任务,也可以在其它模块分别声明。这里的
main
和test
分别是项目和测试的代码目录,可选的persistenceConfig
参数用来指定各自的 persistence.xml 文件。如果这个可选参数没设置,这个任务会对 CLASSPATH 里能找到的*persistence.xml
文件中的所有实体做增强。configure(coreModule) { ... entitiesEnhancing { main { enabled = true persistenceConfig = 'custom-persistence.xml' } test { enabled = true persistenceConfig = 'test-persistence.xml' } } }
非标准的模块依赖可以在 Studio 中通过 CUBA 项目视图的 Project properties 部分来设置。
对于动态版本依赖和版本冲突的问题,可以用 Maven 对此场景的解决方法。按照这个方法,正式版本的优先级会高于快照版本,而且越新的版本有越精确的版本编号。所有条件都一样的情况下,版本编号按照字母表的顺序定优先级,示例:
|