SpringMVC（四）

发布于：2025-08-10 ⋅ 阅读:(14) ⋅ 点赞:(0)

异常处理器

基于配置的异常处理

SpringMVC提供了有关处理控制器方法执行过程中所出现的异常接口：HandlerExceptionResolver

HandlerExceptionResolver接口的实现类有：DefaultHandlerExceptionResolver和SimpleMappingExceptionResolver。

SpringMVC提供了自定义的异常处理器SimpleMappingExceptionResolver，使用方式（基于配置）：

<!--配置异常处理-->
    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <property name="exceptionMappings" >
            <props>
                <!--指定处理的异常，error为异常跳转的指定视图-->
                <prop key="java.lang.ArithmeticException">error</prop>
            </props>
<!--输出异常信息将异常信息共享到请求域中,以ex为键，在前端中可以通过${ex}输出值-->
        <property name="exceptionAttribute" value="ex">
        </property>
    </bean>

基于注解的异常处理

  • @ControllerAdvice是将当前类标识为异常处理的组件
  • @ExceptionHandler用于设置所标识方法处理的异常
  • @ex表示当前请求处理中出现的异常对象
@ControllerAdvice
public class ExceptionController {
    @ExceptionHandler(value = {ArithmeticException.class,NullPointerException.class})
    public String testException(Exception ex, Model model){
        model.addAttribute("ex",ex);
        return "error";
    }
}

注解配置SpringMVC

使用配置类和注解代替web.xml和SpringMVC配置文件的功能。

原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>
    <init-param>
      <!--强制响应的编码-->
      <param-name>forceResponseEncoding</param-name>
      <param-value>true</param-value>
    </init-param>
  </filter>
  <!--配置HiddenHttpMethodFilter，异常http的请求方式过滤器-->
  <filter>
    <filter-name>HiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>HiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
  <filter-mapping>
    <filter-name>CharacterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

  <!--配置SpringMVC的前端控制器，对浏览器发送的请求进行统一处理-->
  <servlet>
    <servlet-name>springMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!--配置SpringMVC配置文件的位置和名称-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:SpringMVC.xml</param-value>
    </init-param>
    <!--将前端控制器DispatcheServlet的初始化时间提前到服务器启动时-->
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>springMVC</servlet-name>
    <!--设置springmvc的核心控制器所能处理的请求的请求路径/所匹配的请求可以
    是/login或.html或.js或.css方式的请求路径，但是不能匹配.jsp请求路径的请求
    /*和/类似，但是/*包括.jsp请求路径-->
    <url-pattern>/</url-pattern>
  </servlet-mapping>

SpringMVC.xml配置

 <!--    扫描组件-->
    <context:component-scan base-package="com.serenity.mvc"></context:component-scan>
    <!--配置Thymeleaf视图解析器-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                        <!--视图前缀-->
                        <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>

    <!--处理静态资源，eg：html、js、css、jpg，若只设置该标签，则只能
    访问静态资源，其他请求无法访问
    此时必须设置<mv：default-servlet-handler/>-->
    <mvc:default-servlet-handler/>
    <!--开启mvc注解驱动-->
    <mvc:annotation-driven>
        <mvc:message-converters>
            <!--处理响应中文内容乱码-->
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <property name="defaultCharset" value="UTF-8"/>
                <property name="supportedMediaTypes">
                    <list>
                        <value>text/html</value>
                        <value>application/json</value>
                    </list>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    <!--视图控制器配置之后，所有转发给重定向都会失效-->
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <!--开启mvc的注解驱动-->
    <mvc:annotation-driven/>
    <!--开放对静态资源的访问-->
    <mvc:default-servlet-handler/>
    <!--配置文件上传解析器，将上传的文件封装为MultipartFile-->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    </bean>
    <!--配置拦截器-->
    <mvc:interceptors>
        <!--<bean class="com.serenity.mvc.Interceptors.FirstInterceptor"></bean>-->
        <!--<ref bean="firstInterceptor"/>-->
        <mvc:interceptor>
            <!--拦截规则-->
            <!--拦截所有-->
            <mvc:mapping path="/*"/>
            <!--除了这个路径-->
            <mvc:exclude-mapping path="/"/>
            <!--指定拦截器-->
            <ref bean="firstInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>
    
    <!--配置异常处理-->
    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <property name="exceptionMappings" >
            <props>
                <!--指定处理的异常,error为异常跳转的指定视图-->
                <prop key="java.lang.ArithmeticException">error</prop>
            </props>
        </property>
        <!--输出异常信息将异常信息共享到请求域中,以ex为键，在前端中可以通过${ex}输出值-->
        <property name="exceptionAttribute" value="ex">

        </property>
    </bean>

拦截器实现：

//拦截器配置,需要实现HandlerInterceptor接口
//通过组件Component将拦截器交给IoC容器管理（注意需要扫描），可以在配置时用ref进行拦截器的配置，未用，可用bean配置
@Component
public class FirstInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("FirstInterceptor->preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("FirstInterceptor->postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("FirstInterceptor->afterHandle");
    }
}

创建初始化类，代替web.xml

在Servlet3.0环境中，容器会在类路径中查找实现javax.servlet.ServletContainerInitilize接口的类。如果找到的话就用它来配置Servlet容器。

Spring提供了这个接口的实现，名为SpringServletContainerInitializer，这个类反过来又会查找实现WebApplicationInitializer得类并将配置的任务交给它们来完成。Spring3.2引入了一个便利的WebApplicationInitializer基础实现，名为AbstractAnnotationConfigDispatcherServletInitializer，当我们的类扩展了AbstractAnnotationConfigDispatcherServletInitializer并将其部署到Servlet3.0容器的时候，容器会自动发现它，并用它来配置Servlet上下文。

/*web工程的初始化类，用来代替web.xml*/
public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {

    /*指定Spring的配置类*/
    @Override
    protected Class<?>[] getRootConfigClasses() {
        //返回配置类
        return new Class[]{SpringConfig.class};
    }

    /*指定SpringMVC的配置类*/
    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{WebConfig.class};
    }

    /*指定DispatcherServlet的映射规则*/
    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    /*注册过滤器*/
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();
        characterEncodingFilter.setEncoding("UTF-8");
        characterEncodingFilter.setForceResponseEncoding(true);
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{characterEncodingFilter,hiddenHttpMethodFilter};
    }
}

