<div dir="ltr" style="text-align: justify;">
<div dir="ltr" style="text-align: justify;">
<div dir="ltr" style="text-align: justify;">
<div class="separator" style="clear: both; text-align: center;"><img src="https://dineshonjava.com/wp-content/uploads/2016/03/spring-requestmapping-requestparam-pathvariable-example.jpg" border="0" /></div>
<p>In this article, we are going discuss about one of the main annotation in Spring MVC @RequestMapping – used to mapping a web request to Spring Controller&#8217;s handler methods.</p>
<p>All incoming requests are handled by the Dispatcher Servlet and it route them through Spring. When it receives a web request, it determines which controllers should handle the incoming request.</p>
<p>Dispatcher Servlet initially scans all the classes that are annotated with the @Controller annotation. The dispatching process depends on the various @RequestMapping annotations declared in a controller class and its handler methods.</p>
<div id="ads-id" align="center"></div>
<p>There are three levels of request mapping in Spring MVC</p>
<ul>
<li><b>@RequestMapping annotations at only method level</b></li>
<li><b>@RequestMapping annotations at class level</b></li>
<li><b>Mapping requests by request type</b></li>
</ul>
<h2><b>@RequestMapping</b></h2>
<p>It can be applied to the controller class as well as methods. This annotation for mapping web requests onto specific handler classes and/or handler methods.</p>
<div class="separator" style="clear: both; text-align: center;"><img src="https://dineshonjava.com/wp-content/uploads/2016/03/spring-mvc-request-mapping-annotation.jpg" border="0" /></div>
<p><b><i>@ImageSource-SlideShare.net</i></b><br />
<b></b></p>
<h2><b>@RequestMapping annotations at only method level</b></h2>
<p>In this case we are using @RequestMapping annotations is to declare the handler methods directly. The handler method is annotated with @RequestMapping annotation containing a URL pattern. If this pattern of a handler @RequestMapping annotation matches the request URL, DispatcherServlet it dispatches the request to this handler for it to process the request.<br />
<b></b></p>
<h3><b>1. @RequestMapping Basics</b></h3>
<p>Let’s discuss with a simple example – mapping an HTTP request to a method using some straightforward criteria.</p>
<h3><b>1.1 @RequestMapping – by Path</b></h3>
<pre class="highlight">@RequestMapping(value = "/doj/spring") 
 @ResponseBody 
 public String getDOJSpringCourse(){ 
 return "Get DOJ Course for Spring"; 
 } 
</pre>
<div style="background-color: #f2f9fc; border: 1px solid #c9e6f2; border-radius: 3px; padding: 16px; line-height: 1.45;"><span style="color: red; font-size: x-large; text-align: center;"><b>Popular Tutorials</b></span></p>
<ul style="text-align: left;">
<li><b><a href="https://dineshonjava.com/spring-tutorial/"><em><strong>Spring Tutorial</strong> </em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-web-mvc-framework-chapter-38/"><strong><em>Spring MVC Web Tutorial </em></strong></a></b></li>
<li><b><a href="https://dineshonjava.com/introduction-to-spring-boot-a-spring-boot-complete-guide/"><strong>Spring Boot Tutorial</strong> </a></b></li>
<li><b><a href="https://dineshonjava.com/spring-security-take-baby-step-to-secure/"><em>Spring Security Tutorial</em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-aop-tutorial-with-example-aspect-advice-pointcut-joinpoint/"><em>Spring AOP Tutorial</em></a></b></li>
<li><b><a href="https://dineshonjava.com/using-spring-jdbc-framework-chapter-32/"><em>Spring JDBC Tutorial</em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-hateoas-hypermedia-driven-restful-web-service/"><em><strong>Spring HATEOAS </strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/microservices-with-spring-boot/"><em><strong>Microservices with Spring Boot</strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/jax-rs-web-service-tutorial/"><strong><em>REST Webservice</em> </strong></a></b></li>
<li><b><a href="https://dineshonjava.com/core-java-baby-step-to-be-best-java-ian/"><em><strong>Core Java </strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/hibernate-3-on-baby-steps/"><em><strong>Hibernate Tutorial</strong></em></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-batch-process-with-example/"><strong><em>Spring Batch</em> </strong></a></b></li>
</ul>
</div>
<p>For testing hit following URL on browser:</p>
<p><b><i>GET http://localhost:8080/SpringApp/doj/spring</i></b></p>
<p><i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: text/html</i><br />
<i>Content-Length: 25</i><br />
<i>Date: Fri, 18 Mar 2016 10:38:14 GMT</i><br />
<i><br />
</i> <i>Get DOJ Course for Spring</i></p>
<h3><b>1.2 @RequestMapping – the HTTP Method</b></h3>
<p>There is no by default HTTP method mapped by a @RequestMapping – so it maps to any type of HTTP request; we sh to add the method :</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", method = RequestMethod.POST) 
 @ResponseBody 
 public String postDOJSpringCourse(){ 
 return "Post DOJ Course for Spring"; 
 } 
