com.jfinal.template.ext.spring

Class JFinalViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.springframework.web.servlet.view.AbstractTemplateViewResolver

com.jfinal.template.ext.spring.JFinalViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver

public class JFinalViewResolver
extends org.springframework.web.servlet.view.AbstractTemplateViewResolver

JFinalViewResolver

 关键配置：
 1：setDevMode(true) 设置支持热加载模板文件
 
 2：addSharedFunction(file) 添加共享函数文件
 
 3：setSourceFactory(new ClassPathSourceFactory())，从 class path 与 jar 包中加载模板文件
    一般用于 sprint boot
 
 4：setSessionInView(true) 设置在模板中可通过 #(session.value) 访问 session 中的数据
 
 5：setCreateSession(boolean) 用来设置 request.getSession(boolean) 调时的参数
 
 6：setBaseTemplatePath(path) 设置模板文件所在的基础路径，通常用于 spring mvc
   默认值为 web 根路径，一般不需要设置
 

Field Summary

Fields

Modifier and Type	Field and Description
static Engine	engine

Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

DEFAULT_CACHE_LIMIT

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
JFinalViewResolver()

Method Summary

Modifier and Type	Method and Description
void	addDirective(String directiveName, Class<? extends Directive> directiveClass) 添加自定义指令
void	addDirective(String directiveName, Directive directive) Deprecated.
static void	addExtensionMethod(Class<?> targetClass, Class<?> extensionClass) 添加扩展方法
static void	addExtensionMethod(Class<?> targetClass, Object objectOfExtensionClass) 添加扩展方法
void	addSharedFunction(String fileName) 添加 shared function 文件，可调用多次添加多个文件
void	addSharedMethod(Class<?> sharedMethodFromClass) 添加共享方法
void	addSharedMethod(Object sharedMethodFromObject) 添加共享方法
void	addSharedObject(String name, Object object) 添加共享对象
Engine	getEngine()
protected void	initServletContext(javax.servlet.ServletContext servletContext) spring 回调，利用 ServletContext 做必要的初始化工作
protected org.springframework.web.servlet.View	loadView(String viewName, Locale locale) 支持 jfinal enjoy、jsp、freemarker、velocity 四类模板共存于一个项目中 注意：这里采用识别 ".jsp"、".ftl"、".vm" 模板后缀名的方式来实现功能 所以 jfinal enjoy 模板不要采用上述三种后缀名，否则功能将失效 还要注意与 jsp、freemarker、velocity 以外类型模板共存使用时 需要改造该方法
static JFinalViewResolver	me() me 会保存在第一次被创建对象
protected Class<?>	requiredViewClass()
void	setBaseTemplatePath(String baseTemplatePath) 设置模板基础路径
void	setCreateSession(boolean createSession) 在使用 request.getSession(createSession) 时传入 用来指示 session 不存在时是否立即创建
void	setDatePattern(String datePattern) 设置 #date(...) 指令，对于 Date、Timestamp、Time 的输出格式
void	setDevMode(boolean devMode) 设置开发模式，值为 true 时支持模板文件热加载
void	setEncoding(String encoding) 设置 encoding
void	setSessionInView(boolean sessionInView) 设置为 true 时支持在模板中使用 #(session.value) 形式访问 session 中的数据
void	setSharedFunction(String sharedFunctionFiles) 设置 shared function 文件，多个文件用逗号分隔 主要用于 Spring MVC 的 xml 配置方式 Spring Boot 的代码配置方式可使用 addSharedFunction(...) 进行配置
void	setSharedFunctionList(List<String> sharedFunctionList) 通过 List 配置多个 shared function file
void	setSourceFactory(ISourceFactory sourceFactory) 设置 ISourceFactory 用于为 engine 切换不同的 ISource 实现类

Methods inherited from class org.springframework.web.servlet.view.AbstractTemplateViewResolver

buildView, setAllowRequestOverride, setAllowSessionOverride, setExposeRequestAttributes, setExposeSessionAttributes, setExposeSpringMacroHelpers

Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

canHandle, createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRedirectHosts, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHosts, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

clearCache, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, setCacheLimit, setCacheUnresolved

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

engine

public static final Engine engine

Constructor Detail

JFinalViewResolver

