在Scalatra中响应JSON格式的诸多问题

简介: 如今的前端JSON已无处不在,如何在Scalatra中使用json响应数据给前端呢,尽管官方只是介绍了一下json4s,其实仍然需要注意其中的一些细节

先看一个最简单的例子,假如我有这样一个entity

case class Entity(var value: String)

在Servlet的一个请求下,响应一个entity的列表

get("/") {
    List(Entity("foo"), Entity("bar"))
}

访问请求我们得到

List(Entity(foo), Entity(bar))

显然前端不习惯于解析这样奇怪的格式,如今的前端JSON已无处不在,如何使用json格式返回呢?

访问scalatra官网,右侧栏Formats下的JSON https://scalatra.org//guides/2.7/formats/json.html

官网建议我们使用json4s,导入json4s-jacksonscalatra-json包,然后在Servlet中定义一个隐式延迟常量jsonFormats

protected implicit lazy val jsonFormats: Formats = DefaultFormats

再实现一个ScalatraBase下的before()方法

before() {
    contentType = formats("json")
}

正常情况下我们就可以得到预期结果了

[{
   
   "value":"foo"},{
   
   "value":"bar"}]

看上去很简单,但是坑并不少,下面盘点一些简单的问题

FAQ

  1. 为什么完全没有效果,仍然显示默认的输出,也没有报错?
    没有成功导入scalatra-json包,没有引入scalatra-json包就不处理jsonFormatsformats("json"),所以不会报错,也不会提示你缺少引入,也可能是没有在servlet上with JacksonJsonSupport

  2. 如果需要响应的entity并非case class呢?

class Entity(var value: String)
get("/") {
    new Entity("foo")
}

它的响应结果是Entity@xxx,不会被自动解析,此时我们需要使用org.json4s.Serialization.write()

get("/") {
    Serialization.write(new Entity("foo"))
}

它将响应正确的结果

{
   
   "value":"foo"}

由于Serialization的api比较简洁,建议将Serialization整个导入,直接使用write()

import org.json4s.jackson.Serialization._
get("/") {
    write(new Entity("foo")
}
  1. 需要响应的json内容十分灵活,field是动态的,所以我不想为返回的json单独写一个实体类,怎么做比较简单?
    可以直接返回JObject的,scalatra-json是会自动解析的,所以按json4s的写就好了,可以用JsonDSL~动态组装json
    ``` scala
    import org.json4s.JsonDSL._

get("/") {
("foo" -> "1") ~ ("bar" -> "2")
}

得到
``` json
{"foo":"1","bar":"2"}
  1. 如何使用jsonp?
    在servlet中定义一个
    override def jsonpCallbackParameterNames = Seq("jsonp")
    
    在parameter中加参数jsonp标注回调函数名称,例如http:/localhost/?jsonp=jsonpCallback ,就可以得到
/**/jsonpCallback({"foo":"1","bar":"2"});

Suggest

建议把servlet看做mvc模式的controller,然后定义一个ControllerBase,把jsonFormats定义在里面,然后所有的controller去继承这个ControllerBase,可以参考这个项目Uniliva/tcc-fatec-back-end-scala,他就是这么做的

如果要对一些类型做特殊处理,诸如date要使用自定义的SimpleDateFormat之类,建议参考AgreementInput.scala

官方文档涉及的问题凤毛麟角,而且例子代码都有问题,我看到有的例子还在用java.util.Date,这实在让人看不下去,建议在Stack Overflow和Github直接检索问题代码,关于scalatra的问题只有这两个大社区全面

目录
相关文章
|
9天前
|
XML JSON JavaScript
js的json格式
js的json格式
|
9天前
|
JSON 数据格式
Blob格式转json格式,拿到后端返回的json数据
文章介绍了如何将后端返回的Blob格式数据转换为JSON格式,并处理文件下载和错误提示。
21 0
Blob格式转json格式,拿到后端返回的json数据
|
8天前
|
JSON 数据格式 Python
6-1|Python如何将json转化为字符串写到文件内 还保留json格式
6-1|Python如何将json转化为字符串写到文件内 还保留json格式
|
2月前
|
JSON Java Android开发
Android 开发者必备秘籍:轻松攻克 JSON 格式数据解析难题,让你的应用更出色!
【8月更文挑战第18天】在Android开发中,解析JSON数据至关重要。JSON以其简洁和易读成为首选的数据交换格式。开发者可通过多种途径解析JSON,如使用内置的`JSONObject`和`JSONArray`类直接操作数据,或借助Google提供的Gson库将JSON自动映射为Java对象。无论哪种方法,正确解析JSON都是实现高效应用的关键,能帮助开发者处理网络请求返回的数据,并将其展示给用户,从而提升应用的功能性和用户体验。
50 1
|
2月前
|
JSON API 数据格式
基于服务器响应的实时天气数据进行JSON解析的详细代码及其框架
【8月更文挑战第25天】这段资料介绍了一个使用Python从服务器获取实时天气数据并解析JSON格式数据的基本框架。主要分为三个部分:一是安装必要的`requests`库以发起HTTP请求获取数据,同时利用Python内置的`json`库处理JSON数据;二是提供了具体的代码实现,包括获取天气数据的`get_weather_data`函数和解析数据的`parse_weather_data`函数;三是对代码逻辑进行了详细说明,包括如何通过API获取数据以及如何解析这些数据来获取温度和天气描述等信息。用户需要根据实际使用的天气API调整代码中的API地址、参数和字段名称。
|
2月前
|
JSON 开发工具 数据格式
【Azure Event Hub】Event Hub的Process Data页面无法通过JSON格式预览数据
【Azure Event Hub】Event Hub的Process Data页面无法通过JSON格式预览数据
|
2月前
|
JSON 数据格式
langchain 入门指南 - JSON 形式输出大模型的响应
langchain 入门指南 - JSON 形式输出大模型的响应
77 0
|
2月前
|
JSON JavaScript 前端开发
Vue项目使用Cookie,以Json格式存入与读取Cookie,设置过期时间以及删除操作
这篇文章介绍了在Vue项目中如何使用JavaScript操作Cookie,包括设置、读取、设置过期时间以及删除Cookie的方法。
111 0
|
3月前
|
JSON 数据格式
Content type ‘text/plain;charset=UTF-8‘ not supported,这里要把测试文件转为json格式
Content type ‘text/plain;charset=UTF-8‘ not supported,这里要把测试文件转为json格式
|
4月前
|
JSON JavaScript 前端开发
一篇文章讲明白json文件格式详解
一篇文章讲明白json文件格式详解
65 0
下一篇
无影云桌面