SpringMVC之源码分析--ThemeResolver（一）

时间 2019-11-11

标签 springmvc 源码分析 themeresolver 栏目 Spring 繁體版

原文原文链接

概述

主题就是系统的总体样式或风格，可经过Spring MVC框架提供的主题（theme）设置应用的总体样式风格，提升用户体验。Spring MVC的主题就是一些静态资源的集合，即包括样式及图片，用来控制应用的视觉风格。html

Spring MVC主题包括两部份内容，分别是Theme和ThemeResolver，下面是对两部份内容的介绍：web

Theme

应用中使用Theme主题时，必须实现org.springframework.ui.context.ThemeSource接口，web应用上下文WebApplicationContext接口继承自ThemeSource，可是实现功能委派给具体的实现，默认的委派给org.springframework.ui.context.support.ResouceBundleThemeSource类实现，此类默认从classpath加载主题属性文件。不管是自定义ThemeSource接口的实现仍是经过配置属性文件路劲的ResourceBundleThemeSource实现，都须要在Spring上下文中定义此bean，而且bean的id必须为themeSource，Spring会自动发现并使用。spring

ThemeResolver

在Spring上下文中定义了Theme后，DispatcherServlet会在Spring容器中查找id为themeResolver的Bean并使用。ThemeResolver工做原理与LocaleResolver工做原理基本是同样的，它在request中查找theme主题并能够修改request的theme主题。Spring提供了以下的主题解析器：cookie

FixedThemeResolver 默认主题解析器，使用固定的主题，经过defaultThemeName属性设置，即此属性指定主题属性文件的文件名。此解析器不能动态设置主题。
SessionThemeResolver 经过用户会话来保持主题，每一个会话（session）仅须要设置一次，全部请求共享主题，可是不能两个会话共享。
CookieThemeResolver 使用客户端cookie存储的主题

Spring提供了ThemeChangeInterceptor拦截器，经过request参数控制改变用户请求的主题。session

FixedThemeResolver

默认的主题解析器（在DispatcherServlet.properties中配置默认策略），实现ThemeResolver接口，使用固定的主题，主题的名字（就是主题的属性文件名）可经过defaultThemeName属性指定，该值默认是theme，该类比较简单，源码以下，作下注释介绍：mvc

public class FixedThemeResolver extends AbstractThemeResolver {
    // 解析主题文件名
    @Override
    public String resolveThemeName(HttpServletRequest request) {
        // 返回主题文件名，默认值为theme（在父类中定义）
        return getDefaultThemeName();
    }
    // 设置主题文件名，此解析器不能设置。
    @Override
    public void setThemeName(
            HttpServletRequest request, @Nullable HttpServletResponse response, @Nullable String themeName) {
        throw new UnsupportedOperationException("Cannot change theme - use a different theme resolution strategy");
    }

}

实战

目标

练习使用FixedThemeResolver解析器，最终效果以下：app

项目结构

在resources下建立了主题文件夹及主题文件，webapp下建立了静态资源文件。框架

主题配置文件（myTheme.properties）

指定了一张测试图片，以下：webapp

background=/img/wolf.jpg

Spring配置文件

配置themeSource和themeResolver，以下：jsp

<!-- 默认Servlet处理静态资源 -->
<mvc:default-servlet-handler />
<!-- jsp视图映射与视图解析 -->
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
    <property name="prefix" value="/WEB-INF/jsp/"/>
    <property name="suffix" value=".jsp"/>
</bean>

<!-- 加载主题资源文件 -->
<bean id="themeSource" class="org.springframework.ui.context.support.ResourceBundleThemeSource">
    <!-- 指定文件前缀，即文件所在目录，若是放在classpath下，value为空（默认从classpath下加载） -->
    <property name="basenamePrefix" value="theme."/>
</bean>
<!-- 使用FixedThemeResolver -->
<bean id="themeResolver" class="org.springframework.web.servlet.theme.FixedThemeResolver">
    <!-- 定义theme文件的名称 -->
    <property name="defaultThemeName" value="myTheme"/>
</bean>

说明：

一、ResourceBundleThemeSource的属性basenamePrefix即为主题属性文件所在目录名称，其后必须有"."或"/"。

二、FixedThemeResolver是Spring默认的解析器，再此配置是为了自定义defaultThemeName属性值，即属性文件名称。

视图

本例使用jsp视图展现，代码以下：

<%@ page contentType="text/html;charset=UTF-8" %>
<%@ taglib prefix="spring" uri="http://www.springframework.org/tags"%>
<html>
<head>
    <title>Spring MVC Theme</title>
</head>
<body>

    <img src="<spring:theme code='background'/>" style="width: 500px;height: 300px;">

</body>
</html>

控制器

为了测试，编写Controller控制器，跳转至jsp页面，代码以下：

@RequestMapping("/theme")
public String theme(){
    return "theme";
}

至此，启动程序并访问/theme地址便可看到以前的效果图。

总结

本例主要分析了Spring MVC对Theme总体支持，并实战了默认的ThemeResolver，后续继续分析SessionThemeResolver和CookieThemeResolver。其实此解析器与LocaleResolver的实现原理基本相同。

最后建立了qq群方便你们交流，可扫描加入，同时也可加我qq：276420284，共同窗习、共同进步，谢谢！