一、SpringMVC注解驱动开发

image.png

1、基于Servlet3.0的环境搭建

1.1、导入坐标

  1. <properties>
  2. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  3. <maven.compiler.source>1.8</maven.compiler.source>
  4. <maven.compiler.target>1.8</maven.compiler.target>
  5. </properties>
  6. <dependencies>
  7. <dependency>
  8. <groupId>org.springframework</groupId>
  9. <artifactId>spring-context</artifactId>
  10. <version>5.1.6.RELEASE</version>
  11. </dependency>
  12. <dependency>
  13. <groupId>org.springframework</groupId>
  14. <artifactId>spring-webmvc</artifactId>
  15. <version>5.1.6.RELEASE</version>
  16. </dependency>
  17. <dependency>
  18. <groupId>javax.servlet</groupId>
  19. <artifactId>javax.servlet-api</artifactId>
  20. <version>3.0.1</version>
  21. <scope>provided</scope>
  22. </dependency>
  23. <dependency>
  24. <groupId>javax.servlet.jsp</groupId>
  25. <artifactId>javax.servlet.jsp-api</artifactId>
  26. <version>2.3.1</version>
  27. <scope>provided</scope>
  28. </dependency>
  29. <dependency>
  30. <groupId>log4j</groupId>
  31. <artifactId>log4j</artifactId>
  32. <version>1.2.17</version>
  33. </dependency>
  34. <!--导入jackson坐标-->
  35. <dependency>
  36. <groupId>com.fasterxml.jackson.core</groupId>
  37. <artifactId>jackson-core</artifactId>
  38. <version>2.9.0</version>
  39. </dependency>
  40. <dependency>
  41. <groupId>com.fasterxml.jackson.core</groupId>
  42. <artifactId>jackson-databind</artifactId>
  43. <version>2.9.0</version>
  44. </dependency>
  45. <dependency>
  46. <groupId>com.fasterxml.jackson.core</groupId>
  47. <artifactId>jackson-annotations</artifactId>
  48. <version>2.9.0</version>
  49. </dependency>
  50. </dependencies>

1.2、编写控制器

  1. @Controller
  2. public class HelloController {
  3. @RequestMapping("/hello")
  4. public String sayHello(){
  5. System.out.println("控制器方法执行了");
  6. return "success";
  7. }
  8. }

1.3、Spring的配置类

  1. /**
  2. * Spring的配置类,它替代了applicationContext.xml
  3. */
  4. @Configuration
  5. @ComponentScan(value="com.itheima", // 不需要扫描Controller注解,Controller有专门的配置类来扫描
  6. excludeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class))
  7. public class SpringConfiguration {
  8. }

1.4、SpringMVC的配置类

  1. package config;
  2. /**
  3. * springmvc的配置类,用于替代springmvc.xml配置文件
  4. */
  5. @Configuration
  6. @ComponentScan("com.itheima.web")
  7. @EnableWebMvc // 开启注解MVC的支持,添加内置Bean对象。使用@DateTimeFormat(pattern = "yyyy-MM-dd")时,必须加上@EnableWebMvc
  8. public class SpringMvcConfiguration implements WebMvcConfigurer {
  9. /**
  10. * 添加资源处理规则
  11. * @param registry
  12. */
  13. @Override
  14. public void addResourceHandlers(ResourceHandlerRegistry registry) {
  15. registry.addResourceHandler("/js/**","/images/**","/css/**")
  16. .addResourceLocations("/js/","/images/","/css/")
  17. .resourceChain(true)
  18. .addResolver(new VersionResourceResolver().addContentVersionStrategy("/**"));
  19. }
  20. /**
  21. * 创建视图解析器并存入ioc容器
  22. * @return
  23. */
  24. @Bean
  25. public ViewResolver createViewResolver(){
  26. InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
  27. viewResolver.setPrefix("/WEB-INF/pages/"); // 设置前缀
  28. viewResolver.setSuffix(".jsp"); // 设置后缀
  29. return viewResolver;
  30. }
  31. }

1.5、初始化Spring和SpringMVC容器的配置类

  1. package config;
  2. /**
  3. * 初始化spring和springmvc ioc容器的配置类
  4. * 这是基于servlet3.0规范,这个类执行完成后才会执行Spring和SpringMVC的容器创建
  5. */
  6. public class Config extends AbstractDispatcherServletInitializer {
  7. /**
  8. * 注册字符集过滤器
  9. * @param servletContext
  10. * @throws ServletException
  11. */
  12. @Override
  13. public void onStartup(ServletContext servletContext) throws ServletException {
  14. // 触发父类的onStartup
  15. super.onStartup(servletContext);
  16. // 1.创建字符集过滤器对象
  17. CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
  18. // 2.设置使用的字符集
  19. characterEncodingFilter.setEncoding("UTF-8");
  20. // 3.添加到容器(它不是ioc容器,而是ServletContainer)
  21. FilterRegistration.Dynamic registration = servletContext.addFilter("characterEncodingFilter", characterEncodingFilter);
  22. // 4.添加映射
  23. registration.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST,DispatcherType.FORWARD, DispatcherType.INCLUDE), false,"/*");
  24. //解决跨域的过滤器
  25. // FilterRegistration.Dynamic registration1 = servletContext.addFilter("crossOriginFilter", new CrossOriginFilter());
  26. // registration1.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST,DispatcherType.FORWARD, DispatcherType.INCLUDE), false,"/*");
  27. }
  28. /**
  29. * 创建servlet容器,可以访问servlet容器bean。用于创建springmvc的Ioc容器
  30. * @return
  31. */
  32. @Override
  33. protected WebApplicationContext createServletApplicationContext() {
  34. AnnotationConfigWebApplicationContext acw = new AnnotationConfigWebApplicationContext();
  35. acw.register(SpringMvcConfiguration.class);
  36. return acw;
  37. }
  38. /**
  39. * 用于指定DispatcherServlet的请求映射,访问规则
  40. * @return
  41. */
  42. @Override
  43. protected String[] getServletMappings() {
  44. return new String[]{"/"};
  45. }
  46. /**
  47. * 创建根容器,不能访问servlet容器bean。用于创建spring的ioc容器
  48. * @return 效果:即controller可以调用service,但service不能调用controller。
  49. */
  50. @Override
  51. protected WebApplicationContext createRootApplicationContext() {
  52. AnnotationConfigWebApplicationContext acw = new AnnotationConfigWebApplicationContext();
  53. acw.register(SpringConfiguration.class);
  54. return acw;
  55. }
  56. }

1.6、编写页面

  1. -- index.jsp
  2. <%@page pageEncoding="UTF-8" language="java" contentType="text/html; UTF-8" %>
  3. <html>
  4. <body>
  5. <!--入门案例的请求-->
  6. <a href="${pageContext.request.contextPath}/hello">SpringMVC基于servlet3.0规范纯注解开发的入门</a>
  7. </body>
  8. </html>
  1. -- success.jsp
  2. <%@page pageEncoding="UTF-8" language="java" contentType="text/html; UTF-8" %>
  3. <html>
  4. <body>
  5. <h2>执行成功!</h2>
  6. </body>
  7. </html>

2、入门案例执行过程分析

springmvc就是对servlet的再次封装

2.1、初始化过程分析(P125-P126)

2.1.1Servlet3.0规范加入的内容

  1. /**
  2. * Servlet3.0规范提供的标准接口。
  3. * servlet容器的初始化接口,任何想要使用servlet3.0规范,都必须提供ServletContainerInitializer的实现类
  4. * 而且这个实现类必须放到spring-web-5.1.6.RELEASF.jar下的services中,标注好全限定类名
  5. * 否则servlet3.0规范读取不到这个初始化方法
  6. */
  7. public interface ServletContainerInitializer {
  8. /**
  9. * 启动容器是做一些初始化操作,例如注册Servlet, Filter ,Listener等等。
  10. * @see javax.servlet.annotation.HandlesTypes
  11. * @since Servlet 3.0
  12. */
  13. public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException;
  14. }

