Grails 命令行

本文主要是介绍Grails 命令行，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

Grails的命令行系统是构建于 Gant 之上，Gant就是使用Groovy对 Apache Ant 进行了简单的包装。

然而，Grails通过约定规则以及grails命令的使用带来了一些改进。当你键入如下内容时：

grails [命令名称]

为了Gant脚本的执行，Grails会在下列目录中做一次搜索：

• USER_HOME/.grails/scripts
• PROJECT_HOME/scripts
• PROJECT_HOME/plugins/*/scripts
• GRAILS_HOME/scripts

Grails将把小写的命令名称（如run-app）转换为单词连写的格式。因此如果键入的是

grails run-app

，那么Grails将会搜索下列文件：

• USER_HOME/.grails/scripts/RunApp.groovy
• PROJECT_HOME/scripts/RunApp.groovy
• PLUGINS_HOME/*/scripts/RunApp.groovy
• GLOBAL_PLUGINS_HOME/*/scripts/RunApp.groovy
• GRAILS_HOME/scripts/RunApp.groovy

如果找到多个同名的文件，Grails将要求你选择执行其中的一个。当Grails执行一个Gant脚本的时候，它会首先调用定义在脚本文件中的“default”任务。如果找不到“default”任务，Grails将退出并报错。

获得可用的命令及其帮助信息：

grails help

这个命令将输出Grails当前所知的命令列表和使用说明：

Usage (optionals marked with *): 
grails [environment]* [target] [arguments]*

参考本使用指南左侧菜单中的命令行指南，可以获得更多的命令行的信息。

4.1 创建Gant脚本

你可以在项目的根目录下运行 create-script 命令来创建你自己的Gant脚本。例如如下命令：

grails create-script compile-sources

这将创建一个叫做 scripts/CompileSources.groovy 的脚本。Gant脚本本身与规范的Groovy脚本非常相似，除了它支持“targets”的概念以及它们之间的依赖关系：

target(default:"default任务是由Grails来执行的") {depends(clean, compile)
}
target(clean:"清除一些东西") {ant.delete(dir:"output")
}
target(compile:"编译一些源码") {ant.mkdir(dir:"mkdir")ant.javac(srcdir:"src/java", destdir:"output")
}

如上面的脚本所说明的，这个内置的 ant 变量可以访问 Apache Ant API。

在以前的Grails中（1.0.3和以下），这个变量是 Ant，即第一个字母是大写的。

你也可以依赖其他的任务，只要在 default 任务中使用 depends 方法说明。

默认任务（default）

在上边的例子中，我们使用明确的名称“default”来指明一个任务。这是为一个脚本文件定义默认任务的一种方式。可选的另一种方式是使用 setDefaultTarget() 方法：

target("clean-compile": "对应用程序源文件执行清理并编译。") {depends(clean, compile)
}
target(clean:"清除文件") {ant.delete(dir:"output")
}
target(compile:"编译源码") {ant.mkdir(dir:"mkdir")ant.javac(srcdir:"src/java", destdir:"output")
}

这样将允许你从其他脚本中直接调用默认的任务。另外，尽管在这个例子中我们把调用 setDefaultTarget() 这一行放在了脚本文件的最后，但你可以把它放在任何位置，只要它位于它要引用的那个任务 之后（在这个例子中这个任务就是“clean-compile”）。

哪种方式更好？坦率地说，你可以使用你喜欢的那种方式——看起来这两种方式都没有什么突出的优势。我们应该讨论的一个问题是，如果你想要允许任何其他脚本都能调用你的“default”任务，那么你应该把它移动到一个没有默认任务的共享脚本文件中。关于这些内容，我们将在下一章节进行更多讨论。

4.2 重用Grails脚本

Grails带了许多开箱即用的命令行功能，你会发现这在你自己的脚本中那个会很有用（查看参考指南的命令行指南部分可以获得所有命令的详细信息）。尤其是使用 compile 、 package 和 bootstrap 脚本。

下边的bootstrap脚本例子允许你启动一个Spring的 ApplicationContext 实例，通过它来访问数据源等(集成测试时可以这样用）：

includeTargets << grailsScript("_GrailsBootstrap")

从其他脚本文件引入任务

Gant允许你从另一个Gant脚本文件中引入所有任务（除了“default”）。然后你就可以依赖或调用这些已经被定义在当前脚本文件中的任务了。实现的途径是 includeTargets 属性。使用左移操作符来简单的“附加”一个文件或类：

includeTargets << new File("/path/to/my/script.groovy")
includeTargets << gant.tools.Ivy

不用太担心关于使用一个类的语法，它是相当专业的。要是你感兴趣，可以看看Gant的文档。

核心的Grails任务

如你在本章开头部分所看到的例子，当使用includeTargets来包含核心的Grails任务时，既没有使用基于文件的语法也没有使用基于类的语法。取而代之的，你应该使用Grails命令启动器提供的特殊的 grailsScript() 方法（注意这个方法在一般的Gant脚本中是不可用的，只有在Grails环境中才行）。

grailsScript() 方法的语法是非常简单易读的：简单的把你想要包含的Grails脚本文件的名称传入，不需要任何路径信息。以下是一个你可能想要重用的Grails脚本列表：

这些由Grails提供的脚本很值得对它们进行深入的分析，从而找出哪些类型的任务是可以使用的。任何脚本文件都是以“_”作为前缀以便进行重用。

在Grails 1.1版本之前，“_Grails...”这样的脚本文件是不可用的。而通常会包含对应命令脚本，例如“Init.groovy”或“Bootstrap.groovy”。

同样，在Grails 1.0.4版本之前，是无法使用 grailsScript() 方法的，你只能使用 includeTargets << new File(...) 并指明脚本的完整位置。（例如： $GRAILS_HOME/scripts）。

脚本结构

你可能对这些下划线词语作为Grails脚本的名称感到疑惑。用_internal_作为一个脚本或者用没有对应的“command”的其他单词，这些就是Grails的决定方式。因此无法运行例如“grails _grails-settings”这样的命令。这也就是为什么它们没有个默认的任务。

内部脚本是和代码共享重用相关的。实际上，我们建议在自己的脚本中使用类似的方式：把你的所有任务放入一个内部脚本中可以更容易的共享，然后提供简单的命令脚本来解析任何命令行参数并委托给内部脚本中的任务。假如你有一个脚本要运行一些功能测试——你可以将它们像这样分离：

./scripts/FunctionalTests.groovy:

以下是在编写脚本时常用的一些指导方案：

• 将脚本分为“command”脚本和内部脚本。
• 将大部分执行脚本放入内部脚本。
• 将参数解析放入“command”脚本。
• 要把参数传入一个任务，先创建一些脚本变量并在调用任务前将它们初始化。
• 为了避免名称冲突，可以为脚本变量分配闭包以替代任务。之后你可以直接将参数传入闭包。

4.3 钩子事件

Grails提供了钩住脚本事件的能力。这里指的是当Grails的任务和插件脚本执行的时候能触发的一些事件。

这个机制是故意简单化和松散的规定的。可能的事件列表是不会以任何方式固定的，所以可以钩住那些被插件脚本触发的事件，在核心目标脚本中没有类似的事件。

定义事件处理器

事件处理器是定义在称为 _Events.groovy 的脚本文件中。Grails会在以下位置搜索这些脚本：

• USER_HOME/.grails/scripts - 用户特定的事件处理器
• PROJECT_HOME/scripts - 应用程序特定的事件处理器
• PLUGINS_HOME/*/scripts - 插件特定的事件处理器
• GLOBAL_PLUGINS_HOME/*/scripts - 由全局插件提供的事件处理器

无论事件在何时被激发， 所有 已经注册到该事件的处理器都会被执行。需要注意的是处理器的注册工作会由Grails自动进行，你只需要在相关的 _Events.groovy 文件中声明即可。

在Grails 1.0.4版本之前，脚本文件被命名为 Events.groovy，它没有前下划线。

事件处理器是分块定义在 _Events.groovy 文件中，使用“event”作为名称的开头部分。下边的例子可以被放在你的 /scripts 目录中来展示这个特性：

eventCreatedArtefact = { type, name ->println "Created $type $name"
}

你可以看到这儿有三个处理器分别是：eventCreatedArtefact、eventStatusUpdate和eventStatusFinal。Grails提供了一些标准的事件，它们在命令行参考指南中有描述。例如compile命令会激发下列事件：

• CompileStart - 当编译过程开始时，针对这几种类型的编译——源文件和测试文件
• CompileEnd - 当编译过程完成时，针对这几种类型的编译——源文件和测试文件

触发事件

要简单地触发一个包含Init.groovy脚本的事件并调用event()闭包：

includeTargets << grailsScript("_GrailsEvents")

公共事件

下表是一些可以被利用的公共事件：

4.4 自定义构建

Grails无疑是一个固执己见框架，并且它喜欢按照约定来进行配置，但这并不意味着你 不能 去配置它。在本章，我们将看到你可以如何去影响和修改标准的Grails构建。

默认

为了自定义一个构建，你首先需要知道你可以自定义些什么。Grails构建配置的核心就是 grails.util.BuildSettings 类，它包含了大量有用的信息。它控制了哪些类被编译、应用程序依赖什么以及其他类似的设置。

以下是一个配置选项和它们的默认值的集录：

BuildSettings 类也有一些其他属性，但是它们应该被只读处理：

当然，如果你不能获得这些属性那么它们并没有多好。幸运的是这很容易实现：通过grailsSettings脚本变量可以得到一个 BuildSettings 实例用于你的脚本。你也可以在你的代码中通过使用 grails.util.BuildSettingsHolder 类来访问它，但是并不推荐这样做。

覆盖默认值

所有在第一个表中的属性都可以被一个系统属性或配置选项所覆盖——简单地使用“config option”名称。例如，要改变项目工作目录，你可以运行这个命令：

grails -Dgrails.project.work.dir=work compile

或者将这个选项添加到你的 grails-app/conf/BuildConfig.groovy 文件中：

grails.project.work.dir = "work"

注意默认值带有许多它们依赖的属性值，因此像这样设置项目工作目录也将迁移编译好的类、测试类、资源和插件。

如果你同时使用系统属性和配置选项将发生什么？当然是系统属性被采用了，因为它优先于 BuildConfig.groovy 文件，而后者优先于默认值。

BuildConfig.groovy 文件是 grails-app/conf/Config.groovy 的姐妹文件，——过去包含的选项仅仅影响构建，但是之后包含的就影响正在运行的应用程序了。这并不局限于第一个表中的选项：你会发现构建配置选项在文档中到处都是，比如其中一些就用来指定内嵌的servlet容器应该运行在哪个端口上或者决定哪些文件应该被打包到WAR文件中。

可用的构建设置

4.5 Ant和Maven

如果你的团队或公司的所有其他项目都在使用像Ant或Maven这样的标准的构建工具进行构建的，当你使用Grails命令行来构建你的应用程序时你可能成为害群之马。幸运的是，今天你可以很容易的将Grails构建系统集成到正在使用的主要构建工具中（嗯，至少是在Java项目中使用的那种构建工具）。

Ant集成

当你通过 create-app 命令来创建一个Grails应用程序时，Grails会自动为你创建一个 Apache Ant 工具使用的build.xml文件，这个文件包含了下列的任务：

• clean - 清理Grails应用程序
• compile -编译你的应用程序的源码
• test - 运行单元测试
• run - 等同于“grails run-app”的功能
• war - 创建一个WAR文件
• deploy - 默认为空，但可以用它实现自动部署

这些任务都可以被Ant运行，例如：

ant war

为了实现依赖管理，构建文件已经被全面改进为使用 Apache Ivy，这意味着它可以自动下载所有需要的Grails JAR文件和其他以来的文件。你甚至不必在本地安装Grails就可以使用它了！这对于需要使用像CruiseControl或Hudson这样的持续集成系统进行自动构建时特别有用。

这里使用了Grails的Ant task来对现有的Grails构建系统进行钩子操作。这个任务允许你运行任何可用的Grails脚本，不只是由生成的构建文件所使用的那些。要使用某个任务，你必须先声明它：

<taskdef name="grailsTask"classname="grails.ant.GrailsTask"classpathref="grails.classpath"/>

这也引出了另外的问题：“grails.classpath”中应该是什么内容？这个任务本身是在“grails-bootstrap”这个JAR工件中的，因此至少这个工件需要在classpath中。同时也应该包含“groovy-all”这个JAR。对于定义这个任务，你只需要使用这个！下表列出了可用的属性：

这个任务也支持下列内嵌元素，这些全都是标准的Ant路径结构：

• classpath - 构建classpath（用来载入Gant和Grails脚本）。
• compileClasspath - 用来编译应用程序的类的Classpath。
• runtimeClasspath - 用来运行应用程序并将程序打成WAR包的Classpath。通常包含了@compileClasspath中的一切。
• testClasspath - 用来编译和运行测试的Classpath。通常包含了 runtimeClasspath中的一切。

要如何填写这些路径信息完全取决于你。如果你正在使用 home 属性并且把你自己的依赖内容放在了 lib 目录中，那么你不需要使用以上任何一个路径。如果想看看使用它们的例子，那么就查看为一个新应用而生成的Ant构建文件吧。

Maven集成

从1.1版本起，Grails通过一个Maven插件提供了与 Maven 2 的集成。当前作为基础的Maven插件，特别是由 Octo 创建的这个版本是非常有效的，它做得非常出色。

准备

为了使用这个新的插件，你只需要安装和设置Maven 2。这是因为 你不再需要单独的安装Grails为了使用Maven！

Grails集成Maven 2已经针对Maven 2.0.9及以上版本进行了设计和测试。它将无法工作在更早期的版本中。

为了让你的生活更轻松，我们强烈推荐你添加一个用于Grails的插件组到Maven的设置文件中（$USER_HOME/.m2/settings.xml）：

<settings>…<pluginGroups><pluginGroup>org.grails</pluginGroup></pluginGroups>
</settings>

另外，如果你已经有用于Grails设置的Octo Maven工具，那么你需要删除 com.octo.mtg 插件组。

创建一个 Grails Maven 项目

要简单地创建一个支持Maven的Grails项目只要运行下边的命令：

mvn archetype:generate -DarchetypeGroupId=org.grails \-DarchetypeArtifactId=grails-maven-archetype \-DarchetypeVersion=1.0-SNAPSHOT \-DarchetypeRepository=http://snapshots.repository.codehaus.org \-DgroupId=example -DartifactId=my-app

无论你想为你的应用选择哪个group ID和artifact ID，一切内容格式都必须像上面写的那样。这将创建一个新的Maven项目以及一个POM文件和一系列其他文件。你不会看到有什么是像一个Grails应用。因此，下一步就要创建一个你要使用的项目结构了：

cd my-app
mvn initialize

现在你已经有一个可以使用的Grails应用了。插件已经集成到了标准的构建周期，因此你可以使用标准的Maven语法来构建和打包你的应用程序了： mvn clean ， mvn compile ， mvn test ， mvn package 。

你也可以利用许多已经被包装成Maven目标的Grails命令：

• grails:create-controller - 调用 create-controller 命令
• grails:create-domain-class - 调用 create-domain-class 命令
• grails:create-integration-test - 调用 create-integration-test 命令
• grails:create-pom - 为现有的Grails项目创建一个新的Maven POM文件
• grails:create-script - 调用 create-script 命令
• grails:create-service - 调用 create-service 命令
• grails:create-taglib - 调用 create-tag-lib 命令
• grails:create-unit-test - 调用 create-unit-test 命令
• grails:exec - 执行一个任意的Grails命令行脚本
• grails:generate-all - 调用 generate-all 命令
• grails:generate-controller - 调用 generate-controller 命令
• grails:generate-views - 调用 generate-views 命令
• grails:install-plugin - 调用 install-plugin 命令
• grails:install-templates - 调用 install-templates 命令
• grails:list-plugins - 调用 list-plugins 命令
• grails:package - 调用 package 命令
• grails:run-app - 调用 run-app 命令
• grails:uninstall-plugin - 调用 uninstall-plugin 命令

给现有项目加入Maven支持

创建一个全新的项目当然是一个很好的途径，但如果已经有一个项目了该怎么办呢？你应该不会愿意先创建一个新项目然后再把旧项目的内容拷贝进去的。解决方法是使用下列命令为现有项目创建一个POM文件：

mvn grails:create-pom -DgroupId=com.mycompany

当这个命令完成时，你就可以立即使用标准的语法了，如 mvn package 。需要注意的是当创建POM文件时你必须指定一个group ID。

添加Grails命令到 phase 中

标准的POM文件被创建是为了让Grails将合适的核心Grails命令附加到它们对应的构建语法上，因此“compile”对应“compile”语法，“war”对应“package”语法。当你想要将一个插件的命令附加到一个特定的phase上时，这可能没有什么帮助。典型的例子是功能测试。你如何确保你的功能测试（无论正在使用你决定的哪个插件）是使用“integration-test” phase来运行的？

恐怕不是：所有事情都是可能的。在这个例子中，你可以使用额外的“execution”块来将命令联合到一个 phase 上：

<plugin><groupId>org.grails</groupId><artifactId>grails-maven-plugin</artifactId><version>1.0-SNAPSHOT</version><extensions>true</extensions><executions><execution><goals>…</goals></execution><!-- 添加 "functional-tests" 命令到 "integration-test" phase --><execution><id>functional-tests</id><phase>integration-test</phase><goals><goal>exec</goal></goals><configuration><command>functional-tests</command></configuration></execution></executions></plugin>

这也展示了 grails:exec 目标，它可以用来运行任何Grails命令。简单的将命令的名字作为 command 系统特性，还可以通过 args 特性来选择性地指定参数：

mvn grails:exec -Dcommand=create-webtest -Dargs=Book

这篇关于Grails 命令行的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！