Skip to content

performance improvement for MessageCodeGenerator and stylesheets #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chrjohn wants to merge 1 commit into
base: master
Choose a base branch
from
Open

performance improvement for MessageCodeGenerator and stylesheets #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 99 additions & 62 deletions src/main/java/org/quickfixj/codegenerator/MessageCodeGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@

package org.quickfixj.codegenerator;

import net.sf.saxon.TransformerFactoryImpl;
import net.sf.saxon.om.NodeInfo;
import net.sf.saxon.trans.XPathException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
Expand All @@ -27,10 +30,10 @@
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Templates;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.TransformerFactoryConfigurationError;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
Expand Down Expand Up @@ -120,7 +123,7 @@ private void generateClassCode(Task task, String className, Map<String, String>
}
parameters.put("messagePackage", task.getMessagePackage());
parameters.put("fieldPackage", task.getFieldPackage());
Document document = getSpecification(task);
NodeInfo document = getSpecificationTree(task);
generateCodeFile(task, document, parameters, task.getOutputBaseDirectory() + "/"
+ task.getMessageDirectory() + "/" + className + ".java", createTransformer(task,
className + ".xsl"));
Expand All @@ -132,36 +135,38 @@ private void generateFieldClasses(Task task) throws ParserConfigurationException
+ "/";
logInfo(task.getName() + ": generating field classes in " + outputDirectory);
writePackageDocumentation(outputDirectory, "FIX field definitions for " + task.getName());
Document document = getSpecification(task);
List<String> fieldNames = getNames(document.getDocumentElement(), "fields/field");
List<String> fieldNames = getNames(getSpecification(task).getDocumentElement(), "fields/field");
try {
NodeInfo document = getSpecificationTree(task);
Transformer transformer = createTransformer(task, "Fields.xsl");
// parameters which are the same for all fields are only set once
Map<String, String> parameters = new HashMap<>();
parameters.put("fieldPackage", task.getFieldPackage());
String utcTimestampPrecision = task.getUtcTimestampPrecision();
if (utcTimestampPrecision != null) {
String utcTimestampPrecisionParameterName = "utcTimestampPrecision";
if (!UTC_TIMESTAMP_PRECISION_ALLOWED_VALUES.contains(utcTimestampPrecision)) {
throw new CodeGenerationException(new IllegalArgumentException(String.format(
"Allowed values for parameter %s are %s. Supplied value: \"%s\".",
utcTimestampPrecisionParameterName,
String.join(", ", UTC_TIMESTAMP_PRECISION_ALLOWED_VALUES),
utcTimestampPrecision
)));
}
parameters.put(utcTimestampPrecisionParameterName, utcTimestampPrecision);
}
if (task.isDecimalGenerated()) {
parameters.put("decimalType", "java.math.BigDecimal");
parameters.put("decimalConverter", "Decimal");
}
parameters.put(XSLPARAM_SERIAL_UID, SERIAL_UID_STR);
setParameters(transformer, parameters);
for (String fieldName : fieldNames) {
String outputFile = outputDirectory + fieldName + ".java";
if (!new File(outputFile).exists() || task.isOverwrite()) { // if overwrite is set, then transform and generate the file
logDebug("field: " + fieldName);
Map<String, String> parameters = new HashMap<>();
parameters.put("fieldName", fieldName);
parameters.put("fieldPackage", task.getFieldPackage());
String utcTimestampPrecision = task.getUtcTimestampPrecision();
if (utcTimestampPrecision != null) {
String utcTimestampPrecisionParameterName = "utcTimestampPrecision";
if (!UTC_TIMESTAMP_PRECISION_ALLOWED_VALUES.contains(utcTimestampPrecision)) {
throw new CodeGenerationException(new IllegalArgumentException(String.format(
"Allowed values for parameter %s are %s. Supplied value: \"%s\".",
utcTimestampPrecisionParameterName,
String.join(", ", UTC_TIMESTAMP_PRECISION_ALLOWED_VALUES),
utcTimestampPrecision
)));
}
parameters.put(utcTimestampPrecisionParameterName, utcTimestampPrecision);
}
if (task.isDecimalGenerated()) {
parameters.put("decimalType", "java.math.BigDecimal");
parameters.put("decimalConverter", "Decimal");
}
parameters.put(XSLPARAM_SERIAL_UID, SERIAL_UID_STR);
generateCodeFile(task, document, parameters, outputFile, transformer);
generateCodeFile(task, document, Collections.singletonMap("fieldName", fieldName),
outputFile, transformer);
}
}
} catch (Exception e) {
Expand All @@ -176,19 +181,19 @@ private void generateMessageSubclasses(Task task) throws ParserConfigurationExce
String outputDirectory = task.getOutputBaseDirectory() + "/" + task.getMessageDirectory()
+ "/";
writePackageDocumentation(outputDirectory, "Message classes");
Document document = getSpecification(task);
List<String> messageNames = getNames(document.getDocumentElement(), "messages/message");
List<String> messageNames = getNames(getSpecification(task).getDocumentElement(), "messages/message");
NodeInfo document = getSpecificationTree(task);
Transformer transformer = createTransformer(task, "MessageSubclass.xsl");
Map<String, String> parameters = new HashMap<>();
parameters.put(XSLPARAM_SERIAL_UID, SERIAL_UID_STR);
parameters.put("orderedFields", Boolean.toString(task.isOrderedFields()));
parameters.put("fieldPackage", task.getFieldPackage());
parameters.put("messagePackage", task.getMessagePackage());
setParameters(transformer, parameters);
for (String messageName : messageNames) {
logDebug("generating message class: " + messageName);
Map<String, String> parameters = new HashMap<>();
parameters.put("itemName", messageName);
parameters.put(XSLPARAM_SERIAL_UID, SERIAL_UID_STR);
parameters.put("orderedFields", Boolean.toString(task.isOrderedFields()));
parameters.put("fieldPackage", task.getFieldPackage());
parameters.put("messagePackage", task.getMessagePackage());
generateCodeFile(task, document, parameters, outputDirectory + messageName + ".java",
transformer);
generateCodeFile(task, document, Collections.singletonMap("itemName", messageName),
outputDirectory + messageName + ".java", transformer);
}
}

