Spring MVC @ModelAttribute Аннотация с примером

Опубликовано: 5 Октября, 2022

В Spring MVC аннотация @ModelAttribute привязывает параметр метода или возвращаемое значение метода к именованному атрибуту модели, а затем предоставляет его веб-представлению. Он относится к свойству объекта Model.

Например, если у нас есть форма с объектом поддержки формы, который называется «Студент», мы можем сделать так, чтобы Spring MVC передал этот объект методу контроллера с помощью аннотации @ModelAttribute:

@RequestMapping("/home")
public String showHomePage(@ModelAttribute("studentInfo") StudentInfoDTO studentInfoDTO) {
    
        return "something";
        
}

Итак, давайте разберемся со всей концепцией аннотации @ModelAttribute на интересном примере проекта. Перед этим мы рекомендуем вам обратиться к этим статьям, чтобы вам было очень легко понять концепцию аннотации @ModelAttribute на примере проекта.

  • Привязка данных в Spring MVC с примером
  • Двусторонняя привязка данных в Spring MVC с примером

Пример проекта

Мы собираемся использовать Spring Tool Suite 4 IDE для этого проекта. Пожалуйста, обратитесь к этой статье, чтобы установить STS на свой локальный компьютер. Как загрузить и установить среду IDE Spring Tool Suite (Spring Tools 4 для Eclipse)? Перейдите в среду IDE STS, затем создайте новый проект maven, выберите «Файл» > «Создать» > «Проект Maven» и выберите следующий архетип, как показано на изображении ниже, следующим образом:

Добавьте следующие зависимости maven и подключаемый модуль в файл yourpom.xml.

<!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.18</version>
</dependency>

<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
    <scope>provided</scope>
</dependency>

<!-- plugin -->
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-war-plugin</artifactId>
            <version>2.6</version>
            <configuration>
                <failOnMissingWebXml>false</failOnMissingWebXml>
            </configuration>
        </plugin>
    </plugins>
</build>

Ниже приведен полный код файла pom.xml после добавления этих зависимостей.

Файл: pom.xml

XML




<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.geeksforgeeks</groupId>
    <artifactId>simple-calculator</artifactId>
    <packaging>war</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>simple-calculator Maven Webapp</name>
    <url>http://maven.apache.org</url>
    
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>
        
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.3.18</version>
        </dependency>
        
        <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
    
    <build>
        <finalName>simple-calculator</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <version>2.6</version>
                <configuration>
                    <failOnMissingWebXml>false</failOnMissingWebXml>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Настройка диспетчерского сервлета
Прежде чем перейти к части кодирования, давайте посмотрим на структуру файла на изображении ниже.
Итак, сначала создайте папку src/main/java и внутри этой папки создайте класс с именем CalculatorAppIntilizer и поместите его в пакет com.geeksforgeeks.calculator.config и расширите класс AbstractAnnotationConfigDispatcherServletInitializer . Обратитесь к изображению ниже.
И всякий раз, когда вы расширяете этот класс, у него есть некоторые предабстрактные методы, которые нам нужны для реализации. Теперь внутри этого класса нам нужно просто написать две строки кода для настройки сервлета Dispatcher. Перед этим мы должны создать еще один класс для файла конфигурации Spring. Итак, перейдите в папку src/main/java и внутри этой папки создайте класс с именем CalculatorAppConfig и поместите его в пакет com.geeksforgeeks.calculator.config . Ниже приведен код файла CalculatorAppConfig.java .
Файл: CalculatorAppConfig.java
Java



package com.geeksforgeeks.calculator.config;
  
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
  
@Configuration
@ComponentScan(basePackages = "com.geeksforgeeks.calculator.controllers")
public class CalculatorAppConfig {
  
}
Ниже приведен полный код файла CalculatorAppIntilizer.java . Комментарии добавляются внутри кода, чтобы понять код более подробно.
Файл: CalculatorAppIntilizer.java
Java



package com.geeksforgeeks.calculator.config;
  
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
  
public class CalculatorAppIntilizer extends AbstractAnnotationConfigDispatcherServletInitializer {
  
    @Override
    protected Class<?>[] getRootConfigClasses() {
        // TODO Auto-generated method stub
        return null;
    }
  
    // Registering the Spring config file
    @Override
    protected Class<?>[] getServletConfigClasses() {
        Class aClass[] = { CalculatorAppConfig.class };
        return aClass;
    }
  
    // Add mapping url
    @Override
    protected String[] getServletMappings() {
        String arr[] = { "/geeksforgeeks.org/*" };
        return arr;
    }
  
}
Настройка ViewResolver
Spring MVC — это Web MVC Framework для создания веб-приложений. В общем, все фреймворки MVC предоставляют способ работы с представлениями. Spring делает это с помощью ViewResolvers, что позволяет отображать модели в браузере, не привязывая реализацию к конкретной технологии представления. Подробнее читайте здесь: ViewResolver в Spring MVC. Итак, для настройки ViewResolver перейдите в файл CalculatorAppConfig.java и запишите код следующим образом.
@Bean
public InternalResourceViewResolver viewResolver() {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/view/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }
А ниже обновленный код файла CalculatorAppConfig.java после написания кода для настройки ViewResolver.
Файл: Обновленный CalculatorAppConfig.java
Java



