JSON 응답 필드 Null 값 제외(@JsonInclude)

JSON 응답 필드가 Null 값인 경우 응답 필드에서 제외 시키는 방법

 

 

▷  해결방법

@JsonInclude(JsonInclude.Include.NON_NULL) 어노테이션 사용(필드 별 설정 가능)

 

 

▷ Example

 

@Data
@JsonInclude(value = Include.NON_NULL)
public class TestResVO {
    /** 학번 */
    private String studentNo; 
    /** 학생 이름 */
    private String name;
    /** 취미 */
    private String hobby;
}

public static void testResJson() {
	try {
		/* TEST DATA 생성 */
		String testData = "{\"STUDENTNO\": \"00001\",\"NAME\": \"홍길동\", \"HOBBY\": \"\"}";

		/* TEST JSONObject 파싱 */
		JSONParser jsonParse = new JSONParser();
		JSONObject jsonObj = (JSONObject) jsonParse.parse(testData);
		
		System.out.println(jsonObj); 
		// {"STUDENTNO":"00001","HOBBY":"","NAME":"홍길동"}

		/* 응답VO 설정 */
		TestResVO resVO = new TestResVO();
		resVO.setStudentNo(String.valueOf(jsonObj.get("STUDENTNO")));
		resVO.setName(String.valueOf(jsonObj.get("NAME")));
		// HOBBY 응답 필드 NULL 설정
		
		System.out.println(resVO); 
		// TestResVO(studentNo=00001, name=홍길동, hobby=null)

		/* 응답VO JSON 변환 */
		ObjectMapper mapper = new ObjectMapper();
		String strResVO = mapper.writeValueAsString(resVO);
		
		/* 최종확인 */
		System.out.println(strResVO);
		// TestResVO에 @JsonInclude(value = Include.NON_NULL)가 있는 경우
			// {"studentNo":"00001","name":"홍길동"}
		// 없는 경우
			// {"studentNo":"00001","name":"홍길동","hobby":null}
	} catch(Exception e) {
		System.out.println(e);
	}
}