点注释后的Spring路径变量截断

Question

我正在尝试设置一个RESTendpoint，允许通过用户的电子邮件地址查询用户。电子邮件地址是路径的最后一部分，因此Spring将[e-mail]视为值foo@example并截断扩展名.com。

<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">
    <property name="useDefaultSuffixPattern" value="false" />
</bean>

@RequestMapping(value = "user/by-email/{email:.+}")

Answer 1

URI末尾的path变量中的点会导致两个意外的行为（对于大多数用户来说是意外的，但熟悉大量Spring配置属性的用户除外）。

第一个（可以使用{email:.+}regex修复）是默认Spring配置匹配所有路径扩展。因此，为/api/{file}设置映射意味着Spring将对/api/myfile.html的调用映射到字符串参数myfile。当您希望/api/myfile.html、/api/myfile.md、/api/myfile.txt和其他文件都指向同一个资源时，这很有用。但是，我们可以在全局范围内关闭这种行为，而不必在每个endpoint上使用regex hack。

第二个问题与第一个问题有关，并被@masstroy正确修复。当/api/myfile.*指向myfile资源时，Spring假定路径扩展(.html,.txt等）指示应该以特定格式返回资源。这种行为在某些情况下也非常有用。但通常，这将意味着方法映射返回的对象不能转换为这种格式，并且Spring将抛出HttpMediaTypeNotAcceptableException。

我们可以通过以下操作将两者关闭（假设是Spring引导）：

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

  @Override
  public void configurePathMatch(PathMatchConfigurer configurer) {
    // turn off all suffix pattern matching
    configurer.setUseSuffixPatternMatch(false);
    // OR
    // turn on suffix pattern matching ONLY for suffixes
    // you explicitly register using
    // configureContentNegotiation(...)
    configurer.setUseRegisteredSuffixPatternMatch(true);
  }

  @Override
  public void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
    configurer.favorPathExtension(false);
  }
}

有关内容协商的更多信息。