Expand All @@ -198,44 +203,73 @@ private void generateComponentClasses(Task task) throws ParserConfigurationExcep
logInfo(task.getName() + ": generating component classes");
String outputDirectory = task.getOutputBaseDirectory() + "/" + task.getMessageDirectory()
+ "/component/";
Document document = getSpecification(task);
List<String> componentNames = getNames(document.getDocumentElement(),
List<String> componentNames = getNames(getSpecification(task).getDocumentElement(),
"components/component");
if (componentNames.size() > 0) {
writePackageDocumentation(outputDirectory, "Message component classes");
}
NodeInfo document = getSpecificationTree(task);
Transformer transformer = createTransformer(task, "MessageSubclass.xsl");
Map<String, String> parameters = new HashMap<>();
parameters.put("baseClass", "quickfix.MessageComponent");
parameters.put("subpackage", ".component");
parameters.put("fieldPackage", task.getFieldPackage());
parameters.put("messagePackage", task.getMessagePackage());
parameters.put("orderedFields", Boolean.toString(task.isOrderedFields()));
parameters.put(XSLPARAM_SERIAL_UID, SERIAL_UID_STR);
setParameters(transformer, parameters);
for (String componentName : componentNames) {
logDebug("generating component class: " + componentName);
Map<String, String> parameters = new HashMap<>();
parameters.put("itemName", componentName);
parameters.put("baseClass", "quickfix.MessageComponent");
parameters.put("subpackage", ".component");
parameters.put("fieldPackage", task.getFieldPackage());
parameters.put("messagePackage", task.getMessagePackage());
parameters.put("orderedFields", Boolean.toString(task.isOrderedFields()));
parameters.put(XSLPARAM_SERIAL_UID, SERIAL_UID_STR);
generateCodeFile(task, document, parameters, outputDirectory + componentName + ".java",
transformer);
generateCodeFile(task, document, Collections.singletonMap("itemName", componentName),
outputDirectory + componentName + ".java", transformer);
}
}

// A single factory is used so that compiled stylesheets and the specification trees share
// the same Saxon configuration (and name pool).
private final TransformerFactoryImpl transformerFactory = new TransformerFactoryImpl();

// Compiled stylesheets are reused for all files and all tasks using the same stylesheet.
private final Map<String, Templates> templatesCache = new HashMap<>();

