格式化LocalDate - day12

使用 Javalin

Javalin 是个轻量型框架，在本范例程序中已有基本设定。请开启Bootstrap.kt，最後一段

@WebServlet(urlPatterns = ["/rest/*"], name = "JavalinRestServlet", asyncSupported = false)
class JavalinRestServlet : HttpServlet() {
    val javalin: JavalinServlet = Javalin.createStandalone()
            .configureRest()
            .servlet()

    override fun service(req: HttpServletRequest, resp: HttpServletResponse) {
        javalin.service(req, resp)
    }
}

fun Javalin.configureRest(): Javalin {
    val gson: Gson = GsonBuilder().create()
    gson.configureToJavalin()
    return this
}

服务器提供REST服务，而设定皆在 configureRest() extension function

编写自己的API。请开新档 StudentRest.kt

package com.example.vok

import io.javalin.Javalin
import io.javalin.http.NotFoundResponse

fun Javalin.studentRest(){

    get("/rest/student/:id"){ ctx ->
        val id = ctx.pathParam("id").toLong()
        Student.findById(id)?.let { ctx.json(it) }?: throw NotFoundResponse("No student with id:$id")
    }

    get("/rest/students"){ctx ->
        ctx.json(Student.findAll())
    }

    get("/rest/student/:id/grade"){ctx->
        val id = ctx.pathParam("id").toLong()
        val student = Student.findById(id) ?: throw NotFoundResponse("No student with id:$id")
        ctx.json(student.grades.fetch())
    }

}

在configureRest()设定提供上述api

fun Javalin.configureRest(): Javalin {
    val gson: Gson = GsonBuilder().create()
    gson.configureToJavalin()
    studentRest()
    return this
}

执行程序结果如下

设定输出JSON栏位

看似已经提供了json格式rest api，但实务应用时，某些栏位并不提供给外部读取，该怎麽做呢？
在configureRest()方法中已设定由Gson处理物件和json的转换，所以可采用Gson所提供的功能，设定哪些栏位需要序列化。

开启Student.kt 在需要输出为Json的栏位前加上 annotation @Expose，例

   @Expose
    var name: String? = null

接着开启Boostrap.kt 修改 configureRest() 加上 excludeFieldsWithoutExposeAnnotation()方法

fun Javalin.configureRest(): Javalin {
    val gson: Gson = GsonBuilder()
        .excludeFieldsWithoutExposeAnnotation()
        .create()
    gson.configureToJavalin()
    studentRest()
    return this
}

格式化 LocalDate

上述birthday 输出为 "birthday":{"year":2001,"month":3,"day":13}，笔者希望可转成"birthday":"2001-03-13"

撰写转换器

class LocalDateAdapter: JsonSerializer<LocalDate>{
    override fun serialize(date: LocalDate, typeOfSrc: Type?, context: JsonSerializationContext?): JsonElement =
        JsonPrimitive(date.format(DateTimeFormatter.ISO_LOCAL_DATE))
}

加Gson设定

    val gson: Gson = GsonBuilder()
        .setPrettyPrinting()
        .registerTypeAdapter(LocalDate::class.java, LocalDateAdapter())
        .excludeFieldsWithoutExposeAnnotation()
        .create()

setPrettyPrinting() 将json格式为较易阅读模式
registerTypeAdapter() 告诉GsonBuilder，只要遇到资料型态为LocalDate，就使用LocalDateAdapter()转换