위치정보 저장의 TPS 개선하기(작성 중)

[Combi153]

문제 발견

NGrinder 로 API 성능 테스트를 진행했습니다.

가상 사용자를 200명으로 설정하고, 3분 간 점진적으로 위치정보 저장 API를 요청하도록 설정했습니다.

TPS는 9.7로 매우 낮은 수치를 기록했습니다.

동일한 설정으로 여행 저장, 여행 전체 조회 등의 API에도 실험을 진행했습니다.

위치정보 저장과는 달리 각각 251, 126으로 100 이상을 상회했습니다.

위치정보 저장 API에 문제가 있다는 사실을 깨달았습니다.

분석

단일 요청

우선 위치정보 저장에 대한 단일 API 요청의 실행 시간을 살펴보았습니다.

로그를 확인해보니, 15ms 를 기록했습니다.

단일 요청에 대해서는 성능이 준수한 것을 확인할 수 있었습니다.

다중 동시 요청

NGrinder 확인

코드 분석

현재 Trip 과 Point는 다대일 양방향 연관관계를 맺고 있습니다.

그리고 두 클래스는 모두 연관관계 편의 메서드를 갖고 있습니다.

@Entity
public class Point extends BaseEntity {

    // (...)

    @JoinColumn(name = "trip_id")
    @ManyToOne(fetch = LAZY)
    private Trip trip;

    public void setTrip(Trip trip) {
        this.trip = trip;
        if (!trip.contains(this)) {
            trip.add(this);
        }
    }
}

@Entity
public class Trip extends BaseEntity {

    // (...)

    @OneToMany(mappedBy = "trip", fetch = LAZY, cascade = {PERSIST, REMOVE})
    private List<Point> points = new ArrayList<>();

    public void add(Point point) {
        points.add(point);
        if (point.trip() != this) {
            point.setTrip(this);
        }
    }

    public boolean contains(Point point) {
        return points.contains(point);
    }
`
``

문제가 되었던 부분은 Point의 setTrip() 메서드입니다. 

Point.setTrip() 메서드는 Point의 trip 필드에 연관관계를 설정하는 동시에 Trip.add() 메서드로 Trip 에도 Point와 연관관계를 맺도록 합니다.

다만, 개발자의 실수로 미리 Trip.add() 가 외부에서 실행될 가능성이 있습니다.

contains() 메서드을 포함하는 if 조건문이 연관관계 설정이 중복되지 않도록 방어합니다.

바로 이 contains() 로직이 병목의 원인이었습니다.

앞서 성능 테스트에서 NGrinder의 요청은 하나의 Trip에 Point를 지속해서 추가했습니다. 

따라서 시간이 지날수록 contains() 메서드의 처리 속도가 늘어난 것입니다.

> Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that `Objects.equals(o, e)`.

Java doc 에 따르면 List.contains 메서드는 전체 리스트의 요소들이 메서드의 인자값과 같은지 비교하는 로직을 수행합니다. 전체 리스트의 요소에 대해 로직을 수행하기 때문에 시간 복잡도가 O(N) 입니다. 따라서 요청의 수가 늘어날수록 TPS가 더 감소했던 것입니다.

## 해결

간단히 두 가지 해결책을 생각할 수 있었습니다.

- 방어로직 없애기
- 문제라고 생각하지 않기

### 방어로직 없애기

방어로직을 없애면 더이상 contains() 메서드로 인한 성능 문제가 발생하지 않습니다.

```java
@Entity
public class Point extends BaseEntity {

    // (...)

    @JoinColumn(name = "trip_id")
    @ManyToOne(fetch = LAZY)
    private Trip trip;

    public void setTrip(Trip trip) {
        this.trip = trip;
        trip.add(this);
    }
}

@Entity
public class Trip extends BaseEntity {

    // (...)

    @OneToMany(mappedBy = "trip", fetch = LAZY, cascade = {PERSIST, REMOVE})
    private List<Point> points = new ArrayList<>();

    // Point 외에 절대 사용하지 않는 메서드
    public void add(Point point) {
        points.add(point);
    }

하지만 Trip.add () 메서드는 사용하지 않는 메서드가 되어야 합니다. 해당 메서드는 Point의 연관관계를 설정해주지 못하며, Point.setTrip() 메서드와 함께 사용할 경우, Trip에 Point가 중복해서 입력되기 때문입니다.

접근제어자가 public 인 메서드를 개발자들이 합의해서 사용하지 않는 것이 과연 괜찮은 코드인가?에 대한 물음이 남습니다.