제가 이때까지 카페 24 호스팅 하면서 배포 후 오류 났던 원인을 정리해보려 합니다.

1. 용량이 꽉차서

-> 대부분 로그 파일 때문이므로, 로그 파일 정리해주시면 됩니다.

2. 서버가 꺼져서

-> 터미널로 서버에 접근해서 tomcat을 다시 켜줍니다.

3. 자바 버전 차이

-> 8 버전만 가능하다고 합니다.

4. 기타

-> log 확인하기 

REST API 제대로 알고 사용하기

목차

1. REST API의 탄생
2. REST 구성
3. REST 의 특징
4. REST API 디자인 가이드
5. HTTP 응답 상태 코드

어느 날 뜬금없이 대학교 친구에게 전화가 왔습니다. 그러더니 ‘야, REST API가 정확히 뭐 어떤 거야? 하는 질문에 가슴에 비수가 날아와 꽂힌 듯한 느낌을 받았습니다. 며칠 전 카톡으로 요즘 보통 웹서비스들은 ‘REST API형태로 서비스를 제공한다’고 아는 척을 조금 했던 기억이 머릿속을 빠르게 스쳐 지나갔고 그 순간 대충 얼버무리며 ‘아, 그거 REST하게 클라이언트랑 서버간에 데이터를 주고 받는 방식’을 말한다며 얼렁뚱땅 마무리 지었던 기억이 납니다. 실제로 REST API의 서비스를 직접 개발도 해보고 사용도 해봤는데도 막상 설명을 하자니 어려움을 겪었던 적이 있으셨을 텐데요. 그래서 이번에 REST API에 대해 정리하게 되었습니다. 기본적인 REST API에 대한 내용 외에도 REST API를 설계하실 때 참고해야 할 몇 가지 TIP들에 대해 공유해보도록 하겠습니다.

1. REST API의 탄생

REST는 Representational State Transfer라는 용어의 약자로서 2000년도에 로이 필딩 (Roy Fielding)의 박사학위 논문에서 최초로 소개되었습니다. 로이 필딩은 HTTP의 주요 저자 중 한 사람으로 그 당시 웹(HTTP) 설계의 우수성에 비해 제대로 사용되어지지 못하는 모습에 안타까워하며 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 REST를 발표했다고 합니다.

2. REST 구성

쉽게 말해 REST API는 다음의 구성으로 이루어져있습니다. 자세한 내용은 밑에서 설명하도록 하겠습니다.

• 자원(RESOURCE) - URI
• 행위(Verb) - HTTP METHOD
• 표현(Representations)

3. REST 의 특징

1) Uniform (유니폼 인터페이스)

Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일을 말합니다.

2) Stateless (무상태성)

REST는 무상태성 성격을 갖습니다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않습니다. 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않기 때문에 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

3) Cacheable (캐시 가능)

REST의 가장 큰 특징 중 하나는 HTTP라는 기존 웹표준을 그대로 사용하기 때문에, 웹에서 사용하는 기존 인프라를 그대로 활용이 가능합니다. 따라서 HTTP가 가진 캐싱 기능이 적용 가능합니다. HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용하면 캐싱 구현이 가능합니다.

4) Self-descriptiveness (자체 표현 구조)

REST의 또 다른 큰 특징 중 하나는 REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조로 되어 있다는 것입니다.

5) Client - Server 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분되기 때문에 클라이언트와 서버에서 개발해야 할 내용이 명확해지고 서로간 의존성이 줄어들게 됩니다.

6) 계층형 구조

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있게 합니다.

4. REST API 디자인 가이드

REST API 설계 시 가장 중요한 항목은 다음의 2가지로 요약할 수 있습니다.

첫 번째, URI는 정보의 자원을 표현해야 한다.
두 번째, 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.

다른 것은 다 잊어도 위 내용은 꼭 기억하시길 바랍니다.

4-1. REST API 중심 규칙

1) URI는 정보의 자원을 표현해야 한다. (리소스명은 동사보다는 명사를 사용)

    GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 합니다. delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현

위의 잘못 된 URI를 HTTP Method를 통해 수정해 보면

    DELETE /members/1

으로 수정할 수 있겠습니다.
회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST METHOD를 사용하여 표현합니다.

회원정보를 가져오는 URI

    GET /members/show/1     (x)
    GET /members/1          (o)

