注解配置SpringMVC

🕗 发布于 2024-07-25 00:33 spring springmvc mvc

文章目录

在这里插入图片描述

本篇文章讲解使用配置类和注解代替 web.xml 和SpringMVC配置文件的功能

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

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

public class WebInit extends AbstractAnnotationConfigDispatcherServletInitializer {

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

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

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

    /**
     * 添加过滤器
     * @return
     */
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter encodingFilter = new CharacterEncodingFilter();
        encodingFilter.setEncoding("UTF-8");
        encodingFilter.setForceRequestEncoding(true);
        HiddenHttpMethodFilter hiddenHttpMethodFilter = new HiddenHttpMethodFilter();
        return new Filter[]{encodingFilter, hiddenHttpMethodFilter};
    }
}

2、创建SpringConfig配置类，代替spring的配置文件

@Configuration
public class SpringConfig {
//ssm整合之后，spring的配置信息写在此类中
}

3、创建WebConfig配置类，代替SpringMVC的配置文件

@Configuration
//扫描组件
@ComponentScan("com.mvc.controller")
//开启MVC注解驱动
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {

    //使用默认的servlet处理静态资源
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }

    //配置文件上传解析器
    @Bean
    public CommonsMultipartResolver multipartResolver(){
        return new CommonsMultipartResolver();
    }

    //配置拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        FirstInterceptor firstInterceptor = new FirstInterceptor();
        registry.addInterceptor(firstInterceptor).addPathPatterns("/**");
    }
    
    //配置视图控制
    
    /*@Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }*/
    
    //配置异常映射
    /*@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("ex");
        resolvers.add(exceptionResolver);
    }*/

    //配置生成模板解析器
    @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;
    }


}

4、测试功能

@RequestMapping("/")
public String index(){
    return "index";
}

总结

@Controller
意义：标识一个类为 Spring MVC 的控制器，用于处理用户请求。它使得这个类能被 Spring 框架识别和管理，从而能够处理 HTTP 请求并返回相应的视图或数据。
@RequestMapping
意义：定义请求的 URL 路径与控制器方法的映射关系。它允许指定哪些请求被某个控制器方法处理，可以配置请求的类型（GET、POST 等）及其他请求参数。
@GetMapping, @PostMapping, @PutMapping, @DeleteMapping
意义：是 @RequestMapping 的快捷方式，分别用于处理不同类型的 HTTP 请求（GET、POST、PUT、DELETE）。这些注解使得请求类型的映射更加清晰和简洁。
@PathVariable
意义：用于提取 URL 中的路径变量。它允许从 URL 模板中提取特定的值，并将其绑定到方法参数中，使得动态 URL 更加易于处理。
@RequestParam
意义：用于提取请求参数。它将请求中的参数值绑定到方法参数中，支持处理表单数据和 URL 查询参数。
@ModelAttribute
意义：用于从请求参数中绑定到方法参数或模型中。它可以将请求参数绑定到对象中，并在表单提交时填充对象的字段，也可以在方法中预先准备数据。
@ResponseBody
意义：将方法的返回值直接写入 HTTP 响应体中，而不是通过视图解析器。适用于返回 JSON、XML 或其他直接数据格式。
@RestController
意义：是 @Controller 和 @ResponseBody 的组合，用于构建 RESTful Web 服务。它简化了 RESTful API 的开发，使得所有控制器方法的返回值都直接写入响应体中。
@ExceptionHandler
意义：用于定义处理特定异常的处理方法。它允许在控制器中处理异常并返回相应的错误视图或数据，提供了集中处理异常的机制。

Spring MVC 的注解配置简化了开发过程，通过直观的方式定义请求处理逻辑、参数绑定、异常处理等。它使得控制器和请求映射的定义更加清晰，提高了代码的可读性和可维护性，减少了繁琐的 XML 配置。

每一项技术深挖都是一个庞大的体系，学海无涯，共勉。