SpringBoot 1.5.6中HTTP PATCH更新JPA实体的非空字段映射最优方案

这个场景我太有共鸣了——字段多的时候一个个写if(dto.getFoo() != null)简直是噩梦！结合你用的SpringBoot 1.5.6.RELEASE，给你推荐几个高效的解决方案，不用再手写一堆空值判断：

方案一：使用ModelMapper实现条件映射 #

ModelMapper是一款灵活的对象映射工具，可以通过配置实现仅复制非空字段的逻辑，非常适合PATCH场景。

步骤1：添加依赖 #

在pom.xml中引入ModelMapper（适配SpringBoot 1.5.x的版本）：

<dependency>
    <groupId>org.modelmapper</groupId>
    <artifactId>modelmapper</artifactId>
    <version>1.1.0</version>
</dependency>

步骤2：配置ModelMapper #

创建配置类，设置全局非空映射条件：

@Configuration
public class ModelMapperConfig {
    @Bean
    public ModelMapper modelMapper() {
        ModelMapper modelMapper = new ModelMapper();
        // 配置仅当源字段非空时才进行映射
        modelMapper.getConfiguration()
            .setPropertyCondition(Conditions.isNotNull());
        return modelMapper;
    }
}

步骤3：实际使用 #

在业务逻辑中直接调用map方法，自动更新实体的非空字段：

@Autowired
private ModelMapper modelMapper;
@Autowired
private EntityRepository entityRepository;

public void updateEntity(Long id, EntityDto dto) {
    // 从数据库查询要更新的实体
    Entity entity = entityRepository.findOne(id);
    // 将DTO中的非空字段映射到实体
    modelMapper.map(dto, entity);
    // 保存更新后的实体
    entityRepository.save(entity);
}

方案二：使用MapStruct实现编译时映射（推荐） #

MapStruct是编译时生成映射代码的工具，性能比运行时反射的工具更好，而且类型安全。它的@MappingTarget注解可以直接更新已有实体，配合自定义条件实现非空字段更新。

步骤1：添加依赖 #

适配SpringBoot 1.5.x的MapStruct版本：

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-jdk8</artifactId>
    <version>1.2.0.Final</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.2.0.Final</version>
    <scope>provided</scope>
</dependency>

步骤2：定义映射接口 #

创建映射接口，使用@MappingTarget指定要更新的实体，并添加非空判断的默认方法：

@Mapper(componentModel = "spring")
public interface EntityMapper {
    // 忽略主键，避免被DTO的null值覆盖
    @Mapping(target = "id", ignore = true)
    void updateEntityFromDto(EntityDto dto, @MappingTarget Entity entity);

    // 自定义非空判断条件，MapStruct会自动应用
    default <T> boolean isNotNull(T value) {
        return value != null;
    }
}

步骤3：实际使用 #

注入映射接口后直接调用更新方法：

@Autowired
private EntityMapper entityMapper;
@Autowired
private EntityRepository entityRepository;

public void updateEntity(Long id, EntityDto dto) {
    Entity entity = entityRepository.findOne(id);
    // 仅更新DTO中非空的字段到实体
    entityMapper.updateEntityFromDto(dto, entity);
    entityRepository.save(entity);
}

方案三：自定义反射工具类（轻量场景） #

如果不想引入第三方依赖，可以自己写一个通用的反射工具类，遍历DTO字段并复制非空值到实体：

public class PatchUtil {
    public static void copyNonNullProperties(Object source, Object target) throws IllegalAccessException {
        Class<?> sourceClass = source.getClass();
        Class<?> targetClass = target.getClass();

        Field[] sourceFields = sourceClass.getDeclaredFields();
        for (Field sourceField : sourceFields) {
            sourceField.setAccessible(true);
            Object value = sourceField.get(source);
            if (value != null) {
                try {
                    Field targetField = targetClass.getDeclaredField(sourceField.getName());
                    targetField.setAccessible(true);
                    targetField.set(target, value);
                } catch (NoSuchFieldException e) {
                    // 字段名不匹配时跳过，可根据需求添加日志
                    e.printStackTrace();
                }
            }
        }
    }
}

使用时直接调用工具方法：

public void updateEntity(Long id, EntityDto dto) {
    Entity entity = entityRepository.findOne(id);
    try {
        PatchUtil.copyNonNullProperties(dto, entity);
    } catch (IllegalAccessException e) {
        // 处理异常逻辑
    }
    entityRepository.save(entity);
}

方案对比 #

• MapStruct：编译时生成代码，性能最优、类型安全，推荐在生产环境使用；
• ModelMapper：配置简单灵活，无需编写映射接口，适合快速开发；
• 自定义反射工具：轻量无依赖，但需要自己维护字段匹配、类型转换等逻辑，适合简单场景。

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