🤗 ApiHug × {Postman|Swagger|Api...} = 快↑ 准√ 省↓
- GitHub - apihug/apihug.com: All abou the Apihug
- apihug.com: 有爱,有温度,有质量,有信任
- ApiHug - API design Copilot - IntelliJ IDEs Plugin | Marketplace
ApiHug 整个工具链基于 Gradle, 使用 ApiHug 准备工作最先需要学习的就是 gradle. 工欲善其事,必先利其器
check
和 test
在是 gradle 中常用的两个任务,他们有相似第三方, 此篇文章具体分析他们的差别。
#Gradle
Gradle 是用来做依赖管理工具, 提供各种函数方便来管理构建的整个生命周期, 从测试到最后的发布。
Gradle 通过不同的 task
来完成这些任务, 每个任务都是整个过程的一个环节比如:
- 源码编译 compile
- 打包成模块
- 把模块发布到远程系统
Gradle 有两种类型任务:
- 可执行任务, 也就是响应的动作行为
- lifecycle 任务,是流程任务, 不包含任何动作,
check
即是。
check & test 任务解释:
Verification tasks
------------------
check - Runs all checks.
test - Runs the test suite.
#test
Test 文档open in new window; gradlew test
即用来执行此任务。
Executes JUnit (3.8.x, 4.x or 5.x) or TestNG tests. Test are always run in (one or more) separate JVMs.
test
任务将会执行所有的单元测试, 并测试测试报告。
test
是做 TDD 测试非常重要的一个环节, 我们将有一个专门的篇章讲如何写测试。
#check
check
是一个 lifecycle 任务, 也就是本身她不包含任务操作, 默认 check
讲执行 test
任务, 也就是没有其他插件, check
效果和 test
一样。
check
将所有 验证任务的输出结果汇总起来。 这可以让我们将多个任务的检查结果聚集起来, 避免一个一个操作。 而扩展 The Checkstyle Pluginopen in new window 提供更多扩展功能。
check
其实是由 Base 插件open in new window 引入进来。
check — lifecycle task
Plugins and build authors should attach their verification tasks, such as ones that run tests, to this lifecycle task using check.dependsOn(task).
执行 check
结果输出:
gradlew.bat check --console=verbose
> Task :compileJava UP-TO-DATE
> Task :processResources NO-SOURCE
> Task :classes UP-TO-DATE
> Task :compileTestJava NO-SOURCE
> Task :processTestResources NO-SOURCE
> Task :testClasses UP-TO-DATE
> Task :test NO-SOURCE
> Task :check UP-TO-DATE
比如 checkstyle
plugins {
// Apply the application plugin to add support for building a CLI application in Java.
id 'application'
id 'java'
id 'checkstyle'
}
可以发现多了两个任务: checkstyleMain
&& checkstyleTest
:
> gradlew.bat check --console=verbose --stacktrace
> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:checkstyleMain
> Task :app:compileTestJava
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses
> Task :app:checkstyleTest
> Task :app:test
> Task :app:check
如果你自己需要添加自己的依赖检查条件比如下面:
task integrationTest {
doLast {
println 'hello'
}
}
tasks.named("check").configure {
dependsOn(tasks.named("integrationTest"))
}
执行 check
:
> Task :app:integrationTest
hello
> Task :app:test UP-TO-DATE
> Task :app:check
什么情况下会触发 check
, 平时常用的 build
同样会触发:
> gradlew.bat build --console=verbose
---
> Task :app:compileJava UP-TO-DATE
> Task :app:processResources NO-SOURCE
> Task :app:classes UP-TO-DATE
> Task :app:jar
> Task :app:startScripts
> Task :app:distTar
> Task :app:distZip
> Task :app:assemble
> Task :app:checkstyleMain UP-TO-DATE
> Task :app:compileTestJava UP-TO-DATE
> Task :app:processTestResources NO-SOURCE
> Task :app:testClasses UP-TO-DATE
> Task :app:checkstyleTest UP-TO-DATE
> Task :app:integrationTest
hello
> Task :app:test UP-TO-DATE
> Task :app:check
> Task :app:build
项目地址 gradle check VS test 例子open in new window