image.png

  1. /**
  2. * 用于指定要加载到ServletContainerInitializer接口实现类中的字节码
  3. * @see javax.servlet.ServletContainerInitializer
  4. * @since Servlet 3.0
  5. */
  6. @Target({ElementType.TYPE})
  7. @Retention(RetentionPolicy.RUNTIME)
  8. public @interface HandlesTypes {
  9. /**
  10. * 指定要加载到ServletContainerInitializer实现类的onStartUp方法中类的字节码。
  11. * 字节码可以是接口,抽象类或者普通类。
  12. */
  13. Class[] value();
  14. }

任何要使用Servlet3.0规范且脱离web.xml的配置,在使用时都必须在对应的jar包的META-INF/services 目录创建一个名为javax.servlet.ServletContainerInitializer的文件,文件内容指定具体的ServletContainerInitializer实现类,那么,当web容器启动时就会运行这个初始化器做一些组件内的初始化工作。 image.png
2.2.3、Confifig类中的onStartUp方法**

  1. public class Config extends AbstractDispatcherServletInitializer{
  2. /**
  3. * 添加字符集过滤器
  4. * @param servletContext
  5. * @throws ServletException
  6. */
  7. @Override
  8. public void onStartup(ServletContext servletContext) throws ServletException {
  9. //执行父类的onStartUp();
  10. super.onStartup(servletContext);
  11. //添加字符集过滤器
  12. CharacterEncodingFilter characterEncodingFilter = new
  13. CharacterEncodingFilter();
  14. characterEncodingFilter.setEncoding("UTF-8");
  15. servletContext.addFilter("characterEncodingFilter",characterEncodingFilter);
  16. }
  17. /**
  18. * 创建web的Ioc容器
  19. * @return
  20. */
  21. @Override
  22. protected WebApplicationContext createServletApplicationContext() {
  23. AnnotationConfigWebApplicationContext acw = new
  24. AnnotationConfigWebApplicationContext();
  25. acw.register(SpringMVCConfiguration.class);
  26. return acw;
  27. }
  28. /**
  29. */
  30. @Override
  31. protected String[] getServletMappings() {
  32. return new String[]{"/"};
  33. }
  34. /**
  35. * 创建根容器(非web层的对象容器)
  36. * @return
  37. */
  38. @Override
  39. protected WebApplicationContext createRootApplicationContext() {
  40. AnnotationConfigWebApplicationContext acw = new
  41. AnnotationConfigWebApplicationContext();
  42. acw.register(SpringConfiguration.class);
  43. return acw;
  44. }
  45. }

2.2.4、AbstractDispatcherServletInitializer中的onStartUp方法

  1. public abstract class AbstractDispatcherServletInitializer extends AbstractContextLoaderInitializer {
  2. @Override
  3. public void onStartup(ServletContext servletContext) throws ServletException {
  4. // 执行父类的onStartUp方法
  5. super.onStartup(servletContext);
  6. // 注册DispatcherServlet
  7. registerDispatcherServlet(servletContext);
  8. }
  9. /**
  10. * 注册DispatcherServlet方法
  11. */
  12. protected void registerDispatcherServlet(ServletContext servletContext) {
  13. String servletName = getServletName();
  14. Assert.hasLength(servletName, "getServletName() must not return null or empty");
  15. //创建表现层IoC容器
  16. WebApplicationContext servletAppContext = createServletApplicationContext();
  17. Assert.notNull(servletAppContext, "createServletApplicationContext() must not return null");
  18. //创建DispatcherServlet对象
  19. FrameworkServlet dispatcherServlet = createDispatcherServlet(servletAppContext);
  20. Assert.notNull(dispatcherServlet, "createDispatcherServlet(WebApplicationContext) must not return null");
  21. dispatcherServlet.setContextInitializers(getServletApplicationContextInitializers());
  22. servletContext.addServlet(servletName, dispatcherServlet);
  23. if (registration == null) {
  24. throw new IllegalStateException("Failed to register servlet with name '" + servletName + "'. " + "Check if there is another servlet registered under the same name.");
  25. }
  26. registration.setLoadOnStartup(1);
  27. registration.addMapping(getServletMappings());
  28. registration.setAsyncSupported(isAsyncSupported());
  29. Filter[] filters = getServletFilters();
  30. if (!ObjectUtils.isEmpty(filters)) {
  31. for (Filter filter : filters) {
  32. registerServletFilter(servletContext, filter);
  33. }
  34. }
  35. customizeRegistration(registration);
  36. }
  37. /**
  38. * 创建DispatcherServlet方法
  39. */
  40. protected FrameworkServlet createDispatcherServlet(WebApplicationContext servletAppContext) {
  41. return new DispatcherServlet(servletAppContext);
  42. }
  43. /**
  44. * 设置Servlet的映射
  45. */
  46. protected abstract String[] getServletMappings();
  47. //其余代理略
  48. }

2.2.5、注册DisptatcherServlet

  1. public abstract class AbstractContextLoaderInitializer implements WebApplicationInitializer {
  2. /**
  3. * onStartUp方法,调用注册ContextLoaderListener方法
  4. */
  5. @Override
  6. public void onStartup(ServletContext servletContext) throws ServletException {
  7. registerContextLoaderListener(servletContext);
  8. }
  9. /**
  10. * 创建根容器方法,并注册ContextLoaderListener
  11. */
  12. //创建根容器方法
  13. WebApplicationContext rootAppContext = createRootApplicationContext();
  14. if (rootAppContext != null) {
  15. //创建ContextLoaderListener
  16. ContextLoaderListener listener = new
  17. ContextLoaderListener(rootAppContext);
  18. listener.setContextInitializers(getRootApplicationContextInitializers());
  19. //注册ContextLoaderListener
  20. servletContext.addListener(listener);
  21. }else {
  22. logger.debug("No ContextLoaderListener registered, as " + "createRootApplicationContext() did not return an application context");
  23. }
  24. }
  25. //其余代码略

2.2、时序图

image.png
image.png

2.3、官方流程图

image.png

二、常用注解说明

1、基础注解

1.1、@Controller

1.1.1、源码

  1. /**
  2. * 此注解用用于修饰表现层控制器的注解
  3. */
  4. @Target({ElementType.TYPE})
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. @Component
  8. public @interface Controller {
  9. /**
  10. * 用于指定存入IOC容器是Bean的唯一标识
  11. */
  12. @AliasFor(annotation = Component.class)
  13. String value() default "";
  14. }

1.1.2、示例

  1. // 默认以短类名helloController作为Bean的ID存入容器中
  2. @Controller
  3. public class HelloController {
  4. }

1.2、@RequesetMapping

1.2.1、源码

  1. /**
  2. * 作用:
  3. * 用于建立请求URL和处理请求方法之间的对应关系。
  4. * 注意:
  5. * 属性只要出现2个或以上时,他们的关系是与的关系。表示必须同时满足条件。
  6. * 出现位置:
  7. * 1、写在类上
  8. * 请求URL的第一级访问目录。此处不写的话,就相当于应用的根目录。
  9. * 它出现的目的是为了使我们的URL可以按照模块化管理,使我们的URL更加精细:
  10. * 例如:
  11. * 账户模块:
  12. * /account/add
  13. * /account/update
  14. * /account/delete
  15. * ...
  16. * 订单模块:
  17. * /order/add
  18. * /order/update
  19. * /order/delete
  20. * 2、方法上:
  21. * 请求URL的第二级访问目录。
  22. */
  23. @Target({ElementType.METHOD, ElementType.TYPE})
  24. @Retention(RetentionPolicy.RUNTIME)
  25. @Documented
  26. @Mapping
  27. public @interface RequestMapping {
  28. /**
  29. * name:给请求URL提供一个名称。
  30. */
  31. String name() default "";
  32. /**
  33. * value:用于指定请求的URL。它和path属性的作用是一样的。
  34. * 细节:在配置此属性时,写不写/都是可以的。
  35. */
  36. @AliasFor("path")
  37. String[] value() default {};
  38. /**
  39. * 它是4.2版本中加入的注解,和value属性是一样的。
  40. * @since 4.2
  41. */
  42. @AliasFor("value")
  43. String[] path() default {};
  44. /**
  45. * method:用于指定请求的方式。它支持以下这些类型:
  46. * GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.
  47. * 这些值是通过RequestMethod枚举指定的。
  48. */
  49. RequestMethod[] method() default {};
  50. /**
  51. * params:用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的key和value必须
  52. * 和配置的一模一样。
  53. * 例如:
  54. * params = {"accountName"},表示请求参数必须有accountName
  55. * params = {"moeny!100"},表示请求参数中money不能是100。
  56. */
  57. String[] params() default {};
  58. /**
  59. * headers:用于指定限制请求消息头的条件。
  60. * 例如:
  61. * RequestMapping(value = "/something", headers = "content-type=text/*")
  62. */
  63. String[] headers() default {};
  64. /**
  65. * consumes:用于指定可以接收的请求正文类型(MIME类型)
  66. * 例如:
  67. * consumes = "text/plain"
  68. * consumes = {"text/plain", "application/*"}
  69. */
  70. String[] consumes() default {};
  71. /**
  72. * produces:用于指定可以生成的响应正文类型。(MIME类型)
  73. * 例如:
  74. * produces = "text/plain"
  75. * produces = {"text/plain", "application/*"}
  76. * produces = MediaType.APPLICATION_JSON_UTF8_VALUE
  77. */
  78. String[] produces() default {};
  79. }