회원을 추가할 때

    GET /members/insert/2 (x)  - GET 메서드는 리소스 생성에 맞지 않습니다.
    POST /members/2       (o)

[참고]HTTP METHOD의 알맞은 역할
POST, GET, PUT, DELETE 이 4가지의 Method를 가지고 CRUD를 할 수 있습니다.

METHOD역할

다음과 같은 식으로 URI는 자원을 표현하는 데에 집중하고 행위에 대한 정의는 HTTP METHOD를 통해 하는 것이 REST한 API를 설계하는 중심 규칙입니다.

4-2. URI 설계 시 주의할 점

1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용

    http://restapi.example.com/houses/apartments
    http://restapi.example.com/animals/mammals/whales

2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

    http://restapi.example.com/houses/apartments/ (X)
    http://restapi.example.com/houses/apartments  (0)

3) 하이픈(-)은 URI 가독성을 높이는데 사용

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.

4) 밑줄(_)은 URI에 사용하지 않는다.

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다. 이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋습니다.(가독성)

5) URI 경로에는 소문자가 적합하다.

URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이지요.

    RFC 3986 is the URI (Unified Resource Identifier) Syntax document

6) 파일 확장자는 URI에 포함시키지 않는다.

    http://restapi.example.com/members/soccer/345/photo.jpg (X)

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않습니다. Accept header를 사용하도록 합시다.

    GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

4-3. 리소스 간의 관계를 표현하는 방법

REST 리소스 간에는 연관 관계가 있을 수 있고, 이런 경우 다음과 같은 표현방법으로 사용합니다.

    /리소스명/리소스 ID/관계가 있는 다른 리소스명

    ex)    GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

만약에 관계명이 복잡하다면 이를 서브 리소스에 명시적으로 표현하는 방법이 있습니다. 예를 들어 사용자가 ‘좋아하는’ 디바이스 목록을 표현해야 할 경우 다음과 같은 형태로 사용될 수 있습니다.

    GET : /users/{userid}/likes/devices (관계명이 애매하거나 구체적 표현이 필요할 때)

4-4. 자원을 표현하는 Colllection과 Document

Collection과 Document에 대해 알면 URI 설계가 한 층 더 쉬워집니다. DOCUMENT는 단순히 문서로 이해해도 되고, 한 객체라고 이해하셔도 될 것 같습니다. 컬렉션은 문서들의 집합, 객체들의 집합이라고 생각하시면 이해하시는데 좀더 편하실 것 같습니다. 컬렉션과 도큐먼트는 모두 리소스라고 표현할 수 있으며 URI에 표현됩니다. 예를 살펴보도록 하겠습니다.

    http:// restapi.example.com/sports/soccer

위 URI를 보시면 sports라는 컬렉션과 soccer라는 도큐먼트로 표현되고 있다고 생각하면 됩니다. 좀 더 예를 들어보자면

    http:// restapi.example.com/sports/soccer/players/13

sports, players 컬렉션과 soccer, 13(13번인 선수)를 의미하는 도큐먼트로 URI가 이루어지게 됩니다. 여기서 중요한 점은 컬렉션은 복수로 사용하고 있다는 점입니다. 좀 더 직관적인 REST API를 위해서는 컬렉션과 도큐먼트를 사용할 때 단수 복수도 지켜준다면 좀 더 이해하기 쉬운 URI를 설계할 수 있습니다.

5. HTTP 응답 상태 코드

마지막으로 응답 상태코드를 간단히 살펴보도록 하겠습니다. 잘 설계된 REST API는 URI만 잘 설계된 것이 아닌 그 리소스에 대한 응답을 잘 내어주는 것까지 포함되어야 합니다. 정확한 응답의 상태코드만으로도 많은 정보를 전달할 수가 있기 때문에 응답의 상태코드 값을 명확히 돌려주는 것은 생각보다 중요한 일이 될 수도 있습니다. 혹시 200이나 4XX관련 특정 코드 정도만 사용하고 있다면 처리 상태에 대한 좀 더 명확한 상태코드 값을 사용할 수 있기를 권장하는 바입니다.
상태코드에 대해서는 몇 가지만 정리하도록 하겠습니다.

상태코드

상태코드

상태코드

글을 마치며

