☕ Java * Utility classes should not have public constructors (java:S1118)

static으로 구성 된 클래스를 배웠다.

실습해보던 중 안내문구가 떳다.

 

Utility classes should not have public constructors (java:S1118)

Utility classes, which are collections of static members, are not meant to be instantiated. 

Even abstract utility classes, which can be extended, should not have public constructors. 

Java adds an implicit public constructor to every class which does not define at least one explicitly. 

Hence, at least one non-public constructor should be defined.

 

🙄 무슨 말인고 하니

static members(정적 멤버들)로 구성 된 유틸 클래스는 인스턴스화 되지 않는다.

extended(상속, 확장)이 가능한 abstract utility classes(추상 유틸 클래스들)라도 public한 constructors(생성자)를 가지지 않아야 한다.

자바는 암묵적으로 적어도 하나의 생성자를 명시적으로 정의하지 않은 모든 클래스에 public 생성자를 추가한다.

따라서, 적어도 하나의 non-public 생성자를 정의해야 한다.

 

그러니까 static 멤버들로 구성된 클래스를 정의 할 때는 non-public한 생성자를 하나 명시적으로 정의하라는 소리다!

 

 

예시를 보자.

Noncompliant Code Example

class StringUtils { // Noncompliant

  public static String concatenate(String s1, String s2) {
    return s1 + s2;
  }

}

 

Compliant Solution

위 코드에서 StringUtils에 대한 생성자를 추가해준다! 단 non-public 하도록!

private StringUtils() {
    throw new IllegalStateException("Utility class");
}

class StringUtils { // Compliant

  private StringUtils() {
    throw new IllegalStateException("Utility class");
  }

  public static String concatenate(String s1, String s2) {
    return s1 + s2;
  }

}

 

 

더 알아보기

Q1. 정의하지 않으면 안되나요?

A. 문제는 없다. 잘 돌아가더라.

 

Q2. 그럼 무슨 차이가 있나요?

A. static 멤버들로 구성된 클래스 객체를 생성하는 코드를 넣었을 때 컴파일 에러를 일으킨다.

 

 

🤔 중요도가 Major 이라고 뜨는 걸 보아서는 지켜주는 편이 좋을 것 같다.