Spring RestAPI

05 Jun 2019

2.5 Spring RestAPI

Spring 프레임워크는 Spring MVC 그대로 Restful을 위한 서비스를 제공하고 있습니다. 이번챕터에서는 TDD로, Restful한 api 서비스를 만들어보고 스프링에서 Restful한 서비스를 위해 지원해주는 사항들을 알아보도록 하겠습니다.

Contents List

2.5.1) REST
1. REST 특징
2. REST 목적
2.5.2) Spring Restful API 서비스 만들기
최종 결과 확인
마무리

2.5.1) REST

먼저 REST에대해서 알아보도록 하겠습니다. REST API 혹은 RESTful, 이제는 REST 그자체로 불리는 REST는 ‘Representational State Transfer’의 약자로써 상태를 표현하면서 전송하는 아키텍쳐를 의미합니다. REST는 자원(Resource), 메서드, 메시지 3가지의 요소로 구성되며 기존의 HTTP 프로토콜 그대로를 활용 할 수 있습니다.

REST 특징

무상태성 (Stateless) : 서버는 들어오는 request들을 각각 별개의 요청으로 처리합니다. 세션과 같은상태를 따로 서버에 저장 하지 않고 들어오는 요청들을 단일의 메세지로 처리합니다.
인터페이스 일관성 (Uniform Interface) : HTTP 표준에 따른 어떤 플랫폼, 언어에 관계없이 사용가능합니다.
캐시처리가능 (Cacheable) : 기존 HTTP에서 사용하던 E-Tag 캐시를 그대로 사용 가능합니다.
자체표현구조 (Self-descriptiveness) : API Resource 즉 URI 만으로 API 기능을 이해 가능합니다.
서버-클라이언트구조 (Server-client) : 서버와 클라이언트가 완전히 분리된 구조로써 의존성이 줄어듭니다.
계층화 (Layerd system) : 클라이언트는 REST API Server만을 호출하고 서버는 다중계층으로 이루어질수 있습니다. 클라이언트는 서버측의 계층구조를 따로 확인할수 없으며 암호화,로드밸런싱,프록시등을 사용해 확장이 가능합니다.

#### REST 주요규칙

URI는 정보의 자원을 표현합니다 (ex : POST http://taes-k.com/users)

1. Method로서 자원의 처리방법을 정의합니다.

Method	내용
POST	Create
GET	Select
PUT	Update
DELETE	Delete

2. URI에 정보의 자원(Resource)들을 표현해야합니다.
users 명사 복수형으로 사용하며 세부 하위 내용들에 대해서는 /이후에 붙여나감으로써 정보에대한 내용을 확장시켜나갈수 있습니다.

예제 1 ) GET https://taes-k.com/users/1 : 1번 user 내용 조회
예제 2 ) POST https://taes-k.com/users/2 : 2번 user 생성

REST 목적

사실 REST를 사용함으로써 특별하게 성능적으로 좋아지는 효과가 있지는 않습니다. 다만 URI만으로도 이해하기 쉬운 API를 제공해 주고 일관적이고 호환성을 높이기 위함에 있습니다.
현재 개발되고 있는 API의 대부분은 RESTFul 하게 개발되어지고 있기때문에 REST를 사용하면 안되는 특별한 이유가 없는한 REST규칙을 따라 개발해 나가는것을 추천 드립니다.

2.5.2) Spring Restful API 서비스 만들기

이전 챕터에서 말씀드렸던 TDD 방법론을 이용하여 Restful API 서비스를 직접 만들어 보도록 하겠습니다.
TDD의 프로세스는 (실패 테스트 작성 > 통과를 위한 개발 코드 작성 > 리팩토링 )의 반복의 과정입니다.

테스트케이스(1)

먼저 제가 구상하고 있는 서비스의 플로우는 다음과 같습니다.
1. 뉴스 입력(저장) -> 생성된 뉴스 데이터 불러오기(조회)
2. 뉴스 데이터 불러오기(조회) -> 뉴스 데이터 수정(수정) -> 변경된 뉴스 데이터 불러오기(조회)