image.png
1.2.2、示例

  1. /**
  2. * RequestMapping注解讲解的控制器
  3. */
  4. @Controller
  5. @RequestMapping("/springmvc")
  6. public class RequestMappingController {
  7. /**
  8. * 用于处理请求的方法。除了name,其他条件都是"与"的关系,只要一个不满足,请求就会失败。
  9. * 比如设置headers = {"Accept-Encoding1"},请求就会失败。因为请求头不含有Accept-Encoding1
  10. * @return
  11. */
  12. @RequestMapping(value = "/useRequestMapping", name = "使用RequestMapping注解的请求映射",
  13. method = RequestMethod.GET, params = {"name"}, headers = {"Accept-Encoding"})
  14. // @PostMapping(value = "useRequestMapping", name = "使用RequestMapping注解的请求映射",
  15. // params = {"name"}, headers = {"Accept-Encoding"})
  16. public String useRequestMapping(){
  17. System.out.println("使用RequestMapping注解");
  18. return "success";
  19. }
  20. }
  1. <%@page contentType="text/html; UTF-8" language="java" pageEncoding="UTF-8" %>
  2. <html>
  3. <body>
  4. <!--RequestMapping注解的使用-->
  5. <a href="springmvc/useRequestMapping?name1">RequestMapping注解的使用</a>
  6. <form action="springmvc/useRequestMapping" method="post">
  7. <input type="text" name="name1" value="123">
  8. <input type="submit" value="RequestMapping注解的使用 Post方式请求">
  9. </form>
  10. <hr/>
  11. <a href="${pageContext.request.contextPath}/springmvc/useRequestMapping?name">RequestMapping注解的使用</a>
  12. <form action="${pageContext.request.contextPath}/springmvc/useRequestMapping" method="post">
  13. <input type="text" name="name" value="123">
  14. <input type="submit" value="RequestMapping注解的使用 Post方式请求">
  15. </form>
  16. </body>
  17. </html>

使用细节一:
image.png
使用细节二:
image.png
1.2.4、衍生注解@GetMapping@PostMapping@PutMapping@DeleteMapping

  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @RequestMapping(method = RequestMethod.GET)
  5. public @interface GetMapping {
  6. //属性略
  7. }
  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @RequestMapping(method = RequestMethod.GET)
  5. public @interface GetMapping {
  6. //属性略
  7. }
  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @RequestMapping(method = RequestMethod.PUT)
  5. public @interface PutMapping {
  6. //属性略
  7. }
  1. @Target(ElementType.METHOD)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @RequestMapping(method = RequestMethod.DELETE)
  5. public @interface DeleteMapping {
  6. //属性略
  7. }

1.3、@RequestParam

Spring可以接收多种多样的数据类型,但表单能够提供的数据类型只有三种:String(或其他基本数据类型)、String数组文件。针对对象、集合等数据类型需要进行请求参数的封装。封装到list集合需要指定集合中的索引,要封装到map集合里面就需要指定map的key

1.3.1 说明

  1. /**
  2. * 此注解是从请求正文中获取请求参数,给控制器方法形参赋值的。
  3. * 当请求参数的名称和控制器方法形参变量名称一致时,无须使用此注解。
  4. * 同时,当没有获取到请求参数时,此注解还可以给控制器方法形参提供默认值。
  5. * 注意:
  6. * 它只能出现在方法的参数上
  7. */
  8. @Target(ElementType.PARAMETER)
  9. @Retention(RetentionPolicy.RUNTIME)
  10. @Documented
  11. public @interface RequestParam {
  12. /**
  13. * 用于指定获取请求参数的名称。它和name属性的作用是一样的,
  14. */
  15. @AliasFor("name")
  16. String value() default "";
  17. /**
  18. * 它是在4.2版本中加入的。和value属性互为引用。
  19. * @since 4.2
  20. */
  21. @AliasFor("value")
  22. String name() default "";
  23. /**
  24. * 指定参数是否必须有值。当为true时,参数没有值会报错。
  25. */
  26. boolean required() default true;
  27. /**
  28. * 在参数没有值时的默认值。
  29. */
  30. String defaultValue() default ValueConstants.DEFAULT_NONE;
  31. }

P132

  1. public class Config extends AbstractDispatcherServletInitializer {
  2. /**
  3. * 注册字符集过滤器
  4. * @param servletContext
  5. * @throws ServletException
  6. */
  7. @Override
  8. public void onStartup(ServletContext servletContext) throws ServletException {
  9. //触发父类的onStartup
  10. super.onStartup(servletContext);
  11. //1.创建字符集过滤器对象
  12. CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
  13. //2.设置使用的字符集
  14. characterEncodingFilter.setEncoding("UTF-8");
  15. //3.添加到容器(它不是ioc容器,而是ServletContainer)
  16. FilterRegistration.Dynamic registration = servletContext.addFilter("characterEncodingFilter",characterEncodingFilter);
  17. //4.添加映射
  18. registration.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST,DispatcherType.FORWARD,DispatcherType.INCLUDE), false,"/*");
  19. }
  20. }

1.3.2 基本类型和String类型的封装

image.png

1.3.3 实体类类型的封装

表单元素的属性和实体类中的属性名称必须对应,不是实体类声明的变量,而是匹配赋值的set方法名称。
image.png

1.3.4 RequestParam注解的使用

1、解决controller中的参数名称与请求提供的名称(表单属性)不一致的问题
2、给controller中的参数加个默认值

  1. /**
  2. * RequestParam注解的使用
  3. * @param page
  4. * @return
  5. * 1、若请求中的参数名称与controller的形参名称不一致,同时未设置@RequestParam映射,则请求接口报错
  6. * 2、value:在请求中匹配currentPage这个名称,若能够找到,则将请求中该名称的值赋值给controller的形参page;
  7. * 若找不到,同时未设置defaultValue,则请求接口报错,若设置有defaultValue,则将defaultValue的值赋值给形参page
  8. * 3、defaultValue:若利用currentPage在请求中匹配不到数据,则将默认值66赋值给形参page
  9. * 当请求参数时基本数据类型或string,入参的参数名称与控制器方法的形参名称不一致时,@RequestParam可以实现绑定的操作
  10. * 从而实现从请求参数中获取指定名称的数据给控制器方法的形参赋值,来保证我们的形参能够拿到值
  11. * 4、当控制器方法的形参没有值或从请求参数中获取不到值,@RequestParam可以提供默认值(分页功能)
  12. * 5、required:若没有数据,而又设置为true,则报错
  13. */
  14. @RequestMapping("/useRequestParam")
  15. public String useRequestParam(@RequestParam(value = "currentPage", defaultValue = "66") int page){
  16. System.out.println("当前页是:" + page);
  17. return "success";
  18. }

场景一:请求提供的参数名称与value名称一致,且设置有默认值,controller的形参名称值为请求值
image.png
场景二:请求提供的参数名称与value名称不一致,且设置有默认值,controller的形参名称值为默认值
image.png
场景三:请求提供的参数名称与value名称不一致,但与controller形参名称一致,且设置有默认值,controller的形参名称值为默认值
image.png
场景四:请求提供的参数名称与value名称不一致,且未设置有默认值,访问接口报错
image.png
场景五:请求提供的参数名称与value名称不一致,但与controller形参名称一致,且未设置有默认值,访问接口报错
image.png

1.4、@lnitBinder

