Spring programmatically register RequestMapping

Question

I have a working url as this: localhost/info

@Controller
@RequestMapping("/info")
public class VersionController {

   @RequestMapping(value = "", method = RequestMethod.GET)
   public @ResponseBody
   Map get() {
      loadProperties();
      Map<String, String> m = new HashMap<String, String>();
      m.put("buildTimestamp", properties.getProperty("Application-Build-Timestamp"));
      m.put("version", properties.getProperty("Application-Version"));
      return m;
   }

}

and I would to register some other mappings at initializing of my application as this:

localhost/xxxx/info
localhost/yyyy/info
localhost/zzzz/info

All these urls will return same response as localhost/info

The xxxx, yyyy part of the application is changeable. I have to register custom mappings as

@Override
public void addViewControllers(ViewControllerRegistry registry) {
    registry.addViewController("???").setViewName("???");
}

Bu this is only working for views.

Any idea for dynamic registration?

Is there a reason you can't use URLs of the form /affId/1313/info? — parsifal
– parsifal, Commented Mar 19, 2013 at 13:22
Yes because it was completely fictional. Actually the changing part is not id part. :( — Cemo
– Cemo, Commented Mar 19, 2013 at 13:28
describing a situation that bears no relationship to your actual problem doesn't help you, and wastes the time of anyone who tries to help you. — parsifal
– parsifal, Commented Mar 19, 2013 at 14:42
And if your current example isn't as completely fictional as your earlier example, @NilsH has given you a workable answer that should require less effort than registering a new HandlerMapping. — parsifal
– parsifal, Commented Mar 19, 2013 at 14:43
Actually I just wanted to learn programmatically registering beans as Costi Ciudatu has resolved perfectly. Anyway, thanks for your efforts. — Cemo
– Cemo, Commented Mar 19, 2013 at 15:35

Przemek Nowak · Accepted Answer · 2019-02-13 19:43:48Z

I believe that simple example is worth more than 1000 words :) In SpringBoot it will look like...

Define your controller (example health endpoint):

public class HealthController extends AbstractController {

    @Override
    protected ModelAndView handleRequestInternal(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response) {
        return new ModelAndView(new MappingJacksonSingleView(), "health", Health.up().build());
    }

}

And create your configuration:

@Configuration
public class CustomHealthConfig {

    @Bean
    public HealthController healthController() {
        return new HealthController();
    }

    @Bean
    public SimpleUrlHandlerMapping simpleUrlHandlerMapping() {
        SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
        mapping.setOrder(Integer.MAX_VALUE - 2);
        mapping.setUrlMap(ImmutableMap.of("/health", healthController()));
        return mapping;
    }

}

Regarding the handler order - take a look about the reason here: Java configuration of SimpleUrlHandlerMapping (Spring boot)

The MappingJacksonSingleView is auxiliary class in order to return single json value for model and view:

public class MappingJacksonSingleView extends MappingJackson2JsonView {

    @Override
    @SuppressWarnings("unchecked")
    protected Object filterModel(Map<String, Object> model) {
        Object result = super.filterModel(model);
        if (!(result instanceof Map)) {
            return result;
        }

        Map map = (Map) result;
        if (map.size() == 1) {
            return map.values().toArray()[0];
        }
        return map;
    }

}

Jackson single view source - this blog post: https://www.pascaldimassimo.com/2010/04/13/how-to-return-a-single-json-list-out-of-mappingjacksonjsonview/

Hope it helps!

Costi Ciudatu · Accepted Answer · 2013-03-19 13:26:57Z

4

You can register a new HandlerMapping where you can add the handlers for your URL paths; the most convenient implementation would be SimpleUrlHandlerMapping.

If you want those handlers to be bean methods (like those annotated with @RequestMapping) you should define them as HandlerMethod wrappers so that the already registered RequestMappingHandlerAdapter will invoke them.

answered Mar 19, 2013 at 13:26

Costi Ciudatu

38.5k7 gold badges58 silver badges95 bronze badges

4 Comments

Simon Forsberg Over a year ago

How to use SimpleUrlHandlerMapping? How to define them as HandlerMethod wrappers? A little example would make this answer much better.

Réda Housni Alaoui Over a year ago

Be careful when you register your own Handler mapping. By default, the new handler ignores all HandlerInterceptor instances.

Torben Oct 25 at 11:10

When you say "by default" do you mean that there is a switch with which the interceptors can be enabled?

Réda Housni Alaoui Oct 26 at 13:34

No, it’s not just a « switch ». You have to replug them manually and there is no automated/easy way to do it.

geoand · Accepted Answer · 2016-09-26 14:17:45Z

4

As of Spring 5.0.M2, Spring provides a functional web framework that allows you to create "controller"-like constructs programmatically.

What you would need to do in your case is create a proper RouterFunction for the URLs you need to handle, and then simply handle the request with the appropriate HandlerFunction.

Keep in mind however that these constructs are not part of Spring MVC, but part of Spring Reactive.

Check out this blog post for more details

answered Sep 26, 2016 at 14:17

geoand

64.8k24 gold badges185 silver badges201 bronze badges

2 Comments

Katona Over a year ago

Is there any way to use HandlerMethodArgumentResolvers somehow with functional endpoints?

geoand Over a year ago

Not that I am aware of

Václav Kužel · Accepted Answer · 2020-05-10 09:53:06Z

3

It is possible (now) to register request mapping by RequestMappingHandlerMapping.registerMapping() method.

Example:

@Autowired
RequestMappingHandlerMapping requestMappingHandlerMapping;

public void register(MyController myController) throws Exception {
    RequestMappingInfo mappingInfo = RequestMappingInfo.paths("xxxx/info").methods(RequestMethod.GET).build();
    Method method = myController.getClass().getMethod("info");
    requestMappingHandlerMapping.registerMapping(mappingInfo, myController, method);
}

answered May 10, 2020 at 9:53

Václav Kužel

1,15914 silver badges19 bronze badges

2 Comments

Umpa Over a year ago

can you explain it please?

Václav Kužel Over a year ago

Check out the documentation for the mentioned method for more details. Example I've posted just maps URL to an halndling method, nothing more. docs.spring.io/spring-framework/docs/current/javadoc-api/org/…

Yannick Block · Accepted Answer · 2016-01-05 16:38:22Z

0

You could register your own HandlerMapping by extending the RequestMappingHandlerMapping, e.g. override the registerHandlerMethod.

answered Jan 5, 2016 at 16:38

Yannick Block

513 bronze badges

Comments

NilsH · Accepted Answer · 2013-03-19 13:28:45Z

-5

It's not quite clear what you're trying to achieve, but maybe you can use @PathVariable in your @RequestMapping, something like:

@RequestMapping("/affId/{id}")
public void myMethod(@PathVariable("id") String id) {}

Edit: Original example has changed it appears, but you might be able to use PathVariable anyway.

answered Mar 19, 2013 at 13:28

NilsH

13.9k4 gold badges43 silver badges59 bronze badges

Collectives™ on Stack Overflow

Spring programmatically register RequestMapping

6 Answers 6

Comments

4 Comments

2 Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

Comments

4 Comments

2 Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related