</pre>
<p><b><i>POST http://localhost:8080/SpringApp/doj/spring</i></b><br />
<i>Content-Type: application/json</i><br />
<i><br />
</i> <i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: text/html</i><br />
<i>Content-Length: 26</i><br />
<i>Date: Fri, 18 Mar 2016 10:38:22 GMT</i><br />
<i><br />
</i> <i>Post DOJ Course for Spring</i></p>
<h3><b>2. RequestMapping with HTTP Headers</b></h3>
<h3><b>2.1. @RequestMapping with the headers attribute</b></h3>
<p>The mapping can be narrowed even further by specifying a header for the request:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", headers = "key=val") 
 @ResponseBody 
 public String getDOJSpringCourseWithHeaders(){ 
 return "Get DOJ Course for Spring with headers"; 
 } 
</pre>
<p>And even multiple headers via the header attribute of @RequestMapping:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", headers = {"key1=val1", "key2=val2"}) 
 @ResponseBody 
 public String getDOJSpringCourseWithHeaders(){ 
 return "Get DOJ Course for Spring with headers"; 
 } 
</pre>
<h3><b>2.2. @RequestMapping Consumes and Produces</b></h3>
<p>Mapping media types produced by a controller method is worth special attention – we can map a request based on its Accept header via the @RequestMapping headers attribute introduced above:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", headers = "Accept=application/json") 
 @ResponseBody 
 public String getDOJSpringCourseJSON(){ 
 return "Get DOJ Course for Spring as JSON"; 
 } 
</pre>
<p><b><i>GET http://localhost:8080/SpringApp/doj/spring</i></b><br />
<i>key: value</i><br />
<i><br />
</i> <i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: application/json</i><br />
<i>Content-Length: 33</i><br />
<i>Date: Fri, 18 Mar 2016 10:57:03 GMT</i><br />
<i><br />
</i> <i>Get DOJ Course for Spring as JSON</i></p>
<p>@RequestMapping annotation now has a produces and a consumes attributes, specifically for this purpose:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", method = RequestMethod.GET, produces = "application/json") 
 @ResponseBody 
 public String getDOJSpringCourseJSONFromREST(){ 
 return "Get DOJ Course for Spring as JSON from REST"; 
 } 
</pre>
<p><b><i>GET http://localhost:8080/SpringApp/doj/spring</i></b><br />
<i>key: value</i><br />
<i><br />
</i> <i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: application/json</i><br />
<i>Content-Length: 43</i><br />
<i>Date: Fri, 18 Mar 2016 11:00:28 GMT</i><br />
<i><br />
</i> <i>Get DOJ Course for Spring as JSON from REST</i></p>
<p>Additionally, produces support multiple values as well:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", produces = { "application/json", "application/xml" }) 
</pre>
<p>A final note on the new produces and consumes mechanism – these behave differently from most other annotations: when specified at type level, the method level annotations do not complement but override the type level information.</p>
<h2><b>3. RequestMapping with Path Variables</b></h2>
<p>Parts of the mapping URI can be bound to variables via the @PathVariable annotation.</p>
<h3><b>3.1. Single @PathVariable</b></h3>
</div>
<p> ;</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring/{id}") 
 @ResponseBody 
 public String getDOJCourseWithPathVariable(@PathVariable("id") int id) { 
 return "Get a DOJ Course with id=" + id; 
 } 
</pre>
<p><i><b>GET http://localhost:8080/SpringApp/doj/spring/2000</b></i><br />
<i><br />
</i> <i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: text/html</i><br />
<i>Content-Length: 29</i><br />
<i>Date: Fri, 18 Mar 2016 11:11:40 GMT</i><br />
<i><br />
</i> <i>Get a DOJ Course with id=2000</i></p>
<p>If the name of the method argument matches the name of the path variable exactly, then this can be simplified by using @PathVariable with no value:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring/{id}") 
 @ResponseBody 
 public String getDOJCourseWithPathVariable(@PathVariable int id) { 
 return "Get a DOJ Course with id=" + id; 
 } 
</pre>
<h3><b>3.2. Multiple @PathVariable</b></h3>
<p>More complex URI may need to map multiple parts of the URI to multiple values:</p>
<pre class="highlight">@RequestMapping(value = "/doj/{course}/{id}") 
 @ResponseBody 
 public String getDOJCourseWithPathVariable(@PathVariable("course") String course ,@PathVariable("id") long id) { 
 return "Get a DOJ Course with id=" + id+" course name ="+course; 
 } 
