如何在 Spring MVC 應用程式中動態排除 Java 物件 JSON 回應中的欄位？

使用Spring MVC 在JSON 回應中動態忽略來自Java 物件的欄位

在Spring MVC 應用程式中，我們經常遇到需要選擇性地排除某些特定欄位的情況。欄位不包含在 JSON 回應中。這通常是維護資料隱私和遵守安全法規所必需的。為了實現這一點，我們有多種選擇。

使用 @JsonIgnoreProperties

最簡單的解決方案是使用 @JsonIgnoreProperties 註解 POJO 並指定您想要的欄位名稱排除。例如：

<code class="java">@Entity
@Table(name = "user")
@JsonIgnoreProperties({ "encryptedPwd", "createdBy", "updatedBy" })
public class User implements java.io.Serializable {
    // Your getters and setters here...
}</code>

這將指示 Spring MVC 在將物件序列化為 JSON 時忽略 @JsonIgnoreProperties 註解中指定的欄位。

將@JsonIgnore 與Jackson 註解結合使用

如果您希望對排除的欄位進行更精細的控制，您可以使用jackson-core 庫中的Jackson 註釋。例如：

<code class="java">import com.fasterxml.jackson.annotation.JsonIgnore;

@JsonIgnore
public String getEncryptedPwd() {
    return encryptedPwd;
}</code>

在 getter 方法之前加入 @JsonIgnore 將阻止該欄位包含在 JSON 回應中。

使用自訂 JSON 序列化器

或者，您可以建立自訂 JSON 序列化器來定義根據您的要求動態排除欄位的邏輯。以下是使用Jackson 的範例：

<code class="java">import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;

public class IgnoreFieldsSerializer extends JsonSerializer<User> {

    private List<String> ignoredFields;

    // Constructor to set the list of ignored fields

    @Override
    public void serialize(User user, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        jsonGenerator.writeStartObject();

        for (Field field : user.getClass().getDeclaredFields()) {

            // Check if the field is in the ignored list
            if (!ignoredFields.contains(field.getName())) {
                jsonGenerator.writeFieldName(field.getName());
                jsonGenerator.writeObject(field.get(user));
            }
        }
        jsonGenerator.writeEndObject();
    }
}</code>

然後您可以在REST 控制器中使用自訂序列化器：

<code class="java">@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/{userId}")
    public ResponseEntity<User> getUser(@PathVariable Integer userId) {
        User user = userService.get(userId);

        ObjectMapper mapper = new ObjectMapper();
        mapper.registerModule(new SimpleModule().addSerializer(User.class, new IgnoreFieldsSerializer(ignoredFields)));
        
        return ResponseEntity.ok(mapper.writeValueAsString(user));
    }
}</code>

透過ignoreFields參數提供要忽略的欄位清單，您可以動態控制JSON 回應中排除的欄位。

以上是如何在 Spring MVC 應用程式中動態排除 Java 物件 JSON 回應中的欄位？的詳細內容。更多資訊請關注PHP中文網其他相關文章！