Groovy Goodness: Streaming JSON with StreamingJsonBuilder

Since Groovy 1.8 we can use JSONBuilder to create JSON data structures. With Groovy 1.8.1 we have a variant of JsonBuilder that will not create a data structure in memory, but will stream directly to a writer the JSON structure: StreamingJsonBuilder. This is useful in situations where we don't have to change the structure and need a memory efficient way to write JSON.

import groovy.json.*

def jsonWriter = new StringWriter()
def jsonBuilder = new StreamingJsonBuilder(jsonWriter)
jsonBuilder.message {
header {
from(author: 'mrhaki')
to 'Groovy Users', 'Java Users'
}
body "Check out Groovy's gr8 JSON support."
}
def json = jsonWriter.toString()
assert json == '{"message":{"header":{"from":{"author":"mrhaki"},"to":["Groovy Users","Java Users"]},"body":"Check out Groovy\'s gr8 JSON support."}}'

def prettyJson = JsonOutput.prettyPrint(json)
assert prettyJson == '''{
"message": {
"header": {
"from": {
"author": "mrhaki"
},
"to": [
"Groovy Users",
"Java Users"
]
},
"body": "Check out Groovy's gr8 JSON support."
}
}'''


new StringWriter().withWriter { sw ->
def builder = new StreamingJsonBuilder(sw)

// Without root element.
builder name: 'Groovy', supports: 'JSON'

assert sw.toString() == '{"name":"Groovy","supports":"JSON"}'
}

new StringWriter().with { sw ->
def builder = new StreamingJsonBuilder(sw)

// Combine named parameters and closures.
builder.user(name: 'mrhaki') {
active true
}

assert sw.toString() == '{"user":{"name":"mrhaki","active":true}}'
}