Spring Rest应用中通过自定义控制器获取用户角色的问题

首先咱们得搞清楚为啥会出现这个差异：你在User类的roles字段上加了@JsonBackReference注解，这个注解的作用是避免双向关联时的JSON循环序列化，Jackson在序列化User对象的时候会自动忽略带这个注解的字段，所以你的自定义接口返回的结果里就没了角色信息。而Spring Data REST的默认端点（比如/users/11）用的是它自己的序列化机制，会处理关联关系的展示，所以能看到roles的链接。

接下来给你几个可行的解决方案，你可以根据自己的需求选：

方案1：调整Jackson双向关联注解 #

把@JsonBackReference和@JsonManagedReference换个位置，让User的roles字段用@JsonManagedReference（被管理的一方，会被序列化），Role的users字段用@JsonBackReference（被忽略的一方，避免循环）。

代码示例： #

User类：

@Entity
public class User {
    // 其他属性（id、username等）
    
    @ManyToMany(fetch = FetchType.EAGER) // 注意：如果用LAZY的话，要确保序列化时roles已加载，不然会抛懒加载异常
    @JoinTable(
        name = "user_roles",
        joinColumns = @JoinColumn(name = "user_id"),
        inverseJoinColumns = @JoinColumn(name = "role_id")
    )
    @JsonManagedReference // 这里改用这个注解
    private Set<Role> roles;
    
    // getter、setter方法
}

Role类：

@Entity
public class Role {
    // 其他属性（id、name等）
    
    @ManyToMany(mappedBy = "roles")
    @JsonBackReference // 这里用BackReference忽略users字段
    private Set<User> users;
    
    // getter、setter方法
}

这样调整后，你自定义的/api/users/{id}接口返回的User对象就会包含roles信息了，同时也不会出现循环序列化的问题。

方案2：使用DTO（数据传输对象） #

如果不想改动实体类的Jackson注解（比如怕影响其他地方的序列化逻辑），可以创建一个专门用于返回前端的DTO类，精准控制要返回的字段，包括角色信息。

代码示例： #

1. 先创建DTO类：

// UserDTO：对应前端需要的用户信息
public class UserDTO {
    private Long id;
    private String username;
    private String email;
    private List<RoleDTO> roles;

    // 构造方法、getter、setter
    public UserDTO() {}
    
    public UserDTO(User user) {
        this.id = user.getId();
        this.username = user.getUsername();
        this.email = user.getEmail();
        // 把Role转换成RoleDTO
        this.roles = user.getRoles().stream()
            .map(role -> new RoleDTO(role.getId(), role.getName()))
            .collect(Collectors.toList());
    }
}

// RoleDTO：只返回角色的核心信息
public class RoleDTO {
    private Long id;
    private String name;

    public RoleDTO(Long id, String name) {
        this.id = id;
        this.name = name;
    }
    
    // getter、setter
}

2. 修改Service层，返回DTO：

@Service
public class UserService {
    @Autowired
    private UserRepository userRepository;

    public UserDTO getUserById(Long id) {
        User user = userRepository.findById(id)
            .orElseThrow(() -> new RuntimeException("User not found with id: " + id));
        // 可以手动转换，也用ModelMapper这类工具简化转换
        return new UserDTO(user);
    }
}

3. 控制器返回DTO：

@RestController
@RequestMapping("/api/users")
public class UserRestController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public ResponseEntity<UserDTO> getUserById(@PathVariable Long id) {
        UserDTO userDTO = userService.getUserById(id);
        return ResponseEntity.ok(userDTO);
    }
}

这个方案的好处是完全解耦了实体类和前端返回结构，你可以自由添加或移除字段，不会影响JPA的关联逻辑。

方案3：用@JsonIgnoreProperties替代@JsonBackReference #

在User的roles字段上使用@JsonIgnoreProperties注解，指定忽略Role类中的users字段，这样既可以序列化roles，又能避免循环引用。

代码示例： #

User类：

@Entity
public class User {
    // 其他属性
    
    @ManyToMany(fetch = FetchType.EAGER)
    @JoinTable(
        name = "user_roles",
        joinColumns = @JoinColumn(name = "user_id"),
        inverseJoinColumns = @JoinColumn(name = "role_id")
    )
    @JsonIgnoreProperties("users") // 忽略Role中的users字段，防止循环
    private Set<Role> roles;
    
    // getter、setter
}

Role类：

@Entity
public class Role {
    // 其他属性
    
    @ManyToMany(mappedBy = "roles")
    private Set<User> users; // 这里不需要加Jackson注解了
    
    // getter、setter
}

这个方案比调整注解更灵活，你可以精准控制忽略关联类中的哪个字段，不会影响其他关联关系的序列化。

注意事项：懒加载问题 #

如果你的roles字段用的是FetchType.LAZY（默认），那么在序列化的时候可能会抛出LazyInitializationException（因为Session已经关闭，roles还没加载）。解决方法有两种：

1. 把fetch改成FetchType.EAGER（简单但可能影响性能，不推荐大数据量场景）；
2. 在Repository中写查询方法，用JOIN FETCH主动加载roles：

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
    @Query("SELECT u FROM User u JOIN FETCH u.roles WHERE u.id = :id")
    User findByIdWithRoles(@Param("id") Long id);
}

然后在Service层调用这个方法获取User对象，确保roles已经被加载。

内容的提问来源于stack exchange，提问作者Ouissal