Mapowanie żądań HTTP

Adnotacje mapujące

• @GetMapping
  
  Dawniej, przed Springiem w wersji 4.3 adnotacja występowała tylko pod postacią:
  @RequestMapping(method = RequestMethod.GET)
  
  Obecnie adnotacja ta jest częścią adnotacji @GetMapping, której użycie powoduje że kod jest nieco bardziej przejrzysty (wspominamy o tym nieco szerzej w dalszej części rozdziału).
  
  Adnotacją oznaczamy metodę, która ma przyjąć nasze żądanie GET, np.:

  @GetMapping(value = "/image/{appaItemId}/{imageName:.+}")
  public void getImage(@PathVariable Long appaItemId, 
                          @PathVariable String imageName, ...) throws Exception {
  
      imageLoader.copyImage(imageName, appaItemId, request, response);
  }
  

  Jak widać adnotacja @GetMapping przyjmuje jako parametr value ścieżkę, którą framework dopasowuje do ścieżki (path), na którą zotało wysłane żądanie. Jeśli ścieżki się zgadzają następuje uruchomienie metody i wykonanie jej kodu.
  
  Reasumując, jeśli wysłaliśmy na serwer (na którym działa Spring MVC) żądanie HTTP za pomocą metody HTTP GET oraz zdefiniowaliśmy URL tego żądania, na przykład: "/image/17/obrazek.jpg", to wówczas Spring przechwyci takie żądanie i uruchomi metodę getImage.
  
  Co oznacza adnotacja @PathVariable oraz jak interpretować fragment mapowania ścieżki "/{appaItemId}/{imageName:.+}" ?
  Zainteresowanych odpowiedzią na to pytanie zapraszamy do rozdziału Spring MVC - Metody obsługi żądań HTTP.
• @PostMapping
  
  Dawniej: @RequestMapping(method = RequestMethod.POST)
  
  Obecnie adnotacja ta jest częścią adnotacji @PostMapping.
  Adnotacją oznaczamy metodę, która ma przyjąć nasze żądanie POST, np.:

  @PostMapping(value = "/xls")
  public ResponseEntity<Void> importAppaItems(@RequestParam MultipartFile multipartFile)
  		throws Exception {
  
      ...
      return new ResponseEntity<Void>(HttpStatus.OK);
  }
  

  Jak widać adnotacja @PostMapping również przyjmuje jako parametr value ścieżkę, którą framework dopasowuje do ścieżki (path), na którą zotało wysłane żądanie. Tak samo jak w przypadku adnotacji @GetMapping jeśli ścieżki się zgadzają następuje uruchomienie metody i wykonanie jej kodu. Podobnie będzie to wyglądać dla pozostałych adnotacji.
  
  O adnotacji @RequestParam piszemy w rozdziale Spring MVC - Metody obsługi żądań HTTP.
• @PutMapping
  
  Dawniej: @RequestMapping(method = RequestMethod.PUT)
  
  Obecnie adnotacja ta jest częścią adnotacji @PutMapping.
  Adnotacją oznaczamy metodę, która ma przyjąć nasze żądanie PUT, np.:

  @PutMapping("/current/roles/{newRoleName}")
  public ResponseEntity<Void> updateCurrentUserRoleName(@PathVariable("newRoleName") ...
  
      ...
      return new ResponseEntity<Void>(HttpStatus.OK);
  }
  

• @DeleteMapping
  
  Dawniej: @RequestMapping(method = RequestMethod.DELETE)
  
  Obecnie adnotacja ta jest częścią adnotacji @DeleteMapping.
  Adnotacją oznaczamy metodę, która ma przyjąć nasze żądanie DELETE, np.:

  @DeleteMapping("/{appaItemId}")
  public ResponseEntity<Void> delete(@PathVariable Long appaItemId) throws Exception {
  
      appaItemService.deleteAppaItem(appaItemId);
      
      return ResponseEntity.noContent().build();
  }
  

• @PatchMapping
  
  Dawniej: @RequestMapping(method = RequestMethod.PATCH)
  
  Obecnie adnotacja ta jest częścią adnotacji @PatchMapping.
  Adnotacją oznaczamy metodę, która ma przyjąć nasze żądanie PATCH, np.:

  @PatchMapping("/{id}")
  public ResponseEntity<Void> updatePart(@RequestBody User userPart, @PathVariable("id") Long id) {
  
      ...
      
      return new ResponseEntity<Void>(HttpStatus.OK);
  }
  

  
  
  O adnotacji @RequestBody piszemy w rozdziale Spring MVC - Metody obsługi żądań HTTP.

Składanie ścieżek

@RestController
@RequestMapping("/api/appaform/appaimages")
public class ImageController {

    ...
    
    @GetMapping(value = "/image/{appaItemId}/{imageName:.+}")
    public void getImage(@PathVariable Long appaItemId, 
                            @PathVariable String imageName, ...) throws Exception {
    
    	imageLoader.copyImage(imageName, appaItemId, request, response);
    }
}

Metoda HEAD