도메인으로 보자면 뉴스 데이터를 생성, 수정, 조회하는 API를 만들기위해 먼저 테스트 케이스를 작성하겠습니다.

// NewsApiTest.java

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@Transactional
public class NewsApiTest {

    @Autowired
    private MockMvc mockMvc;

    @Before
    public void insertNewsTest() throws Exception {
        //뉴스 생성
        mockMvc.perform(MockMvcRequestBuilders.post("/news/{id}",4))
            .andExpect(status().isOk())
            .andExpect(content().string("새로운 4번 뉴스"))
            .andDo(print());
    }
    
    @Test
    public void getNewsTest() throws Exception {
        //뉴스 불러오기
        mockMvc.perform(MockMvcRequestBuilders.get("/news/{id}",4))
            .andExpect(status().isOk())
            .andExpect(content().string("조회된 4번 뉴스"))
            .andDo(print());

    }

    @Test
    public void updateNewsTest() throws Exception {
        //뉴스 수정
        mockMvc.perform(MockMvcRequestBuilders.put("/news/{id}",4))
            .andExpect(status().isOk())
            .andExpect(content().string("수정된 4번 뉴스"))
            .andDo(print());
    }

}

위에서 작성한 테스트케이스는 다음과 같습니다.
1. 뉴스 생성 -> 뉴스 조회
2. 뉴스 생성 -> 뉴스 업데이트

위 테스트는 실제 비즈니스 로직을 검증할수 없는 테스트입니다.
다만 우선, 이번 테스트의 목적은 우리가 Rest한 서비스를 만들수 있는가를 테스트하는 목적으로 만든 테스트입니다.

개발 코드 작성

이제 TDD의 다음단계인 성공을 위한 개발 코드를 구현해보도록 하겠습니다.

// NewsController.java

@RestController
public class NewsController {

    @RequestMapping(value="/news/{id}", method=RequestMethod.POST)
    public String insertNews(@PathVariable ("id") int newsId) {
        String result = "새로운 "+newsId+"번 뉴스";

        return result;
    }

    @RequestMapping(value="/news/{id}", method=RequestMethod.PUT)
    public String updateNews(@PathVariable ("id") int newsId) {
        String result = "수정된 "+newsId+"번 뉴스";

        return result;
    }

    @RequestMapping(value="/news/{id}", method=RequestMethod.GET)
    public String getNews(@PathVariable ("id") int newsId) {
        String result = "조회된 "+newsId+"번 뉴스";

        return result;
    }
}

REST 서비스를 만들기위해서 위 Controller에는 이전 챕터들에서 적용한 @Controller가 아닌 @RestController 어노테이션을 적용해 주었습니다.

기존에 사용하던 @Controller의 경우 MVC에서 사용되는 어노테이션으로, View를 응답하기위한 어노테이션으로, View를 클라이언트에게 전달하기위함이 목적이라고 하면, @RestController 를 사용하게 되면 객체 데이터를 바로 응답시킨다는 차이가 있습니다.

물론, @Controller와 @ResponseBody의 조합으로 @RestController와 같은 목적과 기능으로 동작하도록 만들수 있습니다.

테스트 확인

위의 테스트케이스를 통해 /news의 GET,PUT,POST 모든 Request mapping이 잘 이루어지도록 Controller가 잘 작성되었음을 확인 할 수 있습니다.
사실 위와같이 Controller를 작성한것만으로 벌써 RestApi 서비스를 완성한것이나 다름없습니다.
지금 현재상태에서 실제 서버에 배포를 한다면 원하는 데이터를 잘 응답 해 줄것입니다.

테스트케이스(2)

자 이제 테스트케이스_1이 잘 작동했으니 다음 테스트케이스로 수정해보겠습니다.
이번 케이스에서는 String이 아닌 NEWS Entity를 직접 받아올수 있게끔 해보겠습니다. News 엔티티는 이전 프로젝트를 기반으로 하겠습니다.

