如何在REST Data with Panache中排除实体字段不暴露给REST资源？

针对只读场景下需要隐藏部分实体字段的需求，这里有几个实用的解决办法：

1. 用Jackson注解直接控制字段序列化 #

直接在实体类的敏感/不需要暴露的字段上添加@JsonIgnore注解，Jackson序列化时会自动跳过这些字段：

@Entity
public class User extends PanacheEntity {
    public String username;
    public String email;
    @JsonIgnore // 这个字段不会被REST接口返回
    public String password;
}

如果需要批量排除多个字段，也可以在类上添加@JsonIgnoreProperties({"password", "internalCode"})注解。

2. 使用投影（Projections）定义返回结构 #

REST Data with Panache支持通过投影接口指定要暴露的字段，无需修改实体类：
先定义一个投影接口，只包含你需要对外暴露的字段：

public interface UserPublicView {
    Long getId();
    String getUsername();
    String getEmail();
}

然后在REST资源接口上指定使用这个投影：

public interface UsersResource extends PanacheRepositoryResource<PanacheRepository<User>, User, Long> {
    @Override
    default RepositoryResourceProperties getResourceProperties() {
        return RepositoryResourceProperties.builder()
                .projection(UserPublicView.class)
                .build();
    }
}

这样所有返回User的接口都会自动返回投影定义的字段集合。

3. 自定义REST资源接口（完全可控） #

如果默认生成的资源满足不了需求，直接自己写REST接口，调用Panache的查询方法后返回筛选后的字段或者DTO：

@Path("/users")
public class CustomUsersResource {

    @Inject
    PanacheRepository<User> userRepository;

    @GET
    @Path("/{id}")
    public Response getUserById(@PathParam("id") Long id) {
        User user = userRepository.findById(id);
        if (user == null) {
            return Response.status(Status.NOT_FOUND).build();
        }
        // 手动构造返回对象，只包含需要的字段
        Map<String, Object> response = new HashMap<>();
        response.put("id", user.id);
        response.put("username", user.username);
        response.put("email", user.email);
        return Response.ok(response).build();
    }

    // 也可以用DTO类封装返回结构
    @GET
    public List<UserDTO> getAllUsers() {
        return userRepository.listAll().stream()
                .map(u -> new UserDTO(u.id, u.username, u.email))
                .collect(Collectors.toList());
    }
}

这种方式自由度最高，适合有复杂返回逻辑的场景。

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