配置视图解析器（SpringMVC配置类）

代替SpringMVC的配置文件：
* 1.扫描组件    2.视图解析器     3.view-controller
* 4.default-servlet-handler     5.文件上传解析器
* 6.异常处理    7.mvc注解驱动       8.拦截器

下面主要是实现扫描组件，视图解析器，mvc注解驱动


/*代替SpringMVC的配置文件：
* 1.扫描组件    2.视图解析器     3.view-controller
* 4.default-servlet-handler     5.文件上传解析器
* 6.异常处理    7.mvc注解驱动       8.拦截器*/
//将当前类标识为一个配置类
@Configuration
//扫描组件
@ComponentScan("com.serenity.mvc.controller")
//开启MVC注解驱动
@EnableWebMvc
public class WebConfig {
    
    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver需要一个ServletContext作为构造参数，可通过WebApplicationContext 的方法获得
        ServletContextTemplateResolver templateResolver = new ServletContextTemplateResolver(
                webApplicationContext.getServletContext());
        //前缀
        templateResolver.setPrefix("/WEB-INF/templates/");
        //后缀
        templateResolver.setSuffix(".html");
        templateResolver.setCharacterEncoding("UTF-8");
        templateResolver.setTemplateMode(TemplateMode.HTML);
        return templateResolver;
    }

    //生成模板引擎并为模板引擎注入模板解析器
    @Bean
    public SpringTemplateEngine templateEngine(ITemplateResolver templateResolver) {
        SpringTemplateEngine templateEngine = new SpringTemplateEngine();
        templateEngine.setTemplateResolver(templateResolver);
        return templateEngine;
    }

    //生成视图解析器并未解析器注入模板引擎
    @Bean
    public ViewResolver viewResolver(SpringTemplateEngine templateEngine) {
        ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
        viewResolver.setCharacterEncoding("UTF-8");
        viewResolver.setTemplateEngine(templateEngine);
        return viewResolver;
    }

}

配置Servlet、拦截器、view-controller、异常处理（SpringMVC配置类）