// NewsApiTest.java

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@Transactional
public class NewsApiTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private ObjectMapper mapper;

    @Before
    public void insertNewsTest() throws Exception {
        //뉴스 생성
        News insertNews = new News();
        insertNews.setId(4);
        insertNews.setTitle("새로운 4번 뉴스");
        insertNews.setContents("새로운 뉴스 컨텐츠");
        insertNews.setDate(new Date());
        insertNews.setAuthor("Taes-k");
        insertNews.setType("sports");

        mockMvc.perform(MockMvcRequestBuilders.post("/news/{id}",4)
        .contentType(MediaType.APPLICATION_JSON)
        .content(mapper.writeValueAsString(insertNews)))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.id").value(4))
        .andDo(print());
    }
    
    @Test
    public void getNewsTest() throws Exception {
        //뉴스 불러오기
        mockMvc.perform(MockMvcRequestBuilders.get("/news/{id}",4))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.title").value("조회된 4번 뉴스"))
        .andDo(print());
    }

    @Test
    public void updateNewsTest() throws Exception {
        //뉴스 수정
        News updateNews = new News();
        updateNews.setId(1);
        updateNews.setTitle("수정된 1번 뉴스");
        updateNews.setContents("수정된 뉴스 컨텐츠");
        updateNews.setDate(new Date());
        updateNews.setAuthor("Taes-k");
        updateNews.setType("sports");

        mockMvc.perform(MockMvcRequestBuilders.put("/news/{id}",1)
        .contentType(MediaType.APPLICATION_JSON)
        .content(mapper.writeValueAsString(updateNews)))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.id").value(1))
        .andDo(print());

        //뉴스 불러오기
        mockMvc.perform(MockMvcRequestBuilders.get("/news/{id}",1))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.title").value("조회된 1번 뉴스"))
        .andDo(print());

    }
}

개발 코드 작성

// NewsController.java

@RestController
public class NewsController {

    @RequestMapping(value="/news/{id}", method=RequestMethod.POST)
    public News insertNews( @PathVariable ("id") int newsId,
                            @RequestBody News insertNews
    ) {
        return insertNews;
    }

    @RequestMapping(value="/news/{id}", method=RequestMethod.PUT)
    public News updateNews( @PathVariable ("id") int newsId,
                            @RequestBody News updateNews) {
        return updateNews;
    }

    @RequestMapping(value="/news/{id}", method=RequestMethod.GET)
    public News getNews( @PathVariable ("id") int newsId) {
        News result = new News();
        result.setTitle("조회된 "+newsId+"번 뉴스");

        return result;
    }
}

테스트 확인

테스트 성공 출력화면

자 이제 실제 News Entity 연결 까지 성공했습니다. 이제 Service와 Repository까지 작성하여 실제 Database와의 연동을 진행해보도록 하겠습니다.

테스트케이스 (3)

위의 테스트를 통해서, Rest한 서비스를 만들수 있는지를 테스트를하였고, Entity 객체를 통해 데이터를 주고받는것 까지 테스트를 진행하였습니다.
이번 단계의 테스트에서는 실제 MVC를 구현하여 비즈니스 로직상의 뉴스 등록, 수정, 조회 서비스를 만들어보도록 하겠습니다.

