0

0

如何在 Spring 中实现通用服务并按需返回实体的部分字段

霞舞

霞舞

发布时间:2026-01-20 17:53:24

|

297人浏览过

|

来源于php中文网

原创

如何在 Spring 中实现通用服务并按需返回实体的部分字段

本文介绍在 spring 应用中构建通用实体查询服务时,安全、灵活地控制返回字段的方法,重点解决敏感字段(如密码)暴露问题,推荐使用 dto 模式而非修改实体或依赖 json 注解。

在实际开发中,直接通过 EntityManager.find() 加载完整 JPA 实体并序列化为 JSON 返回前端,极易导致敏感字段(如 password、credentialsNonExpired 等)意外泄露,违反最小权限原则和 OWASP 安全规范。你当前的泛型服务虽具备灵活性,但缺乏数据投影(projection)与领域隔离能力。

最佳实践:采用 DTO(Data Transfer Object)模式
DTO 是解耦持久层与表现层的核心手段。它不继承实体、不参与 JPA 管理,仅作为轻量级数据容器,由服务层显式构造,确保只包含前端所需字段:

// 示例:UserSummaryDTO —— 仅返回公开信息
public record UserSummaryDTO(
    Long id,
    String firstname,
    String lastname,
    String email,
    String username,
    String role,
    boolean enabled
) {}

接着,在通用服务中扩展支持投影查询。避免反射加载任意类后直接返回——这既不安全也不可控。改为基于白名单 + 显式映射策略:

@Service
public class GenericProjectionService {

    @PersistenceContext
    private EntityManager entityManager;

    // 白名单:定义哪些实体允许被投影,及对应 DTO 类型
    private static final Map> PROJECTION_MAPPING = Map.of(
        "User", UserSummaryDTO.class,
        "Product", ProductBriefDTO.class,
        "Order", OrderSummaryDTO.class
    );

    public  T findProjectedById(String resource, Long resourceId, Class dtoClass) 
            throws EntityNotFoundException {
        String entityPackage = "com.example.package.models.";
        String entityClassName = entityPackage + resource;
        String dtoClassName = dtoClass.getName();

        try {
            Class entityClass = Class.forName(entityClassName);
            Class targetDto = dtoClass;

            // 使用 JPQL 构建类型安全的字段投影查询(避免 N+1 和全量加载)
            String jpql = String.format(
                "SELECT new %s(e.id, e.firstname, e.lastname, e.email, e.username, e.role, e.enabled) " +
                "FROM %s e WHERE e.id = :id",
                dtoClassName, resource
            );

            return entityManager.createQuery(jpql, targetDto)
                    .setParameter("id", resourceId)
                    .getSingleResult();

        } catch (NoResultException | IllegalArgumentException e) {
            throw new EntityNotFoundException(
                String.format("Resource '%s' with id %d not found", resource, resourceId)
            );
        } catch (ClassNotFoundException ex) {
            throw new EntityNotFoundException(
                String.format("Unsupported resource type: %s", resource)
            );
        }
    }
}

⚠️ 为什么不推荐其他方案?

Synths.Video
Synths.Video

一键将文章转换为带有真人头像和画外音的视频

下载
  • 移除实体中的 password 字段:破坏领域模型完整性,且写操作(如更新用户)将无法正常工作;
  • 仅靠 @JsonIgnore 或 @JsonView:属于序列化层控制,仍会从数据库加载全部字段,浪费内存与网络带宽,且无法防止误用(如日志打印、调试输出);
  • 运行时反射过滤字段:难以维护、无编译检查、性能差,且无法保证类型安全与空值处理。

? 进阶建议

  • 结合 Spring Data JPA 的 Interface-based ProjectionsClass-based Projections 提升开发体验;
  • 对高频查询场景,可配合 @Query + 构造函数表达式预定义投影方法;
  • 在 REST 层统一使用 ResponseEntity 包装 DTO,配合全局异常处理器拦截 EntityNotFoundException。

总之,通用服务的价值在于复用性与可维护性,而 DTO 是实现这一目标不可或缺的抽象层——它让“查什么、返回什么”变得清晰、可控、可测试。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

104

2025.08.06

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

412

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

465

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

13

2025.12.06

go中interface用法
go中interface用法

本专题整合了go语言中int相关内容,阅读专题下面的文章了解更多详细内容。

76

2025.09.10

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

11

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号