Ninja 框架端点在尝试将 JSON 映射到自定义对象时抛出 500 错误

Posted 2023-02-19

【中文标题】Ninja 框架端点在尝试将 JSON 映射到自定义对象时抛出 500 错误

【英文标题】：Ninja framework endpoint throws 500 error when trying to map JSON to custom object

【发布时间】：2019-03-21 10:14:34

【问题描述】：

所以我在这里有一个 Ninja 端点：

public Result processRecurring(Context context, RecurOrderJSON recurOrderJSON) 
    String id = recurOrderJSON.id;
    String event_type = recurOrderJSON.event_type;
    String request_id = recurOrderJSON.request_id;
    //Map data = recurOrderJSON.data;
    //recurringRouter(event_type, data);
    log.info("ID value");
    log.info(id);

    return JsonResponse.build()
            .message("OK")
            .toResult();

我要映射到的类：

public class RecurOrderJSON 

    public String id;
    public String event_type;
    public String request_id;
    // Maybe switch data type?
    //public Map data;

还有路线：

router.POST().route("/recurring").with(RecurringController::processRecurring);

我只是想向 webhook 发送一些简单的 JSON，但由于某种原因，对象映射似乎不起作用。我想我可能误解了文档？

http://www.ninjaframework.org/documentation/working_with_json_jsonp.html

他们给你的例子是这样的：

If you send that JSON to your application via the HTTP body you only need to add the POJO class to the controller method and Ninja will parse the incoming JSON for you:

package controllers;

public class ApplicationController        

    public Result parsePerson(Person person) 

        String nameOfPerson = person.name; // will be John Johnson
        ...

    

据我所知，我这样做对吗？我对文档的理解有误吗？这是一个示例 JSON 对象 - 目前我只是想抓取***字符串，但我最终也想抓取数据：

  "id": "hook-XXXXX",
  "event_type": "tx-pending",
  "data": 
    "button_id": "static",
    "publisher_organization": "org-XXXXXXX",
    "campaign_id": "camp-097714a40aaf8965",
    "currency": "USD",
    "order_currency": "USD",
    "id": "tx-XXXXXXX",
    "category": "new-user-order",
    "modified_date": "2018-10-15T05:41:12.577Z",
    "order_total": 9680,
    "button_order_id": "btnorder-77c9e56fd990f127",
    "publisher_customer_id": "XymEz8GO2M",
    "rate_card_id": "ratecard-41480b2a6b1196a7",
    "advertising_id": null,
    "event_date": "2018-10-15T05:41:06Z",
    "status": "pending",
    "pub_ref": null,
    "account_id": "acc-4b17f5a014d0de1a",
    "btn_ref": "srctok-0adf9e958510b3f1",
    "order_id": null,
    "posting_rule_id": null,
    "order_line_items": [
      
        "identifier": "Antique Trading Card",
        "description": "Includes Lifetime Warranty",
        "amount": 9680,
        "publisher_commission": 968,
        "attributes": ,
        "total": 9680,
        "quantity": 1
      
    ],
    "order_click_channel": "webview",
    "order_purchase_date": null,
    "validated_date": null,
    "amount": 968,
    "customer_order_id": null,
    "created_date": "2018-10-15T05:41:12.577Z",
    "commerce_organization": "org-XXXXXX"
  ,
  "request_id": "attempt-XXXXXXX"

目前我只是试图获取字符串值，但我不断收到 500 错误，并且在我的日志中没有其他任何错误指示。

据我所知，Ninja 应该只是自动将 JSON 映射到我的对象，对吗？

【问题讨论】：

JsonResponse 的全称是什么？这是一个自定义类还是来自某个扩展？我没有看到它列在ninjaframework.org/apidocs/index.html

还有一个问题。您确定收到的是 500 Internal Server Error 而不是 400 Bad Request？您使用什么工具发送请求？

你能确认请求到达控制器吗？既然你提到了 500 错误。

先把它分解成一个非常简单的例子（例如“hello world”类型的例子）——然后从那里开始构建

【参考方案1】：

我成功重现了您的问题，然后修复了它。

首先，为了方便尝试/测试，我建议（临时）修改：

package controllers;

import models.RecurOrderJSON;
import ninja.Context;
import ninja.Result;

public class RecurringController 
    public Result processRecurring(Context context, RecurOrderJSON recurOrderJSON) 
        log.info("recurOrderJSON => " + recurOrderJSON);
        return ninja.Results.ok();
    