</pre>
<p><i><b>GET http://localhost:8080/SpringApp/doj/spring/2000</b></i><br />
<i><br />
</i> <i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: text/html</i><br />
<i>Content-Length: 49</i><br />
<i>Date: Fri, 18 Mar 2016 11:16:19 GMT</i><br />
<i><br />
</i> <i>Get a DOJ Course with id=2000 course name =spring</i></p>
<h3><b>3.3. @PathVariable with RegEx</b></h3>
<p>Regular expressions can also be used when mapping the @PathVariable; for example, we will restrict the mapping to only accept numerical values for the id:</p>
<pre class="highlight">@RequestMapping(value = "/doj/{course}/{numericId:[d]+") 
 @ResponseBody 
 public String getDOJCourseWithPathVariable(@PathVariable("course") String course ,@PathVariable("id") long id) { 
 return "Get a DOJ Course with id=" + id+" course name ="+course; 
 } 
</pre>
<p>This will mean that the following URIs will match:<br />
<b><i>http://localhost:8080/SpringApp/doj/spring/2000</i></b></p>
<p>But this will not:<br />
<b><i>http://localhost:8080/SpringApp/doj/spring/xyz</i></b></p>
<h2><b>4. RequestMapping with Request Parameters</b></h2>
<p>@RequestMapping allows easy mapping of URL parameters with the @RequestParam annotation.</p>
<p>We are now mapping a request to an URI such as:</p>
</div>
<p> ;</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring") 
 @ResponseBody 
 public String getDOJCourseByRequestParam(@RequestParam("id") long id) { 
 return "Get a DOJ Course with id=" + id; 
 } 
</pre>
<p>We are then extracting the value of the id parameter using the @RequestParam(“id”) annotation in the controller method signature.</p>
<p><b><i>GET http://localhost:8080/SpringApp/doj/spring?id=2000</i></b></p>
<p><i>&#8212; response &#8212;</i><br />
<i>200 OK</i><br />
<i>Server: Apache-Coyote/1.1</i><br />
<i>Content-Type: text/html</i><br />
<i>Content-Length: 29</i><br />
<i>Date: Fri, 18 Mar 2016 11:29:25 GMT</i><br />
<i><br />
</i> <i>Get a DOJ Course with id=2000</i></p>
<p>@RequestMapping can optionally define the parameters – as yet another way of narrowing the request mapping:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", params = "id") 
 @ResponseBody 
 public String getDOJCourseByRequestParam(@RequestParam("id") long id) { 
 return "Get a DOJ Course with id=" + id; 
 } 
</pre>
<p>Even more flexible mappings are allowed – multiple params values can be defined, and not all of them have to be used:</p>
<pre class="highlight">@RequestMapping(value = "/doj/spring", params = {"id","course"}) 
 @ResponseBody 
 public String getDOJCourseByRequestParam(@RequestParam("id") long id, @RequestParam("course") String course) { 
 return "Get a DOJ Course with id=" + id+" Course="+course; 
 } 
</pre>
<h2><b>5. RequestMapping Corner Cases</b></h2>
<h3><b>5.1. @RequestMapping – multiple paths mapped to the same controller method</b></h3>
<p>Although a single @RequestMapping path value is usually used for a single controller method, this is just good practice, not a hard and fast rule – there are some cases where mapping multiple requests to the same method may be necessary. For that case, the value attribute of @RequestMapping does accept multiple mappings, not just a single one:</p>
<pre class="highlight">@RequestMapping(value = {"/doj/spring/index", "/doj/spring/home"}) 
 @ResponseBody 
 public String getDOJHome() { 
 return "Get a DOJ Home Page"; 
 } 
</pre>
<h3><b>5.2. @RequestMapping – multiple HTTP request methods to the same controller method</b></h3>
<p>Multiple requests using different HTTP verbs can be mapped to the same controller method:</p>
<pre class="highlight">@RequestMapping(value = {"/doj/spring/home"}, method = {RequestMethod.GET, RequestMethod.POST}) 
 @ResponseBody 
 public String getDOJHome() { 
 return "Get a DOJ Home Page"; 
 } 
</pre>
<h3><b>5.3. @RequestMapping – a fallback for all requests</b></h3>
<p>To implement a simple fallback for all requests using a specific HTTP method:</p>
<pre class="highlight">@RequestMapping(value = {"*"}) 
 @ResponseBody 
 public String getDOJDefaultPage() { 
 return "Get a DOJ Default Page"; 
 } 
</pre>
<h2><b>@RequestMapping annotations at class level</b></h2>
<p>In this case we are using @RequestMapping annotations at the class level. It is used for filter all incoming request at class level first before forwarding to handler methods. If the incoming request matches the pattern defined in controller class, then it search the controller methods mappings.</p>
<pre class="highlight">@Controller 
@RequestMapping("/login/") 
public class Login{ 
 