Springmvc默认没有对Date进行转换,会导致接口请求异常

  1. <!--InitBinder注解的使用-->
  2. <form action="useInitBinder" method="post">
  3. 用户名:<input type="text" name="username"><br/>
  4. 密码:<input type="text" name="password"><br/>
  5. 年龄:<input type="text" name="age"><br/>
  6. 性别:<input type="text" name="gender"><br/>
  7. 生日:<input type="text" name="birthday"><br/>
  8. <input type="submit" value="提交">
  9. </form>
  10. <hr/>
  1. @RequestMapping("/useInitBinder")
  2. public String useInitBinder(User user){
  3. System.out.println("user is " + user);
  4. return "success";
  5. }

image.png
1.4.1、说明

  1. /**
  2. * 用于初始化表单请求参数的数据绑定器。
  3. */
  4. @Target({ElementType.METHOD})
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. public @interface InitBinder {
  8. /**
  9. * 指定给哪些参数进行绑定操作。
  10. */
  11. String[] value() default {};
  12. }

1.4.2、示例

  1. // 用户实体类
  2. @Data
  3. @ToString
  4. public class User implements Serializable {
  5. private Integer id;
  6. private String username;
  7. private String password;
  8. private Integer age;
  9. private String gender;
  10. private Date birthday;
  11. }
  1. <form action="${pageContext.request.contextPath}/saveUser" method="post">
  2. 用户名:<input type="text" name="username"></br>
  3. 密码:<input type="text" name="password"></br>
  4. 年龄:<input type="text" name="age"></br>
  5. 生日:<input type="text" name="birthday"></br>
  6. 性别:<input type="radio" name="gender" value="男">男
  7. <input type="radio" name="gender" value="女">女</br>
  8. <input type="submit" value="提交">
  9. </form>
  1. // InitBinder注解的使用,只能对当前controller起作用
  2. @Controller
  3. public class InitBinderController {
  4. @RequestMapping("/useInitBinder")
  5. public String useInitBinder(User user){
  6. System.out.println("user is " + user);
  7. return "success";
  8. }
  9. /**
  10. * @param dataBinder:用户自定义的格式化器
  11. *
  12. * @InitBinder可以实现初始化数据转换器,比如WebDataBinder
  13. * 若未指定value,则对所有参数都实现绑定操作;也可以使用value对某些参数实现绑定操作
  14. * @InitBinder只能对当前controller的参数起作用,不能对其他controller起作用
  15. */
  16. // 指定给user、product对象做绑定;若没有指定,则对所有对象进行绑定操作
  17. @InitBinder(value = {"user", "product"})
  18. public void initBinder(WebDataBinder dataBinder){
  19. dataBinder.addCustomFormatter(new DateFormatter("yyyy-MM-dd"));
  20. }
  21. }

image.png
1.4.3、扩展注解@DateTimeFormat

  1. // 用户实体类
  2. @Data
  3. @ToString
  4. public class User implements Serializable {
  5. private Integer id;
  6. private String username;
  7. private String password;
  8. private Integer age;
  9. private String gender;
  10. // 可以对Date进行转换,但需要在主配置文件上添加注解@EnableWebMvc,开启注解MVC的支持,添加内置Bean对象
  11. @DateTimeFormat(pattern = "yyyy-MM-dd")
  12. private Date birthday;
  13. }

1.5、@ControllerAdvice

1.5.1、说明
执行控制器方法之前,指定需要执行的操作(比如:数据格式转换)。

  1. /**
  2. * 用于给控制器提供一个增强的通知。
  3. * 以保证可以在多个控制器之间实现增强共享。
  4. * 它可以配合以下三个注解来用:
  5. * {@link exceptionhandler@exceptionhandler} :处理全局异常
  6. * {@link initbinder@initbinder} :初始化数据绑定器
  7. * {@link modeltattribute@modeltattribute}
  8. */
  9. @Target(ElementType.TYPE)
  10. @Retention(RetentionPolicy.RUNTIME)
  11. @Documented
  12. @Component
  13. public @interface ControllerAdvice { // 控制器的通知
  14. /**
  15. * 用于指定对哪些包下的控制器进行增强
  16. *
  17. */
  18. @AliasFor("basePackages")
  19. String[] value() default {};
  20. /**
  21. * 它是4.0版本新加入的属性,作用和value是一样的。
  22. * @since 4.0
  23. * 若未指定basePackages,则对所有的controller都增强一次
  24. */
  25. @AliasFor("value")
  26. String[] basePackages() default {};
  27. /**
  28. * 它是4.0新加入的注解,可以通过指定类的字节码的方式来指定增强作用范围。
  29. * @since 4.0
  30. */
  31. Class<?>[] basePackageClasses() default {};
  32. /**
  33. * 它是4.0新加入的注解,用于指定特定的类型提供增强。
  34. * @since 4.0
  35. */
  36. Class<?>[] assignableTypes() default {};
  37. /**
  38. * 它是4.0新加入的注解,用于指定给特定注解提供增强。
  39. * @since 4.0
  40. */
  41. Class<? extends Annotation>[] annotations() default {};
  42. }

1.5.2、示例

  1. // 若未指定basePackages,则对所有的controller都增强一次
  2. @ControllerAdvice(basePackageClasses = InitBinderController.class)
  3. public class InitBinderAdvice {
  4. /**
  5. * 初始化数据绑定器
  6. * @param dataBinder
  7. */
  8. // @InitBinder只能对当前controller的参数起作用,不能对其他controller起作用
  9. // 配合@ControllerAdvice可以解决对其他controller增强的作用
  10. @InitBinder("user")
  11. public void dateBinder(WebDataBinder dataBinder){
  12. dataBinder.addCustomFormatter(new DateFormatter("yyyy-MM-dd"));
  13. }
  14. }
  1. /**
  2. * 自定义类型转换器
  3. */
  4. @Component
  5. public class StringToDateConverter implements Converter<String,Date>{
  6. @Override
  7. public Date convert(String source) {
  8. //1.判断来源是否有值
  9. if (StringUtils.isEmpty(source)) {
  10. throw new NullPointerException("Source can not be null!");
  11. }
  12. try{
  13. //2.定义转换器
  14. DateFormat format = new SimpleDateFormat("yyyy-MM-dd");
  15. //3.转换并返回
  16. return format.parse(source);
  17. }catch (Exception e){
  18. e.printStackTrace();
  19. }
  20. return null;
  21. }
  22. }
  1. /**
  2. * 控制器的通知
  3. */
  4. @ControllerAdvice
  5. public class InitBinderAdvice {
  6. @Autowired
  7. private StringToDateConverter stringToDateConverter;
  8. /**
  9. * 初始化数据绑定器
  10. * @param dataBinder
  11. */
  12. @InitBinder
  13. public void initBinder(WebDataBinder dataBinder){
  14. //1.获取转换服务对象
  15. ConversionService conversionService = dataBinder.getConversionService();
  16. //2.判断conversionService是否为GenericConversionService类型
  17. if(conversionService instanceof GenericConversionService){
  18. //3.强转
  19. GenericConversionService genericConversionService = (GenericConversionService)conversionService;
  20. //4.添加类型转换器
  21. genericConversionService.addConverter(stringToDateConverter);
  22. }
  23. dataBinder.addCustomFormatter(new DateFormatter("yyyy-MM-dd"));
  24. }
  25. }

1.6、@RequestHeader

1.6.1、说明

  1. /**
  2. * 此注解是从请求消息头中获取消息头的值,并把值赋给控制器方法形参。
  3. * 注意:
  4. * 它只能出现在方法的参数上
  5. */
  6. @Target(ElementType.PARAMETER)
  7. @Retention(RetentionPolicy.RUNTIME)
  8. @Documented
  9. public @interface RequestHeader {
  10. /**
  11. * 用于指定请求消息头的名称。它和name属性作用一样。
  12. */
  13. @AliasFor("name")
  14. String value() default "";
  15. /**
  16. * 它是4.2版本引入的。和value属性互为引用。
  17. * @since 4.2
  18. */
  19. @AliasFor("value")
  20. String name() default "";
  21. /**
  22. * 用于指定是否必须有此消息头。当取默认值时,没有此消息头会报错。
  23. */
  24. boolean required() default true;
  25. /**
  26. * 用于指定消息头的默认值。
  27. */
  28. String defaultValue() default ValueConstants.DEFAULT_NONE;
  29. }

