Custom Spring annotation for request parameters

Question

I would like to write custom annotations, that would modify Spring request or path parameters according to annotations. For example instead of this code:

@RequestMapping(method = RequestMethod.GET)
public String test(@RequestParam("title") String text) {
   text = text.toUpperCase();
   System.out.println(text);
   return "form";
}

I could make annotation @UpperCase :

@RequestMapping(method = RequestMethod.GET)
   public String test(@RequestParam("title") @UpperCase String text) {
   System.out.println(text);
   return "form";
}

Is it possible and if it is, how could I do it ?

You can also do this with spring AOP; you'd use a method annotated like `@Before("@annotation(my.pkg.annotation.UpperCase)")`, then transform the parameter in the method. — beerbajay, Jun 08 '15 at 17:51

score 49 · Accepted Answer · edited Jun 30 '16 at 17:14

49

As the guys said in the comments, you can easily write your annotation driven custom resolver. Four easy steps,

Create an annotation e.g.

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface UpperCase {
    String value();
}

Write a resolver e.g.

public class UpperCaseResolver implements HandlerMethodArgumentResolver {

    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterAnnotation(UpperCase.class) != null;
    }

    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest,
            WebDataBinderFactory binderFactory) throws Exception {
        UpperCase attr = parameter.getParameterAnnotation(UpperCase.class);
        return webRequest.getParameter(attr.value()).toUpperCase();
    }
}

register a resolver

<mvc:annotation-driven>
        <mvc:argument-resolvers>
            <bean class="your.package.UpperCaseResolver"></bean>
        </mvc:argument-resolvers>
</mvc:annotation-driven>

or the java config

    @Configuration
    @EnableWebMvc
    public class Config extends WebMvcConfigurerAdapter {
    ...
      @Override
      public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
          argumentResolvers.add(new UpperCaseResolver());
      }
    ...
    }

use an annotation in your controller method e.g.

public String test(@UpperCase("foo") String foo)

edited Jun 30 '16 at 17:14

MarCrazyness

2,172
1
27
28

answered Jun 08 '15 at 18:06

Master Slave

27,771
4
57
55

Shouldn't it be : ? – wesker317 Jun 08 '15 at 19:13
1

this answer needs a relative high version of springframework. I tried 4.1.4,does not work, 4.2.4 can work. – hiway Jun 05 '16 at 14:00
I created a custom annotation of my own. Used it in a sample application. It works fine. But when I tried to Integrate the same code with my project, it doesn't work. Not sure why is it not getting picked up – Tushar Banne Jan 07 '18 at 14:08
Works as expected in spring boot 1 with spring-web 4.3.14.RELEASE, thanks. – NickGreen Jun 23 '18 at 14:46
1

Since Spring 5 you should just implement the interface `WebMvcConfigurer` instead of extending (the now deprecated) `WebMvcConfigurerAdapter` – Martin van Wingerden Sep 10 '19 at 07:54
1

@master-slave i have used both the mvc:annotation/config but the custom resolver is not getting called in spring mvc project. It works in spring boot application. I dont know spring boot, is it related to spring boot? – tinker_fairy Feb 06 '20 at 12:12

Custom Spring annotation for request parameters

1 Answers1

Linked