实体类字段为接口的json序列化报错的解决方法以 SpringSecurity UserDetails实现类 GrantedAuthority 为例

2024-01-21 08:05:10

前言

在Java开发中，我们经常需要将对象序列化为JSON格式，以便在网络上进行传输或存储。然而，当实体类字段为接口时，可能会出现JSON序列化报错的问题。本文将详细介绍如何解决此问题，并以SpringSecurity UserDetails实现类GrantedAuthority为例进行详细说明。

问题

在SpringSecurity中，UserDetails接口定义了一个名为getAuthorities()的方法，该方法返回一个Collection。GrantedAuthority接口是一个标记接口，没有任何方法。在实际应用中，我们通常会使用其实现类SimpleGrantedAuthority来表示用户的权限。

然而，当我们尝试将UserDetails对象序列化为JSON格式时，可能会出现以下错误：

java.lang.IllegalArgumentException: Can not construct instance of interface com.example.demo.security.GrantedAuthority

这是因为Jackson无法将接口序列化为JSON格式。

解决方法

为了解决此问题，我们可以使用以下两种方法之一：

使用实现类SimpleGrantedAuthority

我们可以直接使用GrantedAuthority的实现类SimpleGrantedAuthority来表示用户的权限。这样，Jackson就可以直接将SimpleGrantedAuthority对象序列化为JSON格式。

public class UserDetailsImpl implements UserDetails {

    private Collection<SimpleGrantedAuthority> authorities;

    // ...其他代码

}

使用Jackson的@JsonTypeInfo注解

如果我们不想使用SimpleGrantedAuthority，也可以使用Jackson的@JsonTypeInfo注解来指定要序列化的具体类型。

public class UserDetailsImpl implements UserDetails {

    @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
    private Collection<GrantedAuthority> authorities;

    // ...其他代码

}

这样，Jackson就可以根据@class属性的值来确定要序列化的具体类型。

建议

为了避免此类问题，我们应该尽量避免在实体类中使用接口作为字段。如果确实需要使用接口，那么应该使用Jackson的@JsonTypeInfo注解来指定要序列化的具体类型。

结语

本文详细介绍了如何解决实体类字段为接口的json序列化报错问题，并以SpringSecurity UserDetails实现类GrantedAuthority为例进行了详细说明。同时，还提供了一些有用的建议，帮助您避免此类问题。如果您正在开发Java应用程序并遇到类似的问题，那么本文将为您提供有效的解决方案。