基于纯Java代码的Spring容器和Web容器零配置的思考和实现（2） - 静态资源、视图和消息器

在上一篇博文​​《基于纯Java代码的Spring容器和Web容器零配置的思考和实现（1） - 数据源与事务管理》​​中我们介绍了怎么基于Java代码去设计和配置一个具有可扩展性的数据源和事务管理器。在这篇博文中，我们将介绍怎么配置静态资源处理、视图解析器以及消息转换器。

我们知道，Spring的配置分为两个部分，
一部分是配置Spring容器，一般配置在applicationContext.xml。
另一部分是Web容器，也叫Web子容器，一般配置在xxx-servlet.xml。

所以，遵循配置分离的原则，我们提供两个类来分别代替这两个XML文件。

我们首先提供一个SpringContextConfig类，这个类用于配置原本配置在applicationContext.xml中的信息。由于我们已经将数据源和事务管理器的配置单独配置到了DBConfig，对于最基本配置这个范围而言，这个类暂时没有其他的东西需要配置。当然以后我们自定义的一些需要Spring管理的内容可以在这里配置。比如我在这里面配置了一个RPC工具，源码如下：

package com.kiiwow.framework.config.context.spring;

import org.springframework.context.annotation.Bean;

import com.kiiwow.framework.platform.service.KiiwowApiClient;

/**
 * Spring容器上下文配置
 * 对rest请求发起客户端以及其他工具进行配置
 *
 * @author leon.gan
 *
 */
public class SpringContextConfig {
    
    /**
     * RestClient
     */
    @Bean
    public KiiwowApiClient kiiwowApiClient() {
        return new KiiwowApiClient();
    }
    
}

我们接着提供一个WebContextConfig类，这个类用于配置原本配置在xxx-servlet.xml中的信息。我们需要继承org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter这个抽象类，
通过重写其void addResourceHandlers(ResourceHandlerRegistry registry)方法实现静态资源过滤，
重写void addInterceptors(InterceptorRegistry registry)方法来配置我们的监听器。

我们先给出源码，再对源码作出解释：

package com.kiiwow.framework.config.context.spring;

import java.util.ArrayList;
import java.util.List;

import javax.inject.Inject;

import org.springframework.context.annotation.Bean;
import org.springframework.http.MediaType;
import org.springframework.http.converter.ByteArrayHttpMessageConverter;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.http.converter.json.MappingJacksonHttpMessageConverter;
import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
import org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter;
import org.springframework.web.servlet.config.annotation.DefaultServletHandlerConfigurer;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.servlet.view.JstlView;
import org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer;
import org.springframework.web.servlet.view.freemarker.FreeMarkerView;
import org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver;

import com.kiiwow.framework.json.JSONBinder;

/**
 * Web容器上下文配置
 * 
 * @author leon.gan
 *
 */
public class WebContextConfig extends WebMvcConfigurerAdapter  {

    @Inject
    KiiwowEnvironment environment;
    
    /**
     * 静态资源过滤
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler(environment.getProperty("static.handler", "/site-static/**"))
                .addResourceLocations(environment.getProperty("static.locations", "/site-static/"))
                .setCachePeriod(environment.getRequiredProperty("static.cachePeriod", int.class, 31556926));
    }

    /**
     * 将对于静态资源的请求转发到Servlet容器的默认处理静态资源的servlet
     * 因为将spring的拦截模式设置为"/"时会对静态资源进行拦截
     */
    @Override
    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
        configurer.enable();
    }
    
    /**
     * JSP视图解析器
     */
    @Bean
    public InternalResourceViewResolver internalResourceViewResolver() {
        InternalResourceViewResolver internalResourceViewResolver = new InternalResourceViewResolver();
        internalResourceViewResolver.setViewClass(JstlView.class);
        internalResourceViewResolver.setPrefix(environment.getProperty("view.jsp.prefix", "/WEB-INF/website/"));
        internalResourceViewResolver.setSuffix(environment.getProperty("view.jsp.suffix", ".jsp"));
        internalResourceViewResolver.setOrder(environment.getRequiredProperty("view.jsp.order", int.class, 0));
        return internalResourceViewResolver;
    }
    
    /**
     * FreeMarker视图解析器
     */
    @Bean
    public FreeMarkerViewResolver freeMarkerViewResolver() {
        FreeMarkerViewResolver freeMarkerViewResolver = new FreeMarkerViewResolver();
        freeMarkerViewResolver.setViewClass(FreeMarkerView.class);
        freeMarkerViewResolver.setContentType(environment.getProperty("view.freemarker.contentType", "text/html; charset=utf-8"));
        freeMarkerViewResolver.setCache(true);
        freeMarkerViewResolver.setRequestContextAttribute("basePath");
        freeMarkerViewResolver.setSuffix(environment.getProperty("view.freemarker.suffix", ".ftl"));
        freeMarkerViewResolver.setOrder(environment.getRequiredProperty("view.freemarker.order", int.class, 1));
        return freeMarkerViewResolver;
    }
    
    /**
     * FreeMarker模板配置
     */
    @Bean
    public FreeMarkerConfigurer freeMarkerConfigurer() {
        FreeMarkerConfigurer freeMarkerConfigurer = new FreeMarkerConfigurer();
        freeMarkerConfigurer.setTemplateLoaderPath(environment.getProperty("view.freemarker.templateLoaderPath", "/WEB-INF/website/"));
        freeMarkerConfigurer.setDefaultEncoding(environment.getProperty("view.freemarker.defaultEncoding", "UTF-8"));
        return freeMarkerConfigurer;
    }
    
    /**
     * 消息转换器,Spring默认是注册了以下转换器的，但是为了让json转换器使用我们自定义的日期格式，所以需要全部重新配置
     */
    @SuppressWarnings("deprecation")
    private List<HttpMessageConverter<?>> createMessageConverters() {
        List<HttpMessageConverter<?>> converters = new ArrayList<HttpMessageConverter<?>>();
        // 字节数组消息转换器
        converters.add(new ByteArrayHttpMessageConverter());
        
        // 文本消息转换器
        StringHttpMessageConverter stringConverter = new StringHttpMessageConverter();
        stringConverter.setWriteAcceptCharset(false);
        
        // 文本消息转换器所支持的文本类型
        ArrayList<MediaType> textTypes = new ArrayList<MediaType>();
        // 原生格式
        textTypes.add(MediaType.TEXT_PLAIN);
        // HTML格式
        textTypes.add(MediaType.TEXT_HTML);
        // 以us-ascii编码XML内容
        textTypes.add(MediaType.TEXT_XML);
        // 以指定字符集编码XML内容
        textTypes.add(MediaType.APPLICATION_XML);
        
        stringConverter.setSupportedMediaTypes(textTypes);
        converters.add(stringConverter);
        
        // XML消息转换器
        converters.add(new XmlAwareFormHttpMessageConverter());
        converters.add(new Jaxb2RootElementHttpMessageConverter());
        
        //Json消息转换器
        MappingJacksonHttpMessageConverter jsonConverter = new MappingJacksonHttpMessageConverter();
        jsonConverter.setObjectMapper(JSONBinder.createMapper());
        converters.add(jsonConverter);
        
        return converters;
    }
    
    /**
     * 为映射请求处理器配置消息转换器
     * @return
     */
    @Bean
    public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {
        RequestMappingHandlerAdapter requestMappingHandlerAdapter = new RequestMappingHandlerAdapter();
        requestMappingHandlerAdapter.setMessageConverters(createMessageConverters());
        return requestMappingHandlerAdapter;
    }
    
}

