https://github.com/mr-won/todo_backend
[SpringBoot] Todo Application Backend 개발
https://github.com/mr-won/todo_backend
amazoncorretto11 eclipse gradle springboot todo-application
Last synced: about 1 year ago
JSON representation
[SpringBoot] Todo Application Backend 개발
- Host: GitHub
- URL: https://github.com/mr-won/todo_backend
- Owner: mr-won
- Created: 2024-01-25T10:04:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T15:02:51.000Z (over 2 years ago)
- Last Synced: 2025-03-18T02:27:16.064Z (about 1 year ago)
- Topics: amazoncorretto11, eclipse, gradle, springboot, todo-application
- Homepage:
- Size: 108 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 기술 스택
- Gradle - Groovy
- Amazon Corretto 11 (Java 11)
- Springboot 2.7.0
- Spring Web, Spring Data JPA, H2, Lombok
- Eclipse IDE 23.12 version
## Amazon Corretto 11 설치
[Amazon Corretto 11 설치](https://docs.aws.amazon.com/ko_kr/corretto/latest/corretto-11-ug/windows-info.html)
## SpringBoot Project 생성
```
spring initilizer에서 프로젝트를 다운로드 할 때 gradlew라는 프로그램(gradle wrapper)을 같이 받았으므로
따로 그래들을 설치하지 않고 프로젝트 내의 그래들 래퍼를 사용한다.
```
## Dependency 라이브러리 추가
[MVN Repository](https://mvnrepository.com/search?q=google+guava)
```
구글 구아바 라이브러리를 메이븐 레포지토리 홈페이지에서 찾고 usage 가장 사용 수가 많은 31.1-jre 버전의
그래들 코드를 복사해서 build.gradle의 dependency 부분에 추가하였다.
```
## 이클립스 Lombok 설치
```
메이븐 레포지토리에서 lombok 1.18.22의 Jar를 눌러 jar파일을 다운로드한다. (압축풀기x)
다운로드 한 jar파일의 위치로 가서 java -jar lombok-1.18.22.jar 명령어를 치고 롬복 이클립스를 설치한다.
```
```
이클립스를 재시작하면 dependency에 annotationProcessor 어노테이션 프로세서 라이브러리가 추가된다.
이 라이브러리는 그래들이 인식하는 라이브러리이고 이클립스가 인식하는 라이브러리가 아니기 때문에
어노프테이션 프로세서 설정을 한다.
```
```
Demo 우클릭 proference 진입 java compiler - annotation processing - enable project specific settings 체크
```
## TodoEntity
```
모델과 엔티티를 한 클래스에 구현하고자 한다. 즉 데이터를 담는 역할과 데이터베이스의 테이블과 스키마를 표현하는
역할을 한 클래스 내에 구현한다.
```
## TodoDTO
```
TodoDTO에는 데이터베이스에서 사용자를 구별하기 위한 userId를 제외한 Todo dto 클래스를 작성한다.
```
## ResponseDTO
```
Todo 데이터를 하나만 반환하는 경우보다 리스트로 반환하는 경우가 많으므로 데이터를 리스트로 반환하도록 짰다.
또 다른 모델의 DTO 역시 ResponseDTO를 이용해 리턴할 수 있도록 자바 Generic을 이용하였다.
```
## RESTful API 제약조건
```
REST는 Representational State Transfer의 약자로 아키텍처 스타일이다.
REST 제약조건
Client-Server : 리소스를 관리하는 서버가 존재하고, 다수의 클라이언트가 리소스를 소비하기 위해 서버에 접근하는 구조
Stateless : 상태가 없다. 즉 이전 요청의 영향을 받지 않아야 한다. 이전 요청에서 login한 사실을 서버가 알고 있지 않아도
된다는 의미이다.
Cacheable : 서버에서 리소스를 리턴할 때 캐시가 가능한지 아닌지 명시할 수 있어야 한다.
Uniform Interface : 일관된 인터페이스(리턴 타입의 일관성, 요청의 형태와 응답의 형태가 일관적)
Layered System : 서버에 요청을 날릴 때 여러 개의 레이어(인증 서버, 캐싱 서버, 로드 밸런서)를 거치는 데 이 사이의 레이어들은
요청과 응답에 어떤 영향을 미치지 않는다.
Code-On-Demand : 선택사항이며 클라이언트는 서버에 코드를 요청할 수 있고 서버가 리턴한 코드를 실행할 수 있다.
REST는 HTTP와 다르다. REST는 HTTP를 이용해 구현하기 쉽고 REST 아키텍처를 구현할 때 사용하면 쉬운 프로토콜이 HTTP이다.
```
## TestController
```
SpringBoot-Stater-Web 패키지에서 제공하는 연결 작업의 어노테이션(@RestController, @GetMapping, @PostMapping, @PatchMapping 등)을
사용할 수 있다.
HTTP GET 요청을 대신하여 @RestController 어노테이션을 이용한 TestController를 구현하였다.
localhost:8080/test 로 접근하면 Hello World 가 출력된다. 브라우저에서 URL을 입력해 접근하는 GET 요청을
@RestController를 사용하여 구현하였다.
```
```
@PathVariable을 이용해서 경로로 들어오는 숫자 또는 문자를 변수에 매핑할 수 있다.
/test 경로 뒤에 오는 숫자를 리턴하였다.
```
```
또 다른 방법인 @RequestParam을 이용하여 ?id={id}와 같이 요청 매개변수로 넘어오는 값을 변수로 받아올 수 있다.
```
## TestRequestBodyDTO
```
마지막으로 @RequestBody를 사용하여 객체처럼 복잡한 자료형을 요청에 보낼 수 있다.
요청 바디로 보낼 TestRequestDTO 클래스를 작성한다.
```
```
TestRequestBodyDTO를 요청 바디로 받는 testControllerRequestBody() 메서드를 TestController에 추가한다.
```
```
Postman 프로그램에서 /test/testRequestBody 경로로 TestRequestDTO와 같은 형태의 JSON 형식의 문자열을 요청 바디로
넘겨준다.
오브젝트인 TestRequestDTO를 JSON 형식의 문자열의 요청 바디로 사용하여 요청한다. 이 과정을 Serialization이라고 한다.
@RequestBody : 오브젝트를 JSON과 같은 형태의 문자열 요청 바디로 변환한다.
```
```
이번에는 @ResponseBody를 이용하여 TestRequestDTO를 리턴하는 컨트롤러를 구현한다.
DTO 오브젝트를 JSON으로 리턴하여 결과를 나타내준다.
오브젝트를 JSON으로 변환하여 요청바디로 이용하거나 저장하는 일련의 모든 과정을 Serialization이라고 한다.
```
```
@ResponseEntity를 이용하면 HTTP 응답의 Body 뿐만 아니라 status나 header를 조작할 수 있다.
http status를 400, 즉 400 Bad Request를 추가하여 status를 조작한다.
body의 내용은 @ResponseBody와 동일하다.
```
```
todoController에는 200 ok http status를 반환하는 메서드를 작성하였다.
```
## TodoService
```
Todo 프로젝트를 위한 비즈니스 로직 구현을 위한 TodoServie 클래스를 작성한다.
```
## TodoController
```
TodoController에서 TodoService를 @Autowired 어노테이션을 써서 빈에 등록하여 사용한다.
```
## TodoService Test
```
GET localhost:8080/todo/test 요청을 보내면 "Test Service"를 담은 ResponseDTO가 리턴되는 것을 알 수 있다.
```
## TodoEntity
```
TodoEntity에 @Entity, @Table 어노테이션을 추가하고 @Id를 이용하여 id필드를 기본키로 설정하였다.
@GeneratedValue로 ID를 자동으로 생성하되 문자열 형태의 UUID를 사용하기 위해 @GenericGenerator로 generator의 이름을
system-uuid로 정의하고 이를 @GenerateValue의 generator에서 사용하였다.
```
## TodoRepository
```
JpaRepository를 확장한 TodoRepository 인터페이스를 작성한다.
```
## TodoService
```
TodoService 클래스에서 작성한 TodoRepository를 사용해서 TodoEntity를 생성하고 H2 데이터베이스에 엔티티를 저장하고
findById 쿼리를 이용하여 저장한 TodoEntity의 title을 출력한다.
```
## TodoService 테스팅
## Logger 설정
```
서비스 구현에 앞서 디버깅을 위한 로그 설정을 한다. 로그 라이브러리 중 Slf4j 라이브러리를 사용한다.
Slf4j (Simple Logging Facade for Java) 롬복 어노테이션을 TodoService 클래스 위에 작성하였다.
```
## TodoService create 메서드
```
TodoRepository에서 findByUserId 메서드를 추가한 후 TodoService 클래스에 create 메서드를 작성한다.
TodoEntity를 데이터베이스에 저장하고 UserId로 Entity를 조회한다.
```
## TodoService 리팩토링
```
create 메서드 안의 검증 부분은 다른 메서드에서도 쓰일 예정이므로 validate 메서드로 리팩토링한다.
```
## TodoDTO
```
DTO를 Entity로 변환하기 위한 toEntity 메서드를 TodoDTO 클래스에 추가한다.
```
## TodoController
```
TodoDTO를 요청 바디로 넘겨받고 이를 TodoEntity로 변환하여 저장하고 그 Entity의 값들을 설정한 후 다시
create로 새로운 Entity를 생성한다. 그 Entity 리스트를 TodoDTO 리스트로 변환하고 TodoDTO 리스트를 이용해서
ResponseDTO를 초기화하고 리턴한다.
```
## Post 요청 테스팅
```
localhost8080:todo 경로에 JSONRequest Body를 "title" : "새 포스트1"로 작성하여 HTTP POST 요청을 보내면
다음과 같은 JSON 형태의 HTTP 응답이 리턴된다.
```
## Retrieve Todo 구현
## TodoService retrieve 메서드
```
리포지토리의 findByUserId()를 이용해서 UserId를 가지고 TodoEntity를 조회(retrieve)하는 메서드인
retrieve 메서드를 작성한다.
```
## TodoController retrieveTodoList 메서드
```
데이터베이스에 저장된 TodoEntity를 UserId를 이용해서 찾고 Entity 리스트를 DTO 리스트로 변환한 후 리턴하는
GET 메서드인 retrieveTodoList 메서드를 작성한다.
```
## 테스팅
```
POST로 요청 데이터를 Create한 후에 localhost:8080/todo 경로로 HTTP GET 요청을 보내면 해당하는 userId의 Todo 데이터를
JSON 형태의 HTTP 응답이 리턴하는 것을 확인할 수 있다.
```
## Update Todo 구현
## TodoService update 메서드
```
기존에 존재하는 Entity를 데이터베이스에서 가져온 다음 새로운 entity 값으로 덮어 씌우는 update 메서드를 작성한다.
```
## TodoController updateTodo 메서드
```
PUT 메서드인 updateTodo 메서드를 작성한다.
```
## 테스팅
#### Update Todo 테스트를 위한 Todo 아이템 생성
#### HTTP PUT을 이용해 Todo 아이템 업데이트
```
POST로 Todo를 생성한 후 생성된 id를 복사해서 요청 body의 id로 넣고 title과 done을 수정한 후에 localhost:8080/todo 경로로
HTTP PUT 요청을 보내면 해당하는 id의 Todo 아이템 정보가 수정되는 것을 확인할 수 있다.
```
## Delete Todo 구현
## TodoService delete 메서드
```
Delete 기능을 구현하기 위해 delete 메서드를 작성한다.
```
## TodoController deleteTodo 메서드
```
DELETE 메서드인 updateTodo 메서드를 작성한다.
```
## 테스팅
#### Delete Todo 테스트를 위한 Todo 아이템 생성
#### HTTP DELETE를 이용해 Todo 아이템 삭제
```
POST로 Todo를 생성한 후 생성된 id를 복사해서 요청 body의 id로 넣고 localhost:8080/todo 경로로
HTTP DELETE 요청을 보내면 Todo 아이템이 삭제되고 빈 리스트가 리턴된 것을 확인할 수 있다.
```