SYSTEM
基本配置
src/content/notes/system/基本配置.md 基本配置
入门项目
流程分析:
- 服务器启动
- 加载 web.xml 中 DispatcherServlet
- 读取 spring-mvc.xml 中的配置,加载所有 controller 包中所有标记为 bean 的类
- 读取 bean 中方法上方标注 @RequestMapping 的内容
- 处理请求
- DispatcherServlet 配置拦截所有请求 /
- 使用请求路径与所有加载的 @RequestMapping 的内容进行比对
- 执行对应的方法
- 根据方法的返回值在 webapp 目录中查找对应的页面并展示
代码实现:
-
pom.xml 导入坐标
<modelVersion>4.0.0</modelVersion> <groupId>demo</groupId> <artifactId>spring_base_config</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <!-- servlet3.0规范的坐标 --> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> <scope>provided</scope> </dependency> <!--jsp坐标--> <dependency> <groupId>javax.servlet.jsp</groupId> <artifactId>jsp-api</artifactId> <version>2.1</version> <scope>provided</scope> </dependency> <!--spring的坐标--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.1.9.RELEASE</version> </dependency> <!--springmvc的坐标--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>5.1.9.RELEASE</version> </dependency> </dependencies> <!--构建--> <build> <!--设置插件--> <plugins> <!--具体的插件配置--> <plugin> <groupId>org.apache.tomcat.maven</groupId> <artifactId>tomcat7-maven-plugin</artifactId> <version>2.1</version> <configuration> <port>80</port> <path>/</path> </configuration> </plugin> </plugins> </build> -
设定具体 Controller,控制层 java / controller / UserController
@Controller //@Component衍生注解 public class UserController { //设定当前方法的访问映射地址,等同于Servlet在web.xml中的配置 @RequestMapping("/save") //设置当前方法返回值类型为String,用于指定请求完成后跳转的页面 public String save(){ System.out.println("user mvc controller is running ..."); //设定具体跳转的页面 return "success.jsp"; } } -
webapp / WEB-INF / web.xml,配置SpringMVC核心控制器,请求转发到对应的具体业务处理器Controller中(等同于Servlet配置)
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" version="3.1"> <!--配置Servlet--> <servlet> <servlet-name>DispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <!--加载Spring控制文件--> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath*:spring-mvc.xml</param-value> </init-param> </servlet> <servlet-mapping> <servlet-name>DispatcherServlet</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> </web-app> -
resouces / spring-mvc.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd"> <!--扫描加载所有的控制类--> <context:component-scan base-package="controller"/> </beans>
加载控制
Controller 加载控制:SpringMVC 的处理器对应的 bean 必须按照规范格式开发,未避免加入无效的 bean 可通过 bean 加载过滤器进行包含设定或排除设定,表现层 bean 标注通常设定为 @Controller
-
resources / spring-mvc.xml 配置
<context:component-scan base-package="com.seazean"> <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/> </context:component-scan> -
静态资源加载(webapp 目录下的相关资源),spring-mvc.xml 配置,开启 mvc 命名空间
<!--放行指定类型静态资源配置方式--> <mvc:resources mapping="/img/**" location="/img/"/> <!--webapp/img/资源--> <mvc:resources mapping="/js/**" location="/js/"/> <mvc:resources mapping="/css/**" location="/css/"/> <!--SpringMVC 提供的通用资源放行方式,建议选择--> <mvc:default-servlet-handler/> -
中文乱码处理 SpringMVC 提供专用的中文字符过滤器,用于处理乱码问题。配置在 web.xml 里面
<!--乱码处理过滤器,与Servlet中使用的完全相同,差异之处在于处理器的类由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>
注解驱动
WebApplicationContext,生成 Spring 核心容器(主容器/父容器/根容器)
- 父容器:Spring 环境加载后形成的容器,包含 Spring 环境下的所有的 bean
- 子容器:当前 mvc 环境加载后形成的容器,不包含 Spring 环境下的 bean
- 子容器可以访问父容器中的资源,父容器不可以访问子容器的资源
EnableWebMvc 注解作用:
- 支持 ConversionService 的配置,可以方便配置自定义类型转换器
- 支持 @NumberFormat 注解格式化数字类型
- 支持 @DateTimeFormat 注解格式化日期数据,日期包括 Date、Calendar
- 支持 @Valid 的参数校验(需要导入 JSR-303 规范)
- 配合第三方 jar 包和 SpringMVC 提供的注解读写 XML 和 JSON 格式数据
纯注解开发:
-
使用注解形式转化 SpringMVC 核心配置文件为配置类 java / config / SpringMVCConfiguration.java
@Configuration @ComponentScan(value = "com.seazean", includeFilters = @ComponentScan.Filter( type=FilterType.ANNOTATION, classes = {Controller.class} ) ) //等同于<mvc:annotation-driven/>,还不完全相同 @EnableWebMvc public class SpringMVCConfiguration implements WebMvcConfigurer{ //注解配置通用放行资源的格式 建议使用 @Override public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { configurer.enable(); } } -
基于 servlet3.0 规范,自定义 Servlet 容器初始化配置类,加载 SpringMVC 核心配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer { //创建Servlet容器时,使用注解方式加载SPRINGMVC配置类中的信息, //并加载成WEB专用的ApplicationContext对象该对象放入了ServletContext范围, //在整个WEB容器中可以随时获取调用 @Override protected WebApplicationContext createServletApplicationContext() { A.C.W.A ctx = new AnnotationConfigWebApplicationContext(); ctx.register(SpringMVCConfiguration.class); return ctx; } //注解配置映射地址方式,服务于SpringMVC的核心控制器DispatcherServlet @Override protected String[] getServletMappings() { return new String[]{"/"}; } @Override protected WebApplicationContext createRootApplicationContext() { return null; } //乱码处理作为过滤器,在servlet容器启动时进行配置 @Override public void onStartup(ServletContext servletContext) throws ServletException { super.onStartup(servletContext); CharacterEncodingFilter cef = new CharacterEncodingFilter(); cef.setEncoding("UTF-8"); FilterRegistration.Dynamic registration = servletContext.addFilter("characterEncodingFilter", cef); registration.addMappingForUrlPatterns(EnumSet.of( DispatcherType.REQUEST, DispatcherType.FORWARD, DispatcherType.INCLUDE), false,"/*"); } }
请求映射
名称:@RequestMapping
类型:方法注解、类注解
位置:处理器类中的方法定义上方、处理器类定义上方
-
方法注解
作用:绑定请求地址与对应处理方法间的关系
无类映射地址访问格式: http://localhost/requestURL2
@Controller public class UserController { @RequestMapping("/requestURL2") public String requestURL2() { return "page.jsp"; } } -
类注解
作用:为当前处理器中所有方法设定公共的访问路径前缀
带有类映射地址访问格式,将类映射地址作为前缀添加在实际映射地址前面:/user/requestURL1
最终返回的页面如果未设定绝对访问路径,将从类映射地址所在目录中查找 webapp/user/page.jsp
@Controller @RequestMapping("/user") public class UserController { @RequestMapping("/requestURL2") public String requestURL2() { return "page.jsp"; } } -
常用属性
@RequestMapping( value="/requestURL3", //设定请求路径,与path属性、 value属性相同 method = RequestMethod.GET, //设定请求方式 params = "name", //设定请求参数条件 headers = "content-type=text/*", //设定请求消息头条件 consumes = "text/*", //用于指定可以接收的请求正文类型(MIME类型) produces = "text/*" //用于指定可以生成的响应正文类型(MIME类型) ) public String requestURL3() { return "/page.jsp"; }