如何解决JAX-RS中@DefaultValue对空字符串不生效的问题？

JAX-RS的@DefaultValue仅在参数为null时生效，而请求传入的空字符串会被直接赋值，导致默认值不触发。以下是两种可行的解决方法：

方案一：全局字符串参数转换器（JAX-RS标准扩展） #

通过自定义ParamConverter和ParamConverterProvider，将空/空白字符串转为null，触发@DefaultValue的默认值填充逻辑，全局生效。

实现步骤： #

1. 编写字符串转换器，将空字符串转为null

import javax.ws.rs.ext.ParamConverter;
import javax.ws.rs.ext.ParamConverterProvider;
import javax.ws.rs.ext.Provider;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

public class StringEmptyToNullConverter implements ParamConverter<String> {
    @Override
    public String fromString(String value) {
        // 空或空白字符串返回null，让@DefaultValue生效
        return (value == null || value.trim().isEmpty()) ? null : value;
    }

    @Override
    public String toString(String value) {
        return value;
    }

    // 注册为JAX-RS Provider
    @Provider
    public static class ConverterProvider implements ParamConverterProvider {
        @Override
        public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation[] annotations) {
            if (rawType.equals(String.class)) {
                return (ParamConverter<T>) new StringEmptyToNullConverter();
            }
            return null;
        }
    }
}

2. 将转换器注册到JAX-RS应用中
   在自定义的Application子类里添加转换器类：

import javax.ws.rs.core.Application;
import java.util.HashSet;
import java.util.Set;

public class MyJaxRsApplication extends Application {
    @Override
    public Set<Class<?>> getClasses() {
        Set<Class<?>> classes = new HashSet<>();
        classes.add(MyController.class);
        // 注册空字符串转null的转换器
        classes.add(StringEmptyToNullConverter.ConverterProvider.class);
        return classes;
    }
}

优点：一次配置全局生效，无需修改每个DTO类；缺点：会影响所有字符串类型的查询参数，若某些参数允许空字符串需额外处理。

方案二：DTO类内局部处理（@PostConstruct初始化） #

在Pageable类中添加@PostConstruct注解的初始化方法，手动将空字符串替换为默认值，仅对当前类生效。

修改后的Pageable类：

import javax.annotation.PostConstruct;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.QueryParam;
import lombok.Data;

@Data
public class Pageable {

    @QueryParam("sortBy")
    @DefaultValue("1")
    private String sortBy;

    @QueryParam("sortDir")
    @DefaultValue("ASC")
    private String sortDir;

    private int page;

    @PostConstruct
    public void handleEmptyParams() {
        // 处理sortBy空字符串
        if (sortBy == null || sortBy.trim().isEmpty()) {
            sortBy = "1";
        }
        // 处理sortDir空字符串
        if (sortDir == null || sortDir.trim().isEmpty()) {
            sortDir = "ASC";
        }
    }
}

优点：仅针对当前DTO类处理，灵活可控；缺点：每个需要处理空字符串的DTO都需编写类似逻辑。

注意事项 #

• 若只需处理严格空字符串（""）而非空白字符串（如" "），可去掉代码中的trim()调用。
• 方案一的转换器会覆盖所有字符串类型的参数转换逻辑，若有特殊参数需要保留空字符串，可通过自定义注解标记，在转换器中判断注解后跳过处理。

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