【Java从0到架构师】SpringMVC - 基础

客官°小女子只卖身不卖艺 2022-09-03 12:14 150阅读 0赞

### SpringMVC - 基础 ###

*  SpringMVC - 入门
 *   *  web.xml 配置 DispatcherServlet
     *  appliactionContext.xml
     *  新建 Controller
 *  SpringMVC - 基础
 *   *  请求参数 - @RequestParam、@RequestBody
     *  请求路径变量 - @PathVariable
     *  利用反射获取参数名
     *  乱码处理 - GET、POST 请求参数乱码
     *  乱码处理 - 响应数据乱码
     *  Servlet 的 url 匹配 - 3 种
     *   *  Tomcat 中默认的 Servlet
         *  静态资源被拦截的解决方案 - 2种

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

Gitee 代码：[https://gitee.com/szluyu99/mj\_java\_frame/tree/master/03\_SpringMVC][https_gitee.com_szluyu99_mj_java_frame_tree_master_03_SpringMVC]

--------------------

SpringMVC 的正式名称是 Spring Web MVC

*  属于 Spring 框架的一部分
 *  基于 Servlet API 的 Web 框架

SpringMVC 的核心功能是：拦截和处理客户端的请求

[官方参考文档][Link 1]

# SpringMVC - 入门 #

spring-webmvc 依赖于：

*  spring-aop
 *  spring-beans
 *  spring-context
 *  spring-core
 *  spring-expression
 *  spring-web

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.2.8.RELEASE</version>
    </dependency>

## web.xml 配置 DispatcherServlet ##

<servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        
        
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:applicationContext.xml</param-value>
        </init-param>
        
        <load-on-startup>0</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        
        <url-pattern>/</url-pattern>
    </servlet-mapping>

## appliactionContext.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" 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> <context:component-scan base-package="com.mj"/>
    
    </beans>

## 新建 Controller ##

@Controller
    public class TestController() { 
    	@GetMapping("/test")
    	@ResponseBody
    	public String test() { 
    		return "Hello World";
    	}
    }

当 GET 请求 context\_path/test 的时候，就会调用 TestController 的 test 方法

*  并且将 “Hello World” 输出给客户端  
    ![在这里插入图片描述][a10b2d0c273144429fa0bbc6b4e24b42.png]

# SpringMVC - 基础 #

## 请求参数 - @RequestParam、@RequestBody ##

默认情况下，SpringMVC 会主动传递一些参数给请求方法：

*  WebRequest、HttpServletRequest、HttpServletResponse、HttpSession 等
 *  参考：[官方文档][Link 2]

默认情况下，请求参数会传递给同名的方法参数

*  可以通过 `@RequestParam` 指定方法参数对应的请求参数名  
    require 属性为 false：请求参数是可选的，客户端可以不传  
    require 属性为 true：请求参数是必传的，客户端必须传，否则出现 404 错误
 *  可以通过 Model 对象去接收请求参数  
    Model 对象的属性名需要和请求参数保持一致

--------------------

请求参数注解补充：

*  `@RequestParam`：普通的请求参数
 *  `@RequestBody`：请求体，接收 Content-Type 为 application/json 数据

> 前端发送了 json 格式的数据，后端接收时必须用 `@RequestBody` 接收

*  `@RequestHeader("header-name")`：请求头

## 请求路径变量 - @PathVariable ##

如果请求路径中的内容是变化的，可以定义成 `{变量名}`，然后通过 `@PathVariable` 去获取值

@GetMapping("/user/{id}")
    @ResponseBody
    public String testId(@PathVariable("id") String id) { 
    	return "your id is " + id;
    }

## 利用反射获取参数名 ##

从 JDK8 开始，可以通过 java.lang.reflect.Parameter 类获取参数名

*  前提：在编译 \*.java 的时候保留参数名信息到 \*.class
    
        javac -parameters hello.java
 *  可以通过以下指令查看 class 文件的参数名信息
    
        javap -v hello.class

Java 代码获取方法的参数名：

public class TestParam { 
    	public void test(String name, int age) { }
    	public static void main(String[] args) throws Exception { 
    		Method method = TestParam.class.getMethod("test", String.class, int.class);
    		for(Parameter paramter : method.getParameters()) { 
    			System.out.println(parameter.getName());
    		}
    	}
    }

SpringMVC 内部通过 ParameterNameDiscoverer 类获取参数名

## 乱码处理 - GET、POST 请求参数乱码 ##

**从 Tomcat8 开始，GET 请求已经没有乱码问题了**

Tomcat 8 以前处理乱码的解决方案：

*  在 TOMCAT\_HOME/conf/server.xml 中给 Connector 标签增加属性
    
        URIEncoding="UTF-8"

--------------------

POST 请求乱码问题仍然存在，解决方案：

通过 Filter 拦截请求，调用 `request.setCharacterEncoding('UTF-8)`

*  SpringMVC 已经内置了这样的 Filter，直接在 web.xml 中配置即可使用

<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>

## 乱码处理 - 响应数据乱码 ##

方法1：设置 `@RequestMapping` 的 [produces][] 属性

@RequestMapping(
    		value="/coding",
    		produces="text/html; charset=UTF-8"
    )
    @ResponseBody
    public String test() { 
    	return "<h1>哈哈哈</h1>";
    }

方法2：在 [<mvc:annotation-driven>][mvc_annotation-driven] 中添加 <mvc:message-converters>

<mvc:annotation-driven>
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="defaultCharset" value="UTF-8"/>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

> <mvc:annotation-driven> 还有别的作用，可以保证 controller 正常使用，后面有写到

## Servlet 的 url 匹配 - 3 种 ##

`*.do`：不会拦截**动态资源**（比如 \*.jsp）、**静态资源**（\*.html、\*.js）

`/`：会拦截**静态资源**（比如 \*.html、\*.js），不会拦截**动态资源**（比如 \*.jsp）

`/*`：会拦截**动态资源**（比如 \*.jsp）、**静态资源**（比如 \*.html、\*.js）

*  一般用于 Filter 中

### Tomcat 中默认的 Servlet ###

Tomcat 中有两个默认的 Servlet，可以在 TOMCAT\_HOME/conf/web.xml 中找到

1.  **org.apache.catalina.servlets.DefaultServlet**  
    url-pattern 是 `/`，即可以处理静态资源  
    ![在这里插入图片描述][d915e2d3c27b402ea9f32c1c314441e9.png]2. **org.apache.jasper.servlet.JspServlet**  
    url-pattern 是 `*.jsp`，作用是拦截 .jsp 文件并将其转成 Servlet（jsp 的本质是 Servlet）  
    ![在这里插入图片描述][b85b1434bc394c3aaa66b0bdbdbac103.png]

### 静态资源被拦截的解决方案 - 2种 ###

如果 SpringMVC 的 DispatcherServlet 的 url-pattern 设置为 `/`，会导致静态资源被拦截

解决方案1：**将静态资源交回给 Tomcat 的 DefaultServlet 去处理**

<mvc:default-servlet-handler/>

<mvc:default-servlet-handler/> 的原理：

*  通过 DefaultServletHttpRequestHandler 对象将静态资源转发给 Tomcat 的 DefaultServlet

注：使用了 <mvc:default-servlet-handler/> 后，会导致 controller 无法处理请求

*  加上 <mvc:annotation-driven/> 即可保证 controller 正常使用

<mvc:annotation-driven/>

--------------------

解决方案2：由 SpringMVC 框架内部来处理静态资源

*  框架内部是通过 ResourceHttpRequestHandler 对象来处理

<mvc:resources mapping="/asset/**" location="/asset/"/>

注：同样需要加上 <mvc:default-servlet-handler/> 来保证 controller 正常使用

<mvc:annotation-driven/>

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[https_gitee.com_szluyu99_mj_java_frame_tree_master_03_SpringMVC]: https://gitee.com/szluyu99/mj_java_frame/tree/master/03_SpringMVC
[Link 1]: https://docs.spring.io/spring-framework/docs/current/reference/html/web.html
[a10b2d0c273144429fa0bbc6b4e24b42.png]: /images/20220829/93879eba5bab4ce786a3e1306cf83294.png
[Link 2]: https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#mvc-ann-arguments
[produces]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/31_SpringMVC01_%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8/src/main/java/com/mj/controller/EncodingController.java
[mvc_annotation-driven]: https://gitee.com/szluyu99/mj_java_frame/blob/master/03_SpringMVC/31_SpringMVC01_%E5%9F%BA%E6%9C%AC%E4%BD%BF%E7%94%A8/src/main/webapp/WEB-INF/web.xml
[d915e2d3c27b402ea9f32c1c314441e9.png]: /images/20220829/949cf88eed8d468e947963127469110d.png
[b85b1434bc394c3aaa66b0bdbdbac103.png]: /images/20220829/2bf98a390b804c15ad99605db570fcbe.png