Spring - 서버에서 객체를 JSON으로 변환 후 응답하기 (+ API 서버 만들기)

JSON 응답?

클라이언트는 서버를 거쳐서 DB에 접근합니다. 클라이언트가 DB에서 필요한 정보를 얻기 위해, 서버에게 데이터를 요청하면 서버에서는 클라이언트가 필요한 데이터 또는 그 데이터가 포함된 데이터를 보내줍니다.

 

이 때, 서버가 보내주는 데이터는 클라이언트가 해석하기 쉬우면 좋고, 내용이 간결해서 전송속도가 빠르면 좋을 것입니다. 그래서 사용하는 데이터의 형식 중 대표적인 하나가 JSON입니다.

 

API 서버를 만들고, DB의 데이터를 꺼내서 JSON으로 변환하고, 생성한 API 서버에 출력하는 예제를 진행해보겠습니다. 클라이언트는 생성한 API 서버의 url로 접속(요청)해서 JSON 데이터를 가져가서 원하는 로직을 굴릴 수 있을 것입니다.

 

Jackson 라이브러리 의존 추가

Jackson 라이브러리는 [ 자바 객체(Object) <-----> JSON 형식의 문자열 데이터 ] 변환을 처리하는 라이브러리입니다. 

<!-- core와 Annotation 관련 모듈  -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.8</version>
</dependency>

<!-- java8 date/time 지원을 담당하는 Jackson 모듈 -->
<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
    <version>2.9.8</version>
</dependency>

pom.xml에 Jackson 라이브러리 관련 의존을 추가합니다.

 

@RestController 컨트롤러 구현

@RestController
public class RestApiController {
    private MemberDao memberDao;
    
    @GetMapping("/api/members")
    public List<Member> members() {
        return memberDao.selectAll();
    }
    

    public void setMemberDao(MemberDao memberDao) {
	this.memberDao = memberDao;
    }

}

@RestController를 입은 컨트롤러는 요청 매핑 애노테이션을 붙인 메서드의 리턴으로 jsp의 경로를 반환하는 것이 아니라 객체를 반환합니다.

 

예를 들어, 위에서 memberDao.selectAll()는 결국 List<Member>타입 객체(DB에서 긁어온 데이터를 Member 객체에 넣은 것들을 담은 리스트)를 반환합니다.

 

public class Member {
    private Long id;
    private String email;
    private String name;
    
    @JsonIgnore
    private String password;
    
    @JsonFormat(shape = Shape.STRING)
    // @JsonFormat(shape = Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss", timezone = "Asia/Seoul")
    private LocalDateTime registerDateTime;
}

컨트롤러에서 List<Member>를 반환하는데 Member 타입에는 password가 포함되어 있습니다. 이를 제외하려면 @JsonIgnore 애노테이션을 사용합니다.

 

날짜 형식을 JSON의 문자열 값으로 변환할 때는 @JsonFormat 애노테이션을 사용하고 shape 속성의 값으로는 데이터 형식을 지정합니다. pattern 속성을 이용하면 형식을 수정할 수 있고, timezone으로 시간대를 설정할 수 있습니다.

 

* @JsonFormat 애노테이션을 일일이 여러 곳에 붙이기 귀찮다면 WebMvcConfigurer 인터페이스의 extendMessageConverters()메서드를 재정의해서 위 애노테이션 없이도 자동으로 모든 날짜 형식 데이터가 자동으로 원하는 형식으로 변환되게 설정하는 방법도 있습니다.

@Configuration
public class ControllerConfig {
    @Bean
    public RestApiController restApi() {
        RestApiController rac = new RestApiController();
        rac.setMemberDao(memberDao);
        return rac;
    }
    // .. 생략
}

컨트롤러 설정에서 구현한 컨트롤러를 등록합니다.

그러면 클라이언트가 경로로 접속(GET 요청) 했을 때 JSON 데이터를 받아볼 수 있을 것입니다. 배열로 나온 이유는 List타입 객체를 반환했기 때문입니다.

 

클라이언트는 이 JSON 데이터를 원하는 형태로 가공해서 사용할 수 있을 것입니다.

@GetMapping("/api/members/{id}")
public Member member(@PathVariable Long id, HttpServletResponse response) throws IOException {
    Member member = memberDao.selectById(id);
        if (member == null) {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
            return null;
        }
    return member;
}

List가 아닌 특정 유저에 대해서 member 객체 하나만 리턴하는 요청 매핑 메서드는 위와 같이 구현합니다.

 

매핑 경로에 {id}를 사용하는 이유는 사용자가 입력한 경로의 {id}부분에 해당되는 부분을 @PathVariable 애노테이션이 적용된 파라미터 id에 대입해서 해당 id를 가진 멤버의 객체를 반환하기 위함입니다.

 

해당 id를 가진 member가 존재하지 않다면 상태 코드 404(SC_NOT_FOUND)를 알립니다.

 

결과입니다.