带有点（。）的Spring MVC @PathVariable被截断

#1 楼

据我所知，这个问题只出现在requestmapping末尾的pathvariable中。

我们能够通过在requestmapping中定义regex插件来解决此问题。

 /somepath/{variable:.+}

#2 楼

Spring认为最后一个点后面的任何东西都是文件扩展名，例如.json或.xml，并对其进行结构化以检索您的参数。

因此，如果您具有/somepath/{variable}：



/somepath/param，/somepath/param.json，/somepath/param.xml或/somepath/param.anything将产生值param的参数


/somepath/param.value.json，/somepath/param.value.xml或/somepath/param.value.anything将导致值param.value的参数

如果按照建议将映射更改为/somepath/{variable:.+}，则任何点（包括最后一个点）都将被视为参数的一部分：




/somepath/param将导致参数值为param


/somepath/param.json将导致参数值为param.json


/somepath/param.xml将导致参数值为param.xml

/somepath/param.anything将导致参数值为param.anything


/somepath/param.value.json将导致参数值为param.value.json

...

如果您不关心扩展名认知，您可以通过覆盖mvc:annotation-driven automagic来禁用它：

<bean id="handlerMapping"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
    <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
    <property name="useSuffixPatternMatch" value="false"/>
</bean>

因此，如果您有/somepath/{variable}，请再次使用它：



/somepath/param，/somepath/param.json，/somepath/param.xml或/somepath/param.anything将产生值param的参数


/somepath/param.value.json，/somepath/param.value.xml或/somepath/param.value.anything将导致值param.value的参数


注意：与默认配置的区别仅在具有somepath/something.{variable}之类的映射时可见。如果您想保持扩展管理，请参阅Resthub项目问题

，从Spring 3.2开始，您还可以设置RequestMappingHandlerMapping bean的useRegisteredSuffixPatternMatch属性，以保持激活suffixPattern识别，但仅限于已注册的扩展。

这里您仅定义json和xml扩展名：

<bean id="handlerMapping"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
    <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
    <property name="useRegisteredSuffixPatternMatch" value="true"/>
</bean>

<bean id="contentNegotiationManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
    <property name="favorPathExtension" value="false"/>
    <property name="favorParameter" value="true"/>
    <property name="mediaTypes">
        <value>
            json=application/json
            xml=application/xml
        </value>
    </property>
</bean>

请注意，mvc：annotation-driven现在接受contentNegotiation选项以提供自定义bean，但必须将RequestMappingHandlerMapping的属性更改为true（默认为false）（参见https://jira.springsource.org/browse/SPR-7632 ）。

因此，您仍然必须覆盖所有mvc：annotation驱动的配置。我开了一张去Spring的票，要求自定义RequestMappingHandlerMapping：https://jira.springsource.org/browse/SPR-11253。如果您有兴趣，请投票。

覆盖时，请谨慎考虑自定义执行管理覆盖。否则，所有自定义Exception映射将失败。您将必须使用带列表bean的messageCoverters来重用：

<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />
<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean" />

<util:list id="messageConverters">
    <bean class="your.custom.message.converter.IfAny"></bean>
    <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.StringHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"></bean>
</util:list>

<bean name="exceptionHandlerExceptionResolver"
      class="org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver">
    <property name="order" value="0"/>
    <property name="messageConverters" ref="messageConverters"/>
</bean>

<bean name="handlerAdapter"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
    <property name="webBindingInitializer">
        <bean class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
            <property name="conversionService" ref="conversionService" />
            <property name="validator" ref="validator" />
        </bean>
    </property>
    <property name="messageConverters" ref="messageConverters"/>
</bean>

<bean id="handlerMapping"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
</bean>

我在我参与的开源项目Resthub中实现了针对这些主题的一组测试：参见https://github.com/resthub/resthub-spring-stack/pull/219/files和https://github.com/resthub/resthub-spring-stack/issues/217

#3 楼

春季4更新：从4.0.1开始，您可以使用PathMatchConfigurer（通过您的WebMvcConfigurer），例如

@Configuration
protected static class AllResources extends WebMvcConfigurerAdapter {

    @Override
    public void configurePathMatch(PathMatchConfigurer matcher) {
        matcher.setUseRegisteredSuffixPatternMatch(true);
    }

}


@Configuration
public class WebConfig implements WebMvcConfigurer {

   @Override
   public void configurePathMatch(PathMatchConfigurer configurer) {
       configurer.setUseSuffixPatternMatch(false);
   }
}

在xml中，它将是（https：// jira。 spring.io/browse/SPR-10163）：

<mvc:annotation-driven>
    [...]
    <mvc:path-matching registered-suffixes-only="true"/>
</mvc:annotation-driven>

#4 楼

除了Martin Frey的答案之外，还可以通过在RequestMapping值中添加尾斜杠来解决此问题：

/path/{variable}/

请记住，此修复程序不支持可维护性。现在，它要求所有URI都带有斜线-对于API用户/新开发人员而言，这可能并不明显。因为可能并非所有参数中都有一个.，所以它还可能会造成间歇性错误

#5 楼

在Spring Boot Rest Controller中，我已通过以下步骤解决了这些问题：

RestController：

@GetMapping("/statusByEmail/{email:.+}/")
public String statusByEmail(@PathVariable(value = "email") String email){
  //code
}

从Rest Client：

Get http://mywebhook.com/statusByEmail/abc.test@gmail.com/

#6 楼

添加“：。+”对我有用，但是直到我移除了外部花括号。

value = {“ /username/{id:.+}”}无效

值=“ /用户名/{id:.+}”起作用

希望我帮助了某人:)

#7 楼

