在 application.yml 的 json 响应中包含/排除属性

Question

我正在使用 JHipster(spring boot) 来生成我的项目。我想隐藏/显示 application.yml 中 JSON 中的字段。例如：

我有以下类

@Entity
@Table(name = "port")
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE)
public class Port implements Serializable {

    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "sequenceGenerator")
    @SequenceGenerator(name = "sequenceGenerator")
    @Column(name = "id")
    private Long id;

    @Column(name = "city")
    private String city;

    @Column(name = "description")
    private String description;

    //getters & setters
}

我的 GET 方法返回如下响应：

{
"id": 1,
"city": "boston",
"description": "test test"
}

我希望能够从 application.yml 中包含/排除某些字段（因为我没有 application.properties），否则会有类似的内容

//application.yml

include: ['city']
exclude: ['description']

：这个例子我的json应该是这样的：

{
"id": 1,
"city": "boston",
}

例如，如果我有40个字段，并且我需要隐藏10个并显示30个，我只想将我想隐藏的10个放在application.yml中的排除中，而不需要每次都去更改代码。我猜@jsonignore 隐藏字段，但我不知道如何从 application.yml 中做到这一点，

抱歉没有解释清楚。我希望一切都清楚。

预先感谢您提供任何建议或解决方案来执行类似的操作

Answer 1

Spring boot 默认使用 Jackson JSON 库将类序列化为 Json。在该库中，有一个注释 @JsonIgnore ，它的用途正是告诉 Json 引擎忽略序列化/反序列化中的特定属性。因此，假设在您的实体Port 中，您希望从显示中排除房产城市。您所要做的就是使用 @JsonIgnore 注释来注释该属性（或其 getter 方法）：

@Column(name = "city")
@JsonIgnore
private String city;

Answer 2

您可以尝试在控制器中创建哈希图来管理 HTTP 响应。

        Map<String, Object> map = new HashMap<>();

        map.put("id", Port.getId());
        map.put("city", Port.getCity());

        return map;

Answer 3

基本上，您不会在 REST 控制器中公开您的 Port 实体，而是公开一个 DTO（数据传输对象），您使用一个简单的类（例如 PortMapper< /代码>）。正如其他答案中所建议的，PortDTO 也可以是 Map 。

然后，您的服务层可以使用从 application.yml 中获取值的配置对象（例如 PortMapperConfiguration），并由 PortMapper 用于有条件地调用 PortDTO setters 来自 Port getters。

@ConfigurationProperties(prefix = "mapper", ignoreUnknownFields = false)
public class PortMapperConfiguration {
    private List<String> include;
    private List<String> exclude;

    // getters/setters
}

@Service
public class PortMapper {
    private PortMapperConfiguration configuration;

    public PortMapper(PortMapperConfiguration configuration) {
        this.configuration = configuration;
    }

    public PortDTO toDto(Port port) {
      PortDTO dto = new PortDTO();

      // Fill DTO based on configuration
      return dto;
    }
}