场景一:存在requestHeader
image.png
image.png
场景二:不存在requestHeader,同时设置有默认值
image.png
场景三:不存在requestHeader,同时未设置默认值,且required = true
image.png
1.6.3、示例

  1. <!--RequestHaderCookieValue注解的使用-->
  2. <a href="useRequestHeader">RequestHeader注解的使用</a>
  1. @RequestMapping("/useRequestHeader")
  2. public String useRequestHeader(@RequestHeader(value = "Tccept-Language",
  3. required = false,
  4. defaultValue = "test")
  5. String header){
  6. System.out.println("Accept-Language:" + header);
  7. return "success";
  8. }

1.7、@CookieValue

1.7.1、说明

  1. /**
  2. * 此注解是从请求消息头中获取Cookie的值,并把值赋给控制器方法形参。
  3. * 注意:
  4. * 它只能出现在方法的参数上
  5. */
  6. @Target(ElementType.PARAMETER)
  7. @Retention(RetentionPolicy.RUNTIME)
  8. @Documented
  9. public @interface CookieValue {
  10. /**
  11. * 用于指定cookie的名称
  12. */
  13. @AliasFor("name")
  14. String value() default "";
  15. /**
  16. * 它是4.2版本引入的。和value属性互为引用。
  17. * @since 4.2
  18. */
  19. @AliasFor("value")
  20. String name() default "";
  21. /**
  22. * 用于指定是否必须有此消息头。当取默认值时,没有此消息头会报错。
  23. */
  24. boolean required() default true;
  25. /**
  26. * 用于指定消息头的默认值。
  27. */
  28. String defaultValue() default ValueConstants.DEFAULT_NONE;
  29. }

image.png
image.png
1.7.2、示例

  1. <!--RequestHaderCookieValue注解的使用-->
  2. <a href="useRequestHeader">RequestHeader注解的使用</a>
  3. <br/>
  4. <a href="useCookieValue">CookieValue注解的使用</a>
  5. <hr/>
  1. @Controller
  2. public class CookieValueController {
  3. @RequestMapping("/useCookieValue")
  4. public String useCookieValue(@CookieValue(value="JSESSIONID",required=false)
  5. String cookieValue){
  6. System.out.println(cookieValue);
  7. return "success";
  8. }
  9. }

1.8、@ModelAttribute

1.8.1、说明

  1. /**
  2. * 它可以用于修饰方法,或者是参数。
  3. * 当修饰方法时,表示执行控制器方法之前,被此注解修饰的方法都会执行。
  4. * 当修饰参数时,用于获取指定的数据给参数赋值。。
  5. */
  6. @Target({ElementType.PARAMETER, ElementType.METHOD})
  7. @Retention(RetentionPolicy.RUNTIME)
  8. @Documented
  9. public @interface ModelAttribute {
  10. /**
  11. * 当注解写在方法上,则表示存入时的名称。(值是方法的返回值)
  12. * 当注解写在参数上,可以从ModelMap、Model、Map中的获取数据。(前提是之前存入过)
  13. * 指定的是存入时的key。
  14. */
  15. @AliasFor("name")
  16. String value() default "";
  17. /**
  18. * 它和value的作用是一样的。
  19. */
  20. @AliasFor("value")
  21. String name() default "";
  22. /**
  23. * 用于指定是否支持数据绑定。它是4.3版本中新加入的属性。
  24. * @since 4.3
  25. */
  26. boolean binding() default true;
  27. }

方式一:
image.png
方式二:
image.png
1.8.2、示例

  1. @Controller
  2. public class ModelAttributeController {
  3. /**
  4. * 被ModelAttribute修饰的方法
  5. * @param username
  6. */
  7. @ModelAttribute("username")
  8. public String showModel(String username) {
  9. System.out.println("执行了showModel方法" + username);
  10. name = name + "aaa";
  11. return name;
  12. }
  13. /**
  14. * 接收请求的方法
  15. * @param username
  16. * @return
  17. */
  18. @RequestMapping("/testModelAttribute")
  19. public String testModelAttribute(@ModelAttribute("username") String username) {
  20. System.out.println("执行了控制器的方法" + username);
  21. return "success";
  22. }
  23. }

1.9、@SessionAttribute和@SessionAttributes

1.9.1、说明

  1. /**
  2. * 此注解是用于让开发者和ServletAPI进行解耦。
  3. * 让开发者可以无需使用HttpSession的getAttribute方法即可从会话域中获取数据。
  4. */
  5. @Target(ElementType.PARAMETER)
  6. @Retention(RetentionPolicy.RUNTIME)
  7. @Documented
  8. public @interface SessionAttribute {
  9. /**
  10. * 用于指定在会话域中数据的名称。
  11. */
  12. @AliasFor("name")
  13. String value() default "";
  14. /**
  15. * 它和value属性互为引用
  16. */
  17. @AliasFor("value")
  18. String name() default "";
  19. /**
  20. * 用于指定是否必须从会话域中获取到数据。默认值是true,表示如果指定名称不存在会报错。
  21. */
  22. boolean required() default true;
  23. }
  1. /**
  2. * 此注解是用于让开发者和ServletAPI进行解耦。
  3. * 通过此注解即可实现把数据存入会话域,而无需在使用HttpSession的setAttribute方法。
  4. * 当我们在控制器方法形参中加入Model或者ModelMap类型参数时,默认是存入请求域的。
  5. * 但当控制器上使用了此注解,就会往会话域中添加数据。
  6. */
  7. @Target({ElementType.TYPE})
  8. @Retention(RetentionPolicy.RUNTIME)
  9. @Inherited
  10. @Documented
  11. public @interface SessionAttributes {
  12. /**
  13. * 指定可以存入会话域中的名称。
  14. */
  15. @AliasFor("names")
  16. String[] value() default {};
  17. /**
  18. * 它是4.2版本中加入的属性。作用和value是一样的。
  19. * @since 4.2
  20. */
  21. @AliasFor("value")
  22. String[] names() default {};
  23. /**
  24. * 指定可以存入会话域中的数据类型。
  25. */
  26. Class<?>[] types() default {};
  27. }

1.9.2、@SessionAttributes:往会话域存入数据
image.png
image.png
1.9.3、@SessionAttributes:从会话域获取数据
image.png
image.png
1.9.4、示例

  1. @Controller
  2. @SessionAttributes(value ={"username","password"},types={Integer.class})
  3. public class SessionAttributesController {
  4. /**
  5. * 把数据存入SessionAttribute
  6. * @param model
  7. * @return
  8. * Model是spring提供的一个接口,该接口有一个实现类ExtendedModelMap
  9. * 该类继承了ModelMap,而ModelMap就是LinkedHashMap子类
  10. */
  11. @RequestMapping("/testPut")
  12. public String testPut(Model model){
  13. model.addAttribute("username", "泰斯特");
  14. model.addAttribute("password","123456");
  15. model.addAttribute("age", 31);
  16. //跳转之前将数据保存到username、password和age中,因为注解@SessionAttribute中有这几个参数
  17. return "success";
  18. }
  19. @RequestMapping("/testGet")
  20. public String testGet(ModelMap model){
  21. System.out.println(model.get("username")+";"+model.get("password")+";"+model.get("age"));
  22. return "success";
  23. }
  24. @RequestMapping("/testClean")
  25. public String complete(SessionStatus sessionStatus){
  26. sessionStatus.setComplete();
  27. return "success";
  28. }
  29. @RequestMapping("/testSessionAttribute")
  30. public String testSessionAttribute(@SessionAttribute("username")String username){
  31. System.out.println("username is "+username);
  32. return "success";
  33. }
  34. }

1.10、@ExceptionHandler

1.10.1、说明

  1. /**
  2. * 用于注释方法,表明当前方法是控制器执行产生异常后的处理方法
  3. * 系统异常、错误异常
  4. */
  5. @Target(ElementType.METHOD)
  6. @Retention(RetentionPolicy.RUNTIME)
  7. @Documented
  8. public @interface ExceptionHandler {
  9. /**
  10. * 指定用于需要捕获的异常类型
  11. */
  12. Class<? extends Throwable>[] value() default {};
  13. }

