基于Java配置的Spring+SpringMVC

基于Java配置的Spring+SpringMVC

2019.09.06

本篇用于记录对松哥springboot视频学习的第二篇，如果有感兴趣的小伙伴也欢迎关注的松哥知识星球Java达摩学院，文末也会贴出松哥博客。
那么废话也不多说了，下面给出详细记录。

---

一个简单的案例

本文涉及基础的基于Java注解配置Spring+SpringMVC、静态资源路径映射、拦截器配置及FastJsonHttpMessageConverters配置。

1、创建一个简单的maven工程
2、编写pom文件
3、编写SpringConfig配置类
4、编写SpringMVCConfig配置类
5、编写WebInit配置类
6、编写业务

工程目录结构如下：

下面按照顺序晒出代码：

• pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.rain</groupId>
    <artifactId>javassm</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>5.1.9.RELEASE </version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.60</version>
        </dependency>
    </dependencies>
</project>

• SpringConfig.java

@Configuration
@ComponentScan(basePackages = "com.rain", useDefaultFilters = true, excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class)
})
public class SpringConfig {
}

小伙伴对比我的springboot专栏的上一篇博文基于XML配置的Spring+SpringMVC，不难发现其实纯java注解配置的类对应一个xml配置文件。
@Configuration:：声明一个java类为配置类，即对应着一个xml配置文件。
@ComponentScan：定义这个java配置类中扫描组件的规则。
@basePackages：定义扫描包范围，由于后面还专门配置了SpringMVC配置文件，因此这里需要扫描除被@Controller注解的组件以外的所有由注解注册的组件。

• SpringMVCConfig.java

@Configuration
@ComponentScan(basePackages = "com.rain", useDefaultFilters = false, includeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class),
        @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Configuration.class)
})
public class SpringMVCConfig extends WebMvcConfigurationSupport {

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
    }

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        // 拦截任意多层的路径
        // *表示单层路径，**表示多层路径
        registry.addInterceptor(myInterceptor()).addPathPatterns("/**");
    }

    @Bean
    MyInterceptor myInterceptor() {
        return new MyInterceptor();
    }

    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        converters.add(converter);
    }
}

这里在@ComponentScan中，需要注意的是，除了要扫描被@Controller注解注册的组件，也要扫描被@Configuration注解注册的配置组件，否则前面用@Configuration注册的SpringConfig配置组件将不能被加载进spring容器中。
报错信息如下：

对WebMvc支持的功能需要该配置类继承WebMvcConfigurationSupport，以此来注册拦截器、静态资源映射器以及FastJson超文本信息转换器等组件。值得一提的是，springmvc已经帮我们自动注册好了json与gson的超文本信息转换器组件，但是alibaba的fastjson尚需要我们手动注册。
关于静态资源映射器可做如下理解，我们知道maven工程中的resources在打包后即为classpath，但是由于resources中存放的是静态资源，而项目打包的是一个动态的war包，因此需要对其下的静态文件做路径映射，这样便可通过地址栏或静态页面中发送的请求来获取资源。

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
    }

上面的案例是将对static下多级目录资源的请求映射到classpath:/static/
这样便可以在浏览器地址栏中直接通过/static/hello.html来访问静态页面。

• WebInit.java

public class WebInit implements WebApplicationInitializer {
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        // 获得spring容器
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        // 设置spring容器中的servlet上下文
        ctx.setServletContext(servletContext);
        // 在spring容器中注册springmvc配置文件
        ctx.register(SpringMVCConfig.class);
        // 向servlet上下文中添加DispartcherServlet
        ServletRegistration.Dynamic springmvc = servletContext.addServlet("springmvc", new DispatcherServlet(ctx));
        // 设置DispartcherServlet拦截的路径
        springmvc.addMapping("/");
        // 设置程序启动时加载
        springmvc.setLoadOnStartup(1);
    }
}

对比我的上一篇文章，不难发现用java类配置的方式实际上便是对web.xml的翻译。总体来说，基本的配置顺序如下:

1、自定义WebInit类实现WebApplicationInitializer接口的onStartup方法，方法参数会自动注入最原始的ServletContext上下文对象
2、获得spring容器
3、通过spring容器设置原始的ServletContext对象
4、通过spring容器注册springmvc配置类文件
5、通过原始的ServletContext对象添加DispatcherServlet，然后再次基础上定义DispatcherServlet拦截请求路径的规则，并设置服务器启动加载

• HelloController.java

@RestController
public class HelloController {

    @Autowired
    private HelloService helloService;

    @GetMapping(value = "/hello", produces = "text/html;charset=UTF-8")
    public String hello() {
        return helloService.sayHello();
    }

    @GetMapping("/data")
    public List<String> getData() {
        ArrayList<String> list = new ArrayList<>();
        for (int i = 0; i < 10; i++) {
            list.add("com.rain>>>>" + i);
        }
        return list;
    }
}

• HelloService.java

@Service
public class HelloService {
    public String sayHello() {
        return "你好世界！";
    }
}

• MyInterceptor.java

public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}

编写拦截器要实现对应的HandlerInterceptor接口
preHandle：请求拦截器前的操作。
postHandle：拦截过程中的操作。
afterCompletion：拦截结束后的操作。

@Override
    protected void addInterceptors(InterceptorRegistry registry) {
        // 拦截任意多层的路径
        // *表示单层路径，**表示多层路径
        registry.addInterceptor(myInterceptor()).addPathPatterns("/**");
    }

    @Bean
    MyInterceptor myInterceptor() {
        return new MyInterceptor();
    }

值得一提的是，由于拦截器是我们自己编写，因此我们需要将拦截器手动注册到springmvc容器中，并提供路径拦截规则。
@Bean：将自己编写的组件注册到springmvc容器中。
myInterceptor().addPathPatterns("/")**表示用我们自己些的拦截器拦截所有的请求路径（根路径下的多层路径）。

---

以上便是基于java注解配置的spring+springmvc，看到这里，想必聪明的你也一定有不少收获。
文末也给出松哥的个人博客，有兴趣的小伙伴也可以关注。
以上，作为我正式开始学习springboot的伏笔，接下来将会正式开启springboot的学习之旅，大家一起加油呀！