[Error Handling] Spring - lombok, MapStruct를 동시에 사용하는 경우

💣 문제 상황

MapStruct로 객체 간의 Mapper 코드를 자동으로 구현하려고 했는데 다음과 같은 에러가 발생했다.

MemberMapperImpl.java:46: error: constructor MemberResponseDto in class MemberResponseDto cannot be applied to given types;
        MemberResponseDto memberResponseDto = new MemberResponseDto();
                                              ^
  required: long,String,String,String
  found: no arguments
  reason: actual and formal argument lists differ in length

 

📋 코드

// build.gradle
dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-validation'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'org.mapstruct:mapstruct:1.5.2.Final'
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.2.Final'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

// MemberMapper.java
package com.codestates.member.mapstruct.mapper;

import com.codestates.member.dto.MemberPatchDto;
import com.codestates.member.dto.MemberPostDto;
import com.codestates.member.dto.MemberResponseDto;
import com.codestates.member.entity.Member;
import org.mapstruct.Mapper;

@Mapper(componentModel = "spring")
public interface MemberMapper {
    Member memberPostDtoToMember(MemberPostDto memberPostDto);
    Member memberPatchDtoToMember(MemberPatchDto memberPatchDto);
    MemberResponseDto memberToMemberResponseDto(Member member);
}

// Member.java
package com.codestates.member.entity;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public class Member {
    private long memberId;
    private String email;
    private String name;
    private String phone;
}

// MemberPostDto.java
package com.codestates.member.dto;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;

public class MemberPostDto {
    @NotBlank
    @Email
    private String email;

    @NotBlank(message = "이름은 공백이 아니어야 합니다.")
    private String name;

    @Pattern(regexp = "^010-\\d{3,4}-\\d{4}$",
            message = "휴대폰 번호는 010으로 시작하는 11자리 숫자와 '-'로 구성되어야 합니다.")
    private String phone;

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }
}

// MemberPatchDto.java
package com.codestates.member.dto;

import com.codestates.validator.NotSpace;

import javax.validation.constraints.Pattern;

public class MemberPatchDto {
    private long memberId;

    @NotSpace(message = "회원 이름은 공백이 아니어야 합니다")
    private String name;

    @NotSpace(message = "휴대폰 번호는 공백이 아니어야 합니다")
    @Pattern(regexp = "^010-\\d{3,4}-\\d{4}$",
            message = "휴대폰 번호는 010으로 시작하는 11자리 숫자와 '-'로 구성되어야 합니다")
    private String phone;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    public long getMemberId() {
        return memberId;
    }

    public void setMemberId(long memberId) {
        this.memberId = memberId;
    }
}

// MemberResponseDto.java
package com.codestates.member.dto;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public class MemberResponseDto {
    private long memberId;
    private String email;
    private String name;
    private String phone;
}

 

🔧 해결 과정

대략 30분 간 잘못 적은 곳이 있는지 계속 찾아보고 애너테이션도 썼다 지웠다 했다.

그리고 "mapstruct reason actual and formal argument lists differ in length"를 구글에 검색해 스택오버플로우와 블로그들도 전부 살펴보았지만 해결하지 못했다.

 

🎉 결론

답은 build.gradle에 있었다.

// build.gradle
dependencies {
	...
	annotationProcessor 'org.projectlombok:lombok'
	annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.2.Final'
	...
}

어이없게도 순서를 바꿔보니 정상 동작한다...

 

MapStruct를 쓰려면 Getter와 AllArgsConstructor가 필요한데 이를 lombok이 만들어주기 전에 MapStruct가 코드를 구현해 에러가 발생했던 것이다.

build.gradle에 작성한 annotationProcessor의 순서가 Processor의 실행 순서와도 관련이 있다는 건 처음 알게 되었다.

 

"spring annotationProcessor 순서"를 구글에 검색해서 Tistory / [Spring] MapStruct 와 Lombok 이 글을 찾을 수 있었다. 일찍 발견했으면 좋았을걸.. 그래도 시간을 많이 쓴 만큼, 잊지 못할 지식을 하나 얻었으니 만족한다.

 

 

+ 추가 

lombok 1.18.16 이상 버전부터는 lombok-mapstruct-binding을 추가해주면 순서 상관없이 쓸 수 있다.

annotationProcessor "org.projectlombok:lombok-mapstruct-binding:0.2.0"

Velog / Spring Mapstruct와 lombok 같이 사용시 발생하는 문제