1.10.2、示例

  1. /**
  2. * ExceptionHandler注解的使用
  3. */
  4. @Controller
  5. public class ExceptionHandlerController {
  6. @RequestMapping("/useExceptionHandler")
  7. public String useExceptionHandler(Integer age)throws Exception{
  8. if(age == null){
  9. throw new NullPointerException();
  10. }
  11. if(age > 100){
  12. throw new CustomerException("年龄不合法!");
  13. }
  14. System.out.println("年龄是:" + age);
  15. return "success";
  16. }
  17. // 当前异常处理器只对当前controller有效
  18. @ExceptionHandler(Exception.class)
  19. public String handleException(Model model, Exception e){
  20. String errorMsg = "";
  21. // 判断Exception的类型是不是CustomerException,若是则执行业务异常
  22. if(e instanceof CustomerException){
  23. errorMsg = e.getMessage();
  24. }else {
  25. // 执行系统异常
  26. errorMsg = "服务器内部错误,请联系管理员!";
  27. }
  28. model.addAttribute("errorMsg", errorMsg);
  29. return "error";
  30. }
  31. }
  1. /**
  2. * 自定义异常(处理业务异常)
  3. */
  4. public class CustomerException extends Exception{
  5. private String message;
  6. public CustomerException(String message){
  7. this.message = message;
  8. }
  9. @Override
  10. public String getMessage() {
  11. return message;
  12. }
  13. }

场景一:执行业务异常
image.png
场景二:执行系统异常
image.png

  1. // 单独声明异常处理器,利用@ControllerAdvice,可以对所有controller起作用
  2. @ControllerAdvice
  3. public class ExceptionHandlerAdvice {
  4. // 当前异常处理器对所有controller有效
  5. @ExceptionHandler(Exception.class)
  6. public String handleException(Model model, Exception e){
  7. String errorMsg = "";
  8. //判断Exception的类型是不是CustomerException
  9. if(e instanceof CustomerException){
  10. errorMsg = e.getMessage();
  11. }else {
  12. //系统异常
  13. errorMsg = "服务器内部错误,请联系管理员!";
  14. }
  15. model.addAttribute("errorMsg",errorMsg);
  16. return "error";
  17. }
  18. }

2、JSON数据交互相关注解

image.png

2.1、@RequestBody

2.1.1、说明

  1. /**
  2. * 用于获取全部的请求体
  3. */
  4. @Target(ElementType.PARAMETER)
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. public @interface RequestBody {
  8. /**
  9. * 用于指定是否必须有请求体。
  10. */
  11. boolean required() default true;
  12. }

image.png
注意点:@RequestBody只是获取全部请求体的内容,而不能将内容转换为JSON,对JSON数据的处理需要用到其他组件
image.png
2.1.2、示例

  1. @Controller
  2. public class RequestBodyController {
  3. /**
  4. * RequestBody注解
  5. * @return
  6. */
  7. @RequestMapping("/useRequestBody")
  8. public String useRequestBody(@RequestBody(required=false) String body){
  9. System.out.println(body);
  10. return "success";
  11. }
  12. }

2.2、@ResponseBody

2.2.1、说明

  1. /**
  2. * 用于用流输出响应正文
  3. * 可以写到方法上、方法前(public字段后),代表这个方法的返回值用流的形式输出到浏览器上
  4. * 可以写到类上,表示当前类中所有方法的返回值均采用流的形式输出到浏览器上
  5. */
  6. @Target({ElementType.TYPE, ElementType.METHOD})
  7. @Retention(RetentionPolicy.RUNTIME)
  8. @Documented
  9. public @interface ResponseBody {
  10. }

image.png
2.2.2、示例

  1. @Controller
  2. public class ResponseBodyController {
  3. /**
  4. * 控制器方法
  5. * @param name
  6. * @return
  7. */
  8. @RequestMapping("useResponseBody")
  9. public @ResponseBody String useResponseBody(String name){
  10. return "success";
  11. }
  12. }

2.3、@RestController

2.3.1、说明

  1. /**
  2. * 它具备@Controller注解的全部功能,同时多了一个@ResponseBody注解的功能
  3. */
  4. @Target(ElementType.TYPE)
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. @Controller
  8. @ResponseBody
  9. public @interface RestController {
  10. /**
  11. * 用于指定存入ioc容器时bean的唯一标识。
  12. * @since 4.0.1
  13. */
  14. @AliasFor(annotation = Controller.class)
  15. String value() default "";
  16. }

2.3.2、示例

  1. @RestController
  2. public class RestHelloController {
  3. /**
  4. * 控制器方法
  5. * @return
  6. */
  7. @RequestMapping("resthello")
  8. public String sayHello(){
  9. return "success";
  10. }
  11. }

2.4、@RestControllerAdvice

2.4.1、说明

  1. /**
  2. * 它和@ControllerAdvice注解的作用一样,并且支持@ResponseBody的功能
  3. */
  4. @Target(ElementType.TYPE)
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. @ControllerAdvice
  8. @ResponseBody
  9. public @interface RestControllerAdvice {
  10. @AliasFor("basePackages")
  11. String[] value() default {};
  12. @AliasFor("value")
  13. String[] basePackages() default {};
  14. Class<?>[] basePackageClasses() default {};
  15. Class<?>[] assignableTypes() default {};
  16. Class<? extends Annotation>[] annotations() default {};
  17. }

2.4.2、示例

  1. @RestControllerAdvice
  2. public class ExceptionHandlerAdvice {
  3. @ExceptionHandler(Exception.class)
  4. public String handleException(Exception e){
  5. System.err.println(e.getMessage());
  6. return "error";
  7. }
  8. }

3、Rest风格URL请求相关注解

image.png

3.1、@PathVariable

3.1.1、说明

  1. /**
  2. * 它是springmvc框架支持rest风格url的标识。
  3. * 它可以用于获取请求url映射中占位符对应的值。
  4. * 若不使用PathVariable,即使名称一致,也不会获取到对应的值
  5. */
  6. @Target(ElementType.PARAMETER)
  7. @Retention(RetentionPolicy.RUNTIME)
  8. @Documented
  9. public @interface PathVariable {
  10. /**
  11. * 指定url映射中占位符的名称
  12. */
  13. @AliasFor("name")
  14. String value() default "";
  15. /**
  16. * 它是4.3.3版本新加入的属性。作用和value是一样的。
  17. * @since 4.3.3
  18. */
  19. @AliasFor("value")
  20. String name() default "";
  21. /**
  22. * 它是4.3.3版本新加入的属性,用于指定是否必须有此占位符。当取默认值时,没有会报错。
  23. * @since 4.3.3
  24. */
  25. boolean required() default true;
  26. }

3.1.2、示例

  1. /**
  2. * PathVariable注解的讲解
  3. */
  4. @Controller
  5. @ResponseBody
  6. @RequestMapping("/user")
  7. public class PathVariableController {
  8. /**
  9. * PathVariable注解
  10. * @return
  11. */
  12. @RequestMapping("/usePathVariable/{id}")
  13. public String usePathVariable(@PathVariable("id") Integer id){
  14. System.out.println(id);
  15. return "success";
  16. }
  17. /**
  18. * 保存方法
  19. * @param user
  20. * @return
  21. */
  22. @RequestMapping(method = RequestMethod.POST)
  23. public String save(@RequestBody User user){
  24. System.out.println("user is "+user);
  25. return "success";
  26. }
  27. /**
  28. * 更新方法
  29. * @param id
  30. * @param user
  31. * @return
  32. */
  33. @RequestMapping(method = RequestMethod.PUT, value = "/{id}")
  34. public String update(@PathVariable Integer id, User user){
  35. //1.给user的id赋值
  36. user.setId(id);
  37. //2.输出
  38. System.out.println("user is " + user);
  39. return "success";
  40. }
  41. /**
  42. * 删除方法,获取url上的userId赋值给形参id
  43. * @param id
  44. * @return
  45. */
  46. @RequestMapping(method = RequestMethod.DELETE, value = "/{userId}")
  47. public String delete(@PathVariable("userId") Integer id){
  48. System.out.println("删除用户的Id是:"+ id);
  49. return "success";
  50. }
  51. /**
  52. * 根据id查询
  53. * @param id
  54. * @return
  55. */
  56. @RequestMapping(method = RequestMethod.GET,value = "/{id}")
  57. public String findById(@PathVariable("id") Integer id){
  58. System.out.println("查询用户的Id是:" + id);
  59. return "success";
  60. }
  61. }

