blocks|key|587346|text|我通常会从org.gradle.api+package中抛出相关的异常，例如当有人输入了无效的内容时抛出InvalidUserDataException，或者在出现更常见的错误时抛出GradleScriptException。|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|587347|如果要停止当前任务或操作，并继续执行下一个任务或操作，也可以抛出StopActionException|587348|entityMap|0|LINK|mutability|MUTABLE|url|https://docs.gradle.org/current/javadoc/org/gradle/api/package-summary.html|1|http://gradle.org/docs/current/javadoc/org/gradle/api/InvalidUserDataException.html|2|http://gradle.org/docs/current/javadoc/org/gradle/api/GradleScriptException.html|3|http://gradle.org/docs/current/javadoc/org/gradle/api/tasks/StopActionException.html^0|5|E|1G|O|2J|L|5|M|0|1G|O|1|2J|L|2|0|W|J|W|J|3|0^^$0|@$1|2|3|4|5|6|7|V|8|@$9|W|A|X|B|C]|$9|Y|A|Z|B|C]|$9|10|A|11|B|C]]|D|@$9|12|A|13|1|14]|$9|15|A|16|1|17]|$9|18|A|19|1|1A]]|E|$]]|$1|F|3|G|5|6|7|1B|8|@$9|1C|A|1D|B|C]]|D|@$9|1E|A|1F|1|1G]]|E|$]]|$1|H|3|-4|5|6|7|1H|8|@]|D|@]|E|$]]]|I|$J|$5|K|L|M|E|$N|O]]|P|$5|K|L|M|E|$N|Q]]|R|$5|K|L|M|E|$N|S]]|T|$5|K|L|M|E|$N|U]]]]

I usually throw the relevant exception from the <a href="https://docs.gradle.org/current/javadoc/org/gradle/api/package-summary.html" rel="noreferrer" title="See the &quot;Exception Summary&quot; table"><code>org.gradle.api</code> package</a>, for example <a href="http://gradle.org/docs/current/javadoc/org/gradle/api/InvalidUserDataException.html" rel="noreferrer"><code>InvalidUserDataException</code></a> for when someone has entered something invalid, or <a href="http://gradle.org/docs/current/javadoc/org/gradle/api/GradleScriptException.html" rel="noreferrer"><code>GradleScriptException</code></a> for more general errors.

If you want to stop the current task or action, and move on to the next, you can also throw a <a href="http://gradle.org/docs/current/javadoc/org/gradle/api/tasks/StopActionException.html" rel="noreferrer"><code>StopActionException</code></a>

blocks|key|371701|text|目前还没有专门的方法，尽管已经讨论过要添加一个。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|371702|停止Gradle构建的推荐方法是抛出异常。由于Groovy没有检查异常，而Gradle默认情况下不打印异常类型，因此抛出哪个异常并不是那么关键。在构建脚本中，经常使用GradleException，但是Groovy断言似乎也是合理的(取决于环境和受众)。重要的是提供一个清晰的信息。添加原因(如果可用)有助于调试(--stacktrace)。|offset|length|style|CODE|371703|Gradle提供了专用的异常类型StopExecutionException/StopActionException，用于停止当前任务/任务操作，但继续构建。|371704|entityMap^0|0|4D|C|0|G|M|13|J|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|M|8|@$D|N|E|O|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|P|8|@$D|Q|E|R|F|G]|$D|S|E|T|F|G]]|9|@]|A|$]]|$1|J|3|-4|5|6|7|U|8|@]|9|@]|A|$]]]|K|$]]

There is currently no dedicated method, although there have been discussions to add one. 

The recommended way to stop a Gradle build is to throw an exception. Since Groovy doesn't have checked exceptions, and Gradle by default does not print the exception type, it's not that critical which exception is thrown. In build scripts, GradleException is often used, but a Groovy assertion also seems reasonable (depending on the circumstances and audience). What's important is to provide a clear message. Adding a cause (if available) helps for debugging (<code>--stacktrace</code>).

Gradle provides dedicated exception types <code>StopExecutionException</code>/<code>StopActionException</code> for stopping the current task/task action but continuing the build.

