HttpBuilder-NG 使用指南

HttpBuilder-NG 使用指南

http-builder-ngThe easy HTTP client for Groovy (and Java).项目地址:https://gitcode.com/gh_mirrors/ht/http-builder-ng

1. 项目介绍

HttpBuilder-NG 是一款面向 Groovy（同时也适用于 Java 和 Kotlin）的现代HTTP客户端库，旨在通过简洁、可读性高的Groovy领域特定语言（DSL）来简化HTTP请求的制作过程。该项目源自于HTTPBuilder，最初由Thomas Nichols开发，之后经Jason Gritman维护。HttpBuilder-NG作为其进化版，目标是修复原生HTTPBuilder的一些漏洞，并引入更符合现代Groovy风格的设计，但由于兼容性和彻底重构的需求，它以一个全新名称面世。

该库支持Java 8及以上版本，与Groovy 2.4.x构建，但对使用的Groovy版本不设限。HttpBuilder-NG提供GET、HEAD等全部HTTP方法的支持，以及多客户端实现（包括核心Java实现、Apache HttpClient和OkHttp）。

2. 快速启动

要快速开始使用HttpBuilder-NG，首先需将其添加到你的项目依赖中。以下是在Gradle和Maven中的配置示例：

Gradle 配置

dependencies {
    implementation 'io.github.http-builder-ng:http-builder-ng-core:1.0.4'
}

Maven 配置

<dependency>
    <groupId>io.github.http-builder-ng</groupId>
    <artifactId>http-builder-ng-core</artifactId>
    <version>1.0.4</version>
</dependency>

简单的请求示例，展示如何使用HttpBuilder-NG发送GET请求：

import groovyx.net.http.HTTPBuilder
import static groovyx.net.http.Method.GET
import groovyx.net.http.ContentTypes

HTTPBuilder http = new HTTPBuilder("http://example.com")
http.request(GET, ContentTypes.JSON) { req ->
    uri.path = "/api/data"
}

这段代码会向 "http://example.com/api/data" 发送一个GET请求。

3. 应用案例和最佳实践

在处理复杂的HTTP交互时，如上传文件或处理OAuth认证，HttpBuilder-NG提供灵活的API。例如，进行POST请求并上传文件：

http.request(POST) { req ->
    uri.path = '/upload'
    headers.'Content-Type' = 'multipart/form-data'
    multipart {
        file 'file', 'path/to/your/file.txt', 'text/plain'
        field 'description', 'Sample file upload'
    }
}

最佳实践包括利用Groovy的闭包特性进行链式调用来保持代码紧凑且易于阅读，以及充分利用@TypeChecked和@CompileStatic注解以增强类型安全和性能。

4. 典型生态项目集成

虽然HttpBuilder-NG自身作为一个独立的HTTP客户端工具，它很好地融入了Groovy乃至Java生态系统。在数据分析、持续集成、或是任何需要进行网络通信的场景下，都可以看到它的身影。特别地，结合像Jsoup这样的库进行网页解析，可以轻松实现从Web抓取数据的任务：

@Grab(['io.github.http-builder-ng:http-builder-ng-core:1.0.4', 'org.jsoup:jsoup:1.9.2'])
import static groovyx.net.http.HttpBuilder.configure
import org.jsoup.nodes.Document

Document page = configure([request.uri: "http://example.com"]) { req ->
    // HTTPBuilder configuration here if needed
}.get()

// Jsoup processing
println page.title

此例展示了如何将HttpBuilder-NG与Jsoup结合，用于获取和解析网页内容，进一步展现了其在实际应用中的灵活性。

---

以上就是HttpBuilder-NG的基本使用指南，它为开发者提供了强大的HTTP操作能力，无论是基础的HTTP请求还是复杂的数据交互，都能做到游刃有余。

http-builder-ngThe easy HTTP client for Groovy (and Java).项目地址:https://gitcode.com/gh_mirrors/ht/http-builder-ng