注解开发
在使用SpringMvc时,使用注解开发可以让我们开发的速度大大提升,就无需每写一个组件就在配置文件中手动添加一个Bean了。
先介绍一些常用的注解:
-
@Controller
- 该注解用于标注一个类,表示该类是一个SpringMvc的Controller对象,如果被Spring扫描到,会自动添加到Bean。
- 被该注解的类,其中的所有方法,如果返回值时String,就会被视图解析器解析。
-
@RestController
- 该注解与@Controller功能一致,但是被该注解标识的类,其中处理请求的方法,返回时不会被视图解析器解析。
-
@RequestMapping
- 该注解用于标识类或者方法,标识类时,表示类中所有请求的方法都是以该地址作为父路径。用于方法上时,表示该路径的请求由该方法完成。
- value:指定请求的实际地址。
- method:指定请求的方法类型。
- consumes:指定处理请求的提交内容类型。
- produces:指定返回的内容类型。
- params:指定该请求中必须包含某些参数值。
- header:指定请求中必须包含某些指定的头信息。
- 存在@GetMapping、@PostMapping…等注解用于标识指定method请求的方法,这些注解只能存在于方法上。
-
@PathVariable
- 该注解用于功能处理方法的参数上,用于指定请求路径中携带的参数。
-
@ResponseBody
- 该注解用于标识类或者方法,将Controller的方法返回的对象通过指定的格式转换后直接写入Response的Body数据区中,不会用视图解析器解析。
代码演示
- 新建Maven项目,导入依赖:
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.4.RELEASE</version>
</dependency>
- 编写SpringMvc的配置文件(spring-mvc.xml):
<?xml version="1.0" encoding= "UTF-8"?>
<beans xmlns= "http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
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/context
https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!--自动扫描包,让指定包下的注解生效,由Spring容器统一管理-->
<context:component-scan base-package="com.ara.controller"/>
<!--让Spring不处理静态资源-->
<mvc:default-servlet-handler />
<!--
支持mvc注解驱动
在Spring中一般采用@RequestMapping注解来完成映射关系
要使@RequestMapping注解生效
必须向上下文中注册DefaultAnnotationHandlerMapping
和一个AnnotationMethodHandlerAdapter实例
这两个实例分别在类级别和方法级别中处理
而annotation-driven配置帮助我们自动完成上述两个实例的注入
-->
<mvc:annotation-driven />
<!--视图解析器-->
<bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver" >
<!--视图前缀-->
<property name="prefix" value="/WEB-INF/jsp/"/>
<!--视图后缀-->
<property name="suffix" value=".jsp"/>
</bean>
</beans>
- 配置web.xml,在其中添加如下:
<servlet>
<servlet-name>springMvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--配置DispatcherServlet要绑定Spring的配置文件-->
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<!--配置DispatcherServlet的启动级别为1,与服务器同时启动加载-->
<load-on-startup>1</load-on-startup>
</servlet>
<!--
/和/*的区别:这里需要的是/
/:只匹配所有的请求,不会去匹配jsp页面
/*:匹配所有的请求,包括jsp页面
-->
<servlet-mapping>
<servlet-name>springMvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<!-- Spring中自带的编码过滤器,处理中文乱码问题 -->
<filter>
<filter-name>characterEncodingFilter</filter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>characterEncodingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
- 编写测试Controller类(ControllerTest)这里需要注意Controller的所在包路径,要和Springmvc配置文件中配置的扫描包路径一致,否则会扫描不上:
package com.ara.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
//标注该类是Spring的Controller类
@Controller
public class ControllerTest {
//标注该方法的访问路径
@RequestMapping("/test")
//该方法返回的String会被视图解析器解析成对应的页面 "/WEB-INF/jsp/"+"test"+".jsp"
//该方法的参数还可以自己写,比如HttpServletRequest、HttpServletResponse...
public String test(Model model){
model.addAttribute("msg","SpringMvc 测试!");
return "test";
}
}
- 编写测试页面(在WEB-INF下的jsp文件中创建test.jsp)需要和SpringMvc配置文件中的视图解析器对应:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
- 将该项目运行到Tomcat,访问test结果如下:
注解环境没问题,实验成功。