SpringMVC使用注解配置方式

更新時(shí)間：2022年05月28日 10:47:22 作者：把蘋果咬哭的測試筆記

這篇文章主要為大家介紹了SpringMVC使用注解配置方式，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

SpringMVC注解配置方式

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

一、創(chuàng)建初始化類

在 Servlet3.0 環(huán)境中，容器會(huì)在類路徑中查找實(shí)現(xiàn)javax.servlet.ServletContainerInitializer接口的類，如果找到的話就用它來配置 Servlet 容器。

Spring 提供了這個(gè)接口的實(shí)現(xiàn)，名為SpringServletContainerInitializer，這個(gè)類反過來又會(huì)查找實(shí)現(xiàn)WebApplicationInitializer的類并將配置的任務(wù)交給它們來完成。

Spring3.2 引入了一個(gè)便利的WebApplicationInitializer基礎(chǔ)實(shí)現(xiàn)，名為AbstractAnnotationConfigDispatcherServletInitializer，
當(dāng)我們的類擴(kuò)展了AbstractAnnotationConfigDispatcherServletInitializer并將其部署到 Servlet3.0 容器的時(shí)候，容器會(huì)自動(dòng)發(fā)現(xiàn)它，并用它來配置 Servlet 上下文。

這里新建一個(gè)工程來演示。

pom.xml里的依賴可以復(fù)制之前的內(nèi)容，web.xml 和 SpringMVC 已經(jīng)不需要再進(jìn)行創(chuàng)建了。

package com.pingguo.mvc.config;
import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
import javax.servlet.Filter;
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的映射規(guī)則，即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};
    }
}

初始化類里面要指定 spring的配置類、SpringMVC的配置類，給創(chuàng)建出來即可，記得帶上@Configuration注解，標(biāo)記為配置類。

其實(shí)就是把之前各種配置文件里的內(nèi)容轉(zhuǎn)到配置類里了，這些都會(huì)在項(xiàng)目啟動(dòng)時(shí)候初始化。另外，返回的都是數(shù)組，所以每個(gè)類里都可以返回多個(gè)配置。

二、spring的配置類

當(dāng)使用ssm整合之后，spring的配置信息寫在spring的配置類中，這里暫時(shí)用不到，寫出來無妨。

package com.pingguo.mvc.config;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SpringConfig {
}

三、WebConfig 配置類

這個(gè)配置類是代替之前 springMVC.xml 配置文件里的內(nèi)容：

掃描組件
視圖解析器
view-controller
default-servlet-handler
mvc注解驅(qū)動(dòng)
文件上傳解析器
異常處理
攔截器

// 標(biāo)識(shí)當(dāng)前類為配置類
@Configuration
// 掃描組件
@ComponentScan("com.pingguo.mvc")
// mvc 注解驅(qū)動(dòng)
@EnableWebMvc
public class WebConfig {
    //配置生成模板解析器
    @Bean
    public ITemplateResolver templateResolver() {
        WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
        // ServletContextTemplateResolver需要一個(gè)ServletContext作為構(gòu)造參數(shù)，可通過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;
    }
}

有了這幾樣，就可以寫一個(gè)index頁面測試一下了，寫出頁面和controller類。

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>index首頁</title>
</head>
<body>
<h1>首頁</h1>
</body>
</html>

控制器：

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

設(shè)置下部署，啟動(dòng)可以打開首頁。

剩余配置

接下來，需要 WebConfig 類實(shí)現(xiàn)一個(gè)接口WebMvcConfigurer，來重寫里面的方法。

配置 default-servlet-handler

@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    //使用默認(rèn)的servlet處理靜態(tài)資源 default-servlet-handler
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }
... ...

配置攔截器

繼續(xù)增加。

... ... 
    //配置攔截器
    public void addInterceptors(InterceptorRegistry registry) {
        TestInterceptor firstInterceptor = new TestInterceptor();
        registry.addInterceptor(firstInterceptor).addPathPatterns("/**");
    }
... ...

攔截器還是要像之前的那樣創(chuàng)建，這里就創(chuàng)建了一個(gè)攔截器 TestInterceptor ：

public class TestInterceptor implements HandlerInterceptor {
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    }
}

配置 view-controller

當(dāng)僅做視圖跳轉(zhuǎn)時(shí)候可以使用這個(gè)配置。

//配置視圖控制
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("index");
    }

配置文件上傳解析器

... ...
    //配置文件上傳解析器
    @Bean
    public MultipartResolver multipartResolver(){
        CommonsMultipartResolver commonsMultipartResolver = new CommonsMultipartResolver();
        return commonsMultipartResolver;
    }
... ...

配置異常處理

//配置異常映射
    public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
        SimpleMappingExceptionResolver exceptionResolver = new SimpleMappingExceptionResolver();
        Properties prop = new Properties();
        prop.setProperty("java.lang.ArithmeticException", "error");
        //設(shè)置異常映射
        exceptionResolver.setExceptionMappings(prop);
        //設(shè)置共享異常信息的鍵
        exceptionResolver.setExceptionAttribute("ex");
        resolvers.add(exceptionResolver);
    }

里面的功能與之前使用配置文件實(shí)現(xiàn)的一樣，可以逐一測試一下。

以上就是SpringMVC使用注解配置方式的詳細(xì)內(nèi)容，更多關(guān)于SpringMVC注解配置的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: