Java 相关工具
gradle
Overview
gradle 是一款基于JVM 的自动化构建工具。
gradle.build文件是gradle 的配置文件,�其使用groovy 来构建DSL 脚本。
在gradle 中, 有两个基本概念:
项目是构建产物(如jar 包)或实施产物(将应用程序部署到生成环境),一个项目包含若干个任务。
任务是指不可分割的最小工作单元,任务用来执行真正的构建工作。
在gradle 中,所有的特性都是由gradle 插件提供的, gradle 本身只提供了DSL 语言。
Usage
应用gradle 插件:
apply plugin: 'java'
定义变量:
project.ext {
guavaVersion = '18.0'
...
}
定义依赖:
project.dependencies {
compile(...)
runtime(...)
testCompile(...)
}
定义任务:
task uberjar(type: Jar, dependsOn: jar) {...}
Tips
由于gradle 的各个版本间存在兼容性问题,使用wrapper 让每个项目的构建环境独立。
在build.gradle 文件中使用以下的配置来指定本项目使用的gradle 半版本信息:
task wrapper(type: Wrapper) {
gradleVersion = '2.5'
}
gradle的项目构建过程分为三个步骤:初始化, 配置和执行任务。使用org.gradle.daemon=true 来启动后台进程来在构建过程中跳过初始化步骤,从而加速gradle 的构建执行。
将项目拆分为多个子项目,可以利用gradle 提供的并行构建能力。
在root 项目中的build.gradle中定义公共变量,任务和依赖。
在root 项目中的settings.gradle中定义包含的子项目。
在各个子项目的build.gradle中定义各项目所需的变量,任务和依赖。
从cvs 中新获取的项目后,在命令行中依次执行以下的命令:
>> gradle wrapper
>> ./gradlew clean idea
>> ./gradlew clean check
如果check任务通过,说明项目已经在本地成功构建。
Nexus
Overview
nexus是一款支持多种流行组件(如Maven,Docker 等)的仓库管理软件。
在nexus 中,有两个核心的概念:
component:一种资源,例如library或者framework。作为应用程序的一部分,component 可以在运行时,集成,单元测试执行,或者在构建过程中被引用。
在build.gradle中的表现为:
project.dependencies {
compile(...)
runtime(...)
testCompile(...)
}
component 通常又被称为artifact, package, bundle, achive 等。
repository:为了方便components 的使用,repository 聚合了components 集合,并在internet 上提供service。
组件通常有不同的格式,例如maven repository 依赖于特殊的目录结构和XML 格式的元数据, 并通过plain HTTP 命令和附带的XML 文件来对component 进行交互。
Usage
指定从自建的nexus 仓库中获取依赖:
buildscript {
repositories {
jcenter()
maven {
url "your-nexus-repository-url"
}
}
dependencies {
classpath 'your-dependencies'
}
}
gradle upload命令的上传配置:
project.uploadArchives {
repositories {
mavenDeployer {
repository(url: "your-nexus-repository-url") {
authentication(userName: "", password: "")
}
pom.version = "${project.version}"
pom.artifactId = "${project.name}"
pom.groupId = "${project.group}"
}
}
}
Tips
本地缓存导致的依赖不及时刷新新版本:
configurations.all {
resolutionStrategy.cacheChangingModulesFor 0, 'hours'
}
* 根据版本号来分别存储snapshot 和release 组件:
mavenDeployer {
repository(url: "your-nexus-repository-url" +
"${project.version.endsWith('-SNAPSHOT') ? 'snapshots' : 'releases'}") {...
```
checkstyle
Overview
checkstyle 是一款Java 代码风格的检查工具。
checkstyle 的配置文件位于project/config/checkstyle/sun_checks.xml。
通过修改该配置文件来统一项目的代码风格。例如,出于源码阅读的考虑,想要限制代码行的长度为100 个字符,则修改以下的配置:
Usage
在项目的build.gradle文件中,通过以下的配置使用checkstyle:
apply plugin: 'checkstyle'
checkstyle {
configFile = file("$project.projectDir/config/checkstyle/sun_checks.xml")
toolVersion = '6.7'
}
// 是否对测试代码进行代码风格的检查。
checkstyleTest {
enabled = false
}
Tips
不可变形参需要加上final.
将数字定义为有意义的static final常量(否则,会被认为是magic number)。
在代码提交前, 使用IDE 提供的format 快捷键, 过滤掉一些低级的风格问题(如无用的引用, 代码对其等等)。
findbugs
Overview
findbugs 是一款静态检查Java 代码中bug 的工具。
在项目开发过程中,执行gradle check 命令时,findbugs 会在coverageCheck 通过后执行。
如果代码中含有工具认为可能会引发Bug 的写法,那么会在/yourProject/build/reports/findbugs目录中的生成一个main.xml文件来记录。
Usage
如果在check过程中,出现了Execution failed for task ':findbugsMain'.,那么打开main.xml 文件并找到以下的节点:
根据type 字段,在网站中可以找到对应的bug 的描述。
根据Class, Field, SouceLine 字段, 可以在Java 源代码中找到bug 对应的源码位置。
Tips
方法忽略了返回值(这常见于对不可变对象进行调用方法,而误以为不可变对象会被更新)。
忘记资源释放(方法可能没有关闭stream)。
在switch-case 语句块中缺少break关键字。
jacoco
Overview
jacoco 是一款检查代码单元测试覆盖率的工具。
jacoco 的配置文件位于config/scripts/coverage.gradle。
如果代码的覆盖率没有达到指定的标准,那么会在yourproject/build/report/jacoco 目录下生成index.html 和相关的结果文件,打开该文件,可以看到图形化显示的没有覆盖到的代码所在的文件和代码位置。
Usage
在gradle 项目中,在该配置文件中定义jacoco 在gradle 的扩展和任务:
project.extensions.create('coverage', CoverageExtension)
task coverageCheck(dependsOn: test) << {...}
在实际使用中,我们定义了excludePackages 和excludeClasses 对象来让jacoco 跳过一些包和类的覆盖率检查。
coverage.excludePackages.each() {
exclude name: "${it.replaceAll('\\.', '/') + '/*'}"
}
coverage.excludeClasses.each() {
exclude name: "${it.replaceAll('\\.', '/') + '.class'}"
}
然后在build.gradle中使用以下的配置来在gradle check 任务中启用jacoco 任务。
check.dependsOn "coverageCheck"
Tips
尽量使用TDD 的开发方式。
在实际开发过程中,除了一些无法模拟的Exception 之外,尽量不要使用exclude 来跳过单元测试覆盖率的检查。
flyway
Overview
flyway 是一款数据库migration 工具。
相比于手动的sql 脚本的数据库数据版本管理,数据库migration 能够带来以下的优势:
从零开始重建一个数据库。
清晰地获知当期数据库状态。
从当前版本到任意的一个新状态。
flyway 使用schema_version 数据表管理数据库的数据版本。
Usage
在build.gradle 中进行以下的配置:
apply plugin: "org.flywaydb.flyway"
flyway {
url = 'your-database-schema-url'
user = ''
password = ''
}
在以下的位置中放置数据库migration 脚本:
yourProject/src/main/resources/db.migration
数据库migration 脚本的命名格式:
V1__Create_demo_table.sql。 需要注意的是版本号后面是两个下划线。
Tips
在测试中自动化地进行flywayClean 和flywayMigrate:
test.dependsOn "flywayClean"
test.dependsOn "flywayMigrate"
数据schema 的更新原则是只增不删,例如要修改某个既存表的结构,那么在一个新建的migration 脚本中进行,而不用去修改该寄存表的创建脚本。