 @RequestMapping("doLogin") 
 public ModelAndView doLogin( 
 @RequestParam(value = "username") String username, 
 @RequestParam(value = "password") String password) { 
 //.... 
 //.... 
 return null; 
 } 
 
 @RequestMapping(value={"logout","signout"}) 
 public ModelAndView logout( 
 @RequestParam(value = "username") String username) { 
 //.... 
 //.... 
 
 return null; 
 } 
} 
</pre>
<h2><b>Conclusion</b></h2>
<p>This article focus on the @RequestMapping annotation in Spring – discussing a simple usecase, the mapping of HTTP headers, binding parts of the URI with @PathVariable and working with URI parameters and the @RequestParam annotation.</p>
<div style="background-color: #f2f9fc; border: 1px solid #c9e6f2; border-radius: 3px; padding: 16px; line-height: 1.45;"><span style="color: red; font-size: x-large; text-align: center;"><b>Spring MVC Related Posts</b></span></p>
<ul>
<li><b><a href="https://dineshonjava.com/spring-web-mvc-framework-chapter-38/"><span style="color: red;">Spring MVC Web Tutorial</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-mvc-interview-questions-and-answers/"><span style="color: red;">Spring MVC Interview Questions</span></a></b></li>
<li><b><a href="https://dineshonjava.com/introduction-to-mvc/"><span style="color: red;">MVC Design Pattern</span></a></b></li>
<li><b><a href="https://dineshonjava.com/what-is-dispatcherservlet-in-spring-and-its-uses/"><span style="color: red;">Spring MVC DispatcherServlet </span></a></b></li>
<li><b><a href="https://dineshonjava.com/difference-between-applicationcontext-webapplicationcontext-in-spring-mvc/"><span style="color: red;">Spring MVC WebApplicationContext and Root Application Context</span></a></b></li>
<li><b><a href="https://dineshonjava.com/stereotype-annotations-in-spring/"><span style="color: red;">Spring MVC @Controller Annotation</span></a></b></li>
<li><b><a href="https://dineshonjava.com/requestmapping-annotation-in-spring-mvc/"><span style="color: red;">Spring MVC @RequestMapping Annotation</span></a></b></li>
<li><b><a href="https://dineshonjava.com/requestparam-annotation-in-spring-mvc-with-example/"><span style="color: red;">Spring MVC @RequestParam Annotation</span></a></b></li>
<li><b><a href="https://dineshonjava.com/difference-between-applicationcontext-webapplicationcontext-in-spring-mvc/"><span style="color: red;">Spring MVC ContextLoaderListener</span></a></b></li>
<li><b><a href="https://dineshonjava.com/requestparam-vs-pathvariable-annotations-in-spring-mvc/"><span style="color: red;">Spring MVC @RequestParam and @PathVariable annotations</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-30-mvc-hello-world-example/"><span style="color: red;">Spring MVC Hello World Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-exception-handling-example/"><span style="color: red;">Spring MVC Exception Handling Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-mvc-with-hibernate-crud-example/"><span style="color: red;">Spring MVC with Hibernate CRUD Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-3-mvc-tiles-plugin-with-example/"><span style="color: red;">Spring MVC Tiles Plugin with Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-3-mvc-and-interceptor-with/"><span style="color: red;">Spring MVC Interceptor with example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/integration-spring-mvc3-and-mongodb/"><span style="color: red;">Spring MVC with MongoDB CRUD Example</span></a></b></li>
<li><b><a href="https://dineshonjava.com/spring-3-mvc-internationalization/"><span style="color: red;">Spring MVC Internationalization &; Localization with Example</span></a></b></li>
</ul>
<p> ;</p>
</div>
</div>
<div class="wp-post-navigation"> 
									 <div class="wp-post-navigation-pre"> 
									 <a href="https://dineshonjava.com/spring-mvc-exception-handling-example-and-return-custom-404-error-pages/">Previous</a> 
									 </div> 
									 <div class="wp-post-navigation-next"> 
									 <a href="https://dineshonjava.com/exception-handling-for-rest-with-spring-using-exceptionhandler-and-controlleradvice-annotation/">Next</a> 
									 </div> 
									</div>
<script type="text/javascript">
jQuery(document).ready(function($) {
 $.post('https://dineshonjava.com/wp-admin/admin-ajax.php', {action: 'mts_view_count', id: '152'});
});
</script>
Strategy Design Patterns We can easily create a strategy design pattern using lambda. To implement…
Decorator Pattern A decorator pattern allows a user to add new functionality to an existing…
Delegating pattern In software engineering, the delegation pattern is an object-oriented design pattern that allows…
Technology has emerged a lot in the last decade, and now we have artificial intelligence;…
Managing a database is becoming increasingly complex now due to the vast amount of data…
Overview In this article, we will explore Spring Scheduler how we could use it by…