public JFinalViewResolver()

Method Detail

me

public static JFinalViewResolver me()

me 会保存在第一次被创建对象

getEngine

public Engine getEngine()

setDevMode

public void setDevMode(boolean devMode)

设置开发模式，值为 true 时支持模板文件热加载

setSharedFunction

public void setSharedFunction(String sharedFunctionFiles)

设置 shared function 文件，多个文件用逗号分隔 主要用于 Spring MVC 的 xml 配置方式 Spring Boot 的代码配置方式可使用 addSharedFunction(...) 进行配置

setSharedFunctionList

public void setSharedFunctionList(List<String> sharedFunctionList)

通过 List 配置多个 shared function file

 配置示例：
        
        
                _layout.html
                _paginate.html
        
        
 

addSharedFunction

public void addSharedFunction(String fileName)

添加 shared function 文件，可调用多次添加多个文件

addDirective

public void addDirective(String directiveName,
                         Class<? extends Directive> directiveClass)

添加自定义指令

addDirective

@Deprecated
public void addDirective(String directiveName,
                                     Directive directive)

Deprecated.

添加自定义指令，已被 addDirective(String, Class) 方法取代

addSharedObject

public void addSharedObject(String name,
                            Object object)

添加共享对象

addSharedMethod

public void addSharedMethod(Object sharedMethodFromObject)

添加共享方法

addSharedMethod

public void addSharedMethod(Class<?> sharedMethodFromClass)

添加共享方法

addExtensionMethod

public static void addExtensionMethod(Class<?> targetClass,
                                      Object objectOfExtensionClass)

添加扩展方法

addExtensionMethod

public static void addExtensionMethod(Class<?> targetClass,
                                      Class<?> extensionClass)

添加扩展方法

setSourceFactory

public void setSourceFactory(ISourceFactory sourceFactory)

设置 ISourceFactory 用于为 engine 切换不同的 ISource 实现类

 配置为 ClassPathSourceFactory 时特别注意：
    由于在 initServletContext() 通过如下方法中已设置了 baseTemplatePath 值：
        setBaseTemplatePath(servletContext.getRealPath("/"))
    
    而 ClassPathSourceFactory 在 initServletContext() 方法中设置的
    值之下不能工作，所以在本方法中通过如下方法清掉了该值：
         setBaseTemplatePath(null)
    
    这种处理方式适用于绝大部分场景，如果在使用 ClassPathSourceFactory 的同时
    仍然需要设置 baseTemplatePath，则在调用该方法 “之后” 通过如下代码再次配置：
         setBaseTemplatePath(value)
 

setBaseTemplatePath

public void setBaseTemplatePath(String baseTemplatePath)

设置模板基础路径

setSessionInView

public void setSessionInView(boolean sessionInView)

设置为 true 时支持在模板中使用 #(session.value) 形式访问 session 中的数据

setCreateSession

public void setCreateSession(boolean createSession)

在使用 request.getSession(createSession) 时传入 用来指示 session 不存在时是否立即创建

setEncoding

public void setEncoding(String encoding)

设置 encoding

setDatePattern

public void setDatePattern(String datePattern)

设置 #date(...) 指令，对于 Date、Timestamp、Time 的输出格式

requiredViewClass

protected Class<?> requiredViewClass()

Overrides:

requiredViewClass in class org.springframework.web.servlet.view.AbstractTemplateViewResolver

loadView

protected org.springframework.web.servlet.View loadView(String viewName,
                                                        Locale locale)
                                                 throws Exception

支持 jfinal enjoy、jsp、freemarker、velocity 四类模板共存于一个项目中 注意：这里采用识别 ".jsp"、".ftl"、".vm" 模板后缀名的方式来实现功能 所以 jfinal enjoy 模板不要采用上述三种后缀名，否则功能将失效 还要注意与 jsp、freemarker、velocity 以外类型模板共存使用时 需要改造该方法

Overrides:

loadView in class org.springframework.web.servlet.view.UrlBasedViewResolver

Throws:

Exception

initServletContext

protected void initServletContext(javax.servlet.ServletContext servletContext)

spring 回调，利用 ServletContext 做必要的初始化工作

Overrides:

initServletContext in class org.springframework.web.context.support.WebApplicationObjectSupport