Groovy内置的REST / HTTP客户端?


77

我听说Groovy具有内置的REST / HTTP客户端。我唯一可以找到的库是HttpBuilder这是吗?

基本上,我正在寻找一种从Groovy代码内部执行HTTP GET的方法,而不必导入任何库(如果可能的话)。但是由于该模块似乎不是核心Groovy的一部分,所以我不确定此处是否具有正确的库。


1
j = new groovy.json.JsonSlurper().parseText(new URL("https://httpbin.org/get").getText())然后总结下面的答案println j.headers["User-Agent"]
MarkHu

1
您可能还会签出HttpBuilder库的更新(重新)版本-http-builder-ng.github.io/http-builder-ng
cjstehno

如果使用@Grab它,则使http-builder的使用起来非常轻松:@Grab(group='org.codehaus.groovy.modules.http-builder', module='http-builder', version='0.7')
thom_nic

Answers:


115

本地Groovy GET和POST

// GET
def get = new URL("https://httpbin.org/get").openConnection();
def getRC = get.getResponseCode();
println(getRC);
if(getRC.equals(200)) {
    println(get.getInputStream().getText());
}

// POST
def post = new URL("https://httpbin.org/post").openConnection();
def message = '{"message":"this is a message"}'
post.setRequestMethod("POST")
post.setDoOutput(true)
post.setRequestProperty("Content-Type", "application/json")
post.getOutputStream().write(message.getBytes("UTF-8"));
def postRC = post.getResponseCode();
println(postRC);
if(postRC.equals(200)) {
    println(post.getInputStream().getText());
}

1
很好的答案。像魅力一样工作。
Mahendra Prabhu

2
您如何在GET或POST调用中设置标题?
DLeh '19

2
@DLeh setRequestProperty方法可以做到这一点。我在示例中使用它来设置Content-Type标头。见docs.oracle.com/javase/8/docs/api/java/net/...
吉姆·佩里斯

在作为代码的管道中,必须在共享库中执行此操作,否则jenkins出于安全原因将禁止使用它,可以覆盖它们,但实际上可能会添加漏洞。
老和尚

如何获得响应头?我找不到。
luxin.chen

62

如果您的需求很简单,并且希望避免添加其他依赖项,则可以使用getText()Groovy添加到java.net.URL类中的方法:

new URL("http://stackoverflow.com").getText()

// or

new URL("http://stackoverflow.com")
        .getText(connectTimeout: 5000, 
                readTimeout: 10000, 
                useCaches: true, 
                allowUserInteraction: false, 
                requestProperties: ['Connection': 'close'])

如果您期望返回二进制数据,则这些newInputStream()方法还提供了类似的功能。


2
职位要求怎么样?
dnafication


22

您可以利用诸如with()的Groovy功能,对URLConnection的改进以及简化的getter / setter方法:

得到:

String getResult = new URL('http://mytestsite/bloop').text

开机自检:

String postResult
((HttpURLConnection)new URL('http://mytestsite/bloop').openConnection()).with({
    requestMethod = 'POST'
    doOutput = true
    setRequestProperty('Content-Type', '...') // Set your content type.
    outputStream.withPrintWriter({printWriter ->
        printWriter.write('...') // Your post data. Could also use withWriter() if you don't want to write a String.
    })
    // Can check 'responseCode' here if you like.
    postResult = inputStream.text // Using 'inputStream.text' because 'content' will throw an exception when empty.
})

请注意,当你尝试读取从HttpURLConnection的值,如POST将启动responseCodeinputStream.textgetHeaderField('...')


3
为关键的“笔记”投票。谢谢
xbmono

1
这看起来很简单。什么是异常处理和资源处理?有没有close()disconnect()必要的开放连接?有没有一种简单的方法可以通过http post输出流传递文件的内容?
CodingSamples

14

HTTPBuilder就是它。很好用。

import groovyx.net.http.HTTPBuilder

def http = new HTTPBuilder('https://google.com')
def html = http.get(path : '/search', query : [q:'waffles'])

如果您需要错误处理和通常更多的功能,而不仅仅是使用GET提取内容,则它特别有用。


感谢@Dakota Brown-您可以确认我不需要导入任何内容吗?
smeeb 2014年

缺点是,您需要使用jar:groovy.codehaus.org/modules/http-builder/download.html。毫无用处。
达科他·布朗

感谢@Dakota Brown-请在Will P的回答下查看我的评论-我对您有相同的问题
smeeb 2014年

grails.org/plugin/rest将允许您在GRAILS项目中使用HTTP Builder
Dakota Brown

2
不知道为什么这被否决了。好的解决方案,令人欣慰。
奥德里斯·梅斯卡斯卡斯

1

我不认为http-builder是Groovy模块,而是在apache http-client之上的外部API,因此您确实需要导入类并下载大量API。您最好使用Gradle或@Grab下载jar和依赖项:

@Grab(group='org.codehaus.groovy.modules.http-builder', module='http-builder', version='0.7.1' )
import groovyx.net.http.*
import static groovyx.net.http.ContentType.*
import static groovyx.net.http.Method.*

注意:由于CodeHaus站点出现故障,因此可以在以下位置找到JAR:(https://mvnrepository.com/artifact/org.codehaus.groovy.modules.http-builder/http-builder


我不知道该如何回答,我也不认为它属于该视图。您最好下载依赖项或使用URL按@约翰的回答
威尔

1
@smeeb@Grab将会添加到中grails-app/conf/BuildConfig.groovy。这样它将可以在控制器,服务等中工作,但是请不要在视图中添加此类代码。
cfrick 2014年

-1
import groovyx.net.http.HTTPBuilder;

public class HttpclassgetrRoles {
     static void main(String[] args){
         def baseUrl = new URL('http://test.city.com/api/Cirtxyz/GetUser')

         HttpURLConnection connection = (HttpURLConnection) baseUrl.openConnection();
         connection.addRequestProperty("Accept", "application/json")
         connection.with {
           doOutput = true
           requestMethod = 'GET'
           println content.text
         }

     }
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.