SpringMVC使用註解設定方式

2022-05-28 18:02:07

SpringMVC註解設定方式

使用設定類和註解代替web.xml和SpringMVC組態檔的功能。

一、建立初始化類

在 Servlet3.0 環境中，容器會在類路徑中查詢實現javax.servlet.ServletContainerInitializer介面的類，如果找到的話就用它來設定 Servlet 容器。

Spring 提供了這個介面的實現，名為SpringServletContainerInitializer，這個類反過來又會查詢實現WebApplicationInitializer的類並將設定的任務交給它們來完成。

Spring3.2 引入了一個便利的WebApplicationInitializer基礎實現，名為AbstractAnnotationConfigDispatcherServletInitializer，
當我們的類擴充套件了AbstractAnnotationConfigDispatcherServletInitializer並將其部署到 Servlet3.0 容器的時候，容器會自動發現它，並用它來設定 Servlet 上下文。

這裡新建一個工程來演示。

pom.xml裡的依賴可以複製之前的內容，web.xml 和 SpringMVC 已經不需要再進行建立了。

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的對映規則，即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的設定類，給建立出來即可，記得帶上@Configuration註解，標記為設定類。

其實就是把之前各種組態檔裡的內容轉到設定類裡了，這些都會在專案啟動時候初始化。另外，返回的都是陣列，所以每個類裡都可以返回多個設定。

二、spring的設定類

當使用ssm整合之後，spring的設定資訊寫在spring的設定類中，這裡暫時用不到，寫出來無妨。

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

三、WebConfig 設定類

這個設定類是代替之前 springMVC.xml 組態檔裡的內容：

掃描元件
檢視解析器
view-controller
default-servlet-handler
mvc註解驅動
檔案上傳解析器
例外處理
攔截器

// 標識當前類為設定類
@Configuration
// 掃描元件
@ComponentScan("com.pingguo.mvc")
// 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;
    }
}

有了這幾樣，就可以寫一個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";
    }
}

設定下部署，啟動可以開啟首頁。

剩餘設定

接下來，需要 WebConfig 類實現一個介面WebMvcConfigurer，來重寫裡面的方法。

設定 default-servlet-handler

@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    //使用預設的servlet處理靜態資源 default-servlet-handler
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }
... ...

設定攔截器

繼續增加。

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

攔截器還是要像之前的那樣建立，這裡就建立了一個攔截器 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

當僅做檢視跳轉時候可以使用這個設定。

//設定檢視控制
    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");
        //設定異常對映
        exceptionResolver.setExceptionMappings(prop);
        //設定共用異常資訊的鍵
        exceptionResolver.setExceptionAttribute("ex");
        resolvers.add(exceptionResolver);
    }

裡面的功能與之前使用組態檔實現的一樣，可以逐一測試一下。

以上就是SpringMVC使用註解設定方式的詳細內容，更多關於SpringMVC註解設定的資料請關注it145.com其它相關文章！