Spring MVC @PathVariable ที่มีจุด (.) กำลังถูกตัดทอน

นี่คือความต่อเนื่องของคำถาม Spring MVC @PathVariable ที่ถูกตัดทอน

ฟอรัม Spring ระบุว่ามีการแก้ไข (เวอร์ชัน 3.2) เป็นส่วนหนึ่งของ ContentNegotiationManager ดูลิงค์ด้านล่าง
https://jira.springsource.org/browse/SPR-6164
https://jira.springsource.org/browse/SPR-7632

ในแอปพลิเคชันของฉัน requestParameter ที่มี. com จะถูกปัดเศษ

ใครช่วยอธิบายวิธีใช้คุณสมบัติใหม่นี้ให้ฉันได้บ้าง สามารถกำหนดค่าได้อย่างไรที่ xml

หมายเหตุ: spring forum- # 1 Spring MVC @PathVariable ที่มีจุด (.) กำลังถูกตัดทอน

เท่าที่ฉันรู้ปัญหานี้จะปรากฏเฉพาะสำหรับ pathvariable ในตอนท้ายของการร้องขอการทำแผนที่

เราสามารถแก้ปัญหานั้นได้โดยการกำหนด regex addon ใน requestmapping

 /somepath/{variable:.+}

สปริงพิจารณาว่าอะไรก็ตามที่อยู่หลังจุดสุดท้ายคือนามสกุลไฟล์เช่น.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-drivenautomagic:

<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 คุณสามารถตั้งค่าคุณสมบัติ useRegisteredSuffixPatternMatch ของ RequestMappingHandlerMapping bean เพื่อให้การรับรู้ 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: ขับเคลื่อนด้วยคำอธิบายประกอบยอมรับตอนนี้เป็นตัวเลือก contentNegotiation เพื่อให้ถั่วที่กำหนดเอง แต่คุณสมบัติของ RequestMappingHandlerMapping จะต้องเปลี่ยนเป็นจริง (เท็จเริ่มต้น) (cf https://jira.springsource.org/browse/SPR-7632 )

ด้วยเหตุผลดังกล่าวคุณยังคงต้องแทนที่การกำหนดค่าที่ขับเคลื่อนด้วยคำอธิบายประกอบ mvc ทั้งหมด ฉันเปิดตั๋วไป Spring เพื่อขอ RequestMappingHandlerMapping ที่กำหนดเอง: https://jira.springsource.org/browse/SPR-11253 โปรดลงคะแนนถ้าคุณถูกขัดจังหวะ

ในขณะที่การเอาชนะโปรดระมัดระวังในการพิจารณาการจัดการ Execution แบบกำหนดเองด้วย มิฉะนั้นการแมปข้อยกเว้นที่กำหนดเองทั้งหมดของคุณจะล้มเหลว คุณจะต้องใช้ messageCoverters ใหม่ด้วย list bean:

<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 project แบบโอเพนซอร์สที่ฉันเป็นส่วนหนึ่งของชุดการทดสอบในหัวข้อเหล่านี้: ดู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 / นักพัฒนาใหม่ เนื่องจากอาจเป็นไปได้ว่าพารามิเตอร์ทั้งหมดอาจไม่มี a .อยู่ในนั้นจึงอาจสร้างข้อบกพร่องเป็นระยะ

ใน 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/

การเพิ่ม ":. +" ใช้งานได้สำหรับฉัน แต่ไม่ได้จนกว่าฉันจะลบวงเล็บปีกกาด้านนอกออก

value = { "/username/{id:.+}" } ไม่ทำงาน

value = "/username/{id:.+}" ทำงาน

หวังว่าฉันช่วยใครบางคน :)

/somepath/{variable:.+}ทำงานในrequestMappingแท็กJava

นี่คือวิธีการที่ต้องอาศัยการกำหนดค่า 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;
    }
}

วิธีการง่ายๆในการแก้ไขปัญหานี้คือการต่อท้ายสแลชต่อท้าย ...

เช่น:

ใช้:

/somepath/filename.jpg/

แทน:

/somepath/filename.jpg

ใน Spring Boot นิพจน์ปกติแก้ปัญหาเช่น

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

โซลูชันที่สมบูรณ์รวมถึงที่อยู่อีเมลในชื่อพา ธ สำหรับฤดูใบไม้ผลิ 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 config 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 ของทุกคนเป็นอย่างนั้น ... ซึ่งไม่ใช่การเข้ารหัส "มาตรฐาน" แต่ใช้ได้จริง รู้สึกเหมือนเป็นแมลง: |

การทำงานอื่น ๆ คล้ายกับวิธี "ต่อท้ายสแลช" คือการย้ายตัวแปรที่จะมีจุด "inline" อดีต:

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

ตอนนี้จุดทั้งหมดจะได้รับการเก็บรักษาไว้โดยไม่ต้องมีการดัดแปลงหรือ regex

ตั้งแต่ 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) เพื่อเอาชนะปัญหานี้คุณควรจะทำได้ดีด้วยการอัพเดทตัวควบคุมส่วนที่เหลือของคุณ (หรือวิธีการเฉพาะ) เพื่อสนับสนุนรูปแบบ 'ouput' ( @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 และสูงกว่าจะตรงกับคำต่อท้ายที่ลงทะเบียนแล้วเท่านั้น (ชนิดสื่อบันทึก)