Skip to content
This repository has been archived by the owner on Jan 8, 2020. It is now read-only.

Commit

Permalink
Caching date/time/dateTime formatter by formatString in Environment.
Browse files Browse the repository at this point in the history
  • Loading branch information
@ddekany
ddekany committed Aug 30, 2015
1 parent 52669ec commit ecb0c01
Showing 1 changed file with 87 additions and 33 deletions.
120 changes: 87 additions & 33 deletions src/main/java/freemarker/core/Environment.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public final class Environment extends Configurable {
* like ${lastModified?string.iso}.
*
* <p>The index of the array is calculated from what kind of formatter we want
* (see {@link #getCachedTemplateDateFormatIndex(int, boolean, boolean)}):<br>
* (see {@link #getTemplateDateFormatCacheArrayIndex(int, boolean, boolean)}):<br>
* Zoned input: 0: U, 1: T, 2: D, 3: DT<br>
* Zoneless input: 4: U, 5: T, 6: D, 7: DT<br>
* Sys def TZ + Zoned input: 8: U, 9: T, 10: D, 11: DT<br>
Expand All @@ -128,7 +128,9 @@ public final class Environment extends Configurable {
* when first needed the array will be created. The array elements also start out as {@code null}-s, and they
* are filled as the particular kind of formatter is first needed.
*/
private TemplateDateFormat[] cachedTemplateDateFormats;
private TemplateDateFormat[] cachedTempDateFormatArray;
/** Similar to {@link #cachedTempDateFormatArray}, but used when a formatting string was specified. */
private HashMap<String, TemplateDateFormat>[] cachedTempDateFormatsByFmtStrArray;
private static final int CACHED_TDFS_ZONELESS_INPUT_OFFS = 4;
private static final int CACHED_TDFS_DEF_SYS_TZ_OFFS = CACHED_TDFS_ZONELESS_INPUT_OFFS * 2;
private static final int CACHED_TDFS_LENGTH = CACHED_TDFS_DEF_SYS_TZ_OFFS * 2;
Expand Down Expand Up @@ -280,7 +282,8 @@ private void clearCachedValues() {
cachedTemplateNumberFormats = null;
cachedTemplateNumberFormat = null;

cachedTemplateDateFormats = null;
cachedTempDateFormatArray = null;
cachedTempDateFormatsByFmtStrArray = null;
cachedXSLocTempDateFormatFactory = cachedSQLDTXSLocTempDateFormatFactory = null;
cachedISOLocTempDateFormatFactory = cachedSQLDTISOLocTempDateFormatFactory = null;
cachedJavaLocTempDateFormatFactory = cachedSQLDTJavaLocTempDateFormatFactory = null;
Expand Down Expand Up @@ -840,14 +843,16 @@ public void setLocale(Locale locale) {
javaLocTempNumberFormatFactory.setLocale(locale);
}

if (cachedTemplateDateFormats != null) {
if (cachedTempDateFormatArray != null) {
for (int i = 0; i < CACHED_TDFS_LENGTH; i++) {
final TemplateDateFormat f = cachedTemplateDateFormats[i];
final TemplateDateFormat f = cachedTempDateFormatArray[i];
if (f != null && f.isLocaleBound()) {
cachedTemplateDateFormats[i] = null;
cachedTempDateFormatArray[i] = null;
}
}
}

cachedTempDateFormatsByFmtStrArray = null;

if (cachedXSLocTempDateFormatFactory != null) {
cachedXSLocTempDateFormatFactory.setLocale(locale);
Expand Down Expand Up @@ -880,9 +885,14 @@ public void setTimeZone(TimeZone timeZone) {
super.setTimeZone(timeZone);

if (!timeZone.equals(prevTimeZone)) {
if (cachedTemplateDateFormats != null) {
if (cachedTempDateFormatArray != null) {
for (int i = 0; i < CACHED_TDFS_SQL_D_T_TZ_OFFS; i++) {
cachedTempDateFormatArray[i] = null;
}
}
if (cachedTempDateFormatsByFmtStrArray != null) {
for (int i = 0; i < CACHED_TDFS_SQL_D_T_TZ_OFFS; i++) {
cachedTemplateDateFormats[i] = null;
cachedTempDateFormatsByFmtStrArray[i] = null;
}
}

Expand All @@ -900,9 +910,17 @@ public void setSQLDateAndTimeTimeZone(TimeZone timeZone) {
super.setSQLDateAndTimeTimeZone(timeZone);

if (!nullSafeEquals(timeZone, prevTimeZone)) {
if (cachedTemplateDateFormats != null) {
if (cachedTempDateFormatArray != null) {
for (int i = CACHED_TDFS_SQL_D_T_TZ_OFFS; i < CACHED_TDFS_LENGTH; i++) {
cachedTemplateDateFormats[i] = null;
TemplateDateFormat format = cachedTempDateFormatArray[i];
if (format != null && format.isTimeZoneBound()) {
cachedTempDateFormatArray[i] = null;
}
}
}
if (cachedTempDateFormatsByFmtStrArray != null) {
for (int i = CACHED_TDFS_SQL_D_T_TZ_OFFS; i < CACHED_TDFS_LENGTH; i++) {
cachedTempDateFormatsByFmtStrArray[i] = null;
}
}

Expand Down Expand Up @@ -1093,7 +1111,7 @@ String formatNumber(Number number, BackwardCompatibleTemplateNumberFormat format
*
* @since 2.3.24
*/
public TemplateNumberFormat getTemplateNumberFormat() throws InvalidFormatStringException {
TemplateNumberFormat getTemplateNumberFormat() throws InvalidFormatStringException {
TemplateNumberFormat format = cachedTemplateNumberFormat;
if (format == null) {
format = getTemplateNumberFormat(getNumberFormat());
Expand All @@ -1112,7 +1130,7 @@ public TemplateNumberFormat getTemplateNumberFormat() throws InvalidFormatString
*
* @since 2.3.24
*/
public TemplateNumberFormat getTemplateNumberFormat(String formatString) throws InvalidFormatStringException {
TemplateNumberFormat getTemplateNumberFormat(String formatString) throws InvalidFormatStringException {
if (cachedTemplateNumberFormats == null) {
cachedTemplateNumberFormats = new HashMap<String, TemplateNumberFormat>();
} else {
Expand Down Expand Up @@ -1211,9 +1229,9 @@ public void setTimeFormat(String timeFormat) {
String prevTimeFormat = getTimeFormat();
super.setTimeFormat(timeFormat);
if (!timeFormat.equals(prevTimeFormat)) {
if (cachedTemplateDateFormats != null) {
if (cachedTempDateFormatArray != null) {
for (int i = 0; i < CACHED_TDFS_LENGTH; i += CACHED_TDFS_ZONELESS_INPUT_OFFS) {
cachedTemplateDateFormats[i + TemplateDateModel.TIME] = null;
cachedTempDateFormatArray[i + TemplateDateModel.TIME] = null;
}
}
}
Expand All @@ -1224,9 +1242,9 @@ public void setDateFormat(String dateFormat) {
String prevDateFormat = getDateFormat();
super.setDateFormat(dateFormat);
if (!dateFormat.equals(prevDateFormat)) {
if (cachedTemplateDateFormats != null) {
if (cachedTempDateFormatArray != null) {
for (int i = 0; i < CACHED_TDFS_LENGTH; i += CACHED_TDFS_ZONELESS_INPUT_OFFS) {
cachedTemplateDateFormats[i + TemplateDateModel.DATE] = null;
cachedTempDateFormatArray[i + TemplateDateModel.DATE] = null;
}
}
}
Expand All @@ -1237,9 +1255,9 @@ public void setDateTimeFormat(String dateTimeFormat) {
String prevDateTimeFormat = getDateTimeFormat();
super.setDateTimeFormat(dateTimeFormat);
if (!dateTimeFormat.equals(prevDateTimeFormat)) {
if (cachedTemplateDateFormats != null) {
if (cachedTempDateFormatArray != null) {
for (int i = 0; i < CACHED_TDFS_LENGTH; i += CACHED_TDFS_ZONELESS_INPUT_OFFS) {
cachedTemplateDateFormats[i + TemplateDateModel.DATETIME] = null;
cachedTempDateFormatArray[i + TemplateDateModel.DATETIME] = null;
}
}
}
Expand Down Expand Up @@ -1281,7 +1299,8 @@ String formatDate(TemplateDateModel tdm, String formatString, Expression tdmSour
boolean isSQLDateOrTime = isSQLDateOrTimeClass(date.getClass());
try {
return getTemplateDateFormat(
tdm.getDateType(), isSQLDateOrTime, shouldUseSQLDTTimeZone(isSQLDateOrTime), formatString, null)
tdm.getDateType(), isSQLDateOrTime, shouldUseSQLDTTimeZone(isSQLDateOrTime), formatString, true,
null)
.format(tdm);
} catch (UnknownDateTypeFormattingUnsupportedException e) {
throw MessageUtil.newCantFormatUnknownTypeDateException(tdmSourceExpr, e);
Expand Down Expand Up @@ -1316,14 +1335,14 @@ private TemplateDateFormat getTemplateDateFormat(
if (dateType == TemplateDateModel.UNKNOWN) {
throw MessageUtil.newCantFormatUnknownTypeDateException(dateSourceExpr, null);
}
int cacheIdx = getCachedTemplateDateFormatIndex(dateType, isSQLDateOrTime, useSQLDTTZ);
TemplateDateFormat[] cachedTemplateDateFormats = this.cachedTemplateDateFormats;
int cacheIdx = getTemplateDateFormatCacheArrayIndex(dateType, isSQLDateOrTime, useSQLDTTZ);
TemplateDateFormat[] cachedTemplateDateFormats = this.cachedTempDateFormatArray;
if (cachedTemplateDateFormats == null) {
cachedTemplateDateFormats = new TemplateDateFormat[CACHED_TDFS_LENGTH];
this.cachedTemplateDateFormats = cachedTemplateDateFormats;
this.cachedTempDateFormatArray = cachedTemplateDateFormats;
}
TemplateDateFormat f = cachedTemplateDateFormats[cacheIdx];
if (f == null) {
TemplateDateFormat format = cachedTemplateDateFormats[cacheIdx];
if (format == null) {
final String settingName;
final String settingValue;
switch (dateType) {
Expand All @@ -1343,14 +1362,14 @@ private TemplateDateFormat getTemplateDateFormat(
throw new _TemplateModelException("Invalid date type enum: ", Integer.valueOf(dateType));
} // switch

f = getTemplateDateFormat(
format = getTemplateDateFormat(
dateType, isSQLDateOrTime,
useSQLDTTZ, settingValue, settingName);
useSQLDTTZ, settingValue, false,
settingName);

cachedTemplateDateFormats[cacheIdx] = f;
cachedTemplateDateFormats[cacheIdx] = format;
}
return f;

return format;
}

/**
Expand All @@ -1366,7 +1385,8 @@ TemplateDateFormat getTemplateDateFormat(
boolean isSQLDateOrTime = isSQLDateOrTimeClass(dateClass);
return getTemplateDateFormat(
dateType, isSQLDateOrTime,
shouldUseSQLDTTimeZone(isSQLDateOrTime), formatString, null);
shouldUseSQLDTTimeZone(isSQLDateOrTime), formatString, true,
null);
} catch (UnknownDateTypeFormattingUnsupportedException e) {
throw MessageUtil.newCantFormatUnknownTypeDateException(dateSourceExpr, e);
}
Expand All @@ -1385,9 +1405,39 @@ TemplateDateFormat getTemplateDateFormat(
* if the format string was specified directly for this formatting call.
*/
private TemplateDateFormat getTemplateDateFormat(
int dateType, boolean zonelessInput, boolean useSQLDTTZ, String formatString,
int dateType, boolean zonelessInput, boolean useSQLDTTZ, String formatString, boolean cacheByFormatString,
String formatStringCfgSettingName)
throws TemplateModelException, UnknownDateTypeFormattingUnsupportedException {
HashMap<String, TemplateDateFormat> cachedFormatsByFormatString;
if (cacheByFormatString) {
HashMap<String, TemplateDateFormat>[] cachedTempDateFormatsByFmtStrArray
= this.cachedTempDateFormatsByFmtStrArray;
if (cachedTempDateFormatsByFmtStrArray == null) {
cachedTempDateFormatsByFmtStrArray = new HashMap[CACHED_TDFS_LENGTH];
this.cachedTempDateFormatsByFmtStrArray = cachedTempDateFormatsByFmtStrArray;
}

TemplateDateFormat format;
{
int cacheArrIdx = getTemplateDateFormatCacheArrayIndex(dateType, zonelessInput, useSQLDTTZ);
cachedFormatsByFormatString = cachedTempDateFormatsByFmtStrArray[cacheArrIdx];
if (cachedFormatsByFormatString == null) {
cachedFormatsByFormatString = new HashMap<String, TemplateDateFormat>(4);
cachedTempDateFormatsByFmtStrArray[cacheArrIdx] = cachedFormatsByFormatString;
format = null;
} else {
format = cachedFormatsByFormatString.get(formatString);
}
}

if (format != null) {
return format;
}
// Cache miss; falls through
} else {
cachedFormatsByFormatString = null;
}

final int formatStringLen = formatString.length();
final String formatParams;

Expand Down Expand Up @@ -1443,7 +1493,11 @@ private TemplateDateFormat getTemplateDateFormat(
}

try {
return templateDateFormatFactory.get(dateType, zonelessInput, formatParams);
TemplateDateFormat format = templateDateFormatFactory.get(dateType, zonelessInput, formatParams);
if (cachedFormatsByFormatString != null) { // if the cachedByFormatString param is true
cachedFormatsByFormatString.put(formatString, format);
}
return format;
} catch (InvalidFormatParametersException e) {
throw new _TemplateModelException(e.getCause(),
(formatStringCfgSettingName == null
Expand Down Expand Up @@ -1483,7 +1537,7 @@ private static boolean isSQLDateOrTimeClass(Class dateClass) {
|| java.sql.Time.class.isAssignableFrom(dateClass))));
}

private int getCachedTemplateDateFormatIndex(int dateType, boolean zonelessInput, boolean sqlDTTZ) {
private int getTemplateDateFormatCacheArrayIndex(int dateType, boolean zonelessInput, boolean sqlDTTZ) {
return dateType
+ (zonelessInput ? CACHED_TDFS_ZONELESS_INPUT_OFFS : 0)
+ (sqlDTTZ ? CACHED_TDFS_SQL_D_T_TZ_OFFS : 0);
Expand Down

0 comments on commit ecb0c01

Please sign in to comment.