gradle入门（1-5）

Posted 2020-09-22 非淡泊无以明志，非宁静无以致远 - 长安快马

 

1、使用Maven central仓库。
2、使用Log4j写入日志。
3、包含单元测试，保证正确的信息返回，单元测试必须使用JUnit编写。
4、创建一个可执行的Jar文件。

我们来看一下怎样实现这些需求。

1、配置仓库

我们的演示程序的一个需求是构建脚本必须使用Maven central仓库，在我们使用Maven central仓库配置构建脚本后，源代码如下：

apply plugin: ‘java‘
repositories {
mavenCentral()
}
jar {
manifest {
attributes ‘Main-Class‘: ‘net.petrikainulainen.gradle.HelloWorld‘
}
}

我们再来看一下如何对我们的演示程序进行依赖声明。

2、依赖声明

在build.gradle文件中，我们声明了两个依赖：

Log4j（版本1.2.17）用来记录日志。
JUnit（版本4.11）用来编写单元测试。
在我们声明了这些依赖后，build.gradle文件是这样的：

apply plugin: ‘java‘
repositories {
mavenCentral()
}
dependencies {
compile ‘log4j:log4j:1.2.17‘
testCompile ‘junit:junit:4.11‘
}
jar {
manifest {
attributes ‘Main-Class‘: ‘net.petrikainulainen.gradle.HelloWorld‘
}
}

3、编写代码
public class MessageService {
public String getMessage() {
return "Hello World!";
}
}

public class MessageService {
public String getMessage() {
return "Hello World!";
}
}

import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.assertEquals;
public class MessageServiceTest {
private MessageService messageService;
@Before
public void setUp() {
messageService = new MessageService();
}
@Test
public void getMessage_ShouldReturnMessage() {
assertEquals("Hello World!", messageService.getMessage());
}
}

import org.apache.log4j.Logger;
public class HelloWorld {
private static final Logger LOGGER = Logger.getLogger(HelloWorld.class);
public static void main(String[] args) {
MessageService messageService = new MessageService();
String message = messageService.getMessage();
LOGGER.info("Received message: " + message);
}
}

配置log4j，log4j.properties文件如下：
log4j.appender.Stdout=org.apache.log4j.ConsoleAppender
log4j.appender.Stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.Stdout.layout.conversionPattern=%-5p - %-26.26c{1} - %m\n
log4j.rootLogger=DEBUG,Stdout

4、执行测试

执行测试
gradle test

测试输出：
> gradle test
:compileJava
:processResources
:classes
:compileTestJava
:processTestResources
:testClasses
:test
BUILD SUCCESSFUL
Total time: 4.678 secs
然而，如果测试失败，我们将看到如下输出：

执行单元测试时，Gradle会在相应目录创建测试报告：
build/test-results目录包含每次测试执行的原始数据。
build/reports/tests目录包含一个html报告，描述了测试的结果。
HTML测试报告是一个非常有用的工具，因为它描述了测试失败的原因。比如说，如果我们的单元测试认为MessageService类中的getMessage()方法返回字符串“Hello Worl1d!”，那么HTML报告看上去就像下图一样：

5、打包和运行例子

我们能够可以使用以下任意一种命令打包程序：gradle assembly或gradle build，这两个命令都会在build/libs目录中创建dependency-management.jar文件。
当我们使用java -jar dependency-management.jar命令运行演示程序时，我们可以看到如下输出：

java -jar dependency-management.jar
Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/log4j/Logger
at net.petrikainulainen.gradle.HelloWorld.<clinit>(HelloWorld.java:10)
Caused by: java.lang.ClassNotFoundException: org.apache.log4j.Logger
at java.net.URLClassLoader$1.run(URLClassLoader.java:372)
at java.net.URLClassLoader$1.run(URLClassLoader.java:361)
at java.security.AccessController.doPrivileged(Native Method)
at java.net.URLClassLoader.findClass(URLClassLoader.java:360)
at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:308)
at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
... 1 more
抛出异常的原因是，当我们运行程序时，Log4j的依赖在classpath中没有找到。

解决这个问题最简单的方式是创建一个所谓的“胖”Jar文件，即把所有程序运行所需的依赖都打包到Jar文件中去。

通过查阅Gradle Cookbook中的教程，可以修改构建脚本，如下：

apply plugin: ‘java‘

repositories {
mavenCentral()
}

dependencies {
compile ‘log4j:log4j:1.2.17‘
testCompile ‘junit:junit:4.11‘
}

jar {
from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
manifest {
attributes ‘Main-Class‘: ‘net.petrikainulainen.gradle.HelloWorld‘
}
}
现在，我们可以运行演示程序了（打包后），一切正常：

Shell

> java -jar dependency-management.jar
INFO - HelloWorld - Received message: Hello World!
1
2
> java -jar dependency-management.jar
INFO - HelloWorld - Received message: Hello World!