我们首先配置了静态资源所在位置和请求路径，以避免静态资源被拦截成请求。
重写的void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer)方法是为了开启默认处理静态资源的Servlet。
然后我们配置了JSP和FreeMarker两种视图解析器，通过设置order属性来配置其优先级，当找不到优先级高的视图时会自动搜寻下一优先级的视图。
最后就是最重要的消息转换器的配置了。
我们知道，Spring是默认注册了这几个消息转换器的，那为什么我们还需要配置一次呢？

众所周知，Java8以前的时间API是设计的很丧心病狂的，我们通常需要花费大量的精力去处理时间格式。
而Spring默认配置的Json消息转换器的日期格式并不是我们需要的"yyyy-MM-dd HH:mm:ss"格式，所以为了统一我们在JSON返回时间时格式统一，我们在采用的Json转换工具Jackson的配置中设定了固定的日期格式，所以我们需要将Json消息转换器重新配置。
如果您清楚Java对于无参构造器的默认提供策略了解的话，相信您就能明白我们为什么需要重新配置这些消息转换器了。对于Jackson工具的封装源码如下：

package com.kiiwow.framework.json;

import java.io.IOException;
import java.text.SimpleDateFormat;

import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.xc.JaxbAnnotationIntrospector;

import com.kiiwow.framework.exception.KiiwowException;

/**
 * 
 * JSONBinder
 *
 * @Description: json与Obj互相转换
 * @author leon.gan
 *
 */
public final class JSONBinder<T> {
    
    private final Class<T> beanClass;

    private final Class<?>[] elementClasses;
    
    private JSONBinder(Class<T> beanClass, Class<?>... elementClasses) {
        this.beanClass = beanClass;
        this.elementClasses = elementClasses;
    }
    
    public static final String DATE_FORMAT_DATETIME = "yyyy-MM-dd HH:mm:ss";
    
    public static <T> JSONBinder<T> binder(Class<T> beanClass, Class<?>... elementClasses) {
        return new JSONBinder<T>(beanClass, elementClasses);
    }

    public static ObjectMapper createMapper() {
        ObjectMapper mapper = new ObjectMapper();
        SimpleDateFormat dateFormat = new SimpleDateFormat(DATE_FORMAT_DATETIME);
        mapper.setSerializationConfig(mapper.getSerializationConfig().withDateFormat(dateFormat));
        mapper.setDeserializationConfig(mapper.getDeserializationConfig().withDateFormat(dateFormat));
        mapper.setAnnotationIntrospector(new JaxbAnnotationIntrospector());
        return mapper;
    }

    public T fromJSON(String json) {
        ObjectMapper mapper = createMapper();
        try {
            return elementClasses == null || elementClasses.length == 0 ? mapper.readValue(json, beanClass) : fromJSONToGeneric(json);
        } catch (IOException e) {
            throw new KiiwowException(e);
        }
    }

    private T fromJSONToGeneric(String json) throws IOException {
        ObjectMapper mapper = createMapper();
        return mapper.readValue(json, mapper.getTypeFactory().constructParametricType(beanClass, elementClasses));
    }

    public String toJSON(T object) {
        ObjectMapper mapper = createMapper();
        try {
            return mapper.writeValueAsString(object);
        } catch (IOException e) {
            throw new KiiwowException(e);
        }
    }
}

至此，我们对于Spring的所有基本配置就都完成了，我们彻底抛弃了XML配置文件，只需要使用继承就可以获得这些配置并应用于我们的项目中。在下一篇博文中，我们将讲解怎么在我们项目中使用这些配置，并怎么使用Java类代替web.xml文件。