RequestMapping da Primavera 3: obter valor do caminho

133

Existe uma maneira de obter o valor completo do caminho após a requestMapping @PathVariableanálise dos valores?

Ou seja: /{id}/{restOfTheUrl}deve ser capaz de analisar /1/dir1/dir2/file.htmlem id=1erestOfTheUrl=/dir1/dir2/file.html

Todas as idéias seriam apreciadas.

Macaco da Primavera
fonte

Respostas:

198

Parte não correspondente da URL é exposta como um atributo de solicitação denominado HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE:

@RequestMapping("/{id}/**")
public void foo(@PathVariable("id") int id, HttpServletRequest request) {
    String restOfTheUrl = (String) request.getAttribute(
        HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
    ...
}
axtavt
fonte
63
Não, o atributo HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE contém o caminho correspondente TODO.
uthark
11
uthark está certo. O valor restOfTheUrlserá o caminho inteiro, e não apenas a parte restante capturado por**
dcstraw
4
HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE é opcional e pode ser NULL ou "" para algumas implementações. request.getRequestURI () retorna o mesmo valor e não é opcional.
Nidalpres 12/10
2
Esta solução não funciona mais e não é confiável.
DolphinJava 23/09/16
51

Acabei de encontrar esse problema correspondente ao meu problema. Usando constantes HandlerMapping, consegui escrever um pequeno utilitário para esse fim:

/**
 * Extract path from a controller mapping. /controllerUrl/** => return matched **
 * @param request incoming request.
 * @return extracted path
 */
public static String extractPathFromPattern(final HttpServletRequest request){


    String path = (String) request.getAttribute(
            HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
    String bestMatchPattern = (String ) request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE);

    AntPathMatcher apm = new AntPathMatcher();
    String finalPath = apm.extractPathWithinPattern(bestMatchPattern, path);

    return finalPath;

}
Fabien Kruba
fonte
19

Isso já está aqui há um bom tempo, mas postando isso. Pode ser útil para alguém.

@RequestMapping( "/{id}/**" )
public void foo( @PathVariable String id, HttpServletRequest request ) {
    String urlTail = new AntPathMatcher()
            .extractPathWithinPattern( "/{id}/**", request.getRequestURI() );
}
Daniel Jay Marcaida
fonte
1
O problema com esse código é que ele não manipula o prefixo de servlet e o prefixo de mapeamento.
Gavenkoa 18/05
11

Baseando-se já excelente resposta de Fabien Kruba , eu pensei que seria bom se a **parte do URL pode ser dado como um parâmetro para o método de controle através de uma anotação, de forma que era semelhante ao @RequestParame @PathVariable, ao invés de sempre usando um método de utilitário que exigia explicitamente o HttpServletRequest. Então, aqui está um exemplo de como isso pode ser implementado. Espero que alguém ache útil.

Crie a anotação, juntamente com o resolvedor de argumentos:

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WildcardParam {

    class Resolver implements HandlerMethodArgumentResolver {

        @Override
        public boolean supportsParameter(MethodParameter methodParameter) {
            return methodParameter.getParameterAnnotation(WildcardParam.class) != null;
        }

        @Override
        public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer, NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
            HttpServletRequest request = nativeWebRequest.getNativeRequest(HttpServletRequest.class);
            return request == null ? null : new AntPathMatcher().extractPathWithinPattern(
                    (String) request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE),
                    (String) request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE));
        }

    }

}

Registre o resolvedor de argumentos do método:

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(new WildcardParam.Resolver());
    }

}

Use a anotação nos métodos de tratamento do controlador para ter acesso fácil à **parte da URL:

@RestController
public class SomeController {

    @GetMapping("/**")
    public void someHandlerMethod(@WildcardParam String wildcardParam) {
        // use wildcardParam here...
    }

}
thejonwithnoh
fonte
9

Você precisa usar o built-in pathMatcher:

@RequestMapping("/{id}/**")
public void test(HttpServletRequest request, @PathVariable long id) throws Exception {
    ResourceUrlProvider urlProvider = (ResourceUrlProvider) request
            .getAttribute(ResourceUrlProvider.class.getCanonicalName());
    String restOfUrl = urlProvider.getPathMatcher().extractPathWithinPattern(
            String.valueOf(request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE)),
            String.valueOf(request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE)));
Sombrio
fonte
2
Confirmar isso funciona com a versão mais recente do Spring Boot
Dave Bauman
1
Também confirmando que esse método funciona a partir do Spring Boot 2.2.4 RELEASE.
tom_mai78101 13/03
5

Eu usei o Tuckey URLRewriteFilter para manipular elementos de caminho que contêm caracteres '/', pois acho que o Spring 3 MVC ainda não os suporta.

http://www.tuckey.org/

Você coloca esse filtro no seu aplicativo e fornece um arquivo de configuração XML. Nesse arquivo, você fornece regras de reescrita, que podem ser usadas para converter elementos de caminho que contêm caracteres '/' em parâmetros de solicitação com os quais o Spring MVC pode lidar adequadamente usando @RequestParam.