blocks|key|371727|text|如果你想停止构建，抛出：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|371728|throw+new+GradleException('error+occurred')|code-block|syntax|javascript|371729|或者抛出上述异常的子类。一些子类异常实际上只会使当前任务失败，但会继续构建。|371730|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|L|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|M|8|@]|9|@]|A|$]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

If you want to stop the build, throw: 

<pre><code>throw new GradleException('error occurred')
</code></pre>

or throw the subclasses for the above exception. Some of the subclass exceptions actually only fail the current task but continue with the build.

blocks|key|587442|text|抛出一个简单的GradleException可以停止构建脚本。这对于检查所需的环境设置非常有用。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|587443|GradleException('your+message,+why+the+script+is+stopped.')|code-block|syntax|javascript|587444|示例：|587445|if(null+==+System.getenv()['GRADLE_USER_HOME'])+{
++++throw+new+GradleException('Required+GRADLE_USER_HOME+environment+variable+not+set.')
}|587446|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|N|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|O|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

Throwing a simple GradleException works in stopping the build script. This works great for
checking required environment setup.

<pre><code>GradleException('your message, why the script is stopped.')
</code></pre>

Example:

<pre><code>if(null == System.getenv()['GRADLE_USER_HOME']) {
 throw new GradleException('Required GRADLE_USER_HOME environment variable not set.')
}
</code></pre>

blocks|key|587517|text|下面是一个代码片段，它试图模拟Gradle+javac任务如何抛出错误：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|587518|task+myCommand(type:Exec)+{

++++...+normal+task+setup+....

++++ignoreExitValue+true
++++standardOutput+=+new+ByteArrayOutputStream()
++++ext.output+=+{+standardOutput.toString()+}
++++doLast+{
++++++++if+(execResult.exitValue)+{
++++++++++++logger.error(output())
++++++++++++throw+new+TaskExecutionException(+it,
++++++++++++++++new+Exception(+"Command+'${commandLine.join('+')}'+failed;+"
++++++++++++++++++++++++++++++%2B+"see+task+output+for+details."+)
++++++++++++)
++++++++}
++++}
}|code-block|syntax|javascript|587519|当该命令返回0时，没有输出。任何其他值都将打印standardOutput并停止构建。|offset|length|style|CODE|587520|注意:如果您的命令也写入errorOutput，则可能需要将其包括在错误日志中。|587521|entityMap^0|0|0|6|1|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|R|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|S|8|@$I|T|J|U|K|L]]|9|@]|A|$]]|$1|M|3|N|5|6|7|V|8|@]|9|@]|A|$]]|$1|O|3|-4|5|6|7|W|8|@]|9|@]|A|$]]]|P|$]]

Here is a code fragment that tries to emulate how the Gradle javac task throws errors:

<pre><code>task myCommand(type:Exec) {

 ... normal task setup ....

 ignoreExitValue true
 standardOutput = new ByteArrayOutputStream()
 ext.output = { standardOutput.toString() }
 doLast {
 if (execResult.exitValue) {
 logger.error(output())
 throw new TaskExecutionException( it,
 new Exception( "Command '${commandLine.join(' ')}' failed; "
 + "see task output for details." )
 )
 }
 }
}
</code></pre>

When the command returns <code>0</code> there is no output. Any other value will print the standardOutput and halt the build.

NOTE: If your command writes to errorOutput as well, you may need to include that in the error log.

How can I stop a Gradle build after detecting a problem? I can use an assert, throw an exception, do a System.exit (bad idea), or use a dedicated function in Gradle (but I could not find one). What is the best way for Gradle (and why?).

Recommended way to stop a Gradle build

如何在检测到问题后停止Gradle构建？我可以使用断言、抛出异常、执行System.exit (坏主意)，或者使用Gradle中的专用函数(但我找不到)。对Gradle来说最好的方法是什么(为什么？)

问停止Gradle构建的推荐方法
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问停止Gradle构建的推荐方法EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问停止Gradle构建的推荐方法
EN