RESTFul한 API를 설계하실 때 도움이 될만한 내용들을 제 나름의 우선순위를 가지고 정리해 보았습니다. 정리를 하면서 다시 한 번 느낀 것은 정확히 알지 못하면 '설명할 수 없다'는 것입니다. 누군가가 그런 말을 하였습니다. '당신이 어떤 것을 할머니에게 설명해 주지 못한다면, 그것은 진정으로 이해한 것이 아니다.' 저 문구를 항상 가슴 깊이 새기고 앞으로 무엇인가 새로운 지식을 학습해 실무에 적용할 때에도 '대충'이 아닌 '정확한 이해'를 바탕으로 문제를 해결해 나가도록 해야겠다는 다짐과 함께 글을 마무리 짓도록 하겠습니다.
마지막으로 REST API는 정해진 명확한 표준이 없기 때문에 REST API를 사용함에 있어 '무엇이 옳고 그른지'가 아닌 개발하는 서비스의 특징과 개발 집단의 환경과 성향 등이 충분히 고려되어 설계되어야 할 것입니다.

부족한 내용이나 잘못된 내용이 있다면 댓글 부탁 드립니다.
긴 글 읽어주셔서 감사합니다.

Reference

• 마크 메세 (2015), 일관성 있는 웹 서비스 인터페이스 설계를 위한 REST API 디자인 규칙 (김관래, 권원상 역), 한빛미디어
• https://ko.wikipedia.org/wiki/REST
• http://blog.remotty.com/blog/2014/01/28/lets-study-rest/
• https://yangbongsoo.gitbooks.io/study/content/restc758_c774_d574_c640_c124_acc4.html
• http://spoqa.github.io/2012/02/27/rest-introduction.html

   * https://meetup.toast.com/posts/92

1. JPA 개요

- Persistence : java 객체에 포함된 데이터를 데이터베이스를 통해 저장 관리함으로써 객체의 영속성 보장

- JPA : 자바 객체와 데이터베이스 사이의 mapping 방법을 설정, SQL문 자동 생성 및 실행

- Persistenct Provider : JPA의 기능을 구현한 구현체 => 반드시 필요 !!

ex) Hibernate

2.  JPA 구성요소

1) Entity : ORM을 통해 데이터베이스에서 영속적으로 저장, 관리되는 객체

2) EntityManager : Entity에 대한 CRUD 기능 실행

3) ORM 설정 : Entity와 데이터베이스 테이블 사이에 mapping 방법을 정의

: annotation 및 XML 이용

4) JPQL(Java Persistence Query Language)

: SQL과 유사한 질의 언어

=> 복잡한 질의할 때 사용

5) Criteria API

: 자바 코드를 이용한 질의 표현 및 실행 가능

3. Entity

: 영속적인 데이터를 포함하는 POJO 객체

- 식별자(ID) 속성 필요

- 클래스 내에서 어노테이션을 이용해 ORM 설정

4. JPA 주요 어노테이션

1) Entity 정의 : @Entity

2) 식별자 정의 : @Id

3) Entity와 테이블 간의 매핑 정의 : @Table, @Column, 등등

4) Entity들 간의 연관 관계 정의 : @OneToOne

5. EntityManager

: Entity에 대한 생명주기 관리

- 영속 컨텍스트 : 영속성을 갖는 Entity들의 저장 공간(Cache 기능 포함)

- 영속 객체에 대해 데이터베이스 저장, 갱신, 삭제 실행

- 주요 메소드

사용 예)

6. 복합식별자

: 다른 객체에 포함되는 값 객체를 정의

- @Embeddable, @EmbeddableId

- @IdClass, @Id

- @Embeddable, @Embedded

7. @Enumerated

1. Transaction

: 여러 operation들로 이루어 지는 하나의 작업 단위

- database의 상태를 변경(insert, update, delete)

- all or nothing (operation이 하나라도 실패할 경우, 모든 실행 결과를 취소시킴으로써 데이터 무결성 보장)

- ACID 특성을 만족 : Atomicity / Consistency / Isolation / Durability

예시 ) 

2. Transaction 처리의 중요성

무결성 제약조건(check)

alter table inventory add constraint c1 check(qty >= 0);

-> 트랜잭션으로 구현하지 않았을 경우, check 제약조건 위배로 오류 발생했을 때 이미 삽입 및 변경된 행은 그대로 남아 데이터베이스의 무결성이 훼손된다.

