Skip to content

Refactor -> StringUtils replace Optimization #33665

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.

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

Closed
wants to merge 1 commit into from

Conversation

J-unStiN
Copy link
Contributor

@J-unStiN J-unStiN commented Oct 8, 2024

The += 16 used before is too abstract.

-If NewPattern is longer than 16, StringBuilder must be re -permitted again.
-If NewPattern is shorter than 16, you will be assigned a memory to StringBuilder.

For this reason, we request optimized code that allocates memory equal to the length of NewPattern.

There is also a possibility that the length of the
++ NewPattern will be abnormally longer, To prevent the maximum size assignment, the maximum value is set to the maximum value of the int range.

The += 16 used before is too abstract.

-If NewPattern is longer than 16, StringBuilder must be re -permitted again.
-If NewPattern is shorter than 16, you will be assigned a memory to StringBuilder.

For this reason, we will request a Code that is optimized.

There is also a possibility that the length of the + NewPattern will be abnormally longer,
To prevent the maximum size assignment, the maximum value is set to the maximum value of the int range.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Oct 8, 2024
int newPatternLen = newPattern.length();
int oldPatternLen = oldPattern.length();
if (newPatternLen > oldPatternLen) {
capacity += Math.min(Integer.MAX_VALUE, newPatternLen - oldPatternLen);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you elaborate on why Math.min(Integer.MAX_VALUE, newPatternLen - oldPatternLen) is used here?

Copy link
Contributor Author

@J-unStiN J-unStiN Oct 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought that there might be a case where the length of NewPattern is larger than integer.max_value.

In that case, the size of StringBuilder can become ridiculously large when initialized, so I set the size to integer.max_value as a minimum safety measure.

++ If the size of integer.max_value is too large, I think it would be fine to just make it 1024 or 2048.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

capacity += Math.max(16, newPatternLen - oldPatternLen);

I would like to modify the initial size to 16 as in the existing code,
but if the length of newPattern is larger, I would like to modify it to newPatternLen - oldPatternLen.
What do you think?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change is likely to make performance worse. This part is trying to extend the capacity of the builder if the new pattern is longer than the one to be replaced. Here, this change assumes that the pattern will be replaced only once. If the pattern is replaced multiple times, the builder will be expanded again.

I guess 16 is a simple heuristic given that we don't know in advance how many patterns will be replaced. If anything, we could consider expanding the builder by (newPatternLen - oldPatternLen) * 8 because we would guess the builder needs to grow several times the difference.

Looking at our usage pattern in Spring Framework, we're massively using this method for single chars replacements like StringUtils.replace(result, "\r", "\\r");.

In summary, I don't think we should merge this change.

Copy link
Contributor Author

@J-unStiN J-unStiN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

capacity += Math.max(16, newPatternLen - oldPatternLen);

I would like to modify the initial size to 16 as in the existing code,
but if the length of newPattern is larger, I would like to modify it to newPatternLen - oldPatternLen.
What do you think?

@snicoll
Copy link
Member

snicoll commented Oct 9, 2024

I agree with @bclozel this change is likely to make the performance worse.

Going forward, before submitting a change like this, please look for actual usages and share a benchmark that demonstrates the proposal improves the status quo.

@snicoll snicoll closed this Oct 9, 2024
@snicoll snicoll added status: declined A suggestion or change that we don't feel we should currently apply and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Oct 9, 2024
@J-unStiN J-unStiN deleted the stringutils-patch01 branch October 9, 2024 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: declined A suggestion or change that we don't feel we should currently apply
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants