Руководство по аннотациям Spring Framework

В этом примере, как  getExample() и  getNote() методы будут иметь MaxAge 3600 секунд. Кроме того,   getExample() будут разрешены только запросы о происхождении с сайта http://example.com, а  getNote()  запросы всех источников — со всех узлов.

Составленные варианты @RequestMapping

Spring Framework 4.3 представил следующие варианты @RequestMapping аннотаций на уровне методов,  чтобы лучше выразить семантику аннотированных методов. Использование этих аннотаций стало стандартным способом определения конечных точек. Они действуют как обертки для  @RequestMapping.

Эти аннотации могут использоваться с Spring MVC и Spring WebFlux.

@GetMapping

Эта аннотация используется для отображения запросов HTTP GET на определенные методы-обработчики. @GetMapping это составная аннотация, которая действует как ярлык для   @RequestMapping(method = RequestMethod.GET).

@PostMapping

Эта аннотация используется для отображения запросов HTTP POST на определенные методы-обработчики. @PostMapping это составная аннотация, которая действует как ярлык для   @RequestMapping(method = RequestMethod.POST).

@PutMapping

Эта аннотация используется для отображения запросов HTTP PUT на определенные методы-обработчики. @PutMapping это составная аннотация, которая действует как ярлык для   @RequestMapping(method = RequestMethod.PUT).

@PatchMapping

Эта аннотация используется для отображения запросов HTTP PATCH на определенные методы-обработчики. @PatchMapping это составная аннотация, которая действует как ярлык для   @RequestMapping(method = RequestMethod.PATCH).

@DeleteMapping

Эта аннотация используется для отображения запросов HTTP DELETE на определенные методы-обработчики. @DeleteMapping это составная аннотация, которая действует как ярлык для   @RequestMapping(method = RequestMethod.DELETE).

@ExceptionHandler

Эта аннотация используется на уровнях метода для обработки исключений на уровне контроллера. @ExceptionHandler Аннотаций используется для определения класса исключения он будет ловить. Вы можете использовать эту аннотацию для методов, которые должны вызываться для обработки исключения. Эти  @ExceptionHandler значения могут быть установлены в массив типов исключений. Если выдается исключение, которое соответствует одному из типов в списке, то @ExceptionHandler будет вызван метод, аннотированный с сопоставлением  .

@InitBinder

Эта аннотация является аннотацией уровня метода, которая играет роль идентификации методов, которые инициализируют -a  WebDataBinder ,  DataBinder который связывает параметр запроса с объектами JavaBean. Чтобы настроить привязку данных параметров запроса, вы можете использовать  @InitBinder аннотированные методы в нашем контроллере. Методы, отмеченные как,  @InitBinder включают все типы аргументов, которые поддерживаются методами-обработчиками.

В  @InitBinder аннотированные методы будут вызываться для каждого запроса HTTP , если не указать значение элемента этой аннотации. Элементом value может быть одно или несколько имен форм или параметров запроса, к которым применяется метод привязки init.

@Mappings и @Mapping

Эта аннотация используется на полях. @Mapping Аннотаций является мета-аннотаций , что указывает на веб — отображение аннотацию. При отображении разных имен полей необходимо настроить исходное поле на его целевое поле, и для этого необходимо добавить  @Mappings аннотацию. Эта аннотация принимает массив  @Mapping с исходными и целевыми полями.

@MatrixVariable

Эта аннотация используется для аннотирования аргументов метода обработчика запросов, чтобы Spring мог внедрить соответствующие биты матричного URI. Матричные переменные могут появляться в любом сегменте, каждый из которых разделен точкой с запятой. Если URL-адрес содержит матричные переменные, шаблон отображения запроса должен представлять их с помощью шаблона URI. @MatrixVariable Аннотацию гарантирует , что запрос соответствует с правильным матричным переменной URI.

@PathVariable

Эта аннотация используется для аннотирования аргументов метода обработчика запроса. @RequestMapping Аннотации могут быть использованы для обработки динамических изменений в URI , где определенное значение URI , действует в качестве параметра. Вы можете указать этот параметр с помощью регулярного выражения. @PathVariable Аннотации могут быть использованы для объявления этого параметра.

@RequestAttribute

Эта аннотация используется для привязки атрибута запроса к параметру метода обработчика. Spring получает значение именованного атрибута, чтобы заполнить параметр, отмеченный @RequestAttribute. Хотя  @RequestParamannotation используется для связывания значений параметров из строки запроса,  @RequestAttribute  используется для доступа к объектам, которые были заполнены на стороне сервера.

@RequestBody

Эта аннотация используется для аннотирования аргументов метода обработчика запроса. @RequestBody Аннотации указывает на то, что параметр метод должен быть связан с величиной тела запроса HTTP. HttpMessageConveter Отвечает за преобразование из сообщения запроса HTTP на объект.

@RequestHeader

Эта аннотация используется для аннотирования аргументов метода обработчика запроса. @RequestHeader Аннотаций используется для отображения параметра контроллера к значению заголовка запроса. Когда Spring отображает запрос,  @RequestHeader проверяет заголовок с именем, указанным в аннотации, и связывает его значение с параметром метода-обработчика. Эта аннотация поможет вам получить подробности заголовка в классе контроллера.

