Kotlin DSL для создания объектов json (без создания мусора)

Question

Я пытаюсь создать DSL для создания JSONObjects. Вот класс строитель и использование образца:

import org.json.JSONObject 

fun json(build: JsonObjectBuilder.() -> Unit): JSONObject { 
    val builder = JsonObjectBuilder() 
    builder.build() 
    return builder.json 
} 

class JsonObjectBuilder { 
    val json = JSONObject() 

    infix fun <T> String.To(value: T) { 
     json.put(this, value) 
    } 
} 

fun main(args: Array<String>) { 
    val jsonObject = 
      json { 
       "name" To "ilkin" 
       "age" To 37 
       "male" To true 
       "contact" To json { 
        "city" To "istanbul" 
        "email" To "xxx@yyy.com" 
       } 
      } 
    println(jsonObject) 
} 

Выход выше код:

{"contact":{"city":"istanbul","email":"xxx@yyy.com"},"name":"ilkin","age":37,"male":true} 

Он работает, как ожидалось. Но он создает дополнительный экземпляр JsonObjectBuilder каждый раз, когда он создает объект json. Можно ли написать DSL для создания объектов json без лишнего мусора?

Answer 1

Вы можете использовать Deque в качестве стека для отслеживания текущего JSONObject контекст с одним JsonObjectBuilder:

fun json(build: JsonObjectBuilder.() -> Unit): JSONObject { 
    return JsonObjectBuilder().json(build) 
} 

class JsonObjectBuilder { 
    private val deque: Deque<JSONObject> = ArrayDeque() 

    fun json(build: JsonObjectBuilder.() -> Unit): JSONObject { 
     deque.push(JSONObject()) 
     this.build() 
     return deque.pop() 
    } 

    infix fun <T> String.To(value: T) { 
     deque.peek().put(this, value) 
    } 
} 

fun main(args: Array<String>) { 
    val jsonObject = 
      json { 
       "name" To "ilkin" 
       "age" To 37 
       "male" To true 
       "contact" To json { 
        "city" To "istanbul" 
        "email" To "xxx@yyy.com" 
       } 
      } 
    println(jsonObject) 
} 

Пример вывода:

{"contact":{"city":"istanbul","email":"xxx@yyy.com"},"name":"ilkin","age":37,"male":true} 

Calling json и build через несколько потоков на один JsonObjectBuilder будет проблематичным, но это не должно быть проблемой для вашего случая использования.

Answer 2

Вам нужна DSL? Вы теряете возможность принудительного String ключей, но ваниль Котлин не так уж плохо :)

JSONObject(mapOf(
     "name" to "ilkin", 
     "age" to 37, 
     "male" to true, 
     "contact" to mapOf(
       "city" to "istanbul", 
       "email" to "xxx@yyy.com" 
     ) 
)) 

Answer 3

Да, это возможно, если вам не нужно какое-либо промежуточное представление узлов, и если контекст всегда то же самое (рекурсивные вызовы не отличаются друг от друга). Это можно сделать, написав вывод сразу.

Однако это сильно увеличивает сложность кода, потому что вам необходимо немедленно обрабатывать вызовы DSL, не сохраняя их в любом месте (опять же, чтобы избежать избыточных объектов).

Пример (см ее демо here):

class JsonContext internal constructor() { 
    internal val output = StringBuilder() 

    private var indentation = 4 

    private fun StringBuilder.indent() = apply { 
     for (i in 1..indentation) 
      append(' ') 
    } 

    private var needsSeparator = false 

    private fun StringBuilder.separator() = apply { 
     if (needsSeparator) append(",\n") 
    } 

    infix fun String.to(value: Any) { 
     output.separator().indent().append("\"$this\": \"$value\"") 
     needsSeparator = true 
    } 

    infix fun String.toJson(block: JsonContext.() -> Unit) { 
     output.separator().indent().append("\"$this\": {\n") 
     indentation += 4 
     needsSeparator = false 
     block(this@JsonContext) 
     needsSeparator = true 
     indentation -= 4 
     output.append("\n").indent().append("}") 
    } 
} 

fun json(block: JsonContext.() -> Unit) = JsonContext().run { 
    block() 
    "{\n" + output.toString() + "\n}" 
} 

val j = json { 
    "a" to 1 
    "b" to "abc" 
    "c" toJson { 
     "d" to 123 
     "e" toJson { 
      "f" to "g" 
     } 
    } 
} 

Если вам не нужны отступы, но только правильный JSON, это может быть легко хотя и упрощен.

Вы можете сделать json { } и .toJson { } функции inline избавиться даже классы лямбды и, таким образом, вы достигнете почти нулевого объект накладных расходов (один JsonContext и StringBuilder со своими буферами все еще выделяются), но это потребует вас изменить модификаторы видимости элементов, используемые этими функциями: общедоступные встроенные функции могут обращаться только к public или к @PublishedApi internal членам.

Answer 4

Я не уверен, правильно ли задал вопрос. Вам не нужен строитель?

class Json() { 

    val json = JSONObject() 

    constructor(init: Json.() -> Unit) : this() { 
     this.init() 
    } 

    infix fun <T> String.To(value: T) { 
     json.put(this, value) 
    } 

    override fun toString(): String { 
     return json.toString() 
    } 
} 

Вы можете просто сделать это:

val json = Json { 
    "name" To "Roy" 
    "body" To Json { 
     "height" To 173 
     "weight" To 80 
    } 
} 

println(json) 

{"name":"Roy","body":"{\"weight\":80,\"height\":173}"}

Answer 5

Найдено другое решение. Вы можете просто наследовать класс JSONObject без необходимости создавать другие объекты.

class Json() : JSONObject() { 

    constructor(init: Json.() -> Unit) : this() { 
     this.init() 
    } 

    infix fun <T> String.To(value: T) { 
     put(this, value) 
    } 
} 

fun main(args: Array<String>) { 
    val jsonObject = 
      Json { 
       "name" To "ilkin" 
       "age" To 37 
       "male" To true 
       "contact" To Json { 
        "city" To "istanbul" 
        "email" To "xxx@yyy.com" 
       } 
      } 
    println(jsonObject) 
} 

Выходной код будет таким же.

{"contact":{"city":"istanbul","email":"xxx@yyy.com"},"name":"ilkin","age":37,"male":true}