image.png

4、跨域访问

4.1、关于跨域访问

跨域访问即跨站 HTTP 请求(Cross-site HTTP request),它是指发起请求的资源所在域不同于该请求所指向资源所在的域的 HTTP 请求。
比如说,域名A(http://www.itheima.example)的某 Web 应用程序中通过标签引入了域名 B(http://www.itheima.foo)站点的某图片资源(http://www.itheima.foo/image.jpg),域名A的那 Web 应用就会导致浏览器发起一个跨站 HTTP 请求。在当今的 Web 开发中,使用跨站 HTTP 请求加载各类资源(包括CSS、图片、JavaScript 脚本以及其它类资源),已经成为了一种普遍且流行的方式。

  1. /* 允许跨域的主机地址 */
  2. response.setHeader("Access-Control-Allow-Origin", "*");
  3. /* 允许跨域的请求方法GET, POST, HEAD 等 */
  4. response.setHeader("Access-Control-Allow-Methods", "*");
  5. /* 重新预检验跨域的缓存时间 (s) */
  6. response.setHeader("Access-Control-Max-Age", "3600");
  7. /* 允许跨域的请求头 */
  8. response.setHeader("Access-Control-Allow-Headers", "*");
  9. /* 是否携带cookie */
  10. response.setHeader("Access-Control-Allow-Credentials", "true");

4.1、@CrossOrigin

4.1.1、说明

  1. /**
  2. * 此注解用于指定是否支持跨域访问
  3. */
  4. @Target({ ElementType.METHOD, ElementType.TYPE })
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. public @interface CrossOrigin {
  8. /** @deprecated as of Spring 5.0, in favor of {@link
  9. CorsConfiguration#applyPermitDefaultValues} */
  10. @Deprecated
  11. String[] DEFAULT_ORIGINS = { "*" };
  12. /** @deprecated as of Spring 5.0, in favor of {@link
  13. CorsConfiguration#applyPermitDefaultValues} */
  14. @Deprecated
  15. String[] DEFAULT_ALLOWED_HEADERS = { "*" };
  16. /** @deprecated as of Spring 5.0, in favor of {@link
  17. CorsConfiguration#applyPermitDefaultValues} */
  18. @Deprecated
  19. boolean DEFAULT_ALLOW_CREDENTIALS = false;
  20. /** @deprecated as of Spring 5.0, in favor of {@link
  21. CorsConfiguration#applyPermitDefaultValues} */
  22. @Deprecated
  23. long DEFAULT_MAX_AGE = 1800;
  24. /**
  25. * 它和origins属性一样
  26. */
  27. @AliasFor("origins")
  28. String[] value() default {};
  29. /**
  30. * 所有支持域的集合,例如"http://domain1.com"。
  31. * <p>这些值都显示在请求头中的Access-Control-Allow-Origin
  32. * "*"代表所有域的请求都支持
  33. * <p>如果没有定义,所有请求的域都支持
  34. * @see #value
  35. */
  36. @AliasFor("value")
  37. String[] origins() default {};
  38. /**
  39. * 允许请求头中的header,默认都支持
  40. */
  41. String[] allowedHeaders() default {};
  42. /**
  43. * 响应头中允许访问的header,默认为空
  44. */
  45. String[] exposedHeaders() default {};
  46. /**
  47. * 用于指定支持的HTTP请求方式列表
  48. */
  49. RequestMethod[] methods() default {};
  50. /**
  51. * 是否允许cookie随请求发送,使用时必须指定具体的域
  52. */
  53. String allowCredentials() default "";
  54. /**
  55. * 预请求的结果的有效期
  56. * 默认值是:1800秒 (30分钟).
  57. */
  58. long maxAge() default -1;
  59. }

4.1.2、示例

  1. @RestController
  2. @CrossOrigin
  3. public class CrossOriginController {
  4. @RequestMapping("/useCrossOrigin")
  5. public String useCrossOrigin()throws Exception{
  6. System.out.println("支持跨域访问");
  7. return "success";
  8. }
  9. }

5、注解总结

  1. 1、用于配置控制器
  2. @Controller
  3. @RestController
  4. 2、用于提供方法映射的
  5. @RequestMapping
  6. @GetMapping
  7. @PostMapping
  8. @PutMapping
  9. @DeleteMapping
  10. @PatchMapping
  11. 3、用于增强控制器方法的
  12. @ModelAttribute
  13. @ExceptionHandler
  14. @InitBinder
  15. 4、用于给控制器方法提供通知的注解
  16. @ControllerAdive
  17. @RestControllerAdive
  18. 5、用于绑定控制器方法参数的注解
  19. @RequestParam
  20. @RequstBody
  21. @RequestHeader
  22. @CookieValue
  23. @PathVariable
  24. @SessionAttribute
  25. 6、用于改变响应方式的
  26. 响应的方式:转发,重定向,用流输出
  27. @ResponeBody 用流输出的方式
  28. 7、用于在控制器方法提供Model或者ModelMap存入会话域的
  29. @SessionAttribues
  30. 8、用于提供跨域访问
  31. @CrossOrigin

三、SpringMVC中各组件详解及源码分析

1、前端控制器:DispatcherServlet

1.1、作用

用户请求到达前端控制器,它就相当于mvc模式中的c, dispatcherservlet是整个流程控制的中心, 由它调用其它组件处理用户的请求,dispatcherservlet的存在降低了组件之间的耦合性。

1.2、执行过程分析

1.2.1、doService方法
接收到请求首先执行的方法,它就相当于Servlet中的service方法

1.2.2、doDispatche方法
/*
处理请求分发的核心方法
它负责通过反射调用我们的控制器方法
负责执行拦截器
负责处理结果视图
/

2、处理器映射器HandlerMapping

2.1、作用

HandlerMapping负责根据用户请求找到Handler即处理器,SpringMVC提供了不同的映射器实现不
同的映射方式,例如:配置文件方式,实现接口方式,注解方式等。

2.2、RequestMappingHandlerMapping的执行时机

3、处理器适配器HandlerAdapter

3.1、适配器模式

适配器模式就是把一个类的接口变换成客户端所期待的另一种接口,从而使原本因接口原因不匹配而无法一起工作的两个类能够一起工作。适配类可以根据参数返还一个合适的实例给客户端。
通过HandlerAdapter对处理器进行执行,这是适配器模式的应用,通过扩展适配器可以对更多类型的
处理器进行执行。
image.png

3.2、控制器的三种编写方式

3.2.1、Controller注解

  1. /**
  2. * 用于注释控制器类
  3. */
  4. @Target({ElementType.TYPE})
  5. @Retention(RetentionPolicy.RUNTIME)
  6. @Documented
  7. @Component
  8. public @interface Controller {
  9. //指定存入ioc容器中bean的唯一标识
  10. @AliasFor(annotation = Component.class)
  11. String value() default "";
  12. }

3.3.2、Controller接口

  1. @FunctionalInterface
  2. public interface Controller {
  3. /**
  4. * 用于处理请求并返回ModelAndView
  5. */
  6. @Nullable
  7. ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse
  8. response) throws Exception;
  9. }

3.3.3、HttpRequestHandler接口

  1. @FunctionalInterface
  2. public interface HttpRequestHandler {
  3. /**
  4. * 用于处理器请求,并由使用者提供相应
  5. */
  6. void handleRequest(HttpServletRequest request, HttpServletResponse response)
  7. throws ServletException, IOException;
  8. }

4、视图解析器ViewResovler和View

4.1、View

首先,我们得先了解一下SpringMVC中的视图。视图的作用是渲染模型数据,将模型里的数据以某种形式呈现给客户。 为了实现视图模型和具体实现技术的解耦,Spring在org.springframework.web.servlet包中定义了一个高度抽象的View接口。我们的视图是无状态的,所以他们不会有线程安全的问题。无状态是指对于每一个请求,都会创建一个View对象。
在SpringMVC中常用的视图类型:

分类 视图类型 说明
URL视图 InternalResourceView 将JSP或者其他资源封装成一个视图,是
InternaleResourceViewResolver默认使用的视图类型

