Cách được đề xuất để dừng xây dựng Gradle

Làm cách nào tôi có thể dừng bản dựng Gradle sau khi phát hiện sự cố? Tôi có thể sử dụng một xác nhận, đưa ra một ngoại lệ, thực hiện System.exit (ý tưởng tồi) hoặc sử dụng một chức năng chuyên dụng trong Gradle (nhưng tôi không thể tìm thấy một). Cách tốt nhất cho Gradle (và tại sao?).

Tôi thường ném ngoại lệ có liên quan từ org.gradle.apigói , ví dụ như InvalidUserDataExceptionkhi ai đó đã nhập một cái gì đó không hợp lệ hoặc GradleScriptExceptioncho các lỗi chung hơn.

Nếu bạn muốn dừng nhiệm vụ hoặc hành động hiện tại và chuyển sang tiếp theo, bạn cũng có thể ném StopActionException

Nếu bạn muốn dừng việc xây dựng, hãy ném:

throw new GradleException('error occurred')

hoặc ném các lớp con cho ngoại lệ trên. Một số trường hợp ngoại lệ lớp con thực sự chỉ thất bại nhiệm vụ hiện tại nhưng tiếp tục với việc xây dựng.

Hiện tại không có phương pháp dành riêng, mặc dù đã có các cuộc thảo luận để thêm một phương pháp.

Cách được đề xuất để ngăn chặn bản dựng Gradle là ném ngoại lệ. Vì Groovy không kiểm tra ngoại lệ và Gradle theo mặc định không in loại ngoại lệ, nên việc ném ngoại lệ nào không quan trọng. Trong các tập lệnh xây dựng, GradleException thường được sử dụng, nhưng một xác nhận Groovy cũng có vẻ hợp lý (tùy thuộc vào hoàn cảnh và đối tượng). Điều quan trọng là cung cấp một thông điệp rõ ràng. Thêm một nguyên nhân (nếu có) sẽ giúp gỡ lỗi ( --stacktrace).

Gradle cung cấp các loại ngoại lệ chuyên dụng StopExecutionException/ StopActionExceptionđể dừng tác vụ / tác vụ hiện tại nhưng vẫn tiếp tục quá trình xây dựng.

Một lựa chọn khác nếu bạn không có mong muốn có thể bắt ngoại lệ sau này là gọi nhiệm vụ thất bại. Theo ý kiến ​​của tôi, nó dễ đọc hơn một chút và bạn có thể đưa ra một thông điệp tốt đẹp cho người dùng mà không cần sử dụng --stacktrace.

task (tarball, dependsOn: warAdmin) << {
    ant.fail('The sky is falling!!')
}

Cung cấp cho bạn một tin nhắn như:

* What went wrong:
Execution failed for task ':tarball'.
> The sky is falling!!

Có lẽ bạn có thể bắt được điều này (có lẽ nó ném BuildException của kiến?) Nhưng nếu đó là mục tiêu thì tôi sẽ không sử dụng ant.fail. Tôi chỉ làm cho nó dễ dàng để xem ngoại lệ nào cần nắm bắt bằng cách ném ngoại lệ lớp tiêu chuẩn như tim_yates đề xuất.

Ném một GradleException đơn giản hoạt động trong việc dừng tập lệnh xây dựng. Điều này hoạt động tuyệt vời để kiểm tra thiết lập môi trường cần thiết.

GradleException('your message, why the script is stopped.')

Thí dụ:

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

Đây là một đoạn mã cố gắng mô phỏng cách tác vụ Gradac javac ném lỗi:

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." )
            )
        }
    }
}

Khi lệnh trả về 0không có đầu ra. Bất kỳ giá trị nào khác sẽ in ra StandardOutput và tạm dừng quá trình xây dựng.

LƯU Ý: Nếu lệnh của bạn cũng ghi vào errorOutput, bạn có thể cần đưa nó vào nhật ký lỗi.