@RequestParam

Эта аннотация используется для аннотирования аргументов метода обработчика запроса. Иногда вы получаете параметры в URL запроса, в основном в запросах GET. В этом случае, наряду с  @RequestMapping аннотацией, вы можете использовать  @RequestParam аннотацию, чтобы получить параметр URL и сопоставить его с аргументом метода. @RequestParam Аннотаций используется для связывания параметров запроса с параметром метода в контроллере.

@RequestPart

Эта аннотация используется для аннотирования аргументов метода обработчика запроса. @RequestPart Аннотаций может быть использован вместо  того @RequestParam чтобы получить содержание конкретного многоголосных и привязать его к аргументу методы аннотации   @RequestPart. Эта аннотация учитывает заголовок «Content-Type» в составной части (часть запроса).

@ResponseBody

Эта аннотация используется для аннотирования методов обработчика запросов. @ResponseBody Аннотация похожа на  @RequestBody аннотацию. @ResponseBody Аннотацию указывает на то, что тип результата должен быть записан прямо в теле ответа в любом формате , вы указываете , как JSON или XML. Spring преобразует возвращаемый объект в тело ответа, используя  HttpMessageConveter.

@ResponseStatus

Эта аннотация используется для методов и классов исключений. @ResponseStatus помечает метод или класс исключений кодом состояния и причиной, которая должна быть возвращена. Когда вызывается метод-обработчик, для кода состояния устанавливается HTTP-ответ, который переопределяет информацию о состоянии, предоставленную любыми другими средствами. Класс контроллера также может быть аннотирован   @ResponseStatus, который затем наследуется всеми  @RequestMapping методами.

@ControllerAdvice

Эта аннотация применяется на уровне класса. Как объяснялось ранее, для каждого контроллера вы можете использовать  @ExceptionHandler метод, который будет вызываться при возникновении данного исключения. Но это обрабатывает только те исключения, которые происходят в контроллере, в котором он определен. Чтобы преодолеть эту проблему, теперь вы можете использовать  @ControllerAdvice аннотацию. Это примечание используется для определения @ExceptionHandler, @InitBinderи  @ModelAttribute методы , которые применяются ко всем  @RequestMapping методам. Таким образом, если вы определите  @ExceptionHandler аннотацию для метода в   @ControllerAdvice классе, она будет применена ко всем контроллерам.

@RestController

Эта аннотация используется на уровне класса. В  @RestController аннотации класс исполняется в качестве контроллера , где каждый метод возвращает объект домена вместо зрения. Аннотируя класс этой аннотацией, вам больше не нужно добавлять  @ResponseBody все  RequestMapping методы. Это означает, что вы больше не используете средства разрешения представления или не отправляете HTML в ответ. Вы просто отправляете объект домена в виде HTTP-ответа в формате, понятном потребителям, например JSON.

 @RestController  это удобная аннотация, которая сочетает в себе  @Controller и   @ResponseBody.

@RestControllerAdvice

Эта аннотация применяется к классам Java. @RestControllerAdvice это удобная аннотация, которая сочетает в себе  @ControllerAdvice и @ResponseBody. Эта аннотация используется вместе с  @ExceptionHandler аннотацией для обработки исключений, возникающих в контроллере.

@SessionAttribute

Эта аннотация используется на уровне параметров метода. @SessionAttribute Аннотаций используется для связывания параметра метода в атрибут сеанса. Эта аннотация обеспечивает удобный доступ к существующим или постоянным атрибутам сеанса.

@SessionAttributes

Эта аннотация применяется на уровне типа для определенного обработчика. @SessionAtrributes Аннотаций используется , когда вы хотите добавить JavaBean объекта в сессию. Это используется, когда вы хотите сохранить объект в сеансе на короткое время. @SessionAttributes используется в сочетании с @ModelAttribute.

Рассмотрим этот пример:

@ModelAttribute("person")
public Person getPerson() {}
// within the same controller as above snippet
@Controller
@SeesionAttributes(value = "person", types = {
    Person.class
})
public class PersonController {}

@Service
public class BookService {
    private final RestTemplate restTemplate;
    public BookService(RestTemplate rest) {
        this.restTemplate = rest;
    }
    @HystrixCommand(fallbackMethod = "newList") public String bookList() {
        URI uri = URI.create("http://localhost:8081/recommended");
        return this.restTemplate.getForObject(uri, String.class);
    }
    public String newList() {
        return "Cloud native Java";
    }
}

@Cacheable("addresses")
public String getAddress(Book book){...}

@CachePut("addresses")
public String getAddress(Book book){...}

@CacheEvict(value="addresses", allEntries="true")
public String getAddress(Book book){...}

@Scheduled(fixedDelay=5000)
public void doSomething() {
    // something that should execute periodically   
}

@Scheduled(fixedRate=5000)
public void doSomething() { 
    // something that should execute periodically 
}

@Scheduled(initialDelay=1000,fixedRate=5000)
public void doSomething() { 
   // something that should execute periodically after an initial delay  
}

@ContextConfiguration(locations={"example/test-context.xml", loader = Custom ContextLoader.class})

@Timed(millis=10000)
public void testLongRunningProcess() {  ... }

@Repeat(10)
@Test
public void testProcessRepeatedly() {  ... }