[jira] [Comment Edited] (RATIS-956) Use format specifier instead of string concat

[Tsz-wo Sze (Jira)]

    [ 
https://issues.apache.org/jira/browse/RATIS-956?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17782260#comment-17782260
 ] 

Tsz-wo Sze edited comment on RATIS-956 at 11/2/23 5:52 PM:
-----------------------------------------------------------

We used string concat
{code:java}
if (LOG.isWarnEnabled()) {
  LOG.warn("some message " + info1  + ", " + info2 + ", " + info3, e); // e is 
an exception 
}
{code}
instead format specifier
{code:java}
LOG.warn("some message {}, {}, {}", info1, info2, info3, e); // e is an 
exception which will be ignored.
{code}
to avoid the exception e being skipped. It will work correctly only for zero or 
one variable. For the three variable case above, it will use "void warn(String 
var1, Object... var2)" and then skip printing the exception e.

The following is the Logger API.
{code:java}
// org.slf4j.Logger
  void warn(String var1);

  void warn(String var1, Object var2);

  void warn(String var1, Object... var2);

  void warn(String var1, Object var2, Object var3);

  void warn(String var1, Throwable var2);                // <-------- Throwable

  boolean isWarnEnabled(Marker var1);

  void warn(Marker var1, String var2);

  void warn(Marker var1, String var2, Object var3);

  void warn(Marker var1, String var2, Object var3, Object var4);

  void warn(Marker var1, String var2, Object... var3);

  void warn(Marker var1, String var2, Throwable var3);                 // 
<-------- Throwable
{code}


was (Author: szetszwo):
We used string concat
{code:java}
LOG.warn("some message " + info1  + ", " + info2 + ", " + info3, e); // e is an 
exception 
{code}
instead format specifier
{code:java}
LOG.warn("some message {}, {}, {}", info1, info2, info3, e); // e is an 
exception which will be ignored.
{code}
to avoid the exception e being skipped. It will work correctly only for zero or 
one variable. For the three variable case above, it will use "void warn(String 
var1, Object... var2)" and then skip printing the exception e.

The following is the Logger API.
{code:java}
// org.slf4j.Logger
  void warn(String var1);

  void warn(String var1, Object var2);

  void warn(String var1, Object... var2);

  void warn(String var1, Object var2, Object var3);

  void warn(String var1, Throwable var2);                // <-------- Throwable

  boolean isWarnEnabled(Marker var1);

  void warn(Marker var1, String var2);

  void warn(Marker var1, String var2, Object var3);

  void warn(Marker var1, String var2, Object var3, Object var4);

  void warn(Marker var1, String var2, Object... var3);

  void warn(Marker var1, String var2, Throwable var3);                 // 
<-------- Throwable
{code}

> Use format specifier instead of string concat
> ---------------------------------------------
>
>                 Key: RATIS-956
>                 URL: https://issues.apache.org/jira/browse/RATIS-956
>             Project: Ratis
>          Issue Type: Sub-task
>            Reporter: Dinesh Chitlangia
>            Assignee: Cyrus Jackson
>            Priority: Major
>         Attachments: RATIS-956.001.patch
>
>
> [https://sonarcloud.io/project/issues?id=apache_incubator-ratis&resolved=false&rules=java%3AS3457&types=CODE_SMELL]



--
This message was sent by Atlassian Jira
(v8.20.10#820010)