-> 트랜잭션으로 구현될 경우, 변경된 사항이 취소(rollback)된다.

3. Transaction Manager

: 다양한 영속성 기술들을 위한 구현 클래스 제공

- JDBC 기반

: DataSourceTransactionManager 이용

: commit(), rollback() 등 호출

4. 스프링의 Transaction 지원

- 선언적 트랜잭션 관리

: 트랜잭션 처리를 코드에서 직접 구현하지 않고 xml 설정 파일이나 annotation을 통해 트랜잭션의 범위와 규칙을 정의

: XML, annotation 이용

1) TransactionProxyFactoryBean

2) <tx:advice>

3) @Transactional

5. transaction 속성

1) Propagation Behavior

2) Isolation level

: 한 트랜잭션이 동시에 실행중인 다른 트랜잭션의 영향을 얼마나 받았는가를 의미

- dirty reads : 다른 트랜잭션에 의해 변경되었지만, 아직 commit 되지 않은 데이터를 읽는 현상

- non-repeatable reads : 같은 질의를 두 번 이상 할 때 서로 다른 데이터를 얻는 현상

- phantom reads : 여러 데이터 행을 읽은 후 다시 질의를 수행할 때 이전에 없던 데이터를 얻는 현상

6. @Transactional annotation 이용

: @Transactional 어노테이션이 붙은 모든 class/bean들에 대해 transaction advice를 자동 생성 및 적용

적용 예 )

* 메소드가 먼저 적용됨

1. REST

: web과 같은 distributed hypermedia system을 위한 구조

: 요청 가능한 resource에 대해 주소를 지정하고 HTTP 위에서 부가적인 전송 계층 없이 상태 표현을 전송하기 위한 방법을 정의

* resource : 주소(URI)를 통해 접근할 수 있는 의미있는 정보

2. RESTful Web Service 

: REST 개념에 기반하고 HTTP 프로토콜을 이용하여 구현된 resource 지향적인 서비스

1) URI를 통한 resource 식별

2) Internet media type를 이용한 resource 표현 ex) XML, JSON, RSS 등

3) HTTP method를 이용한 resource에 대한 연산 요청 ex) POST(CREATE), GET(READ), PUT(UPDATE), DELETE

3. spring MVC framework의 REST 지원

: controller 에서 get, post, put, delete 등 모든 http method 요청 처리 가능

- @PathVariable : URI에 대한 요청 처리

- @RequestBody, @ResponseBody : 요청 메시지 -> 자바객체 / 자바객체 -> 응답 메시지 변환 수행

- HttpMessageConverter : XML, JSON, RSS 등 다양한 data format에 대한 변환 처리

- RestTemplate : RESTful Service를 이용하는 클라이언트 개발 지원

4. @RequestBody / @ResponsBody

- @RequestBody : 요청 메시지의 body에 포함된 데이터를 저장할 Java 객체 지정

- @ResponseBody : Java 객체를 응답 메시지의 body에 포함될 데이터로 사용

- @RestController : @Controller의 확장으로, @ResponseBody를 자동으로 적용

5. HTTP Message Conversion

- Java 객체와 message 간의 변환 처리

: 앞 예제에서 message body와 String 객체 사이의 변환을 위해  StringHttpMessageConverter가 사용됨

: <mvc:annotation-driven/>또는@EnableWebMvc설정을통해 다양한 HttpMessageConverter 구현 객체를 생성 및 이용 가능

6. JAXB2를 이용한 XML 처리

- JAXB2 : Java class와 XML 사이의 mapping 을 위한 표준 라이브러리 (Java SE / EE에 포함됨 )

Java objects => XML data (marshalling)

XML data => Java objects (unmarshalling)

예 1)

예 2)

- Controller : GET 요청 처리

* 객체 타입(MessageList)이 JAXB2가 적용된 클래스일 경우, Jaxb2RootElementHttpMessageConverter를 이용하여 return 객체를 XML 데이터로 변환하여 응답 메시지 body에 출력

- Controller : POST 요청 처리

Client(browser) : XML 데이터를 포함한 POST 요청 생성

7. JSON

- Data Type : 수, 문자열, 불린, 배열, 객체(순서가없음), null

예 ) 

8. Jackson2

: Java 객체와 JSON 형식 데이터 사이의 변환 실행

- Controller : GET 요청 처리

* Request handler method가 Java 객체나 HashMap을 return 할 경우, Spring이 MappingJackson2HttpMessageConverter를 이용하여 return 객체를 JSON 데이터로 변환함

* JSON 변환 제외 처리 : @JsonIgnore

* 날짜 형식 변환 처리 : @JsonFormat

- Controller : POST 요청 처리

: 요청 메시지를 통해 전송된 JSON 데이터를 java 객체로 변환하여 사용

Client : Ajax

8. RestTemplate

- REST client 구현

: RESTful Service를 호출하기 위한 다양한 메소드 제공

: HttpMessageConverter를 이용해 message와 JAVA 객체 간 변환

- 주요 메서드

1) 가변 인자 방식을 이용한 parameterized URL

2) Map 을 이용한 parameterized URL

3) java.net.URI 이용

9. RestTemplate을 이용한 HTTP method

1) GET 요청

2) POST

- PUT

- DELETE 

1. DAO 의 개념

: DBMS를 통해 데이터를 저장 및 검색하는 기능을 전담하는 객체

- business layer와 독립적인 persistence layer 구현 및 변경 가능

- dao mock object를 이용한 테스트 용이

2. Data Access Template

: 각 영속성 기술을 위한 template class 제공한다.

: DAO 에서 반복적으로 실행되는 작업들을 자동으로 수행한다.

3. Spring 에서 예외처리 지원

: DB 오류에 관한 다양한 Exception class 제공한다.

: Spring 이 지원하는 Exception은 모두 "unchecked" exception 이다. 즉 try-catch로 잡아서 처리할 필요가 없다.

4. Data Source 설정

: 데이터베이스에 대한 connection을 제공하는 factory 객체

- Connection pool 사용

- JNDI에 등록된 Data Source 

- JDBC driver 직접 이용

1) connection pool

: 데이터베이스 커넥션을 미리 생성시키고 pool로 관리함으로써 데이터베이스 접근 성능을 향상시키기 위한 방법

- BasicDataSource 타입의 객체를 spring bean으로 생성

2) JNDI에 등록된 data source 설정

: Java EE application server에서 data source를 생성하고 JNDI service에 등록 및 사용

5. JDBC API

: java application에서 데이터베이스를 접근하는 가장 기본적인 방법

- 장점

1) 표준 SQL 언어를 사용

2) 특정 DBMS에서 제공하는 고유 기능 사용 가능

- 단점

1) 데이터 질의, 갱신 등 핵심적인 코드 외에 connection, statement 등의 자원 할당 및 반납, 예외 처리 등과 관련된 코드 필요

2) 위와 같은 코드가 각 데이터 접근 메소드마다 중복됨

- JDBC API 사용 예

6. Spring JDBC Template Classes

: JDBC 기반 프로그램에서 반복적으로 작성되는 코드를 구현하여 숨김

1) JdbcTemplate

2) NamedParameterJdbcTemplate

7. JdbcTemplate

- bean 설정 (spring boot는 필요x)

* 참조 관계 주목 !

- Query method 1 : query()

: rowMapper - ResultSet 에 포함된 각 행을 추출해서 T type의 domain객체를 생성하는 RowMapper 객체

- RowMapper interface

: mapRow() => ResultSet의 특정 행에 대해 T type의 객체 생성 및 반환

- 구현 예 1 : RowMapper class를 별도로 정의

- 구현 예 2: RowMapper를 익명 클래스로 구현

- 구현 예 3 : Java 8의 Lambda expression 활용

- query method 2 : queryForList()

: 질의가 하나의 column만을 조회하는 경우 RowMapper 대신 그 column type에 해당하는 Java type 이름을 제공

- query method 3 : queryForObject() 

: 질의 결과로 List 대신 하나의 T type 객체를 반환

: 질의 결과로 검색되는 row 가 하나인 경우 사용

- Insert/Update/Delete method

- 가변 길이 인자 지원

예 1) 

예 2)

8. NamedParameterJdbcTemplate

: 질의에 포함된 parameter에 이름을 사용

=> Object 대신에 Map이나 paramSource 를 인자로 받음

예시 )

- SqlParameterSource를 사용한 parameter값 설정

- BeanPropertySqlParameterSource 이용

9. SimpleJdbcInsert

예 1)

예 2)

10. DaoSupport

- bean 설정