private Transformer createTransformer(Task task, String xsltFile)
throws TransformerFactoryConfigurationError, TransformerConfigurationException {
StreamSource styleSource;
File xslt = new File(task.getTransformDirectory() + "/" + xsltFile);
if (xslt.exists()) {
styleSource = new StreamSource(xslt);
} else {
logInfo("Loading predefined xslt file:" + xsltFile);
styleSource = new StreamSource(this.getClass().getResourceAsStream(xsltFile));
String cacheKey = xslt.exists() ? xslt.getAbsolutePath() : "predefined:" + xsltFile;
Templates templates = templatesCache.get(cacheKey);
if (templates == null) {
StreamSource styleSource;
if (xslt.exists()) {
styleSource = new StreamSource(xslt);
} else {
logInfo("Loading predefined xslt file:" + xsltFile);
styleSource = new StreamSource(this.getClass().getResourceAsStream(xsltFile));
}
templates = transformerFactory.newTemplates(styleSource);
templatesCache.put(cacheKey, templates);
}
TransformerFactory transformerFactory = new net.sf.saxon.TransformerFactoryImpl();
return transformerFactory.newTransformer(styleSource);
return templates.newTransformer();
}

private final Map<String, Document> specificationCache = new HashMap<>();

private final Map<String, NodeInfo> specificationTreeCache = new HashMap<>();

/*
* Returns the specification as a Saxon tree. Transforming a DOM would make Saxon wrap or copy
* the DOM for every single generated file, so the DOM is converted only once per task.
*/
private NodeInfo getSpecificationTree(Task task) throws ParserConfigurationException,
SAXException, IOException, XPathException {
NodeInfo tree = specificationTreeCache.get(task.getName());
if (tree == null) {
tree = transformerFactory.getConfiguration()
.buildDocumentTree(new DOMSource(getSpecification(task))).getRootNode();
specificationTreeCache.put(task.getName(), tree);
}
return tree;
}

private Document getSpecification(Task task) throws ParserConfigurationException, SAXException,
IOException {
Document document = specificationCache.get(task.getName());
Expand Down Expand Up @@ -286,15 +320,19 @@ private List<String> getNames(Element element, String path, List<String> names)
return names;
}

private void generateCodeFile(Task task, Document document, Map<String, String> parameters,
String outputFileName, Transformer transformer)
throws TransformerFactoryConfigurationError,
FileNotFoundException, TransformerException {
private void setParameters(Transformer transformer, Map<String, String> parameters) {
if (parameters != null) {
for (Map.Entry<String, String> entry : parameters.entrySet()) {
transformer.setParameter(entry.getKey(), entry.getValue());
}
}
}

private void generateCodeFile(Task task, NodeInfo document, Map<String, String> parameters,
String outputFileName, Transformer transformer)
throws TransformerFactoryConfigurationError,
FileNotFoundException, TransformerException {
setParameters(transformer, parameters);

File outputFile = new File(outputFileName);
if (!outputFile.getParentFile().exists()) {
Expand All @@ -307,12 +345,11 @@ private void generateCodeFile(Task task, Document document, Map<String, String>
}
}

DOMSource source = new DOMSource(document);
FileOutputStream fos = new FileOutputStream(outputFile);
BufferedOutputStream bos = new BufferedOutputStream(fos);
try {
StreamResult result = new StreamResult(bos);
transformer.transform(source, result);
transformer.transform(document, result);
} finally {
try {
bos.close();
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/org/quickfixj/codegenerator/Fields.xsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@
* Contact ask@quickfixengine.org if any conditions of this licensing
* are not clear to you.
******************************************************************************/
<xsl:apply-templates/>
<xsl:apply-templates select="fields/field[@name=$fieldName]"/>
</xsl:template>

<xsl:template match="fix/fields/field[@name=$fieldName]">
<xsl:template match="fix/fields/field">
package <xsl:value-of select="$fieldPackage"/>;

import quickfix.<xsl:call-template name="get-field-type"/>Field;
Expand Down
24 changes: 13 additions & 11 deletions src/main/resources/org/quickfixj/codegenerator/Message.xsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0">
<xsl:output method="text" encoding="UTF-8"/>
<xsl:key name="fields-by-name" match="/fix/fields/field" use="@name"/>
<xsl:key name="components-by-name" match="/fix/components/component" use="@name"/>
<xsl:param name="serialVersionUID"/>
<xsl:param name="messagePackage"/>
<xsl:param name="fieldPackage"/>
Expand Down Expand Up @@ -126,7 +128,7 @@ public class Message extends quickfix.Message {
private static final int[] ORDER = {<xsl:apply-templates select="field|component|group" mode="group-field-numbers"/>0};

public <xsl:value-of select="@name"/>() {
super(<xsl:value-of select="/fix/fields/field[@name=$groupFieldName]/@number"/>, <xsl:apply-templates select="field|component|group" mode="group-delimeter"/>, ORDER);
super(<xsl:value-of select="key('fields-by-name', $groupFieldName)/@number"/>, <xsl:apply-templates select="field|component|group" mode="group-delimeter"/>, ORDER);
}
<xsl:apply-templates select="field|component|group" mode="field-accessors"/>
}
Expand All @@ -137,7 +139,7 @@ public class Message extends quickfix.Message {
<xsl:template mode="group-delimeter" match="field">
<xsl:if test="position() = 1">
<xsl:variable name="name" select="@name"/>
<xsl:value-of select="/fix/fields/field[@name=$name]/@number"/>
<xsl:value-of select="key('fields-by-name', $name)/@number"/>
</xsl:if>
</xsl:template>

Expand All @@ -148,7 +150,7 @@ public class Message extends quickfix.Message {
<xsl:template mode="group-delimeter" match="group//component">
<xsl:if test="position() = 1">
<xsl:variable name="name" select="@name"/>
<xsl:apply-templates select="/fix/components/component[@name=$name]/*[name(.)='field' or name(.)='group' or name(.)='component']"
<xsl:apply-templates select="key('components-by-name', $name)/*[name(.)='field' or name(.)='group' or name(.)='component']"
mode="group-delimeter"/>
</xsl:if>
</xsl:template>
Expand All @@ -157,15 +159,15 @@ public class Message extends quickfix.Message {

<xsl:template mode="component-field-numbers" match="field">
<xsl:variable name="name" select="@name"/>
<xsl:value-of select="/fix/fields/field[@name=$name]/@number"/>, </xsl:template>
<xsl:value-of select="key('fields-by-name', $name)/@number"/>, </xsl:template>

<xsl:template mode="component-field-numbers" match="group">
<xsl:variable name="name" select="@name"/>
<xsl:value-of select="/fix/fields/field[@name=$name]/@number"/>, </xsl:template>
<xsl:value-of select="key('fields-by-name', $name)/@number"/>, </xsl:template>

<xsl:template mode="component-field-numbers" match="component">
<xsl:variable name="name" select="@name"/>
<xsl:apply-templates select="/fix/components/component[@name=$name]/*"
<xsl:apply-templates select="key('components-by-name', $name)/*"
mode="component-field-numbers"/>
</xsl:template>

Expand All @@ -175,11 +177,11 @@ public class Message extends quickfix.Message {

<xsl:template mode="group-field-numbers" match="field|group">
<xsl:variable name="name" select="@name"/>
<xsl:value-of select="/fix/fields/field[@name=$name]/@number"/>, </xsl:template>
<xsl:value-of select="key('fields-by-name', $name)/@number"/>, </xsl:template>

<xsl:template mode="group-field-numbers" match="component">
<xsl:variable name="name" select="@name"/>
<xsl:apply-templates select="/fix/components/component[@name=$name]/*"
<xsl:apply-templates select="key('components-by-name', $name)/*"
mode="group-field-numbers"/>
</xsl:template>

Expand Down Expand Up @@ -212,7 +214,7 @@ public class Message extends quickfix.Message {
}

public boolean isSet<xsl:value-of select="@name"/>() {
return isSetField(<xsl:value-of select="/fix/fields/field[@name=$name]/@number"/>);
return isSetField(<xsl:value-of select="key('fields-by-name', $name)/@number"/>);
}
</xsl:template>

Expand All @@ -235,7 +237,7 @@ public class Message extends quickfix.Message {
<xsl:template mode="field-accessors" match="message//component">
<xsl:call-template name="component-accessor-template"/>
<xsl:variable name="name" select="@name"/>
<xsl:apply-templates select="/fix/components/component[@name=$name]/*[name(.)='field' or name(.)='group' or name(.)='component']"
<xsl:apply-templates select="key('components-by-name', $name)/*[name(.)='field' or name(.)='group' or name(.)='component']"
mode="field-accessors"/>
</xsl:template>

Expand All @@ -259,7 +261,7 @@ import quickfix.Group;</xsl:when>
<xsl:param name="position"/>
<xsl:if test="$position &lt;= count($components)">
<xsl:variable name="name" select="$components[$position]/@name"/>
<xsl:variable name="group" select="/fix/components/component[@name=$name]/group[1]"/>
<xsl:variable name="group" select="key('components-by-name', $name)/group[1]"/>
<xsl:choose>
<xsl:when test="$group">
import quickfix.Group;</xsl:when>
Expand Down
Loading
Loading