[Back end] ResponseObject Builder

 

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;

/**
 * @author
 * @desc 결과 리턴용 object
 */
@Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@Builder(builderMethodName = "responseObjectBuilder")
public class ResponseObject {
    
    private int resultCode;
    private Object resultData;
    private String resultMessage;
    
    public static ResponseObjectBuilder builder(int resultCode) {
    	
    	if (resultCode == 0) {
    		throw new IllegalArgumentException("resultCode Missing");
    	}
    	return responseObjectBuilder().resultCode(resultCode);
    }
    
    public static ResponseObjectBuilder builder(int resultCode, Object resultData, String resultMessage) {
    	
    	if (resultCode == 0) {
    		throw new IllegalArgumentException("resultCode Missing");
    	}
    	return responseObjectBuilder().resultCode(resultCode).resultData(resultData).resultMessage(resultMessage);
    }
    
}

결과 리턴용 객체를 생성할 때 빌더 패턴을 사용하여 구성한 방법이다.

 

@AllArgsConstructor(access = AccessLevel.PRIVATE) - 전체 필드의 생성자를 자동으로 생성한다. 이때 접근자를 private로 지정하여 외부에서는 접근할 수 없도록 한다.

@Builder(builderMethodName = "responseObjectBuilder") - Builder 어노테이션을 추가하면 자동으로 Builder패턴을 생성해 준다. 이때 메소드명을 지정하면 해당 메소드명으로 Builder를 생성해준다.

ResponseObject responseObject = ResponseObject.builder(ServiceConstant.HttpStatus.OK)
                                                .resultData(resultData)
                                                .resultMessage(resultMessage)
                                                .build();

//OR

ResponseObject responseObject = ResponseObject.builder(ServiceConstant.HttpStatus.OK, resultData, ServiceConstant.ResponseMessage.SUCCESS).build();