Spring MVC Missing matrix variable

Question

I'm trying to add a matrix parameter (or matrix variable) to my Rest Controller using SpringMVC (from Spring boot 1.2.3.RELEASE) Here is my code :

@RestController
public class SubAgentsController {

    @RequestMapping(value = "/{subagents}", method = RequestMethod.GET)
    public SubAgent subAgents(@MatrixVariable(value="agentName", pathVar="subagents") String agentName) {
        System.out.println(agentName);
    }
}

Unfortunately, when I try to get : http://localhost:8080/subagents;agentName=hello

that is the answer I receive :

There was an unexpected error (type=Bad Request, status=400).

Missing matrix variable 'agentName' for method parameter of type String

What did I do wrong ? According to http://docs.spring.io/spring-framework/docs/3.2.0.M2/reference/html/mvc.html that should work :-(

Thanks for your answers!

score 4 · Answer 1 · answered Feb 16 '17 at 17:58

In SpringBoot Application In order to enable Matrix variables you need to define below override code

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        UrlPathHelper urlPathHelper = new UrlPathHelper();
        urlPathHelper.setRemoveSemicolonContent(false);
        configurer.setUrlPathHelper(urlPathHelper);
    }
}

Otherwise, they’re disabled by default

Sotirios Delimanolis · Accepted Answer · 2015-05-29T22:32:59.177

2

As the documentation you linked to states,

Note that to enable the use of matrix variables, you must set the removeSemicolonContent property of RequestMappingHandlerMapping to false. By default it is set to true with the exception of the MVC namespace and the MVC Java config both of which automatically enable the use of matrix variables.

If you're configuring your application by extending WebMvcConfigurationSupport, then override the requestMappingHandlerMapping method which prepares the RequestMappingHandlerMapping and set its appropriate property.

@Override
public RequestMappingHandlerMapping requestMappingHandlerMapping() {
    final RequestMappingHandlerMapping requestMappingHandlerMapping = super.requestMappingHandlerMapping();
    requestMappingHandlerMapping.setRemoveSemicolonContent(false); // <<< this
    return requestMappingHandlerMapping;
}

You'll then be all set.

With Spring Boot, I think all you need is to declare a @Bean method with the above, ie. that returns a RequestMappingHandlerMapping instance.

edited May 29 '15 at 22:32

answered May 29 '15 at 22:25

Sotirios Delimanolis

274,122
60
696
724

right, thanks for your answer, that was it ! I would also add that for Spring Boot, you need to mark the class holding the RequestMapperHandling to to be annotated with `@Configuration` (not `@Bean`) – Anthony Dahanne Jun 01 '15 at 16:37
@AnthonyDahanne I'm saying the method needs to be annotated with `@Bean`. – Sotirios Delimanolis Jun 01 '15 at 16:44
I did not need to add this `@Bean` annotation to the method. Just the method you provided, in a class annotated with `@Configuration` was necessary with Spring boot 1.2.3 - this is what I'm using : https://gist.github.com/anthonydahanne/82915d8123eea9ff60b7 and it's working great – Anthony Dahanne Jun 01 '15 at 16:52
@AnthonyDahanne Oh, because you're overriding `WebMvcConfigurationSupport#requestMappingHandlerMapping` which is the typical solution I suggested. In Spring boot, I don't believe it's necessary. You can simply provide a `@Bean` method in a registered `@Configuration` class. – Sotirios Delimanolis Jun 01 '15 at 16:54

score 0 · Answer 3 · answered Nov 02 '22 at 01:51

If you are using Spring Data and its controller mapping, try something like this also

@Configuration
public class DataMvcConfig extends RepositoryRestMvcConfiguration {

    @Override
    public DelegatingHandlerMapping restHandlerMapping() {
        final DelegatingHandlerMapping delegatingHandlerMapping = super.restHandlerMapping();
        for (HandlerMapping delegate : delegatingHandlerMapping.getDelegates()) {
            if (delegate instanceof AbstractHandlerMapping) {
                ((AbstractHandlerMapping)delegate).setRemoveSemicolonContent(false);
            }
        }
        return delegatingHandlerMapping;
    }
}

Spring MVC Missing matrix variable

3 Answers3

Linked