在 SpringMVC 的上下文中，如何让 Web 服务为同一个类提供不同的 JSON 表示？

Question

我有一个数据类，像这样：

public class Person {
   private String name;
   private Long code;

   // corresponding getters and setters
}

我想编写两个 Web 服务，它们提供两种不同的 JSON 表示的 Person。例如，其中一个提供{"name":"foo"}，而另一个提供{"name":"foo", "code":"123"}。

作为一个更复杂的场景，假设 Person 有一个引用属性，例如地址。 Address 也有自己的属性，我希望我的两个 Web 服务都考虑这个属性，但每个服务都以自己的方式这样做。

我的 SpringMVC 视图应该是什么样的？

请注意，我是 SpringMVC 的新手。所以请在你的答案旁边给我一个示例代码。

更新 1： 几天后，所有答案都促使我解决控制器中的问题或通过注释数据类。但我想在视图中做到这一点，没有更多的 java 代码。我可以在 JSP 文件或 thymeleaf 模板甚至 .properties 文件中执行此操作吗？

更新 2： 我找到了json-taglib。但不知何故，它被排除在新的升级之外。有没有类似的解决方案？

Answer 1

您正在使用Spring-MVC，因此Jackson 负责JSON 序列化和反序列化。

在这种情况下，您可以使用@JsonInclude(Include.NON_NULL) 在序列化过程中忽略空字段。

public class Person {
   @JsonInclude(Include.NON_NULL)
   private String name;

   @JsonInclude(Include.NON_NULL)
   private Long code;

   // corresponding getters and setters
}

如果您的name 或code 是null，那么它将从输出JSON 中排除

因此，如果您将code 传递为null，您的输出JSON 将类似于{"name":"foo"}

Answer 2

您可以使用MappingJacksonValue 查找字段的动态过滤。

过滤器允许您序列化满足自定义条件的字段。

你可以在这里查看我的示例代码：

package com.github.tddiaz.jsonresponsefiltering;

import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import jdk.nashorn.internal.objects.annotations.Getter;
import lombok.Data;
import lombok.NonNull;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.json.MappingJacksonValue;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @RestController
    class Controller {

        @GetMapping("/filter")
        public ResponseEntity filter() {
            final Response response = new Response("value1", "value2", "value3");

            //ignore field3; will only return values of field1 and field2
            final SimpleBeanPropertyFilter beanPropertyFilter = SimpleBeanPropertyFilter.filterOutAllExcept("field1", "field2");

            final FilterProvider filterProvider = new SimpleFilterProvider().addFilter("responseFilter", beanPropertyFilter);

            final MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(response);
            mappingJacksonValue.setFilters(filterProvider);

            return ResponseEntity.ok(mappingJacksonValue);
        }
    }

    @JsonFilter("responseFilter")
    @Data
    class Response {
        @NonNull
        private String field1, field2, field3;
    }
}

Answer 3

使用 Projection 以不同的方式公开您的 json，如果您需要通过投影向该模型添加更多信息，例如可能是另一个 DB 表，则使用 ResourceProcessor。

Answer 4

根据您的用例，只需从 jsp/js 页面调用您选择的控制器...例如假设 Admin 是用户，然后调用 AdminController 否则调用用户控制器 ...这可以使用简单的 if/else 条件来完成...您也可以查看代理设计模式，但这取决于用例

Answer 5

使用 Spring MVC 创建 JSon 时，默认情况下，“视图渲染器”是 Jackson。不需要使用 JSP 或其他视图技术之类的东西。你想要做的是告诉杰克逊如何为给定的情况渲染一个对象。有多种选择，但我建议使用投影。 一个例子：

@RestController
@RequestMapping(value = "person")
public class PersonController {

    private final ProjectionFactory projectionFactory;

    public PersonController(ProjectionFactory projectionFactory) {
        this.projectionFactory = projectionFactory;
    }

    @GetMapping("...")
    public PersonBase getPerson(..., @RequestParam(value = "view", required = false, defaultValue = "base") String view) {
        ...

        if(view.equals("extended")) {
            return projectionFactory.createProjection(PersonExtended.class, person);
        } else {
            return projectionFactory.createProjection(PersonBase.class, person);
        }
    }
}



public interface PersonBase {
    String getName();
}

public interface PersonExtended extends PersonBase {
    Long getCode;
}

您的应用程序的视图层是投影类（然后放在一个包中，如果您愿意，可以放在视图包中）。 控制器可以选择要渲染的视图，或者您可以像示例中那样使结果动态化。

您关于如何呈现地址的问题可以通过像这样的另一个投影来解决：

public interface PersonWithAddress extends PersonExtended {
    AddressProjection getAddress();
}

public interface AddressProjection {
    String getStreetName();
    String getZipcode();
    ...
}

Answer 6

我建议你在前端使用 JSON.stringify(value[, replacer[, space]]) 函数。我在下面给出了一个例子。您可以根据您对特定视图的要求编写自定义函数。

例如。下面的示例忽略空值。在这里，我编写了删除空值的 editperson 函数。

该函数有两个输入参数，即键和值。根据要删除或更改的键和值编写逻辑。

var springperson = { "name":"foo","code":null }

console.log(springperson); // person recieved from  spring


function editjson(key, value){
if (value !== null) return value
}

var editperson = JSON.stringify(springperson, editjson); // String representation of person

var personjson=JSON.parse(editperson);  // JSON object representation of person

console.log(personjson); // person as required by the view

如果您有任何问题，请发表评论。