스프링부트 와 REST API

---

Spring boot 와 REST api

초기 spring 프로젝트는 스프링 구성에 필요한 XML 코드가 많았다. 이를 극복하려고 스프링 2.5는 애너테이션 (Annotation) 기반으로 컴포넌트 검색 기능을 도입했고 많은 노력에도 불구하고 복잡한 구성에서 벗어나지 못하였고 트랜잭션 관리와 스피링 mvc같은 기능을 사용하려면 명시적인 XML 이나 자바 구성이 필요했다. 이러한 것을 Spring boot가 해결해준다.

스프링부트의 기능

• Create stand-alone Spring applications
• 단독실행가능한 스프링애플리케이션을 생성한다.
• Embed Tomcat, Jetty or Undertow directly (no need to deploy WAR files)
• 내장형 톰캣, 제티 혹은 언더토우를 내장한다.
• Provide opinionated 'starter' component to simplify your build configuration
• 기본설정되어있는 'starter' 컴포넌트들을 쉽게 빌드에 추가할 수 있다.
• Automatically configure Spring whenever possible
• 가능한 자동설정 되어있다.
• Provide production-ready features such as metrics, health checks and externalized configuration
• 상용화에 필요한 통계 및 점검, 외부상태를 제공한다.
• Absolutely no code generation and no requirement for XML configuration
• 설정을 위한 XML 코드를 생성하거나 요구하지 않는다.

---

Rest API

Repressentational State Transfer의 약어로 하나의 URL은 하나의 고유한 리소스를 대표하도록 설계된다 라는 개념

HTTP -GET method (Controller of MVC)

• 주소창에 파라미터가 노출된다.
  www.localhost:8080/search?id=account&password=1234
• 브라우저에서 주소에 대한 캐시가 이루어지므로, 정보를 얻을 때 사용 한다.

---

사용자로부터 접속을 받기 위해서 주소를 설정해야 하는데 그 주소의 묶음을 Controller라고 부른다.

우리는 Controller 패키지를 만들고 매핑된 주소에 따라서 다른 기능을 할 컨트롤러 클래스를 만들어 보자

경로: com.test.study.controller/GetController.java/

package com.test.study.controller;

import org.springframework.web.bind.annotition.RequestMapping
import org.springframework.web.bind.annotition.RequestMethod
import org.springframework.web.bind.annotition.RestController

@RestController
/* 
@RestController 은 @Controller 어노테이션과 @ResponseBody 어노테이션을
합쳐놓은 어노테이션으로 클래스 상단에 @RestController 어노테이션을 선선하면 Method마다 
@ResponseBody 를 붙여주지 않아도 된다.
*/
@RequestMapping("/api"); // URL을 컨트롤러의 메서드와 매핑할 때 사용하는 스프링의 어노테이션
public class GetController {

    /*
        Method는 어떠한 타입으로 받을 것인지 (Post,GET,...) 어노테이션 인자 1에서 결정하고
        path는 어떠한 주소로 받겠다.를 뜻한다.
    */
    @RequestMapping(method = RequestMethod.GET, path = "/getMethod") // -> localhost:8080/api/getMethod
    public String getRequest() {

        return "Hi getMethod";

    }

}

---

사용자에게 지정된 URL을 통해서 "Hi getMethod 를 표시해주었다." 하지만 사용자의 요청을 받을 방법이 없기 때문에
그 보완을 해보자

package com.test.study.controller;

import org.springframework.web.bind.annotition.RequestMapping

@RestController
@RequestMapping("/api"); // URL을 컨트롤러의 메서드와 매핑할 때 사용하는 스프링의 어노테이션
public class GetController {


    @RequestMapping(method = RequestMethod.GET, path = "/getMethod"))
    public String getRequest() {

        return "Hi getMethod";

    }

    @Getmapping("/getParameter") //getMapping 으로 Parameter을 받아준다.
    public String getParam(@RequestParam String id, @RequestParam String password){
        return id+password;
    }
}

이렇게 사용자에게 정보를 보여줄 뿐 아니라 사용자가 입력한 , 요청한 정보를 받을 수 있게 되었다.

하지만 변수가 밚아진다면 어떻게 될까?

지금 위에서는 파라미터로 id와 password만 받지만 만약 (Email, Address, name, id, password)을 받는다고 치자.

@Getmapping("/getParameter") //getMapping 으로 Parameter을 받아준다.
public String getParam(@RequestParam String id, 
                        @RequestParam String email,
                        @RequestParam String Address,
                        @RequestParam String name,
                        @RequestParam String id,
                        @RequestParam String password,
                        ){
    return id+password;
}

이런식으로 사용자에게 받아야할 Data가 많아진다면 객체를 통해서 하나의 묶음으로 받는것이 훨씬 편할 것이다.

이제 mvc의 model에 대해서 들어가보자.

---

Model (Model of MVC)

---

경로: com.test.study.model/SearchParam.java

아까 controller을 셜치한 경로에 model이라는 패키지를 생성하고 SearchParam 이라는 클래스를 생성한다.

//SearchParam.java

public class Searchparam {
    private String email;
    private String address;
    private String name;
    private String id;
    private String password;

    public String getEmail(){
        return email;
    }

    public void setEmail(String email){
        this.email = email;
    }
    ... getter/setter 게속 작성
}

후에 다시 controller 패키지로 돌아와서 매핑을 시켜준다.

하지만 이번에는 @RequestParam 어노테이션으로 매핑하는게 아니라 객체 형식으로 매핑을 시켜준다.

@GetMapping("/getMultParam")
public String getMultP(SearchParam searchparam) {
    return "ok";
}

하지만 우리는 네트워크 통신을 할 때 JSON 형식으로 Data가 표현된다는 것을 알고 있다 그러나 Servlet,jsp

에서는 JSON 라이브러리를 사용했지만 스프링은 return 값을 객체로 주면 된다.

지금은 String 형식으로 Data를 받았기 때문에 데이터를 가공하는데 어려움이 있으므로 JSON 형식으로

받아보자.

@GetMapping("/getMultParam")
public SearchParam getMultP(SearchParam searchparam) {
    return searchParam;
}

으로 지정해준다면 JSON 타입으로 받을 수 있게 된다.

---

HTTP -POST method (Controller of MVC)

---

• 주소창에 파라미터가 노출되지 않는다
  www.localhost:8080/search
• 주소 창에 사용자의 요청 사항이 노출되지 않는다.
• GET 방식에서는 주소 길이 제한이 있지만 POST는 그보다 길게 사용 가능하다 (제한 존재)
• 브라우저가 주소 캐시를 하지못하는 특성이 있다.

---

package com.test.study.controller;

import org.springframework.web.bind.annotition.RequestMapping
import org.springframework.web.bind.annotition.RequestMethod
import org.springframework.web.bind.annotition.RestController

@RestController
@RequestMapping("/api"); // URL을 컨트롤러의 메서드와 매핑할 때 사용하는 스프링의 어노테이션
public class GetController {

    @PostMappint(value = "/postMethod")
    public SearchParam postMehod(SearchParam searchParam) {

        return "searchParam";

    }

}

---

---

HTTP - PUT/PATCH/DELETE

• PUT/PATCH 는 POST와 마찬가지로 BODY에 데이터가 들어있으며, 주로 업데이트에 사용된다.

---

결론

REST API의 개념

• Http 프로토콜에 있는 Method를 활용한 아키텍처 스타일이다.
• Http 메서드를 통해서 Resource를 처리한다.
• CRUD를 통한 Resource를 조작할 때 사용한다.