package com.geeksforgeeks.calculator.config;
  
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.ViewResolver;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
  
@EnableWebMvc
@Configuration
@ComponentScan(basePackages = "com.geeksforgeeks.calculator.controllers")
public class CalculatorAppConfig {
  
    // setup ViewResolver
    @Bean
    public InternalResourceViewResolver viewResolver() {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/view/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }
  
}
Создать DTO
Перейдите в папку src/main/java и внутри этой папки создайте класс с именем NameInfoDTO и поместите его в пакет com.geeksforgeeks.calculator.dto . Ниже приведен код файла NameInfoDTO.java . Комментарии добавляются внутри кода, чтобы понять код более подробно.
Файл: NameInfoDTO.java
Java



package com.geeksforgeeks.calculator.dto;
  
public class NameInfoDTO {
  
    // Provided some static values
    // inside the variable
    // And we are going to read these values
    private String firstName = "Anshul";
    private String lastName = "Aggarwal";
  
    public String getFirstName() {
        return firstName;
    }
  
    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }
  
    public String getLastName() {
        return lastName;
    }
  
    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
  
    @Override
    public String toString() {
        return "NameInfoDTO [firstName=" + firstName + ", lastName=" + lastName + "]";
    }
  
}
Создать контроллер
Перейдите в папку src/main/java и внутри этой папки создайте класс с именем AppController и поместите его в пакет com.geeksforgeeks.calculator.controllers . Ниже приведен полный код файла AppController.java .
Файл: Файл AppController.java
Java



package com.geeksforgeeks.calculator.controllers;
  
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
  
import com.geeksforgeeks.calculator.dto.NameInfoDTO;
  
@Controller
public class AppController {
  
    @RequestMapping("/home")
    public String showHomePage(Model model) {
          
        // Read the existing property by
        // fetching it from the DTO
        NameInfoDTO nameInfoDTO = new NameInfoDTO();
        model.addAttribute("nameInfo", nameInfoDTO);
          
        return "welcome-page";
    }
  
    @RequestMapping("/process-homepage")
    public String showResultPage(NameInfoDTO nameInfoDTO, Model model) {
  
        // writing the value to the properties
        // by fetching from the URL
        model.addAttribute("nameInfo", nameInfoDTO);
  
        return "result-page";
    }
  
  
}
Создать вид
Теперь нам нужно создать представление с именем « welcome-page » внутри папки WEB-INF/view с расширением .jsp . Итак, перейдите в src > main > webapp > WEB-INF и создайте представление папки, а внутри этой папки создайте файл jsp с именем welcome-page . Итак, ниже приведен код файла welcome-page.jsp .
Файл: welcome-page.jsp
HTML



<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%>
  
<html>
<head>
</head>
<body>
  
    <hr />
  
    <form:form action="process-homepage" method="get" modelAttribute="nameInfo">
  
        <div align="center">
              
<p>
                <label for="name1">Enter First Name : </label>
                <form:input id="name1" path="firstName" />
            </p>
  
              
<p>
                <label for="name2">Enter Last Name : </label> 
                <form:input id="name2" path="lastName" />
            </p>
  
  
            <input type="submit" value="Bind Data" />
  
        </div>
  
    </form:form>
</body>
</html>
Теперь нам нужно создать еще одно представление с именем «страница результатов» для отображения захваченных значений. Итак, ниже приведен код файла result-page.jsp .
Файл: result-page.jsp
HTML



<
            

                            

                    
                                            Java
                                    

                        

                
РЕКОМЕНДУЕМЫЕ СТАТЬИ

                

                                            

                            
JUnit — написание примеров тестовых случаев для StudentService на Java

                            
24 Февраля, 2023

                        

                                            

                            
Как сканировать все файлы MP3 в данном каталоге с помощью Java?

                            
23 Февраля, 2023

                        

                                            

                            
Что такое графика Java AWT?

                            
23 Февраля, 2023

                        

                                            

                            
Каковы негативные аспекты наследования класса Java Stack от Vector?

                            
23 Февраля, 2023

                        

                                            

                            
Как скопировать текст в буфер обмена в Java?

                            
22 Февраля, 2023

                        

                                            

                            
MapmyIndia Android SDK — добавление многоугольника на карту

                            
22 Февраля, 2023

                        

                                            

                            
Модульное тестирование, интеграционное тестирование, приоритетное тестирование с использованием TestNG в Java

                            
22 Февраля, 2023

                        

                                            

                            
MapmyIndia Android SDK — добавление полилиний на карту

                            
22 Февраля, 2023