然后，以这种方式更新您的模型：

package models;

import java.util.Map;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties(ignoreUnknown = true)
public class RecurOrderJSON 

    public String id;
    public String event_type;
    public String request_id;
    public Map data;

    @Override
    public String toString() 
        return "RecurOrderJSON [id=" + id + ", event_type=" + event_type + ", request_id=" + request_id + ", data="
                + data.toString() + "]";
    

你可以注意到：

数据类型必须保持原始（此处不能使用泛型） 重要的 @JsonIgnoreProperties(ignoreUnknown = true) 注释以避免反序列化问题，如果您的源数据与您的模型不完全匹配（请务必使用最新版本的注释，在 fastxml 子包中，而不是旧的一、在codehaus子包中） toString() 实现只允许快速检查 OK/KO 反序列化

然后您可以轻松地使用 wget 或 curl 测试系统：

curl -H 'Content-Type: application/json' -d "@/tmp/jsonINput.json" -X POST http://localhost:8080/recurring

请注意，指定 Content-type 以进行良好的解释非常重要。

/tmp/jsonINput.json 文件包含您在问题中指定的 json 内容。

这样，一切都像魅力一样工作，获得以下输出：

recurOrderJSON => RecurOrderJSON [id=hook-XXXXX, event_type=tx-pending, request_id=attempt-XXXXXXX, data=button_id=static, publisher_organization=org-XXXXXXX, campaign_id=camp-097714a40aaf8965, currency=USD, order_currency=USD, id=tx-XXXXXXX, category=new-user-order, modified_date=2018-10-15T05:41:12.577Z, order_total=9680, button_order_id=btnorder-77c9e56fd990f127, publisher_customer_id=XymEz8GO2M, rate_card_id=ratecard-41480b2a6b1196a7, advertising_id=null, event_date=2018-10-15T05:41:06Z, status=pending, pub_ref=null, account_id=acc-4b17f5a014d0de1a, btn_ref=srctok-0adf9e958510b3f1, order_id=null, posting_rule_id=null, order_line_items=[identifier=Antique Trading Card, description=Includes Lifetime Warranty, amount=9680, publisher_commission=968, attributes=, total=9680, quantity=1], order_click_channel=webview, order_purchase_date=null, validated_date=null, amount=968, customer_order_id=null, created_date=2018-10-15T05:41:12.577Z, commerce_organization=org-XXXXXX]

【参考方案2】：

给定特定的输入代码，data 字段被注释掉

//public Map data;

以及包含此字段的已发布输入 JSON，请求应失败并显示 400 Bad Request。

原因是 Ninja 使用 Jackson 进行 JSON 解析，默认会抛出未知字段。

快速的解决方法是将@JsonIgnoreProperties 注释添加到RecurOrderJSON 类。

例如

@JsonIgnoreProperties(ignoreUnknown = true)
public class RecurOrderJSON 
    ...

见：Ignoring new fields on JSON objects using Jackson

现在，如果错误不是 400，则没有太多信息可供参考，因为代码似乎没有任何其他明显错误。

要么发布一个 SSCCE 来演示问题，要么尝试通过使用以下方法显示错误页面来进行调试：

使用mvn package ninja:run 在调试模式下启动应用程序 使用允许详细检查响应的工具访问端点，例如 curl，例如
将请求 JSON 存储在 input.json 运行curl -v -o result.html -H 'Content-Type: application/json' --data '@input.json' http://localhost:8080/recurring 打开 result.html 以检查响应

【参考方案3】：

可能是您执行了错误的请求（因此未找到 JSON），但对于某些 Ninja 错误，它返回错误 500？

例如，您可以查看here，其中声明在 JSON 请求中解析空 JSON 会导致误导性错误 (500)，而它应该返回 400“错误请求”

【参考方案4】：

processRecurring 中不需要上下文并使用 Results.json() 并返回原始文件

public Result processRecurring(RecurOrderJSON recurOrderJSON) 
    String id = recurOrderJSON.id;
    String event_type = recurOrderJSON.event_type;
    String request_id = recurOrderJSON.request_id;
    //Map data = recurOrderJSON.data;
    //recurringRouter(event_type, data);
    log.info("ID value");
    log.info(id);

    return Results.json().render(recurOrderJSON);

确保在 RecurOrderJSON 中获取命名空间

package models;

public class RecurOrderJSON 

    public String id;
    public String event_type;
    public String request_id;
    // Maybe switch data type?
    //public Map data;

祝你好运！