Skip to content

Refactor: BinaryExporter optimization + javadoc #2524

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Refactor: BinaryExporter optimization + javadoc #2524

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
670bf02
Update BinaryExporter.java
capdevon Jun 24, 2025
d5ac1f7
BinaryExporter: log messages
capdevon Jun 25, 2025
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
92 changes: 46 additions & 46 deletions jme3-core/src/plugins/java/com/jme3/export/binary/BinaryExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2021 jMonkeyEngine
* Copyright (c) 2009-2025 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -38,7 +38,13 @@
import com.jme3.export.Savable;
import com.jme3.export.SavableClassUtil;
import com.jme3.math.FastMath;
import java.io.*;

import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.IdentityHashMap;
Expand Down Expand Up @@ -116,39 +122,39 @@
*
* @author Joshua Slack
*/

public class BinaryExporter implements JmeExporter {
private static final Logger logger = Logger.getLogger(BinaryExporter.class
.getName());

private static final Logger logger = Logger.getLogger(BinaryExporter.class.getName());

protected int aliasCount = 1;
protected int idCount = 1;

private final IdentityHashMap<Savable, BinaryIdContentPair> contentTable
= new IdentityHashMap<>();

protected HashMap<Integer, Integer> locationTable
= new HashMap<>();
private final IdentityHashMap<Savable, BinaryIdContentPair> contentTable = new IdentityHashMap<>();
protected HashMap<Integer, Integer> locationTable = new HashMap<>();

// key - class name, value = bco
private final HashMap<String, BinaryClassObject> classes
= new HashMap<>();

private final HashMap<String, BinaryClassObject> classes = new HashMap<>();
private final ArrayList<Savable> contentKeys = new ArrayList<>();

public static boolean debug = false;
public static boolean useFastBufs = true;

/**
* Constructs a new {@code BinaryExporter}.
*/
public BinaryExporter() {
}

/**
* Returns a new instance of {@code BinaryExporter}.
*
* @return A new {@code BinaryExporter} instance.
*/
public static BinaryExporter getInstance() {
return new BinaryExporter();
}

/**
* Saves the object into memory then loads it from memory.
*
* Used by tests to check if the persistence system is working.
*
* @param <T> The type of savable.
Expand All @@ -163,9 +169,11 @@ public static <T extends Savable> T saveAndLoad(AssetManager assetManager, T obj
try {
BinaryExporter exporter = new BinaryExporter();
exporter.save(object, baos);

BinaryImporter importer = new BinaryImporter();
importer.setAssetManager(assetManager);
return (T) importer.load(baos.toByteArray());

} catch (IOException ex) {
// Should never happen.
throw new AssertionError(ex);
Expand All @@ -191,28 +199,25 @@ public void save(Savable object, OutputStream os) throws IOException {
// write out tag table
int classTableSize = 0;
int classNum = classes.keySet().size();
int aliasSize = ((int) FastMath.log(classNum, 256) + 1); // make all
// aliases a
// fixed width
int aliasSize = ((int) FastMath.log(classNum, 256) + 1); // make all aliases a fixed width

os.write(ByteUtils.convertToBytes(classNum)); // 3. "number of classes"
for (String key : classes.keySet()) {
BinaryClassObject bco = classes.get(key);

// write alias
byte[] aliasBytes = fixClassAlias(bco.alias,
aliasSize);
byte[] aliasBytes = fixClassAlias(bco.alias, aliasSize);
os.write(aliasBytes); // 4. "class alias"
classTableSize += aliasSize;

// jME3 NEW: Write class hierarchy version numbers
os.write( bco.classHierarchyVersions.length );
for (int version : bco.classHierarchyVersions){
os.write(bco.classHierarchyVersions.length);
for (int version : bco.classHierarchyVersions) {
os.write(ByteUtils.convertToBytes(version));
}
classTableSize += 1 + bco.classHierarchyVersions.length * 4;

// write classname size & classname
// write class name size & class name
byte[] classBytes = key.getBytes();
os.write(ByteUtils.convertToBytes(classBytes.length)); // 5. "full class-name size"
os.write(classBytes); // 6. "full class name"
Expand All @@ -236,14 +241,12 @@ public void save(Savable object, OutputStream os) throws IOException {
// write out data to a separate stream
int location = 0;
// keep track of location for each piece
HashMap<String, ArrayList<BinaryIdContentPair>> alreadySaved = new HashMap<>(
contentTable.size());
HashMap<String, ArrayList<BinaryIdContentPair>> alreadySaved = new HashMap<>(contentTable.size());
for (Savable savable : contentKeys) {
// look back at previous written data for matches
String savableName = savable.getClass().getName();
BinaryIdContentPair pair = contentTable.get(savable);
ArrayList<BinaryIdContentPair> bucket = alreadySaved
.get(savableName + getChunk(pair));
ArrayList<BinaryIdContentPair> bucket = alreadySaved.get(savableName + getChunk(pair));
int prevLoc = findPrevMatch(pair, bucket);
if (prevLoc != -1) {
locationTable.put(pair.getId(), prevLoc);
Expand Down Expand Up @@ -286,17 +289,14 @@ public void save(Savable object, OutputStream os) throws IOException {
// append stream to the output stream
out.writeTo(os);


out = null;
os = null;

if (debug) {
logger.fine("Stats:");
logger.log(Level.FINE, "classes: {0}", classNum);
logger.log(Level.FINE, "class table: {0} bytes", classTableSize);
logger.log(Level.FINE, "objects: {0}", numLocations);
logger.log(Level.FINE, "location table: {0} bytes", locationTableSize);
logger.log(Level.FINE, "data: {0} bytes", location);
logger.log(Level.INFO, "BinaryExporter Stats:"
+ "\n * Classes: {0}"
+ "\n * Class Table: {1} bytes"
+ "\n * Objects: {2}"
+ "\n * Location Table: {3} bytes"
+ "\n * Data: {4} bytes",
new Object[] {classNum, classTableSize, numLocations, locationTableSize, location});
}
}

Expand All @@ -305,14 +305,15 @@ private String getChunk(BinaryIdContentPair pair) {
.getContent().bytes.length));
}

private int findPrevMatch(BinaryIdContentPair oldPair,
ArrayList<BinaryIdContentPair> bucket) {
if (bucket == null)
private int findPrevMatch(BinaryIdContentPair oldPair, ArrayList<BinaryIdContentPair> bucket) {
if (bucket == null) {
return -1;
}
for (int x = bucket.size(); --x >= 0;) {
BinaryIdContentPair pair = bucket.get(x);
if (pair.getContent().equals(oldPair.getContent()))
if (pair.getContent().equals(oldPair.getContent())) {
return locationTable.get(pair.getId());
}
}
return -1;
}
Expand Down Expand Up @@ -345,7 +346,7 @@ public OutputCapsule getCapsule(Savable object) {
return contentTable.get(object).getContent();
}

private BinaryClassObject createClassObject(Class<? extends Savable> clazz) throws IOException{
private BinaryClassObject createClassObject(Class<? extends Savable> clazz) throws IOException {
BinaryClassObject bco = new BinaryClassObject();
bco.alias = generateTag();
bco.nameFields = new HashMap<>();
Expand All @@ -361,10 +362,10 @@ public int processBinarySavable(Savable object) throws IOException {
return -1;
}
Class<? extends Savable> clazz = object.getClass();
BinaryClassObject bco = classes.get(object.getClass().getName());
BinaryClassObject bco = classes.get(clazz.getName());
// is this class been looked at before? in tagTable?
if (bco == null) {
bco = createClassObject(object.getClass());
bco = createClassObject(clazz);
}

// is object in contentTable?
Expand All @@ -379,7 +380,6 @@ public int processBinarySavable(Savable object) throws IOException {
object.write(this);
newPair.getContent().finish();
return newPair.getId();

}

protected byte[] generateTag() {
Expand All @@ -401,4 +401,4 @@ private BinaryIdContentPair generateIdContentPair(BinaryClassObject bco) {
new BinaryOutputCapsule(this, bco));
return pair;
}
}
}