equals() ?
equals 메서드는 두 객체를 비교하는 기능으로 Object 클래스의 메서드여서
어느 클래스를 만들던 쓸 수 있는 기능이지만 Object 클래스의 equals 메서드는 단순히 해당 객체 참조값이 같은지 비교하는 메서드 이기 때문에 좀 더 구체적인 비교를 원한다면 메서드 Overriding 하여 구현해야 한다.
하지만 곳곳에 함정이 도사리고 있어 잘못 Overriding 하게되면 프로그램이 이상하게 동작하거나 종료될 것이고, 원인이 되는 코드를 찾기도 굉장히 어렵다.
Object 클래스의 equals는 비교 연산자인 == 와 같은 기능을 하는 메서드로 각 인스턴스가 본질적으로 고유한 객체를 나타내는 클래스라면 Object의 equals 메서드가 적절히 구현되어 있어 굳이 재정의 할 필요가 없다.
값을 표현하는 클래스라면 조금 달라지는데 String 클래스의 equals 메서드를 재정의 한 것이나 Integer 클래스의 equals 메서드를 재정의 한 내용을 보면 알 수 있다.
String 객체에서는 비교를 할 때 == 비교 연산자가 아닌 equals 메서드를 사용해야하는데 문자열을 생성할 때 리터럴 방식으로 생성할 때, new로 생성할 때와 다른 것이 리터럴 방식으로 같은 문자열을 생성하면 처음 생성할 때 String Fly Weight Pool에 생성이 되어있는 String 인스턴스의 참조값을 가져오지만 new로 생성할 경우 새롭게 인스턴스가 생성이 된다.
String의 equals 메서드를 보면 해당 객체 참조값이 같다면 당연히 같은 문자열이 담긴 인스턴스를 가르키게 되니 true를 리턴하고 비교 객체가 String 이면 문자열을 배열에 담아 한글자씩 비교하여 같으면 true 다르면 false를 리턴해주고 있다.
Integer 역시 비교되는 객체의 참조값을 비교하는게 아닌 값 자체를 비교하고 있다.
equals 메서드를 재정의 하지 않아도 되는 상황
- 각 인스턴스가 본질적으로 고유할 때 - 값을 표현하는게 아닌 동작하는 개체를 표현하는 클래스가 해당된다.
- 값을 표현하는 클래스라고 해도 singleton, Enum 클래스에서는 어차피 논리적ㅇ로 같은 인스턴스가 2개 이상 만들어지지 않으니 논리적 동치성과 객체 식별성이 사실상 똑같은 의미여서 Object의 equals 메서드가 논리적 동치성까지 확인해준다.
- 인스턴스의 '논리적 동치성(logical equality)'을 검사할 일이 없을 때 - java.util.regex.Pattern은 equals를 재정의해서 두 Pattern의 인스턴스가 같은 정규표현식인지 검사하는 논리적 동치성을 검사하는 방법도 있지만 필요하지 않다고 판단하여 별도로 재정의 하지 않았다.
- 상위 클래스에서 재정의한 eqauls가 하위 클래스에도 딱 들어 맞을 때 - Set 구현체는 AbstractSet이 구현한 equals 메서드를 상속 받아 쓰고 List 구현체는 AbstractList로 부터, Map 구현체는 AbstractMap으로부터 상속받아 그대로 쓴다.
- 클래스가 private이거나 package-private 이고 equals 메서드를 호출할 일이 없을 때 - 외부에서 접근하지 못하는 클래스라면 비교를 할 일도 없기 때문에.. 혹시라도 실수로 equals 메서드가 호출되는걸 막고 싶다면
@Override
public boolean equals(Object obj) {
throw new AssertionError(); // 호출금지!
}
equals 메서드를 재정의 규약
두 객체가 물리적으로 같은가(객체 식별성 object identity)가 아니라 논리적으로 동일(논리적 동치성 logical equality)한지 확인해야 하는데 상위 클래스의 equals가 논리적 동치성을 비교하도록 재정의 되어있지 않은 경우.
반사성(reflexivity)
null이 아닌 모든 참조 값 x에 대해, x.equals(x)는 true다.
x.equals(x) == true
객체는 자기 자신과 비교했을 때 같아야 한다. 조건을 어기기가 오히려 어렵다.
대칭성(symmetry)
null이 아닌 모든 참조 값 x, y에 대해 x.equals(y)가 true면 y.equals(x)도 true다.
x.equals(y) == y.equals(x)
두 객체는 서로에 대한 동치 여부에 똑같은 결과값이 나와야 한다.
x.equals(y) == true 이면 y.equals(x) == true
x.equals(y) == false이면 y.equals(x) == false
package item10;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
public class CaseInsensitiveString {
private final String s;
public CaseInsensitiveString(String s) {
this.s = Objects.requireNonNull(s);
}
// 대칭성 위배되는 equals
@Override
public boolean equals(Object obj) {
if(obj instanceof CaseInsensitiveString)
// CaseInsensitiveString 객체일 경우 문자열의 대소문자를 무시하고 동일할 경우 true 리턴
return s.equalsIgnoreCase(((CaseInsensitiveString) obj).s);
if(obj instanceof String)
// String 객체일 경우 문자열의 대소문자를 무시하고 동일할 경우 true 리턴
return s.equalsIgnoreCase((String) obj);
return false;
}
public static void main(String[] args) {
CaseInsensitiveString cis = new CaseInsensitiveString("Polish");
String polish = "polish";
// 대칭성을 이루려면 같은 결과값이 나와야 하지만
// String 클래스의 equals는 대소문자 구별을 해서 다른 결과값이 나온다.
System.out.println(cis.equals(polish));
System.out.println(polish.equals(cis));
List<CaseInsensitiveString> list = new ArrayList<>();
list.add(cis);
System.out.println("---------");
System.out.println(list.contains(cis));
System.out.println(list.contains(polish));
}//end of main
}//end of class
CaseInsensitiveString 객체의 equals 메서드는 대칭성에 위배된다.
String 객체에서는 CaseInsensitiveString 객체가 들어왔을 때 대소문자를 무시하는 코드가 따로 equals에 구현되어 있지 않다.
대칭성 문제를 해결하려면 CaseInsensitiveString의 equals를 String과 연동하겠다는 생각을 버려야 한다.
package item10;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
public class CaseInsensitiveString {
private final String s;
public CaseInsensitiveString(String s) {
this.s = Objects.requireNonNull(s);
}
// 수정한 equals 메서드
// 같은 CaseInsensitiveString 객체인 경우만 비교
@Override
public boolean equals(Object obj) {
return obj instanceof CaseInsensitiveString &&
((CaseInsensitiveString) obj).s.equalsIgnoreCase(s);
}
public static void main(String[] args) {
CaseInsensitiveString cis = new CaseInsensitiveString("Polish");
String polish = "polish";
// 결과값이 동일해졌다.
System.out.println(cis.equals(polish));
System.out.println(polish.equals(cis));
List<CaseInsensitiveString> list = new ArrayList<>();
list.add(cis);
System.out.println("---------");
System.out.println(list.contains(cis));
System.out.println(list.contains(polish));
}//end of main
}//end of class
추이성(transitivity)
null이 아닌 모든 참조 값 x, y, z에 대해 x.equals(y)가 true이고 y.equals(z)도 true면 x.equals(z)도 true이다.
x.equals(y) && y.equals(z), x.equals(z)
2차원에서 점을 표현하는 Point 클래스와 Point를 확장한 서브 클래스 ColorPoint클래스로 예를 들어보자면
package item10;
public class Point {
private final int x;
private final int y;
public Point(int x, int y) {
this.x = x;
this.y = y;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Point)) {
return false;
}
Point p = (Point) obj;
return p.x == x && p.y == y;
}
@Override
public int hashCode() {
return 31 * x + y;
}
}package item10.inheritance;
import item10.Color;
import item10.Point;
public class ColorPoint extends Point {
private final Color color;
public ColorPoint(int x, int y, Color color) {
super(x, y);
this.color = color;
}
// 대칭성 위배
@Override
public boolean equals(Object obj) {
if(!(obj instanceof ColorPoint))
return false;
return super.equals(obj) && ((ColorPoint) obj).color == color;
}
public static void main(String[] args) {
Point p = new Point(1, 2);
ColorPoint cp = new ColorPoint(1, 2, Color.RED);
System.out.println(p.equals(cp) + " " + cp.equals(p));
}// end of main
}// end of class
ColorPoint is a Point 는 성립되지만 Point is a ColorPoint는 되지 않는다.
ColorPoint가 Point 클래스를 더 구체적으로 구현한 객체이기 때문에 Point의 equals는 색상 정보를 무시하고, ColorPoint의 equals는 입력 매개변수 클래스 타입이 다르다며 false를 리턴한다.
package item10.inheritance;
import item10.Color;
import item10.Point;
public class ColorPoint extends Point {
private final Color color;
public ColorPoint(int x, int y, Color color) {
super(x, y);
this.color = color;
}
// 추이성 위배
@Override
public boolean equals(Object obj) {
if(!(obj instanceof Point)) {
return false;
}
// obj가 Point타입이면 색상을 무시하고 비교
// ColorPoint 타입과 같은 레벨의 Point 서브 클래스가 있다는 가정하에
// 해당 클래스 equals 메서드 내부에도 아래와 같은 코드가 있다면
// 무한 재귀에 빠져 StackOverFlowError를 일으킨다
// 각각의 equals 메서드가 계속 실행되기 때문
if(!(obj instanceof ColorPoint)) {
return obj.equals(this);
}
// obj가 ColorPoint면 색상까지 비교
return super.equals(obj) && ((ColorPoint) obj).color == color;
}
public static void main(String[] args) {
ColorPoint cp1 = new ColorPoint(1, 2, Color.RED);
Point p2 = new Point(1, 2);
ColorPoint cp2 = new ColorPoint(1, 2, Color.BLUE);
System.out.printf("%s %s %s%n", cp1.equals(p2), p2.equals(cp2), cp1.equals(cp2));
}// end of main
}// end of class
ColorPoint.equals가 Point와 비교할 때 색상을 무시하게 되면 대칭성은 지켜주지만 추이성을 깨버린다.
구체 클래스를 확장해 새로운 상태값 field를 추가하면서 equals 규약을 만족시킬 방법은 존재하지 않는다.
혹여나 equals 안에 instanceof 검사를 getClass로 변경하여 규약도 지키고 값도 추가 하면서 구체 클래스를 상속하려 한다면
package item10;
public class Point {
private final int x;
private final int y;
public Point(int x, int y) {
this.x = x;
this.y = y;
}
@Override
public boolean equals(Object obj) {
// instanceof -> getClass로 변경
if(obj == null || obj.getClass() != getClass())
return false;
Point p = (Point) obj;
return p.x == x && p.y == y;
}
@Override
public int hashCode() {
return 31 * x + y;
}
}
같은 구현 클래스 객체와 비교할 떄만 true를 반환하지만 실제로 활용할 수 없다.
Point 하위 클래스는 정의상 여전히 Point 이므로 어디서든 Point 로서 활용될 수 있어야 하지만 이 equals는 리스코프 치환 원칙에 위배된다.
리스코프 치환 원칙은 어떤 타입에 있어 중요한 속성이라면 하위 타입에서도 마찬가지로 중요하여 똑같이 잘 작동되야 한다.
Point의 하위 클래스는 정의상 여전히 Point 이므로 어디서든 Point로써 활용될 수 있어야 한다.
package item10.inheritance;
import java.util.concurrent.atomic.AtomicInteger;
import item10.Point;
public class CounterPoint extends Point {
private static final AtomicInteger counter = new AtomicInteger();
public CounterPoint(int x, int y) {
super(x, y);
counter.incrementAndGet();
}
public static int numberCreated() {
return counter.get();
}
}Point의 하위 객체 CounterPoint 이다. 해당 객체는 Point의 equlas를 받아서 쓰게 된다.
주어진 점이 반지름이 1인 원 안에 있는지 판별하는 메서드가 필요하다고 했을 때 CounterPoint의 인스턴스를 onUnitCircle 메서드에 넘기면 어떻게 될까?
package item10.inheritance;
import java.util.Set;
import item10.Color;
import item10.Point;
public class CounterPointTest {
private static final Set<Point> unitCircle = Set.of(
new Point(1, 0), new Point (0, 1),
new Point(-1, 0), new Point(0, -1));
public static boolean onUnitCircle(Point p) {
return unitCircle.contains(p);
}
public static void main(String[] args) {
Point p1 = new Point(1, 0);
Point p2 = new CounterPoint(1, 0);
Point p3 = new ColorPoint(1, 0, Color.RED);
System.out.println(onUnitCircle(p1));
System.out.println(onUnitCircle(p2));
System.out.println(onUnitCircle(p3));
}
}
왜 false가 나온걸까? 원인은 컬렉션 구현체에서 주어진 원소를 담고있는지 확인할 때 equals 메서드를 이용하기 때문이다.
p2의 getClass()를 사용하여 들여다보면 Point로 형변환을 하였지만 해당 객체 자체는 CounterPoint이기 떄문에 같은 객체로 보지 않는다. 만약 Point 객체 equals 메서드 내부를 instanceof 기반으로 구현했다면 동일한 객체로 onUnitCircle 메서드가 제대로 동작했을 것.
구체 클래스의 하위 클래스에서 값을 추가할 방법은 없지만 우회적인 방법으로 상속대신 컴포지션을 사용하라
is-a 관계 대신 has-a 관계로 만들어 Point를 반환하는 뷰 메서드를 public으로 추가하는 방식
package item10.composition;
import java.util.Objects;
import item10.Color;
import item10.Point;
public class ColorPoint {
private final Point point;
private final Color color;
public ColorPoint(int x, int y, Color color) {
point = new Point(x, y);
this.color = Objects.requireNonNull(color);
}
// ColorPoint의 뷰를 반환
public Point asPoint() {
return point;
}
@Override
public int hashCode() {
return 31 + point.hashCode() + color.hashCode();
}
@Override
public boolean equals(Object obj) {
if(!(obj instanceof ColorPoint))
return false;
ColorPoint cp = (ColorPoint) obj;
return cp.point.equals(point) && cp.color.equals(color);
}
}// end of classpackage item10;
public class Point {
private final int x;
private final int y;
public Point(int x, int y) {
this.x = x;
this.y = y;
}
@Override
public boolean equals(Object obj) {
// 다시 instanseof 로 변경
if (!(obj instanceof Point)) {
return false;
}
Point p = (Point) obj;
return p.x == x && p.y == y;
}
@Override
public int hashCode() {
return 31 * x + y;
}
}package item10.inheritance;
import java.util.Set;
import item10.Color;
import item10.Point;
public class CounterPointTest {
private static final Set<Point> unitCircle = Set.of(
new Point(1, 0), new Point (0, 1),
new Point(-1, 0), new Point(0, -1));
public static boolean onUnitCircle(Point p) {
return unitCircle.contains(p);
}
public static void main(String[] args) {
Point p1 = new Point(1, 0);
Point p2 = new CounterPoint(1, 0);
Point p3 = new item10.composition.ColorPoint(1, 0, Color.RED).asPoint();
System.out.println(onUnitCircle(p1));
System.out.println(onUnitCircle(p2));
System.out.println(onUnitCircle(p3));
}
}
자바 라이브러리에도 구체클래스를 확장해 값을 추가한 클래스가 있는데 java.sql.Timestamp는 java.util.Date를 확장한 후 nanoseconds필드를 추가했다. 그 결과로 Timestamp의 equals는 대칭성을 위배하며, Date 객체와 한 컬렉션에 넣거나 서로 섞어 사용하면 엉뚱하게 동작할 수 있다. 설계상 실수.
일관성(consistency)
null이 아닌 모든 참조 값 x, y에 대해 x.equals(y)를 반복해서 호출하면 항상 true를 반환하거나 항상 false를 반환한다.
x.equals(y) == x.equals(y)
두 객체가 같다면 (어느 하나 혹은 두 객체 모두가 수정되지 않는 한) 앞으로도 영원히 같아야 한다.
가변 객체는 비교시점에 따라 서롤 다를 수도 혹은 같을수도 있는 반면 불변 객체는 한번 다르면 끝까지 달라야한다. 클래스 작성시 불변 클래스로 만드는게 나을지 심사숙고 해야한다.
java.net.URL의 equals는 주어진 URL과 매핑된 호스트 IP의 주소를 이용해 비교하는데 호스트 이름을 IP 주소로 바꾸려면 네트워크를 통해야하는데 그 결과가 항상 같다고 보장할 수 없다. URL 도메인 주소는 항상 같지만 연결되는 IP는 바뀔 수 있다. 이런 문제를 피하려면 equals는 항상 메모리에 존재하는 객체만을 사용한 계산만 수행해야한다.
null-아님
null이 아닌 모든 참조 값 x에 대해 x.equals(null)은 false다.
equals 구현 방법
- == 연산자를 사용해 입력이 자기 자신의 참조인지 확인한다.
- instanceof 연산자로 입력이 올바른 타입인지 확인한다.
- 입력을 올바른 타입으로 형변환한다.
- 입력 객체와 자기 자신의 대응되는 '핵심' field 들이 모두 일치하는지 하나씩 검사한다. float과 double을 제외한 기본 타입 필드는 == 연산자로 비교하고 레퍼런스 타입은 각각의 equals로 비교한다. float과 double은 특수한 부동소수점등을 다루기때문에 wrapper 클래스로 감싼 후 compare 메서드를 이용한다.
// 전형적인 equals 메서드의 예
@Override
public boolean equals(Object obj){
if(this == obj){
return true;
}
if(!(obj instanceof Point)) return false;
Point p = (Point) obj;
return p.x == x && p.y == y;
}
equals를 재정의 해주는
- 애노테이션 프로세서 : AutoValue, Lombok
- record 클래스 : 자바 14버전부터 나온 기능으로 클래스 시그니쳐만 적으면 알아서 equals를 재정의 해줌
- IDE 툴에서 코드 생성
주의사항
- equals를 재정의 했다면 대칭성, 추이성, 일관성에 대한 체크를 하자.
- equals를 재정의 할 떄 hashCode도 반드시 재정의 하자
- 너무 복잡하게 해결하려 들지말자
- Object가 아닌 타입의 매개변수를 받느 equals 메서드는 선언하지 말자 overriding이 아님 overloading임
StackOverflowError
메모리 Stack영역에 메소드 호출시 각각 스택 프레임이 쌓인다. FILO방식으로 스택 프레임 안에는 메서드 호출시 넘겨졌던 매개변수 값이나 인스턴스를 참조하고 있는 로컬변수들, 메서드가 실행이 끝났을 때 돌아가야 하는 곳 등의 정보가 담기는데 해당 공간에 새로운 스택 프레임을 할당할 공간이 부족하게 되면 StackOverflowError가 난다.
가장 흔하게 접할 수 있는 사례로는 재귀함수가 무한정 호출하면 발생할 수 있다.
리스코프 치환 원칙
- S(Single Responsibility Principle 단일 책임 원칙) : 하나의 객체는 반드시 하나의 동작만의 책임을 갖는다는 원칙. 모듈화가 강해질수록 다른 객체와의 의존/연관성이 줄어든다. 반대로 이야기하면 모듈화가 약해질수록 다른 객체와의 의존/연관성은 크게늘어나며, 최악의 경우 어떠한 은닉화 정책도 존재하지 않아 모듈의 메소드에 무분별하게 접근할 수도 있게 된다. 객체가 ㄷ마당하는 동작. 즉, 책임이 많아질수록 해당 객체의 변경에 따른 영향도의 범위가 매우 커진다. 단일 책임 원칙은 특정 객체의 책임 의존성 과중을 최대한 지양하기 위한 원칙이다.
- O(Open-closed Principle 개방-폐쇄 원칙) : 객체를 다룸에 있어서 객체의 확장은 개방적으로, 객체의 수정은 폐쇄적으로 대하는 원칙. 한 마디로, 보여줄건 보여주고, 숨길건 숨긴다는의미. 기능이 변하거나 확장 가능하지만, 해당 기능의 코드는 수정하면 안 된다는 뜻으로 객체 하나를 수정한다고 가정했을 대 단순히 해당 객체만 수정하는 것 뿐 아니라 해당 객체에 의존하는 다른 객체들의 코드까지 줄줄이 고쳐야한다면 좋은 설계로 보기 힘들다. 각 객체의 모듈화와 정보 은닉의 올바른 구현을 추구하며, 이를 통해 객체간 의존성을 최소화하여 코드 변경에 따른 영향력을 낮추기 위한 원칙
- L(Liskov Subsitution Principle 리스코프 치환 원칙) : 부모 객체와 이를 상속한 자식 객체가 있을 때 부모 객체를 호출하는 동작에서 자식 객체가 부모 객체를 완전히 대체할 수 있다는 원칙. 객체지향 언어에선 객체의 상속이 일어난다. 이 과정에서 부모/자식 관계가 정의된다. 자식 객체는 부모 객체의 특성을 가지며, 이를 토대로 확장할 수 있다. 하지만 이 과정에서 무리하거나 객체의 의의와 어긋나는 확장으로 인해 잘못된 방향으로 상속되는 경우가 생긴다. 리스코프 치환 원칙은 올바른 상속을 위해 자식 객체의 확장이 부모 객체의 방향을 온전히 따르도록 권고하는 원칙.
- I(Interface Segrefation Principle 인터페이스 분리 원칙) : 객체는 자신이 호출하지 않는 메소드에 의존하지않아야 한다는 원칙이다. 구현할 객체에게 무의미한 메소드의 구현을 방지하기 위해 반드시 필요한 메소드만을 상속/구현하도록 권고한다. 만약 상속할 객체의 규모가 너무 크다면, 해당 객체의 메소드를 작은 인터페이스로 나누는 것이 좋다. 상속 대상인 객체의 메소드를 각 동작별로 구분해 인터페이스를 만들고 각 객체가 필요한 인터페이스만을 상속하여 구현하면 되므로 각자가 필요한 메소드만을 가지게 된다. 이것이 인터페이스 분리 원칙이 지향하는 바다.
- D(Dependency Inversion Principle 의존성 역전 원칙) : 객체는 저수준 모듈보다 고수준 모듈에 의존해야한다는 원칙이다. (고수준 모듈 : 인터페이스와 같은 객체의 형태나 추상적 개념 / 저수준 모듈 : 구현된 객체) 고/저수준 모델의 정이는 이와 같다. 의존성 역전원칙에 대입하면 객체는 객체보다 인터페이스에 의존해야한다로 치환할 수 있다. 즉, 가급적 객체의 상속은 인터페이스를 통해 이루어져야 한다는 의미로 해석할 수 있다.
Item 10. Equals는 일반 규약을 지켜 재정의하라 | Carrey`s 기술블로그
서론 equals 메서드는 Object 클래스에 구현된 메서드로 객체 내의 정보들에 대한 동등성(equality) 비교를 목적으로 하는 메서드이다. equals 메서드를 잘못 작성하게 되면 의도하지 않는 결과들이 초
jaehun2841.github.io
https://blog.itcode.dev/posts/2021/08/15/liskov-subsitution-principle
[OOP] 객체지향 5원칙(SOLID) - 리스코프 치환 원칙 (Liskov Subsitution Principle) - 𝝅번째 알파카의 개발
리스코프 치환 원칙은 부모 객체와 이를 상속한 자식 객체가 있을 때 부모 객체를 호출하는 동작에서 자식 객체가 부모 객체를 완전히 대체할 수 있다는 원칙이다. 객체지향 언어에선 객체의 상
blog.itcode.dev
https://www.inflearn.com/course/%EC%9D%B4%ED%8E%99%ED%8B%B0%EB%B8%8C-%EC%9E%90%EB%B0%94-1/dashboard
'Effective Java > 정리' 카테고리의 다른 글
| Item12. toString을 항상 재정의하라 (0) | 2023.02.04 |
|---|---|
| Item11. equals를 재정의하려거든 hashCode도 재정의하라 (0) | 2023.01.31 |
| [Item 9] try-finally보다는 try-with-resources를 사용하라 (0) | 2023.01.17 |
| [Item 8] finalizer와 cleaner 사용을 피하라 (0) | 2023.01.17 |
| [Item 7] 다 쓴 객체 참조를 해제하라 (0) | 2023.01.17 |
