Skip to content

Use DateTimeFormatter.formatTo to directly append to StringBuilder #2515

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

Merged
merged 3 commits into from
Apr 26, 2024
Merged

Use DateTimeFormatter.formatTo to directly append to StringBuilder #2515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
486b80c
Use DateTimeFormatter.formatTo to directly append to StringBuilder
michaelbraun Apr 24, 2024
490fa60
Review feedback
michaelbraun Apr 25, 2024
b5f731b
Improve changelog text
vy Apr 26, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion log4j-api/src/main/java/org/apache/logging/log4j/message/ParameterFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ private static boolean appendDate(final Object o, final StringBuilder str) {
if (!(o instanceof Date)) {
return false;
}
str.append(DATE_FORMATTER.format(((Date) o).toInstant()));
DATE_FORMATTER.formatTo(((Date) o).toInstant(), str);
return true;
}

Expand Down
8 changes: 3 additions & 5 deletions log4j-api/src/main/java/org/apache/logging/log4j/status/StatusData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ public class StatusData implements Serializable {

private final Instant instant;

@Nullable
private final DateTimeFormatter instantFormatter;

@Nullable
Expand Down Expand Up @@ -79,7 +78,8 @@ public StatusData(
@Nullable final String threadName,
@Nullable final DateTimeFormatter instantFormatter,
final Instant instant) {
this.instantFormatter = instantFormatter;
// DateTimeFormatter.ISO_INSTANT is the default used in instant.toString()
this.instantFormatter = instantFormatter != null ? instantFormatter : DateTimeFormatter.ISO_INSTANT;
this.instant = instant;
this.caller = caller;
this.level = requireNonNull(level, "level");
Expand Down Expand Up @@ -167,9 +167,7 @@ public Throwable getThrowable() {
@SuppressWarnings("DefaultCharset")
public String getFormattedStatus() {
final StringBuilder sb = new StringBuilder();
final String formattedInstant =
instantFormatter != null ? instantFormatter.format(instant) : instant.toString();
sb.append(formattedInstant);
instantFormatter.formatTo(instant, sb);
sb.append(SPACE);
sb.append(getThreadName());
sb.append(SPACE);
Expand Down
8 changes: 8 additions & 0 deletions src/changelog/.2.x.x/2515_datetimeformatter_formatto.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://logging.apache.org/xml/ns"
xsi:schemaLocation="https://logging.apache.org/xml/ns https://logging.apache.org/xml/ns/log4j-changelog-0.xsd"
type="changed">
<issue id="2515" link="https://github.com/apache/logging-log4j2/pull/2515"/>
<description format="asciidoc">Replace some usages of `DateTimeFormatter#toString()` with `DateTimeFormatter#formatTo(StringBuilder)` to cut down on allocations</description>
</entry>