// NewsApiTest.java

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
@Transactional
public class NewsApiTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private ObjectMapper mapper;

    @Before
    public void insertNewsTest() throws Exception {
        //뉴스 생성
        News insertNews = new News();
        insertNews.setTitle("새로운 뉴스");
        insertNews.setContents("새로운 뉴스 컨텐츠");
        insertNews.setDate(new Date());
        insertNews.setAuthor("Taes-k");
        insertNews.setType("sports");

        MvcResult insertResult = mockMvc.perform(MockMvcRequestBuilders.post("/news")
        .contentType(MediaType.APPLICATION_JSON)
        .content(mapper.writeValueAsString(insertNews)))
        .andExpect(status().isOk())
        .andDo(print())
        .andReturn();

        String contents = insertResult.getResponse().getContentAsString();
        News insertResultNews = mapper.readValue(contents, News.class);

    }

    @Test
    public void getNewsTest() throws Exception {
        //뉴스 불러오기
        mockMvc.perform(MockMvcRequestBuilders.get("/news/{id}",1))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.title").value("새로운 뉴스"))
        .andDo(print());
    }

    @Test
    public void updateNewsTest() throws Exception {
        //뉴스 수정
        News updateNews = new News();
        updateNews.setTitle("수정된 1번 뉴스");
        updateNews.setContents("수정된 뉴스 컨텐츠");
        updateNews.setDate(new Date());
        updateNews.setAuthor("Taes-k");
        updateNews.setType("sports");

        mockMvc.perform(MockMvcRequestBuilders.put("/news/{id}",1)
        .contentType(MediaType.APPLICATION_JSON)
        .content(mapper.writeValueAsString(updateNews)))
        .andExpect(status().isOk())
        .andDo(print());

        //뉴스 불러오기
        mockMvc.perform(MockMvcRequestBuilders.get("/news/{id}",1))
        .andExpect(status().isOk())
        .andExpect(jsonPath("$.title").value("수정된 1번 뉴스"))
        .andDo(print());
    }
}

개발 코드 작성

// NewsController.java

@RestController
public class NewsController {

    @Autowired
    MainNewsServiceImpl mainNewsService;

    @RequestMapping(value="/news", method=RequestMethod.POST)
        public News insertNews(@RequestBody News insertNews) {

        return mainNewsService.insertNews(insertNews);
    }

    @RequestMapping(value="/news/{id}", method=RequestMethod.PUT)
    public News updateNews( @PathVariable ("id") int newsId,
                            @RequestBody News updateNews) {

        return mainNewsService.updateNews(newsId,updateNews);
    }

    @RequestMapping(value="/news/{id}", method=RequestMethod.GET)
    public Optional<News> getNews( @PathVariable ("id") int newsId) {

        return mainNewsService.getNews(newsId);
    }
}

@Service
public class MainNewsServiceImpl implements NewsService {

    @Autowired
    NewsDao newsDao;

    @Override
    public News insertNews(News news) {

        return newsDao.save(news);
    }

    @Override
    public News updateNews(int id, News news) {

        news.setId(id);

        return newsDao.save(news);
    }

    @Override
    public Optional<News> getNews(int newsId) {

        return newsDao.findById(newsId);
    }
}

테스트 확인

최종 결과 확인

테스트 완료후 curl을 통해 실제 데이터 출력까지 잘 되는것이 확인되었고, 또한 테스트과정에서 수정했떤 데이터가 테스트 완료 후에는 Transaction 을 통해 roll back 되어 있음을 확인 할 수 있습니다.

마무리

지난챕터에서 미리 말씀드렸던것 처럼 TDD를 활용하여 Spring Rest API 서비스를 만들어보았습니다. 간단한 api와 간단한 테스트였기 때문에 어려움없이 진행 되었지만, TDD가 익숙하시지 않으신 분이라면 조금 어려우실수도 있겠으나 최대한 간단하게 진행했던 예제 프로젝트이기 때문에 위의 과정을 잘 이해하신다면 TDD를 이해하시고 앞으로의 프로젝트에서 적용하시는데 큰 도움이 되실것입니다.

특히나 RestAPI서비스를 만들면서 Spring에서 지원하고있는 RestController와 JPA를 사용하여 굉장히 효율적으로 만들수 있었는데요 본문상에는 생략한 파일들이 많아 따라하기 어려우신 분들은 하단 샘플 프로젝트를 확인해주시면 감사드리겠습니다.

샘플 프로젝트

위 프로젝트는 다음 링크에서 확인하실수 있습니다.
https://github.com/taes-k/spring-example/tree/master/spring-rest-api

요령과 기본 Spring