Spring MVC（RESTful API）：根据路径变量验证有效负载

Question

用例：

• 让我们使用 POST HTTP 动词设计一个 RESTful 创建操作 - 创建票证，其中创建者（分配者）指定票证受让人
• 我们正在以下位置创建新的“票证”：/companyId/userId/ticket

• 我们正在提供包含 assigneeId:

  的票证正文

  { “assigneeId”：10 }

• 我们需要验证 assigneeId 属于 URL 中的公司 - companyId 路径变量

到目前为止：

@RequestMapping(value="/{companyId}/{userId}/ticket", method=POST)
public void createTicket(@Valid @RequestBody Ticket newTicket, @PathVariable Long companyId, @PathVariable Long userId) {
  ...
}

• 我们可以轻松指定自定义验证器 (TicketValidator)（即使有依赖项）并验证 Ticket 实例
• 我们不能轻松地将companyId 传递给这个验证器！我们需要验证ticket.assigneeId 属于companyId 的公司。

期望的输出：

• 能够在自定义验证器中访问路径变量

任何想法如何在这里实现所需的输出？

Answer 1

如果我们假设我们的自定义验证器知道所需的属性名称，那么我们可以这样做：

方法一：

1) 我们可以将这个获取路径变量的逻辑转移到某种基础验证器中：

public abstract class BaseValidator implements Validator {

    @Override
    public boolean supports(Class<?> clazz)
    {
        // supports logic
    }

    @Override
    public void validate(Object target, Errors errors)
    {
        // some base validation logic or empty if there isn't any
    }

    protected String getPathVariable(String name) {
        // Getting current request (Can be autowired - depends on your implementation)
        HttpServletRequest req = HttpServletRequest((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
        if (req != null) {
            // getting variables map from current request
            Map<String, String> variables = req.getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
            return variables.get(name);
        }
        return null;
    }
}

2) 使用您的 TicketValidator 实现扩展它：

public class TicketValidator extends BaseValidator {

    @Override
    public void validate(Object target, Errors errors)
    {
        // Getting our companyId var
        String companyId = getPathVariable("companyId");
        ...
        // proceed with your validation logic. Note, that all path variables
        // is `String`, so you're going to have to cast them (you can do 
        // this in `BaseValidator` though, by passing `Class` to which you 
        // want to cast it as a method param). You can also get `null` from 
        // `getPathVariable` method - you might want to handle it too somehow
    }
}

方法二：

我认为值得一提的是，您可以将 @PreAuthorize 注释与 SpEL 一起使用来进行这种验证（您可以将路径变量和请求正文传递给它）。你会得到HTTP 403 代码虽然如果验证不会通过，所以我想这不是你想要的。

Answer 2

你总是可以这样做的：

@Controller
public class MyController {

    @Autowired
    private TicketValidator ticketValidator;

    @RequestMapping(value="/{companyId}/{userId}/ticket", method=POST)
    public void createTicket(@RequestBody Ticket newTicket,
            @PathVariable Long companyId, @PathVariable Long userId) {

        ticketValidator.validate(newTicket, companyId, userId);
        // do whatever

    }

}

---

编辑回应评论：

当Ticket 的有效性依赖于companyId 时，独立于companyId 验证Ticket 是没有意义的。

如果您无法使用上述解决方案，请考虑在 DTO 中将 Ticket 与 companyId 分组，并像这样更改映射：

@Controller
public class MyController {

    @RequestMapping(value="/{userId}/ticket", method=POST)
    public void createTicket(@Valid @RequestBody TicketDTO ticketDto,
            @PathVariable Long userId) {

        // do whatever
    }

}

public class TicketDTO {

    private Ticket ticket;

    private Long companyId;

    // setters & getters

}