配置default-servlet-handler，拦截器，view-controller、异常处理需要
实现WebMvcConfigurer接口，重写configureDefaultServletHandling、
addInterceptors、addViewControllers、configureHandlerExceptionResolvers方法

public class WebConfig implements WebMvcConfigurer {

    //配置default-servlet-handler
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    //拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        TestInterceptor testInterceptor = new TestInterceptor();
        //拦截所有请求
        registry.addInterceptor(testInterceptor).addPathPatterns("/**");
    }

    //view-controller,默认路径和视图
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/hello").setViewName("hello");
    }

    //异常处理
    @Override
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver=new SimpleMappingExceptionResolver();
        Properties prop = new Properties();
        //指定处理的异常
        prop.setProperty("java.lang.ArithmeticException","error");
        exceptionResolver.setExceptionMappings(prop);
        //从请求域中获的异常信息
        exceptionResolver.setExceptionAttribute("exception");
        resolvers.add(exceptionResolver);
    }
}

拦截器实现：

//拦截器
public class TestInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("testInterceptor-->preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

配置文件上传（SpringMVC配置类）

//文件上传
    @Bean
    public MultipartResolver multipartResolver(){
        CommonsMultipartResolver commonsMultipartResolver=new CommonsMultipartResolver();
        return commonsMultipartResolver;
    }

SpringMVC常用组件

  • DispatcherServlet：前端控制器，框架提供
    • 作用：统一处理请求和响应，整个流程控制的中心，由它调用其他组件处理用户的请求
  • HandlerMapping：处理器映射器，框架提供
    • 作用：根据请求url、method等信息查找Handler，即控制器方法
  • Handler：处理器，需要开发
    • 作用：在DispatcherServlet的控制下Handler对具体的用户请求进行处理。
  • HandlerAdapter：处理器适配器，框架提供
    • 作用：通过HandlerAdapter对处理器（控制器方法）进行执行
  • ViewResolver：视图解析器，框架提供
    • 作用：进行视图解析，得到相应的视图，如ThymeleafView、InternalResourceView、RedirectView
  • View：视图，框架提供
    • 作用：将模型数据通过页面展示给用户

SpringMVC的执行流程

  1. 用户向服务器发送请求，请求被SpringMVC前端控制器DispatcherServlet捕获。
  2. DispatcherServlet对请求URL进行解析，得到请求资源标识符（URI），判断请求URI对应的映射。
    1. 如果不存在，在判断是否配置了mvc:default-servelt-handler
      1. 如果没有配置，则控制台映射查找不到，客户端显示404错误。PageNotFound 404 not_found
      2. 如果有配置，则访问目标资源（一般为静态资源，eg：js、css、html),找不到客户端也会显示404错误。DefaultServletHttpRequestHandlerDispatcherServlet
    2. 如果存在。
      1. 根据该URI，调用HandlerMapping获得Handler配置的所有相关的对象（包括Handler对象以及Handler对象对应的拦截器），最后以HandlerExecutionChain执行链对象的形式返回。
      2. DispatcherServlet根据获得的Handler，选择应该合适的HandlerAdapter。
      3. 如果成功获得HandlerAdapter，此时将开始执行拦截器的preHandler方法
      4. 提取Request中的模型数据，填充Handler入参，开始执行Handler（Controller）方法，处理请求，在填充Handler的入参过程中，根据你的配置，Spring将帮你做一些额外的工作。
        1. HttpMessageConveter：将请求消息（eg：json、xml等数据）转换为一个对象，将对象转换为指定的响应信息。
        2. 数据转换：对请求消息进行数据转换，如String转换为Integer、Double等。
        3. 数据格式化：对请求消息进行数据格式化，如将字符串转换成格式化数据或格式化日期等。
        4. 数据验证：验证数据的有效性（长度、格式等），验证结果存储到BindingResult或Error中
  •  Handler执行完成后，向DispatcherServlet返回一个ModelAndView对象。        
  • 此时将开始执行拦截器的postHandler方法
  • 根据返回的ModelAndView（此时会判断是否存在异常：如果存在异常，则执行HandlerExceptionResolven进行异常处理），选择一个合适的ViewResolver进行视图解析，根据Model和View，来渲染视图。
  • 渲染视图完毕执行拦截器的afterCompletion方法
  • 将渲染结果返回给客户端

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布