WEB-INF / web.xml:

<filter>
  <filter-name>UrlRewriteFilter</filter-name>
  <filter-class>org.tuckey.web.filters.urlrewrite.UrlRewriteFilter</filter-class>
</filter>
<!-- map to /* -->

WEB-INF / urlrewrite.xml:

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE urlrewrite
    PUBLIC "-//tuckey.org//DTD UrlRewrite 3.0//EN"
    "http://tuckey.org/res/dtds/urlrewrite3.0.dtd">
<urlrewrite>
  <rule>
    <from>^/(.*)/(.*)$</from>
    <to last="true">/$1?restOfTheUrl=$2</to>
</urlrewrite>

Método do controlador:

@RequestMapping("/{id}")
public void handler(@PathVariable("id") int id, @RequestParam("restOfTheUrl") String pathToFile) {
  ...
}
sdouglass
fonte
2

Sim, o restOfTheUrlnão está retornando apenas o valor necessário, mas podemos obtê-lo usando a UriTemplatecorrespondência.

Eu resolvi o problema, então aqui a solução de trabalho para o problema:

@RequestMapping("/{id}/**")
public void foo(@PathVariable("id") int id, HttpServletRequest request) {
String restOfTheUrl = (String) request.getAttribute(
    HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
    /*We can use UriTemplate to map the restOfTheUrl*/
    UriTemplate template = new UriTemplate("/{id}/{value}");        
    boolean isTemplateMatched = template.matches(restOfTheUrl);
    if(isTemplateMatched) {
        Map<String, String> matchTemplate = new HashMap<String, String>();
        matchTemplate = template.match(restOfTheUrl);
        String value = matchTemplate.get("value");
       /*variable `value` will contain the required detail.*/
    }
}
Anil Kumar Pandey
fonte
1

Aqui está como eu fiz isso. Você pode ver como eu converto a URL solicitada em um caminho do sistema de arquivos (sobre o que é essa pergunta do SO). Bônus: e também como responder com o arquivo.

@RequestMapping(value = "/file/{userId}/**", method = RequestMethod.GET)
public void serveFile(@PathVariable("userId") long userId, HttpServletRequest request, HttpServletResponse response) {
    assert request != null;
    assert response != null;

    // requestURL:  http://192.168.1.3:8080/file/54/documents/tutorial.pdf
    // requestURI:  /file/54/documents/tutorial.pdf
    // servletPath: /file/54/documents/tutorial.pdf
    // logger.debug("requestURL: " + request.getRequestURL());
    // logger.debug("requestURI: " + request.getRequestURI());
    // logger.debug("servletPath: " + request.getServletPath());

    String requestURI = request.getRequestURI();
    String relativePath = requestURI.replaceFirst("^/file/", "");

    Path path = Paths.get("/user_files").resolve(relativePath);
    try {
        InputStream is = new FileInputStream(path.toFile());  
        org.apache.commons.io.IOUtils.copy(is, response.getOutputStream());
        response.flushBuffer();
    } catch (IOException ex) {
        logger.error("Error writing file to output stream. Path: '" + path + "', requestURI: '" + requestURI + "'");
        throw new RuntimeException("IOError writing file to output stream");
    }
}
neoneye
fonte
0
private final static String MAPPING = "/foo/*";

@RequestMapping(value = MAPPING, method = RequestMethod.GET)
public @ResponseBody void foo(HttpServletRequest request, HttpServletResponse response) {
    final String mapping = getMapping("foo").replace("*", ""); 
    final String path = (String) request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
    final String restOfPath = url.replace(mapping, "");
    System.out.println(restOfPath);
}

private String getMapping(String methodName) {
    Method methods[] = this.getClass().getMethods();
    for (int i = 0; i < methods.length; i++) {
        if (methods[i].getName() == methodName) {
            String mapping[] = methods[i].getAnnotation(RequestMapping.class).value();
            if (mapping.length > 0) {
                return mapping[mapping.length - 1];
            }
        }
    }
    return null;
}
xsampedro
fonte
-4

Eu tenho um problema semelhante e resolvi desta maneira:

@RequestMapping(value = "{siteCode}/**/{fileName}.{fileExtension}")
public HttpEntity<byte[]> getResource(@PathVariable String siteCode,
        @PathVariable String fileName, @PathVariable String fileExtension,
        HttpServletRequest req, HttpServletResponse response ) throws IOException {
    String fullPath = req.getPathInfo();
    // Calling http://localhost:8080/SiteXX/images/argentine/flag.jpg
    // fullPath conentent: /SiteXX/images/argentine/flag.jpg
}

Observe que req.getPathInfo()retornará o caminho completo (com {siteCode}e {fileName}.{fileExtension}) para que você precise processar convenientemente.

Nico's
fonte