JstlView 它是当我们在页面中使用了JSTL标签库的国际化标签后,需要采用的类型。p
文档类视图 AbstractPdfViewc PDF文档视图的抽象类
AbstarctXlsViewc Excel文档视图的抽象类,该类是4.2版本之后才有的。 之前使用的是AbstractExcelView
JSON视图 MappingJackson2JsonView 将模型数据封装成Json格式数据输出。它需要借助 Jackson开源框架
XML视图 MappingJackson2XmlView 将模型数据封装成XML格式数据。它是从4.1版本之后才加入的

4.2、ViewResolver

View Resolver负责将处理结果生成View视图,View Resolver首先根据逻辑视图名解析成物理视图名即具体的页面地址,再生成View视图对象,最后对View进行渲染将处理结果通过页面展示给用户。视图对象是由视图解析器负责实例化。
视图解析器的作用是将逻辑视图转为物理视图,所有的视图解析器都必须实现ViewResolver接口。
SpringMVC为逻辑视图名的解析提供了不同的策略,可以在Spring WEB上下文中配置一种或多种解析
策略,并指定他们之间的先后顺序。每一种映射策略对应一个具体的视图解析器实现类。程序员可以选择一种视图解析器或混用多种视图解析器。可以通过order属性指定解析器的优先顺序,order越小优先级越高,SpringMVC会按视图解析器顺序的优先顺序对逻辑视图名进行解析,直到解析成功并返回视图对象,否则抛出ServletException异常。
image.png

5、请求参数封装的源码分析

5.1、传统表单数据封装原理

5.2、@RequestBody注解执行原理

5.3、@PathVariable注解实现原理

6、拦截器的执行时机和调用过程

6.1、执行流程图

image.png**

6.2、拦截器的执行过程分析

image.png

6.3、拦截器的责任链模式

责任链模式是一种常见的行为模式。它是使多个对象都有处理请求的机会,从而避免请求的发送者和接收者之间的耦合关系。将这些对象串成一条链,并沿着这条链一直传递该请求,直到有对象处理它为止
1、优势:

  • 解耦了请求与处理;
  • 请求处理者(节点对象)只需关注自己感兴趣的请求进行处理即可,对于不感兴趣的请求,直接转发给下一级节点对象;
  • 具备链式传递处理请求功能,请求发送者无需知晓链路结构,只需等待请求处理结果;
  • 链路结构灵活,可以通过改变链路结构动态地新增或删减责任;
  • 易于扩展新的请求处理类(节点),符合 开闭原则;

2、弊端:

  • 责任链路过长时,可能对请求传递处理效率有影响;
  • 如果节点对象存在循环引用时,会造成死循环,导致系统崩溃;

    7、类型转换器和异常处理器

    7.1、类型转换器

    7.1.1、Converter接口

    1. @FunctionalInterface
    2. public interface Converter<S, T> {
    3. /**
    4. * 提供类型转换的逻辑
    5. */
    6. @Nullable
    7. T convert(S source);
    8. }

    7.1.2、自定义Converter

    1. public class StringToDateConverter implements Converter<String,Date>{
    2. private String pattern;
    3. public void setPattern(String pattern) {
    4. this.pattern = pattern;
    5. }
    6. private DateFormat format;
    7. @Override
    8. public Date convert(String source) {
    9. try{
    10. //1.实例化format对象
    11. if(StringUtils.isEmpty(pattern)){
    12. pattern = "yyyy-MM-dd";
    13. }
    14. format = new SimpleDateFormat(pattern);
    15. //2.转换字符串
    16. return format.parse(source);
    17. }catch (Exception e){
    18. throw new IllegalArgumentException("给定的日期格式不对!");
    19. }
    20. }
    21. }

    7.1.3、注册类型转换器

    1. // 控制器的通知
    2. @ControllerAdvice
    3. public class InitBinderAdvice {
    4. @Autowired
    5. private Converter stringToDateConverter;
    6. /**
    7. * 初始化数据绑定器
    8. * @param dataBinder
    9. */
    10. @InitBinder
    11. public void initBinder(WebDataBinder dataBinder){
    12. ConversionService conversionService = dataBinder.getConversionService();
    13. if(conversionService instanceof GenericConversionService){
    14. GenericConversionService genericConversionService = (GenericConversionService)conversionService;
    15. genericConversionService.addConverter(stringToDateConverter);
    16. }
    17. }
    18. }

    7.2、异常处理器

    7.2.1、HandlerExceptionResovler

    1. /**
    2. * 异常处理器的根接口
    3. */
    4. public interface HandlerExceptionResolver {
    5. /**
    6. * 用于提供异常处理的逻辑
    7. */
    8. @Nullable
    9. ModelAndView resolveException(
    10. HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex);
    11. }

    7.2.2、自定义异常处理器

    1. @Component
    2. public class CustomeExceptionHandlerResovler implements HandlerExceptionResolver {
    3. /**
    4. * 此方法是处理异常的。异常就分为系统异常和业务异常
    5. * @param request 请求
    6. * @param response 响应
    7. * @param handler 当前控制器对象
    8. * @param ex 异常对象
    9. * @return
    10. */
    11. @Override
    12. public ModelAndView resolveException(HttpServletRequest request,
    13. HttpServletResponse response,
    14. Object handler,
    15. Exception ex) {
    16. //1.创建返回值
    17. ModelAndView mv = new ModelAndView();
    18. //2.判断当前的ex是系统异常还是业务异常
    19. CustomeException ce = null;
    20. if(ex instanceof CustomeException){
    21. //业务异常
    22. ce = (CustomeException)ex;
    23. //设置错误信息
    24. mv.addObject("errorMsg", ce.getMessage());
    25. }else{
    26. //系统异常
    27. //设置错误信息
    28. mv.addObject("errorMsg","服务器忙!" + ex.getMessage());
    29. //只输出系统异到控制台
    30. ex.printStackTrace();
    31. }
    32. //3.设置响应视图
    33. mv.setViewName("error");
    34. return mv;
    35. }
    36. }

    8、SpringMVC中的文件上传

    8.1、MultipartFile

    8.1.1、源码

    1. /**
    2. * SpringMVC中对上传文件的封装。
    3. */
    4. public interface MultipartFile extends InputStreamSource {
    5. /**
    6. * 获取临时文件名称
    7. */
    8. String getName();
    9. /**
    10. * 获取真实(原始)文件名称
    11. */
    12. @Nullable
    13. String getOriginalFilename();
    14. /**
    15. * 获取上传文件的MIME类型
    16. */
    17. @Nullable
    18. String getContentType();
    19. /**
    20. * 是否是空文件
    21. */
    22. boolean isEmpty();
    23. /**
    24. * 获取上传文件的字节大小
    25. */
    26. long getSize();
    27. /**
    28. * 获取上传文件的字节数组
    29. */
    30. byte[] getBytes() throws IOException;
    31. /**
    32. * 获取上传文件的字节输入流
    33. */
    34. @Override
    35. InputStream getInputStream() throws IOException;
    36. /**
    37. * 把上传文件转换成一个Resource对象
    38. */
    39. default Resource getResource() {
    40. return new MultipartFileResource(this);
    41. }
    42. /**
    43. * 把临时文件移动到指定位置并重命名,参数是一个文件对象
    44. */
    45. void transferTo(File dest) throws IOException, IllegalStateException;
    46. /**
    47. * 把临时文件移动到指定位置并重命名,参数是一个文件路径
    48. */
    49. default void transferTo(Path dest) throws IOException, IllegalStateException
    50. {
    51. FileCopyUtils.copy(getInputStream(), Files.newOutputStream(dest));
    52. }
    53. }

    8.1.2、commons-fifileupload的实现

    8.2、MultipartResolver

    8.2.1、源码

    1. /**
    2. * 它是SpringMVC中文件解析器的标准。
    3. * 通过一个接口规定了文件解析器中必须包含的方法
    4. */
    5. public interface MultipartResolver {
    6. /**
    7. * 判断是否支持文件上传
    8. */
    9. boolean isMultipart(HttpServletRequest request);
    10. /**
    11. * 解析HttpServletRequest
    12. */
    13. MultipartHttpServletRequest resolveMultipart(HttpServletRequest request)
    14. throws MultipartException;
    15. /**
    16. * 删除临时文件和一些清理操作
    17. */
    18. void cleanupMultipart(MultipartHttpServletRequest request);
    19. }

    8.2.1、CommonsFileUploadResolver