如何编写管理@RequestParam多参数的代码逻辑？含查询服务示例

Hey there! Let's tackle how to better organize the logic around different @RequestParam values in your Spring service. First, let's format your existing code to make it clearer:

@RequestMapping(value = "/{productId}/freeTrial", method = RequestMethod.GET)
@ResponseBody
public RestResponse<List<RetrieveFreeTrialResponse>> retrieveServiceFreeTrialsByProductIdWithParam(
        @PathVariable String productId,
        @RequestParam(value = "addFields", required = false) String field) {
    
    if("includeDeleted".equals(field)) {
        return retrieveFreeTrialsActivity.retrieveFreeTrialsByProductId(productId, true);
    } else {
        return retrieveFreeTrialsActivity.retrieveFreeTrialsByProductId(productId, false);
    }
}

Right now, this works for a single parameter value, but as you add more possible addFields options, this if-else chain will get messy and hard to maintain. Here are a few clean, scalable approaches:

1. Use an Enum for Valid Parameter Values #

First, define an enum to represent all valid addFields options. This eliminates hardcoded strings and makes parameter validation straightforward:

private enum FieldOption {
    INCLUDE_DELETED("includeDeleted"),
    DEFAULT(""); // Handle empty/null case

    private final String paramValue;

    FieldOption(String paramValue) {
        this.paramValue = paramValue;
    }

    public static FieldOption fromParam(String param) {
        for (FieldOption option : values()) {
            if (option.paramValue.equals(param)) {
                return option;
            }
        }
        return DEFAULT; // Or throw an exception for invalid params
    }
}

Then update your controller method to use this enum:

@RequestMapping(value = "/{productId}/freeTrial", method = RequestMethod.GET)
@ResponseBody
public RestResponse<List<RetrieveFreeTrialResponse>> retrieveServiceFreeTrialsByProductIdWithParam(
        @PathVariable String productId,
        @RequestParam(value = "addFields", required = false) String field) {
    
    FieldOption option = FieldOption.fromParam(field);
    boolean includeDeleted = FieldOption.INCLUDE_DELETED.equals(option);
    
    return retrieveFreeTrialsActivity.retrieveFreeTrialsByProductId(productId, includeDeleted);
}

This makes it easy to add new options later—just add a new enum constant and update the logic if needed.

2. Strategy Pattern for Complex Logic #

If each parameter value requires more complex logic than just a boolean flag, use the Strategy Pattern to encapsulate each behavior.

First, define a strategy interface:

interface FreeTrialRetrievalStrategy {
    RestResponse<List<RetrieveFreeTrialResponse>> retrieve(String productId);
}

Then implement strategies for each option:

class DefaultRetrievalStrategy implements FreeTrialRetrievalStrategy {
    private final RetrieveFreeTrialsActivity activity;

    // Constructor injection
    public DefaultRetrievalStrategy(RetrieveFreeTrialsActivity activity) {
        this.activity = activity;
    }

    @Override
    public RestResponse<List<RetrieveFreeTrialResponse>> retrieve(String productId) {
        return activity.retrieveFreeTrialsByProductId(productId, false);
    }
}

class IncludeDeletedRetrievalStrategy implements FreeTrialRetrievalStrategy {
    private final RetrieveFreeTrialsActivity activity;

    // Constructor injection
    public IncludeDeletedRetrievalStrategy(RetrieveFreeTrialsActivity activity) {
        this.activity = activity;
    }

    @Override
    public RestResponse<List<RetrieveFreeTrialResponse>> retrieve(String productId) {
        return activity.retrieveFreeTrialsByProductId(productId, true);
    }
}

Then in your controller, map parameter values to strategies (you can use a Map for this):

@RestController
public class FreeTrialController {
    private final Map<String, FreeTrialRetrievalStrategy> strategyMap;
    private final FreeTrialRetrievalStrategy defaultStrategy;

    // Constructor injection with strategy map
    public FreeTrialController(RetrieveFreeTrialsActivity activity) {
        this.strategyMap = Map.of(
            "includeDeleted", new IncludeDeletedRetrievalStrategy(activity)
        );
        this.defaultStrategy = new DefaultRetrievalStrategy(activity);
    }

    @RequestMapping(value = "/{productId}/freeTrial", method = RequestMethod.GET)
    @ResponseBody
    public RestResponse<List<RetrieveFreeTrialResponse>> retrieveServiceFreeTrialsByProductIdWithParam(
            @PathVariable String productId,
            @RequestParam(value = "addFields", required = false) String field) {
        
        FreeTrialRetrievalStrategy strategy = strategyMap.getOrDefault(field, defaultStrategy);
        return strategy.retrieve(productId);
    }
}

This approach is perfect if you expect to add many more addFields values with unique logic—you just add a new strategy class and update the map, no need to modify existing controller code.

3. Simplify for Small Use Cases #

If you only have a couple of parameter values and don't expect to expand much, you can clean up the existing logic by extracting the condition into a helper method:

@RequestMapping(value = "/{productId}/freeTrial", method = RequestMethod.GET)
@ResponseBody
public RestResponse<List<RetrieveFreeTrialResponse>> retrieveServiceFreeTrialsByProductIdWithParam(
        @PathVariable String productId,
        @RequestParam(value = "addFields", required = false) String field) {
    
    return retrieveFreeTrialsActivity.retrieveFreeTrialsByProductId(productId, shouldIncludeDeleted(field));
}

private boolean shouldIncludeDeleted(String field) {
    return "includeDeleted".equals(field);
}

This keeps your main controller method clean and focused, and the helper method makes the intent clear.

Bonus: Validate Invalid Parameters #

Don't forget to handle invalid addFields values! If someone passes a value you don't support, you can throw a BadRequestException (or return a 400 response) to let the client know:

private FieldOption fromParam(String param) {
    for (FieldOption option : values()) {
        if (option.paramValue.equals(param)) {
            return option;
        }
    }
    throw new ResponseStatusException(HttpStatus.BAD_REQUEST, "Invalid addFields value: " + param);
}

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