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

Question

所以我在这里有一个 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();
}

我正在尝试映射到的class：

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);

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

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 映射到我的对象，对吗？

Answer 1

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

例如，您可以看一下 here，其中说明在 JSON 请求中解析空 JSON 确实会导致误导错误 (500)，而这是应该的至 return 400 "Bad Request"

Answer 2

进程中不需要上下文重复使用 Results.json() 和 return 原始

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;
}

祝你好运！

Answer 3

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

//public Map data;

和包含此字段的 posted 输入 JSON，请求应该失败并显示 400 Bad Request。

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

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

例如

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

参见：Ignoring new fields on JSON objects using Jackson

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

post 演示问题的 SSCCE 或尝试通过使用以下方法显示错误页面来进行调试：

使用 mvn package ninja:run
使用允许详细检查响应的工具访问端点，例如 curl，例如
1. 在 input.json
2. 运行 curl -v -o result.html -H 'Content-Type: application/json' --data '@input.json' http://localhost:8080/recurring
3. 打开 result.html 检查响应

Answer 4

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

首先，为了方便 try/test，我建议（临时）修改：

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) 注释可以避免反序列化问题，如果您的源数据与您的模型不完全匹配（一定要使用最新版本的注释，在 fasterxml 子包中，而不是旧的，在 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}]

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

Ninja framework endpoint throws 500 error when trying to map JSON to custom object

java

json

ninjaframework