SpringMVC注解详解

SpringMVC是基于Spring框架的MVC框架，具有易维护、灵活性高、可扩展性强等优点，在Web开发中得到了广泛应用。本文将从多个方面对SpringMVC注解进行详细讲解，帮助读者深入了解SpringMVC注解的相关知识。

一、Spring注解有哪些

在深入讲解SpringMVC注解之前，需要先了解一下Spring框架的注解，主要包括以下几种：

@Autowired：自动装配注解，用于自动注入一个Bean。

@Value：属性注入注解，用于为Bean属性注入值。

@Repository：DAO层注解，用于标识持久化层的Bean。

@Service：Service层注解，用于标识逻辑层的Bean。

@Controller：Controller层注解，用于标识控制层的Bean。

除此外，还有一些常用的注解，如@PostConstruct、@PreDestroy等，这里不再赘述。

二、SpringMVC注解原理

SpringMVC是一个基于Servlet的MVC框架，每个请求都由中央控制器（DispatcherServlet）进行处理。当客户端发送请求时，DispatcherServlet会先进行请求映射，找到对应的Controller处理请求，并将请求参数传递给Controller。Controller处理请求后，将处理结果封装成ModelAndView对象，并返回给DispatcherServlet。DispatcherServlet通过ViewResolver进行视图解析，并将ModelAndView对象传递给View，最终返回客户端。

而SpringMVC的注解则是为了简化这一过程而产生的，通过在Controller层、方法、参数等地方添加注解，可以更加简便地处理请求和响应。

三、Spring Boot注解有哪些

Spring Boot是基于Spring框架的快速开发框架，也拥有一些常用的注解，如下：

@SpringBootApplication：Spring Boot项目主类注解，用于标识一个应用程序的主类。

@RestController：RestController注解，用于标识控制器类。

@RequestMapping：请求映射注解，用于将请求映射到特定的处理程序方法。

@Autowired：自动装配注解，用于自动注入一个Bean。

@Value：属性注入注解，用于为Bean属性注入值。

四、SpringMVC的配置文件有哪些

SpringMVC的配置主要包括两个文件：web.xml和SpringMVC配置文件。

web.xml

    <web-app>
        <!--配置DispatcherServlet-->
        <servlet>
            <servlet-name>DispatcherServlet</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <param-name>contextConfigLocation</param-name>
                <param-value>/WEB-INF/spring-mvc.xml</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <servlet-mapping>
            <servlet-name>DispatcherServlet</servlet-name>
            <url-pattern>/</url-pattern>
        </servlet-mapping>
    </web-app>

SpringMVC配置文件（spring-mvc.xml）

    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
        
        <!--配置视图解析器-->
        <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/WEB-INF/jsp/" />
            <property name="suffix" value=".jsp" />
        </bean>
        
        <!--配置控制器-->
        <bean id="homeController" class="com.example.demo.controller.HomeController">
            <property name="message" value="Hello SpringMVC!" />
        </bean>
        
        <!--配置处理器映射器-->
        <bean id="handlerMapping" class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping" />
        
        <!--配置处理器适配器-->
        <bean id="handlerAdapter" class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter" />
    
    </beans>

五、SpringMVC的6个常用注解

SpringMVC的注解种类很多，但是在实际开发中，比较常用的注解主要包括以下6种：

@RequestMapping

@RequestMapping注解用于将请求映射到特定的处理程序方法上。可以用于类级别和方法级别，常用的属性包括value、method、params、headers、consumes、produces等。

示例：

    @Controller
    @RequestMapping("/home")
    public class HomeController {
        
        @RequestMapping(value = "/index", method = RequestMethod.GET)
        public String index(Model model) {
            model.addAttribute("message", "Hello SpringMVC!");
            return "index";
        }
    }

@RequestParam

@RequestParam注解用于将请求参数绑定到处理程序方法的参数上。常用的属性包括value和required。

示例：

    @Controller
    @RequestMapping("/home")
    public class HomeController {
        
        @RequestMapping(value = "/hello")
        public String hello(@RequestParam("name") String name, Model model) {
            model.addAttribute("message", "Hello " + name + "!");
            return "hello";
        }
    }

@PathVariable

@PathVariable注解用于将请求URL中的变量绑定到处理程序方法的参数上。

示例：

    @Controller
    @RequestMapping("/home")
    public class HomeController {
        
        @RequestMapping(value = "/{id}")
        public String detail(@PathVariable("id") int id, Model model) {
            //根据id获取详情
            model.addAttribute("message", "Detail: " + id);
            return "detail";
        }
    }

@ModelAttribute

@ModelAttribute注解用于在请求处理之前将模型对象添加到模型中。也可以用于将表单数据绑定到模型对象上。

示例：

    @Controller
    @RequestMapping("/home")
    public class HomeController {
    
        @ModelAttribute
        public void init(Model model) {
            model.addAttribute("welcome", "Welcome to SpringMVC!");
        }
        
        @RequestMapping(value = "/form", method = RequestMethod.GET)
        public String form() {
            return "form";
        }
        
        @RequestMapping(value = "/submit", method = RequestMethod.POST)
        public String submit(@ModelAttribute User user, Model model) {
            //处理表单提交
            model.addAttribute("message", user.getName() + " " + user.getAge());
            return "submit";
        }
    }

@ResponseBody

@ResponseBody注解用于将处理程序方法返回的对象转换为特定的格式（如JSON、XML等）并发送到客户端。常用于处理RESTful API。

示例：

    @RestController
    @RequestMapping("/api")
    public class ApiController {
        
        @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
        public User getUser(@PathVariable("id") int id) {
            //根据id获取用户信息
            return user;
        }
    }

@ControllerAdvice

@ControllerAdvice注解用于定义全局控制器建议（例如全局异常处理和全局数据绑定），可以用于类级别和方法级别。

示例：

    @ControllerAdvice
    public class GlobalExceptionHandler {
        
        @ExceptionHandler(Exception.class)
        public ModelAndView handleException(Exception e) {
            ModelAndView mav = new ModelAndView();
            mav.addObject("message", e.getMessage());
            mav.setViewName("error");
            return mav;
        }
    }

六、SpringMVC的组件有哪些

除了注解之外，SpringMVC中还有一些常用的组件，如下：

HandlerMapping

HandlerMapping是用于查找处理程序（Controller）和处理程序方法（HandlerMethod）的接口。

示例：

    <bean id="handlerMapping" class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
        <property name="order" value="1" />
    </bean>

HandlerAdapter

HandlerAdapter是用于处理处理程序方法的接口。

示例：

    <bean id="handlerAdapter" class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter" />

ViewResolver

ViewResolver是用于解析视图名称并返回视图对象的接口。

示例：

    <bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/jsp/" />
        <property name="suffix" value=".jsp" />
    </bean>

HandlerInterceptor

HandlerInterceptor是用于拦截请求并处理拦截后的操作的接口。常用的操作包括记录日志、鉴权、参数校验等。

示例：

    public class LogHandlerInterceptor implements HandlerInterceptor {
        
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            //记录日志
            return true;
        }
        
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
            //处理视图
        }
        
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            //清理资源
        }
    }

MultipartResolver

MultipartResolver是用于处理文件上传的接口，常用的实现类包括CommonsMultipartResolver和StandardServletMultipartResolver。

示例：

    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <property name="maxUploadSize" value="100000" />
    </bean>

以上就是SpringMVC注解的详细讲解，通过对注解的了解，可以更加方便地开发SpringMVC应用。

原创文章，作者：IVLWK，如若转载，请注明出处：https://www.506064.com/n/332103.html