摘要：更多相關博文參考前一篇博文講了的方式創建應用，用過的童鞋都知道，早就沒有什么事情了，其實的版本，就已經支持，不用再寫本篇將介紹下，如何利用取代配置本篇博文，建議和上一篇對比看，貼出上一篇地址之基于配置的應用構建構建項目依賴對于依賴

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

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

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

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

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

200-mvc-annotation
war


    5.1.5.RELEASE



    
        javax.servlet
        javax.servlet-api
        3.1.0
    

    
        org.springframework
        spring-core
        ${spring.version}
    
    
        org.aspectj
        aspectjweaver
    
    
        org.springframework
        spring-aop
        ${spring.version}
    
    
        org.springframework
        spring-web
        ${spring.version}
    
    
        org.springframework
        spring-webmvc
        ${spring.version}
    

    
        org.eclipse.jetty.aggregate
        jetty-all
        9.2.19.v20160908
    



    web-mvc
    
        
            org.eclipse.jetty
            jetty-maven-plugin
            9.4.12.RC2
            
                
                    8080
                
            
        
    

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

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

現在沒有了配置文件，我們的配置還是得有，不然web容器（如tomcat）怎么找到DispatchServlet呢

同樣我們需要干的第一件事情及時聲明DispatchServlet，并設置它的應用上下文；可以怎么用呢？從官方找到教程

{% 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 handling

{% 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可以怎么用

前面定義了DispatchServlet，接下來對比web.xml就是需要配置掃描并注冊bean了，本文基于JavaConfig的方式，則主要是借助 @Configuration 注解來聲明配置類（這個可以等同于一個xml文件）

前面的代碼也可以看到，上下文中注冊了兩個Config類

RootConfig定義如下，注意下注解@ComponentScan，這個等同于，指定了掃描并注冊激活的bean的包路徑

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

另外一個WebConfig的作用則主要在于開啟WebMVC

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
}

實例和上一篇一樣，一個普通的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();
    }
}

測試依然可以和前面一樣，使用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();
    }
}

測試示意圖如下

簡單對比下xml的方式，會發現java config方式會清爽很多，不需要多個xml配置文件，維持幾個配置類，加幾個注解即可；當然再后面的SpringBoot就更簡單了，幾個注解了事，連上面的兩個Config文件, ServletConfig都可以省略掉

另外一個需要注意的點就是java config的運行方式，在servlet3之后才支持的，也就是說如果用比較老的jetty是起不來的（或者無法正常訪問web服務）

web系列:

Spring Web系列博文匯總

mvc應用搭建篇:

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

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

工程：spring-boot-demo

項目: https://github.com/liuyueyi/spring-boot-demo/blob/master/spring/200-mvc-annotation

一灰灰Blog個人博客 https://blog.hhui.top

一灰灰Blog-Spring專題博客 http://spring.hhui.top

一灰灰的個人博客，記錄所有學習和工作中的博文，歡迎大家前去逛逛

盡信書則不如，以上內容，純屬一家之言，因個人能力有限，難免有疏漏和錯誤之處，如發現bug或者有更好的建議，歡迎批評指正，不吝感激

微博地址: 小灰灰Blog

QQ： 一灰灰/3302797840

一灰灰blog

知識星球