ドット（。）を含むSpring MVC @PathVariableが切り捨てられる

これは質問の続きです MVC @PathVariableが切り捨てられます

Springフォーラムは、ContentNegotiationManagerの一部として修正済み（バージョン3.2）であると述べています。以下のリンクを参照してください。
https://jira.springsource.org/browse/SPR-6164
https://jira.springsource.org/browse/SPR-7632

私のアプリケーションでは、.comのrequestParameterが切り捨てられています。

この新機能の使い方を誰かに説明してもらえますか？xmlでどのように構成できますか？

注：Springフォーラム-＃1 Spring MVC @PathVariable with dot（。）is truncated

私の知る限り、この問題はリクエストマッピングの最後のパス変数でのみ発生します。

requestmappingで正規表現アドオンを定義することで、これを解決できました。

 /somepath/{variable:.+}

Springは、最後のドットの後ろにあるものは、.jsonor などのファイル拡張子である.xmlと見なし、それを切り捨ててパラメーターを取得します。

だからあなたが持っている場合/somepath/{variable}：

• /somepath/param、/somepath/param.json、/somepath/param.xmlまたは/somepath/param.anything値PARAMをもたらします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をもたらしますparam
• /somepath/param.value.json、/somepath/param.value.xmlまたは/somepath/param.value.anything値を持つパラメータになりますparam.value

注：デフォルトの構成との違いは、のようなマッピングがある場合にのみ表示されますsomepath/something.{variable}。Resthubプロジェクトの問題を参照

拡張機能の管理を維持したい場合は、Spring 3.2以降、suffixPattern認識を有効にしたまま登録済み拡張機能に限定するために、RequestMappingHandlerMapping BeanのuseRegisteredSuffixPatternMatchプロパティを設定することもできます。

ここでは、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は、カスタムBeanを提供するcontentNegotiationオプションを受け入れるようになりましたが、RequestMappingHandlerMappingのプロパティをtrue（デフォルトはfalse）に変更する必要があることに注意してください（https://jira.springsource.org/browse/SPR-7632を参照））。

そのため、すべてのmvc：annotation-driven構成をオーバーライドする必要があります。Springへのチケットを開いて、カスタムのRequestMappingHandlerMappingを要求しました（https://jira.springsource.org/browse/SPR-11253）。興味のある方は投票してください。

オーバーライドするときは、カスタム実行管理のオーバーライドも考慮してください。そうしないと、すべてのカスタム例外マッピングが失敗します。リストBeanでmessageCoverterを再利用する必要があります。

<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

Spring 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>

Martin Freyの回答に加えて、RequestMapping値に末尾のスラッシュを追加することでこれを修正することもできます。

/path/{variable}/

この修正は保守性をサポートしないことに注意してください。現在では、すべてのURIに末尾にスラッシュを付ける必要があります。これは、APIユーザーや新しい開発者にはわかりにくいものです。すべてのパラメーターにが含まれている.とは限らないため、断続的なバグが発生する可能性もあります

Spring Boot Rest Controllerでは、次の手順でこれらを解決しました：

RestController：

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

そして残りのクライアントから：

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

"：。+"の追加は私にとってはうまくいきましたが、外側の中括弧を削除するまではできませんでした。

値= { "/username/{id:.+}" } が機能しませんでした

値= "/username/{id:.+}"は 機能します

私が誰かを助けたことを願っています:)

/somepath/{variable:.+}Java requestMappingタグで動作します。

純粋に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;
    }
}

この問題を回避する非常に簡単な方法の1つは、末尾にスラッシュを追加することです...

例えば：

使用する ：

/somepath/filename.jpg/

の代わりに：

/somepath/filename.jpg

Spring Bootでは、正規表現は次のような問題を解決します

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

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に追加します

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" />

最後に私は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);
}

私にとって

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

動作しますが、リクエストURLの「ドット」も「％2E」としてエンコードした場合にのみ機能します。ただし、URLがすべてであることを必要とします...これは有効ですが、「標準」エンコーディングではありません。バグのような気がします：|

「末尾のスラッシュ」の方法と同様の別の回避策は、ドット「インライン」を持つ変数を移動することですex：

@GetMapping（パス= "/ {変数名} / a"）

これで、すべてのドットが保持され、変更や正規表現は必要ありません。

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 and https://github.com/spring-projects/spring-framework/issues/24179）。

実際の問題は、クライアントが特定のメディアタイプ（.comなど）をリクエストし、Springがデフォルトでそれらすべてのメディアタイプを追加したことです。ほとんどの場合、RESTコントローラーはJSONのみを生成するため、要求された出力形式（.com）はサポートされません。この問題を克服するには、レストコントローラ（または特定のメソッド）を更新して「出力」形式（@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以降では、登録済みのサフィックス（メディアタイプ）のみが一致します。