📄 [문서] CommonUtil 공통 유틸 클래스

[Chuseok22]

❌ 문제 상황

No response

📝 핵심 내용과 방향성

📌 CommonUtil 클래스 문서

CommonUtil 클래스는 공통적으로 사용할 유틸리티 메서드를 제공하는 클래스입니다.
문자열 및 정수 변환, 엔티티를 DTO로 변환하는 기능을 포함하고 있습니다.

---

📌 1. nvl 메서드

설명

• null 처리: str1이 null이면 str2를 반환합니다.
• 문자열 "null" 처리: str1이 "null" 문자열이면 str2를 반환합니다.
• 빈 문자열("") 또는 공백 문자열(" ") 처리: str1이 공백만 포함하는 경우 str2를 반환합니다.

메서드 시그니처

public static String nvl(String str1, String str2)

매개변수

이름	타입	설명
str1	String	검증할 문자열
str2	String	str1이 null 또는 "null" 또는 빈 문자열일 경우 반환할 문자열

반환 값

• str1이 null, "null", 빈 문자열이면 str2 반환
• 그 외의 경우 str1 반환

예제

String result1 = CommonUtil.nvl(null, "기본값");   // 결과: "기본값"
String result2 = CommonUtil.nvl("null", "기본값"); // 결과: "기본값"
String result3 = CommonUtil.nvl("", "기본값");     // 결과: "기본값"
String result4 = CommonUtil.nvl("Hello", "기본값"); // 결과: "Hello"

---

📌 2. null2ZeroInt 메서드

설명

• null 값 처리: Integer 값이 null이면 0을 반환합니다.

메서드 시그니처

public static int null2ZeroInt(Integer val)

매개변수

이름	타입	설명
val	Integer	검증할 Integer 값

반환 값

• val이 null이면 0 반환
• 그렇지 않으면 val 그대로 반환

예제

int result1 = CommonUtil.null2ZeroInt(null);   // 결과: 0
int result2 = CommonUtil.null2ZeroInt(10);     // 결과: 10
int result3 = CommonUtil.null2ZeroInt(-5);     // 결과: -5

---

📌 3. convertEntityToDto 메서드

설명

• Entity 객체를 DTO 객체로 변환하는 기능을 제공합니다.
• BeanUtils.copyProperties()를 사용하여 필드 값을 복사합니다.
• entity가 null이면 null을 반환합니다.
• 반환할 DTO 객체는 기본 생성자가 있어야 합니다.

메서드 시그니처

public static <D, E> D convertEntityToDto(E entity, Class<D> dtoClass)

매개변수

이름	타입	설명
entity	E	변환할 엔티티 객체
dtoClass	Class<D>	변환할 DTO 클래스 타입

반환 값

• 변환된 DTO 객체 반환
• entity가 null이면 null 반환

예제

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class ConcertHallDto {
    private String concertHallName;
    private int capacity;
    private String address;
}

@Entity
@Getter
@Setter
public class ConcertHall {
    private String concertHallName;
    private int capacity;
    private String address;
}

ConcertHall concertHall = new ConcertHall();
concertHall.setConcertHallName("올림픽 체조경기장");
concertHall.setCapacity(15000);
concertHall.setAddress("서울 송파구 올림픽로 424");

ConcertHallDto dto = CommonUtil.convertEntityToDto(concertHall, ConcertHallDto.class);
System.out.println(dto.getConcertHallName()); // 출력: "올림픽 체조경기장"

---

📌 예외 처리

• convertEntityToDto() 실행 중 오류가 발생하면 런타임 예외(RuntimeException)가 발생합니다.
• 오류 발생 시 로그(log.error(...))가 기록됩니다.

---

📌 결론

메서드명	기능
nvl(str1, str2)	null, "null", 빈 문자열("")을 str2로 대체
null2ZeroInt(val)	null이면 0 반환
convertEntityToDto(entity, dtoClass)	엔티티 객체를 DTO로 변환

이 CommonUtil 클래스는 문자열 변환, 정수 변환, DTO 변환 기능을 제공하여 코드의 일관성을 유지하고 재사용성을 높이는 데 도움을 줍니다. 🚀🔥

📚 트러블슈팅 및 기대효과

No response

🔗 관련 자료

No response

🙋‍ 담당자

• 백엔드: @nayoung04 @HyerimH @Chuseok22
• 프로트엔드: 이름
• 디자인: 이름