Spring MVC之基於java config無xml配置的web應用構建

時間 2020-03-14

標籤 spring mvc 基於 java config xml 配置 web 應用構建欄目 Spring 简体版

原文原文鏈接

更多spring相關博文參考: http://spring.hhui.top

前一篇博文講了SpringMVC+web.xml的方式建立web應用，用過SpringBoot的童鞋都知道，早就沒有xml什麼事情了，其實Spring 3+, Servlet 3+的版本，就已經支持java config，不用再寫xml；本篇將介紹下，如何利用java config取代xml配置html

本篇博文，建議和上一篇對比看，貼出上一篇地址java

190316-Spring MVC之基於xml配置的web應用構建

git

I. Web構建

1. 項目依賴

對於依賴這一塊，和前面同樣，不一樣的在於java config 取代 xmlgithub

<artifactId>200-mvc-annotation</artifactId>
<packaging>war</packaging>

<properties>
    <spring.version>5.1.5.RELEASE</spring.version>
</properties>

<dependencies>
    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-web</artifactId>
        <version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>${spring.version}</version>
    </dependency>

    <dependency>
        <groupId>org.eclipse.jetty.aggregate</groupId>
        <artifactId>jetty-all</artifactId>
        <version>9.2.19.v20160908</version>
    </dependency>
</dependencies>

<build>
    <finalName>web-mvc</finalName>
    <plugins>
        <plugin>
            <groupId>org.eclipse.jetty</groupId>
            <artifactId>jetty-maven-plugin</artifactId>
            <version>9.4.12.RC2</version>
            <configuration>
                <httpConnector>
                    <port>8080</port>
                </httpConnector>
            </configuration>
        </plugin>
    </plugins>
</build>

細心的童鞋會看到，依賴中多了一個jetty-all，後面測試篇幅會說到用法web

2. 項目結構

第二節依然放上項目結構，在這裏把xml的結構也截進來了，對於咱們的示例demo而言，最大的區別就是沒有了webapp，更沒有webapp下面的幾個xml配置文件spring

3. 配置設定

如今沒有了配置文件，咱們的配置仍是得有，否則web容器（如tomcat）怎麼找到DispatchServlet呢api

a. DispatchServlet 聲明

一樣咱們須要乾的第一件事情及時聲明DispatchServlet，並設置它的應用上下文；能夠怎麼用呢？從官方找到教程tomcat

{% blockquote @SpringWebMvc教程 https://docs.spring.io/spring... %}服務器

The DispatcherServlet, as any Servlet, needs to be declared and mapped according to the Servlet specification by using Java configuration or in web.xml. In turn, the DispatcherServlet uses Spring configuration to discover the delegate components it needs for request mapping, view resolution, exception handlingmvc

{% endblockquote %}

上面的解釋，就是說下面的代碼和web.xml的效果是同樣同樣的

public class MyWebApplicationInitializer implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext servletCxt) {
        // Load Spring web application configuration
        AnnotationConfigWebApplicationContext ac = new AnnotationConfigWebApplicationContext();
        ac.register(AppConfig.class);
        ac.refresh();

        // Create and register the DispatcherServlet
        DispatcherServlet servlet = new DispatcherServlet(ac);
        ServletRegistration.Dynamic registration = servletCxt.addServlet("mvc-dispatcher", servlet);
        registration.setLoadOnStartup(1);
        registration.addMapping("/*");
    }
}

固然直接實現接口的方式有點粗暴，可是好理解，上面的代碼和咱們前面的web.xml效果同樣，建立了一個DispatchServlet, 而且綁定了url命中規則；設置了應用上下文AnnotationConfigWebApplicationContext

這個上下文，和咱們前面的配置文件mvc-dispatcher-servlet有點像了；若是有興趣看到項目源碼的同窗，會發現用的不是上面這個方式，而是及基礎接口AbstractDispatcherServletInitializer

public class MyWebApplicationInitializer extends AbstractDispatcherServletInitializer {
    @Override
    protected WebApplicationContext createRootApplicationContext() {
        return null;
    }

    @Override
    protected WebApplicationContext createServletApplicationContext() {
        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext();
        //        applicationContext.setConfigLocation("com.git.hui.spring");
        applicationContext.register(RootConfig.class);
        applicationContext.register(WebConfig.class);
        return applicationContext;
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/*"};
    }
    
    @Override
    protected Filter[] getServletFilters() {
        return new Filter[]{new HiddenHttpMethodFilter(), new CharacterEncodingFilter()};
    }
}

看到上面這段代碼，這個感受就和xml的方式更像了，好比Servlet應用上下文和根應用上下文

說明

上面代碼中增長的Filter先無視，後續會有專文講什麼是Filter以及Filter能夠怎麼用

b. java config

前面定義了DispatchServlet，接下來對比web.xml就是須要配置掃描並註冊bean了，本文基於JavaConfig的方式，則主要是藉助 @Configuration 註解來聲明配置類（這個能夠等同於一個xml文件）

前面的代碼也能夠看到，上下文中註冊了兩個Config類

RootConfig定義以下，注意下註解@ComponentScan，這個等同於<context:component-sca/>，指定了掃描並註冊激活的bean的包路徑

@Configuration
@ComponentScan(value = "com.git.hui.spring")
public class RootConfig {
}

另一個WebConfig的做用則主要在於開啓WebMVC

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
}

4. 實例代碼

實例和上一篇同樣，一個普通的Server Bean和一個Controller

@Component
public class PrintServer {
    public void print() {
        System.out.println(System.currentTimeMillis());
    }
}

一個提供rest服務的HelloRest

@RestController
public class HelloRest {
    @Autowired
    private PrintServer printServer;

    @GetMapping(path = "hello", produces="text/html;charset=UTF-8")
    public String sayHello(HttpServletRequest request) {
        printServer.print();
        return "hello, " + request.getParameter("name");
    }


    @GetMapping({"/", ""})
    public String index() {
        return UUID.randomUUID().toString();
    }
}

5. 測試

測試依然能夠和前面同樣，使用jetty來啓動，此外，介紹另一種測試方式，也是jetty，可是不一樣的是咱們直接寫main方法來啓動服務

public class SpringApplication {

    public static void main(String[] args) throws Exception {
        Server server = new Server(8080);
        ServletContextHandler handler = new ServletContextHandler();

        // 服務器根目錄，相似於tomcat部署的項目。 完整的訪問路徑爲ip:port/contextPath/realRequestMapping
        //ip:port/項目路徑/api請求路徑
        handler.setContextPath("/");

        AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext();
        applicationContext.register(WebConfig.class);
        applicationContext.register(RootConfig.class);

        //至關於web.xml中配置的ContextLoaderListener
        handler.addEventListener(new ContextLoaderListener(applicationContext));

        //springmvc攔截規則 至關於web.xml中配置的DispatcherServlet
        handler.addServlet(new ServletHolder(new DispatcherServlet(applicationContext)), "/*");

        server.setHandler(handler);
        server.start();
        server.join();
    }
}

測試示意圖以下