/somepath/{variable:.+}可在Java requestMapping标签中使用。

#8 楼

这是一种完全依赖于Java配置的方法：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

@Configuration
public class MvcConfig extends WebMvcConfigurationSupport{

    @Bean
    public RequestMappingHandlerMapping requestMappingHandlerMapping() {
        RequestMappingHandlerMapping handlerMapping = super.requestMappingHandlerMapping();
        handlerMapping.setUseSuffixPatternMatch(false);
        handlerMapping.setUseTrailingSlashMatch(false);
        return handlerMapping;
    }
}

#9 楼

解决此问题的一种非常简单的方法是在末尾添加斜杠...

例如：

use：

/somepath/filename.jpg/

而不是：

/somepath/filename.jpg

#10 楼

在Spring Boot中，正则表达式解决了类似

@GetMapping("/path/{param1:.+}")

的问题

#11 楼

包括Spring 4.2路径名在内的电子邮件地址在内的完整解决方案是

<bean id="contentNegotiationManager"
    class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
    <property name="favorPathExtension" value="false" />
    <property name="favorParameter" value="true" />
    <property name="mediaTypes">
        <value>
            json=application/json
            xml=application/xml
        </value>
    </property>
</bean>
<mvc:annotation-driven
    content-negotiation-manager="contentNegotiationManager">
    <mvc:path-matching suffix-pattern="false" registered-suffixes-only="true" />
</mvc:annotation-driven>

将其添加到application-xml

#12 楼

如果您使用的是Spring 3.2.x和<mvc:annotation-driven />，请创建以下小小的BeanPostProcessor：

package spring;

public final class DoNotTruncateMyUrls implements BeanPostProcessor {
    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        if (bean instanceof RequestMappingHandlerMapping) {
            ((RequestMappingHandlerMapping)bean).setUseSuffixPatternMatch(false);
        }
        return bean;
    }
    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

然后将其放在MVC配置xml中：

<bean class="spring.DoNotTruncateMyUrls" />

#13 楼

最后，我在Spring Docs中找到了解决方案：

要完全禁用文件扩展名，您必须同时设置以下两项：

 useSuffixPatternMatching(false), see PathMatchConfigurer

 favorPathExtension(false), see ContentNegotiationConfigurer

将其添加到我的WebMvcConfigurerAdapter实现解决了问题：

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

@Override
public void configurePathMatch(PathMatchConfigurer matcher) {
    matcher.setUseSuffixPatternMatch(false);
}

#14 楼

对我来说，

@GetMapping(path = "/a/{variableName:.+}")

有效，但仅当您还将请求URL中的“点”也编码为“％2E”时，它才有效。但要求URL全部都是……虽然有效，但这不是“标准”编码。感觉像是一个bug：|
另一个解决方法，类似于“ trailing slash”，是移动将带有点“ inline”的变量，例如：
@GetMapping（path =“ / {variableName} / a“）
现在将保留所有点，无需进行任何修改。

#15 楼

从Spring 5.2.4（Spring Boot v2.2.6.RELEASE）开始，不推荐使用PathMatchConfigurer.setUseSuffixPatternMatch和ContentNegotiationConfigurer.favorPathExtension（https://spring.io/blog/2020/03/24/spring-framework-5-2- 5-available-now和https://github.com/spring-projects/spring-framework/issues/24179）。

真正的问题是客户端请求特定的媒体类型（例如。 com），默认情况下，Spring添加了所有这些媒体类型。在大多数情况下，您的REST控制器只会生成JSON，因此不支持请求的输出格式（.com）。
要克服此问题，您应该通过更新rest控制器（或特定方法）以支持'输出'格式（@RequestMapping(produces = MediaType.ALL_VALUE）并确保允许点号（{username:.+}）之类的字符来使一切都很好。

示例：

@RequestMapping(value = USERNAME, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
public class UsernameAPI {

    private final UsernameService service;

    @GetMapping(value = "/{username:.+}", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.ALL_VALUE)
    public ResponseEntity isUsernameAlreadyInUse(@PathVariable(value = "username") @Valid @Size(max = 255) String username) {
        log.debug("Check if username already exists");
        if (service.doesUsernameExist(username)) {
            return ResponseEntity.status(HttpStatus.NO_CONTENT).build();
        }
        return ResponseEntity.notFound().build();
    }
}

Spring 5.3及更高版本将仅匹配注册的后缀（媒体类型）。

#16 楼

如果同时写后端和前端，则另一个简单的解决方案是在URL的末尾附加一个“ /”。如果是这样，则无需更改后端...

somepath/myemail@gmail.com/

请开心！

#17 楼

如果您使用的是Spring 3.2+，则以下解决方案将有所帮助。这样处理所有URL绝对比在请求URI映射中允许使用regex模式更好。像/somepath/{variable:.+}
在xml文件中定义一个bean

<bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
        <property name="useSuffixPatternMatch" value="false"/>
        <property name="useRegisteredSuffixPatternMatch" value="true"/>
    </bean>

标志的用法可以在文档中找到。我不愿透露姓名以解释
useRegisteredSuffixPatternMatch的使用可以解决此问题。从类的Java文档中，
如果启用，则映射到“ / users”的控制器方法也将匹配到“
” /users.json”，并假设“ .json”是在
提供了{@link #setContentNegotiationManager（ContentNegotiationManager）
contentNegotiationManager}。这对于仅允许使用特定的
URL扩展名以及“。”的情况很有用。 URL路径中的
可能导致路径变量内容的模棱两可（例如，给定的
“ / users / {user}”以及传入的URL，例如“ /users/john.j.joe”和
"/users/john.j.joe.json“）。