Spring MVC 中配置 DispatcherServlet

编程小弟

于 2024-05-03 22:23:40 发布

阅读量1.6k

点赞数 30

分类专栏： spring 文章标签： spring mvc java

本文链接：https://blog.youkuaiyun.com/m0_37638307/article/details/138031172

版权

spring 专栏收录该内容

61 篇文章

订阅专栏

本文详细介绍了SpringMVC中的DispatcherServlet配置过程，包括添加依赖、web.xml配置、创建控制器和配置文件、组件扫描、消息转换器、拦截器、国际化、SpringSecurity集成以及性能优化等方面。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在Spring MVC中，DispatcherServlet 是前端控制器，负责处理所有的HTTP请求。它是整个Spring MVC框架的核心组件，负责将请求分派给相应的处理器。以下是如何配置DispatcherServlet的详细步骤：

添加依赖：
确保项目中包含了Spring MVC的依赖。如果使用Maven，可以在pom.xml文件中添加如下依赖：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>您的Spring MVC版本</version>
</dependency>

配置web.xml：
在web.xml中配置DispatcherServlet作为Servlet，并设置其加载顺序和映射路径。

<web-app ...>
    <!-- 配置DispatcherServlet -->
    <servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring/dispatcher-config.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    
    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

在上述配置中，<init-param>元素用于指定Spring MVC配置文件的位置，这里假设配置文件名为dispatcher-config.xml，并位于/WEB-INF/spring/目录下。<load-on-startup>元素设置为1，表示在Web应用启动时立即加载DispatcherServlet。<url-pattern>/</url-pattern>表示所有的请求都会被DispatcherServlet处理。

创建Spring MVC配置文件：
根据web.xml中的配置，创建对应的Spring MVC配置文件（例如dispatcher-config.xml）。在该配置文件中，可以定义视图解析器、拦截器、消息转换器等。

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    
    <!-- 配置视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/views/" />
        <property name="suffix" value=".jsp" />
    </bean>
    
    <!-- 配置其他bean，如控制器、拦截器等 -->
    
</beans>

在上述配置中，定义了一个InternalResourceViewResolver，用于解析JSP视图。prefix和suffix属性分别指定了视图文件的前缀和后缀。

创建控制器：
创建Spring MVC的控制器类，并使用@Controller注解进行标记。在控制器中，定义处理请求的方法，并使用@RequestMapping注解指定请求的URL模式。

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class HomeController {
    
    @GetMapping("/")
    public String home() {
        return "home"; // 返回视图名称，由视图解析器解析为具体的JSP文件
    }
}

部署和测试：
将项目部署到Web服务器（如Tomcat）上，并启动服务器。通过浏览器访问应用的URL，观察DispatcherServlet是否正确处理请求并返回相应的视图。
配置组件扫描：
在Spring MVC的配置文件中，可以配置组件扫描，以便自动发现并注册带有@Controller、@Service、@Repository等注解的类。

<context:component-scan base-package="com.example.controller, com.example.service, com.example.repository" />

配置消息转换器：
如果需要处理JSON或XML等格式的请求和响应，可以配置消息转换器。Spring MVC默认提供了对JSON的支持，但也可以添加其他的转换器。

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter" />
        <!-- 其他消息转换器 -->
    </mvc:message-converters>
</mvc:annotation-driven>

配置拦截器：
可以配置拦截器来拦截请求，进行权限验证、日志记录等操作。

<mvc:interceptors>
    <bean class="com.example.interceptor.MyInterceptor" />
    <!-- 其他拦截器 -->
</mvc:interceptors>

在Java配置中，可以使用@Configuration和WebMvcConfigurer接口来替代XML配置。

使用Java配置：
通过Java配置，可以避免使用XML文件，而是使用Java类来配置Spring MVC。

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = "com.example")
public class WebConfig implements WebMvcConfigurer {
    // 实现WebMvcConfigurer接口的方法，配置Spring MVC
}

静态资源处理：
如果项目中包含静态资源（如CSS、JavaScript、图片等），需要配置DispatcherServlet来正确地处理这些资源的请求。可以通过在配置文件中添加资源处理器来实现。

<mvc:resources mapping="/resources/**" location="/WEB-INF/resources/" />

或者，在Java配置中：

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/resources/**")
        .addResourceLocations("/WEB-INF/resources/");
}

自定义异常处理：
可以配置自定义的异常处理器来处理控制器中抛出的异常，并提供友好的错误页面给用户。

<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
    <property name="exceptionMappings">
        <props>
            <prop key="com.example.MyCustomException">error-page</prop>
        </props>
    </property>
</bean>

或者在Java配置中：

@Override
public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    resolvers.add(new SimpleMappingExceptionResolver() {
        @Override
        protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
            // 自定义异常处理逻辑
            return super.doResolveException(request, response, handler, ex);
        }
    });
}

视图解析器配置：
在Spring MVC中，视图解析器用于解析视图名称并找到正确的视图实现。例如，可以使用InternalResourceViewResolver来解析JSP视图。

<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix" value="/WEB-INF/views/" />
    <property name="suffix" value=".jsp" />
</bean>

在Java配置中，可以通过实现WebMvcConfigurer接口来配置视图解析器。

CORS支持：
如果应用需要支持跨域资源共享（CORS），可以在配置中添加CORS的支持。

@Override
public void addCorsMappings(CorsRegistry registry) {
    registry.addMapping("/**")
            .allowedOrigins("http://example.com")
            .allowedMethods("GET", "POST", "PUT", "DELETE")
            .allowedHeaders("Content-Type");
}

异步请求处理：
Spring MVC支持异步请求处理，这允许控制器方法返回Callable、DeferredResult或WebAsyncTask对象，以便在后台异步地处理请求，并在完成后返回结果。

@RequestMapping("/async")
public Callable<String> asyncMethod() {
    return () -> {
        // 模拟长时间运行的任务
        Thread.sleep(5000);
        return "Async result";
    };
}

国际化：
Spring MVC支持国际化，允许根据不同的地区设置返回不同语言的响应。这通常涉及到配置LocaleResolver和MessageSource。

<bean id="localeResolver" class="org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver" />
<bean id="messageSource" class="org.springframework.context.support.ReloadableResourceBundleMessageSource">
    <property name="basename" value="classpath:messages" />
    <property name="cacheDuration" value="3600" />
</bean>

在Java配置中，可以通过实现WebMvcConfigurer接口来配置国际化支持。

Spring Security集成：
如果需要为应用添加安全性功能，如用户认证和授权，可以集成Spring Security。Spring Security提供了一套完整的安全解决方案，可以与Spring MVC无缝集成。

<security:http auto-config="true">
    <security:intercept-url pattern="/admin/**" access="ROLE_ADMIN" />
    <!-- 其他安全配置 -->
</security:http>

在Java配置中，可以使用@EnableWebSecurity注解和配置类来定义安全规则。

性能优化：
对于大型应用，性能优化是一个重要的考虑因素。可以通过缓存、压缩响应、减少HTTP请求等方式来提升Spring MVC应用的性能。

@Bean
public GzipFilter gzipFilter() {
    GzipFilter gzipFilter = new GzipFilter();
    gzipFilter.setAfterResponse(true);
    return gzipFilter;
}

上述只是一些Spring MVC中DispatcherServlet配置和使用的额外方面。实际上，Spring MVC的功能非常丰富，可以根据项目的具体需求进行更深入的定制和优化。建议查阅Spring官方文档以获取更详细和全面的信息。