springMVC 思维导图模板_ProcessOn思维导图、流程图

request相关

web.xml配置

<?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_4_0.xsd"          version="4.0">      <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:spring-mvc.xml</param-value>     </init-param>          <load-on-startup>1</load-on-startup>   </servlet>      <servlet-mapping>     <servlet-name>springmvc</servlet-name>          <url-pattern>/</url-pattern>   </servlet-mapping>      <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>               <init-param>       <param-name>forceEncoding</param-name>       <param-value>true</param-value>     </init-param>   </filter>      <filter-mapping>     <filter-name>characterEncodingFilter</filter-name>                    <servlet-name>springmvc</servlet-name>   </filter-mapping>      <filter>     <filter-name>hiddenHttpMethodFilter</filter-name>     <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>   </filter>   <filter-mapping>     <filter-name>hiddenHttpMethodFilter</filter-name>     <servlet-name>springmvc</servlet-name>   </filter-mapping>      <error-page>     <error-code>404</error-code>     <location>/404.html</location>   </error-page> </web-app>

Mapping映射

@RequestMapping

@RequestMapping(value = "/hello3",params = {"username!=123","age"}) public String hello3(@ModelAttribute("username")String username){

@RequestMapping(value = "/hello4",          headers = {"User-Agent=Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:73.0) Gecko/20100101 Firefox/73.0"}) @RequestMapping(value = "/hello5",consumes = {"application/x-www-form-urlencoded"}) // @RequestMapping(value = "/hello5",consumes = {"multipart/form-data"}) // @RequestMapping(value = "/hello5",consumes = {"application/json"}) // @GetMapping(value = "/hello5",consumes = {"multipart/form-data"}) // @PostMapping(value = "/hello5",consumes = {"application/json"}) @RequestMapping(value = "/hello6",produces = {"application/json"}) @RequestMapping(value = "/ant?") @RequestMapping(value = "/ant*") @RequestMapping(value = "/**/ant") @RequestMapping(value = "/**/h*llo?")

// @RequestMapping(value = "/hello6",produces = "text/html;charset=utf-8")     @RequestMapping(value = "/hello6",produces = {"application/json"})

@GetMapping

@PostMapping

@PutMapping

@DeleteMapping

@ModelAttribute

Params参数

@RequestParam

@RequestParam(value = "username",  required = false,  defaultValue = "金鳞")

@RequestHeader

public String header(@RequestHeader("User-Agent") String agent,                          @RequestHeader(value = "Host",required = true,defaultValue = "127.0.0.1") String host) {

@CookieValue

public String cookie(             // @CookieValue("JSESSIONID")             @CookieValue(value = "JSESSIONID", required = false, defaultValue = "xxxx")             String jsessionId) {

@PathVariable：获URL目录级别里的参数

@RequestMapping("/user/{id}/{username}") public String path01(@PathVariable("id") Integer id, @PathVariable("username") String name)

Rest风格

在web.xml里，添加  HiddenHttpMethodFilter 过滤器

在表单中添加一个有隐藏域 <input type="hidden" value="put" name="_method">   value就是对应的请求方式

将 form的 method 设置 POST

过滤器就会自动将 POST请求修改成隐藏域中对应值的请求

tomcat 7 以上的版本对 request.method 更加严格：只支持 GET / POST / HEAD:HTTP Status 405 - JSPs only permit GET POST or HEAD

解决方式有四个： 1.   用tomcat7 2. 不用转发，用重定向 3. 将jsp的 page模块的 isErrorPage属性改成 true(不建议)    jsp页面顶端的page属性：<%@ page contentType="text/html;charset=UTF-8" language="java" isErrorPage="true" %> 4. 自定义一个过滤器，将 request.method 改回 POST

Restful

@RestController

* 基于服务api 的方式  使用 restful api: * 使用  注解 @RestController   标识后的类， * 那么，所有的方法  返回的是 json格式的数据；而不是某个jsp 的名字了；

response相关

forward:进行转发

默认是进行转发;

return "/login.jsp";

return "forward:/login.jsp";

redirect:重定向

重定向：必须加上redirect:

return "redirect:/login.jsp";

@SessionAttributes

负责往 session里写入数据的 底层会从 model中去找一个叫做 type的属性 找到了会将 type 设置一份到 session 中； 这种方式是依赖 model的 @SessionAttributes写在类上，功能在当前控制器下,所有的处理方法都会将 model 指定的属性, 写入session

@SessionAttributes("type") public class TransferringDataToViewController

@RequestMapping("/model") public String model(Model model) {     System.out.println(model.getClass());     model.addAttribute("type", "model");     return "main"; }

/** * @SessionAttribute，功能是负责获取 session 里的数据的 *   required：用来设置 session中某个属性必须存在，不存在则会报错： *      HTTP Status 400 - Missing session attribute 'type' of type String * *   当使用注解的时： *      model 和 session 是互通的： *        session  会从 model中  获取指定的属性的值  并自动写入到 session中的相同属性名称的值中， *        model  也会从 session中获取指定的属性的值  并自动写入到 model 中的相同属性名称的值中； *        或者这么描述： *        session 从 session会话中读取到指定的属性的值后，也会往 model   中设置一份相同属性名称的值 *        model   从 request会话中读取到指定的属性的值后，也会往 session 中设置一份相同属性名称的值 * @param type * @return */ @RequestMapping("/annotation/session") public String session03(@SessionAttribute(value="type",required = false) String type,                         Model model ){

@ModelAttribute

@ModelAttribute 的作用 @ModelAttribute 是 Spring MVC 中一个重要的注解，主要有两种使用方式： 1.方法级别使用 当用在方法上时，@ModelAttribute 表示该方法会在控制器中所有处理方法之前执行，用于准备模型数据： 特点： 会在每个请求处理方法调用前执行 用于添加多个控制器共享的模型属性 方法返回值会自动添加到模型中 2.参数级别使用 当用在方法参数上时，@ModelAttribute 表示从模型中  获取或创建对象： 特点： - 可以从表单绑定数据到对象 - 如果模型中不存在指定名称的对象，会自动实例化 - 常用于表单处理

主要作用 数据绑定：将请求参数绑定到模型对象 数据预加载：在处理方法执行前准备模型数据 数据共享：在多个请求间共享数据 表单处理：简化表单对象的创建和绑定 工作流程 Spring 检查是否有对应的 @ModelAttribute 方法 执行这些方法并将结果添加到模型 对于参数级别的注解，从模型或请求中获取/创建对象 执行请求处理方法 @ModelAttribute 是 Spring MVC 实现数据绑定和模型管理的重要机制。

* 被@ModelAttribute 注解过的方法， * 会在当前处理器类中，所有的请求处理方法(被@RequestMapping注解过的方法) 执行之前，都会先调用此方法;

类型转换器

数据校验

* 实现数据验证的步骤： *      1.加入hibernate-validator依赖 *      2.一定要注意！！将新加入的 jar包加入到 WEB-INF/lib 中 *      3.在需要验证的 javaBean的属性上面，加入对应的验证注解，可以设置 message属性，定制更友好的错误提示信息 *      4.在需要验证的处理方法的对应 javaBean 参数上，加上 @Valid *      5.在需要验证的处理方法的参数中，加入 BindingResult，代表自己处理错误，这样就不会显示错误页面了。 * *   基于原生 html form表单实现方式： *      1.在将错误信息循环通过 map 存入到 request域中 *      2.在jsp 通过${errors.id} 获取对应的错误信息 * *   基于 spring form标签库的实现方式： *      1.添加一个显示jsp的处理方法，一定要传入一个空的 User 到 model 中 *      2.在jsp中，导入 spring-form 标签库:<%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %> *      3.在form标签上，一定要加上 ModelAtrribute="user" *      4.加上对应的 form标签，  必须都要以<form:开头

@PostMapping("/user")     public String add(@Valid User user, BindingResult result, Model model){

自定义类型转换器

配置自定义的类型转换器     当配置了自定义的类型转换器，需要将实现类改为：FormattingConversionServiceFactoryBean，     才可以同时支持自定义类型转换器和数据格式化的注解：@NumberFormat 和 @DateTimeFormat      但是，同一个数据类型的类型转换器会先执行自定义的  类型转换器,           再在自定义的类型转换器执行后的结果的基础上  再执行  相同数据类型的注解的类型转换器功能

*****************************  自定义类型转换器  ************************** *  不常用，因为有 “数据格式化” 标签：@NumberFormat 和 @DateTimeFormat； * *  可以直接使用标签直接在类属性上标注即可； *  例如：在User类的birthday属性上标注注解 @DateTimeFormat(pattern = "yyyy-MM-dd")就可以实现此类的功能 * *  1.定义类型转换器：   需要明确源类型和目标类型 *  2.在convert方法里，自定义类型转换的实现 *  3.在springmvc中，配置自定义类型转换器 *     <bean class="org.springframework.context.support.ConversionServiceFactoryBean" id="conversionService"> *         <property name="converters"> *             <set> *                 <bean class="cn.tulingxueyuan.converters.MyStringToDateConverter"></bean> *             </set> *         </property> *     </bean> * 4.<mvc:annotation-driven conversion-service="conversionService"></mvc:annotation-driven>

json格式数据

@RestController

相当于控制器类中所有的处理方法都加上了 @ResponseBody, 适用于web api

@RequestBody

响应json 1.pom.xml中加入 jackson依赖 2.将 jackson的 jar包加入 WEB-INF的lib 文件夹 ·请求Json接收 使用 @RequestBody，前提是要保证请求过来的参数数据一定是 json数据，并且内容类型也必须是 "application/json"，只有指定的数据格式，才能接收，否则拒绝请求

上传下载

upload

会将文件上传到三个地方： 1.项目路径（适用项目小，上传使用率低） 2.磁盘路径，这种方式需要通过虚拟目录的映射 3.静态资源服务器（CDN）

基于springmvc MultiPartResolver 单文件上传 基于springmvc MultiPartResolver多文件文件上传 基于springmvc MultiPartResolver多文件文件上传--多线程

download

基于servlet api的文件下载

基于 spring ResponseEntity的文件下载

1、不支持缓冲区，容易造成内存溢出；(不建议使用，还是建议直接使用servlet-api的下载方式即可) 2、ResponseEntity 可以同时定制文件的响应内容，响应头，响应状态码

Interceptor拦截器

<mvc:view-controller>

<mvc:view-controller>是Spring MVC框架中的一个配置元素， 主要用于简化视图控制器的定义，特别适用于  那些  不需要业务逻辑处理的  简单页面跳转场景。         主要用途         直接映射URL到视图：    无需编写控制器方法，直接将请求路径映射到视图名称         简化配置：            减少简单页面跳转所需的控制器类和方法         处理静态页面请求：    适用于首页、欢迎页、关于页等不需要业务逻辑的页面 基本语法在Spring MVC的XML配置文件中使用： <mvc:view-controller path="/welcome" view-name="welcomePage"/>

常见使用场景

1. 配置首页

<mvc:view-controller path="/about" view-name="aboutPage"/>

2. 多个简单页面路由

<mvc:view-controller path="/about" view-name="aboutPage"/> <mvc:view-controller path="/contact" view-name="contactPage"/> <mvc:view-controller path="/faq" view-name="faqPage"/>

3. 重定向场景

<mvc:view-controller path="/old" view-name="redirect:/new"/>

高级配置

可以与<mvc:annotation-driven>一起使用，两者不会冲突：<mvc:annotation-driven/> <mvc:view-controller path="/home" view-name="home"/>

注意事项

1.  视图解析器：需要正确配置视图解析器（如InternalResourceViewResolver）  2.  HTTP方法：默认处理所有HTTP方法，可通过method属性限制  3.  状态码：可通过status-code属性设置响应状态码 4.  优先级：当与@RequestMapping冲突时，<mvc:view-controller> 优先级较低

Java配置方式

如果使用Java配置而非XML，可以通过实现WebMvcConfigurer接口达到同样效果： @Configuration @EnableWebMvc public class WebConfig implements WebMvcConfigurer {     @Override     public void addViewControllers(ViewControllerRegistry registry) {         registry.addViewController("/welcome").setViewName("welcomePage");         registry.addViewController("/").setViewName("index");     } }

<mvc:view-controller>是Spring MVC中提高开发效率的有用特性，特别适合项目中  大量  简单页面跳转  的场景。

@WebFilter

@WebFilter 是 Java Servlet 3.0 规范引入的注解，用于简化过滤器的配置，无需在 web.xml 中声明过滤器。

基本用法

@WebFilter(urlPatterns = "/*") // 拦截所有请求 public class MyFilter implements Filter {         @Override     public void init(FilterConfig filterConfig) throws ServletException {         // 初始化代码     }     @Override     public void doFilter(ServletRequest request, ServletResponse response,                          FilterChain chain) throws IOException, ServletException {         // 预处理逻辑         System.out.println("Before servlet execution");                 // 放行请求         chain.doFilter(request, response);                 // 后处理逻辑         System.out.println("After servlet execution");     }     @Override     public void destroy() {         // 销毁代码     } }

执行顺序控制

默认顺序不确定，可以通过以下方式控制： 1.实现 javax.servlet.annotation.WebFilter 的 filterName 并按字母顺序 2.使用 @Order 注解（Spring环境下） 3.编程式注册（在Spring Boot中）

常见应用场景

1.认证/授权检查 @WebFilter("/admin/*") public class AuthFilter implements Filter {     // 检查用户是否登录 } 2.请求/响应日志 @WebFilter("/*") public class LoggingFilter implements Filter {     // 记录请求信息 } 3.编码设置 @WebFilter("/*") public class EncodingFilter implements Filter {     public void doFilter(...) {         request.setCharacterEncoding("UTF-8");         chain.doFilter(request, response);     } } 4.跨域处理 @WebFilter("/*") public class CorsFilter implements Filter {     // 设置CORS头 }

注意事项

1.Servlet容器支持：需要Servlet 3.0+容器（Tomcat 7+、Jetty 8+等） 2.Spring Boot集成：Spring Boot会自动扫描@WebFilter 3.扫描范围：        确保过滤器类在组件扫描路径下 4.与web.xml冲突：避免同时在web.xml中配置相同过滤器

完整示例

@WebFilter(     filterName = "myAdvancedFilter",     urlPatterns = {"/api/*", "/secure/*"},     initParams = {         @WebInitParam(name = "exclusions", value = "/api/public/*"),         @WebInitParam(name = "timeout", value = "5000")     },     dispatcherTypes = {DispatcherType.REQUEST, DispatcherType.ASYNC},     asyncSupported = true ) public class AdvancedFilter implements Filter {     private String exclusions;     private int timeout;     @Override     public void init(FilterConfig filterConfig) {         this.exclusions = filterConfig.getInitParameter("exclusions");         this.timeout = Integer.parseInt(filterConfig.getInitParameter("timeout"));     }     @Override     public void doFilter(ServletRequest request, ServletResponse response,                        FilterChain chain) throws IOException, ServletException {         HttpServletRequest httpRequest = (HttpServletRequest) request;                 // 检查排除路径         if (isExcluded(httpRequest.getRequestURI())) {             chain.doFilter(request, response);             return;         }                 // 执行过滤逻辑         long start = System.currentTimeMillis();         chain.doFilter(request, response);         long duration = System.currentTimeMillis() - start;                 if (duration > timeout) {             System.out.println("Slow request: " + httpRequest.getRequestURI());         }     }     private boolean isExcluded(String uri) {         // 实现排除逻辑         return uri.startsWith(exclusions);     } }

拦截器

1、定义拦截器，必须要实现 HandlerInterceptor 2、在springmvc配置文件中增加拦截器配置

<mvc:interceptors> <bean class="cn.outstanding.interceptors.MyInterceptor"></bean>  <bean class="com.outstanding.interceptors.MyFirstInterceptor"/> <bean class="com.outstanding.interceptors.MySecondInterceptor"/> <bean class="com.outstanding.interceptors.InvokeTimeIntercptor"/>  <mvc:interceptor>          <mvc:mapping path="/**"/>          <mvc:exclude-mapping path="/login"/>          <bean class="com.outstanding.interceptors.CheckLoginInterceptor"/> </mvc:interceptor> </mvc:interceptors>

i18n-国际化

解决 java的硬编码的国际化步骤

1、在属性资源文件中，假如需要国际化的硬编码内容 2、在spring-mvc.xml里，注册国际化资源文件到  messageSource对象里。 3、根据 messageSource.getMessage 获取国际内容 string code:    资源文件中的key Object[] args:  文本中的参数，可以用占位符的方式在资源文件文本中设置参数占位符：{0},{2} Locale locale:  当前本地化语言对象 jsp页面上的<%@taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %> jsp页面上的<spring:message，会自动获取对应的国际化信息

<bean class="org.springframework.context.support.ResourceBundleMessageSource" id="messageSource">     <property name="basenames">         <array>             <value>i18n.login</value>                      </array>     </property>     <property name="defaultEncoding" value="UTF-8"/> </bean>

Exception-处理异常

@ControllerAdvice

被 @ControllerAdvice 标记的类是处理全局异常的类:

1、全局异常      2、处理器异常      3、全局异常中的具体异常      被拦截到的优先级：          a、处理器异常优先级最高; 就近原则匹配处理；              如果处理器异常中，没有匹配到异常，那么则会去全局异常里  找匹配；谁最精准就交给谁  处理。          b、全局异常中的具体异常优先级其次;              如果处理器异常中，没有定义异常，那么就会按照精准原则去匹配处理；谁最精准就交给谁  处理。          c、全局异常优先级最后;  当异常没有满足上面两种情况，就会交给全局异常处理 在实际项目开发中，往往只需要一个全局异常就够了 统一异常处理：同时处理普通请求和 ajax请求   普通请求：返回视图，错误信息   ajax: 返回json   {       code       message   }

@ExceptionHandler处理异常

通过 @ExceptionHandler，可以在方法中记录日志 转发一个友好的界面进行提示： 经验：1.记录日志中 2.可以将异常转发到错误页面，将错误信息在一个隐藏的div 中显示 如果 @ExceptionHandler标注的方法写在 @Controller类中，只能处理当前控制器类的处理方法

@ExceptionHandler(RuntimeException.class)     // @ExceptionHandler(Exception.class)     public ModelAndView handleException(Exception ex){         System.out.println("@Controller异常处理");         ModelAndView modelAndView=new ModelAndView();         modelAndView.setViewName("error");         modelAndView.addObject("ex",ex);         System.out.println(ex.getMessage());         //打印异常的详细信息         StringWriter sw = new StringWriter();         PrintWriter pw = new PrintWriter(sw);         ex.printStackTrace(pw);         System.out.println(sw.toString());   // 日志记录         return modelAndView;     }

@ResponseStatus

@ResponseStatus 是 Spring Framework 中的一个注解，主要用于控制 HTTP 响应的状态码和原因描述。它可以用在类级别或方法级别

通常用于以下场景

-------------------------------------------------------------------------------- 1. 标记异常类（用于全局异常处理） 当某个异常被抛出时，Spring 会自动返回指定的 HTTP 状态码和错误信息。 示例： @ResponseStatus(code = HttpStatus.NOT_FOUND, reason = "User not found") public class UserNotFoundException extends RuntimeException { // 当抛出此异常时，Spring 会自动返回 404 状态码和 "User not found" } 当 UserNotFoundException 抛出时，客户端会收到： HTTP/1.1 404 Not Found {"error": "User not found"} 2. 直接标记控制器方法（指定返回状态码） 即使方法正常执行，也可以通过 @ResponseStatus 强制返回特定的 HTTP 状态码。 示例： @PostMapping("/create") @ResponseStatus(HttpStatus.CREATED) // 无论是否显式返回，状态码始终是 201 public void createUser(@RequestBody User user) {     // 业务逻辑 } 调用此接口后，响应状态码会是 201 Created，而不是默认的 200 OK。 -------------------------------------------------------------------------------- 3. 自定义错误消息 结合 reason 或通过 MessageSource  国际化支持，可以返回更友好的错误提示。 示例： @ResponseStatus(code = HttpStatus.BAD_REQUEST, reason = "Invalid input data") public class InvalidInputException extends RuntimeException { } 客户端会收到： HTTP/1.1 400 Bad Request {"error": "Invalid input data"}

常见用途

- 替代 ResponseEntity：如果不需要复杂响应体，直接用 @ResponseStatus 更简洁。 - 统一异常处理 ：结合 @ControllerAdvice 或自定义异常，规范全局错误码。 - RESTful 设计 ：比如 201 Created 用于资源创建，204 No Content 用于删除操作。

注意事项

- 如果同时使用 @ResponseStatus 和 ResponseEntity，后者会覆盖前者的状态码。 - Spring 5 以后， reason 支持通过占位符动态解析（如 reason = "{error.user.notfound}"）。 -------------------------------------------------------------------------------- 总结：@ResponseStatus 是一种声明式定义 HTTP 响应状态码的方式，让代码更简洁，尤其适合 REST API 开发。