[웹개발의 봄, Spring] 2주차 개발일지(3) - Lombok, DTO, Controller

 

[웹개발의 봄, Spring] 2주차 개발일지(1) - RDBMS, H2, SQL

[웹개발의 봄, Spring] 2주차 개발일지(2) - JPA의 CRUD와 Repository

 

이번 포스팅에서 정리할 부분은 Lombok, DTO, Controller에 관한 내용이다. 

 

 

Lombok

💡 Lombok이란?

Lombok(롬복)은 자바 프로젝트를 진행하는데 거의 필수적으로 필요한 메소드/생성자 등을 자동 생성해줌으로써 코드를 절약할 수 있도록 도와주는 라이브러리이다. plugins에서 lombok을 검색해서 설치한 후 사용할 수 있다. 

 

Getter, NoArgsConstructor, RequiredArgsConstructor 등을 프로젝트에 적용해봤다. 

 

 

 

 

DTO

💡 DTO의 필요성

read, update를 할 때 Course 클래스를 막 써도 될까? 내가 아닌 다른 사람이 변경한다면?? 즉, 테이블을 막 건드려도 되는 걸까??? 이런 걱정이 들 때, 완충재로 활용하는 것이 DTO(Data Transfer Object)이다. 

 

 

💡 DTO 적용하기

DTO를 2주차 프로젝트에 적용해보자. 

1. src > main > java > com.sparta.week02 > domain에 CourseRequestDto 클래스를 생성한다. 

@NoArgsConstructor
@Getter
public class CourseRequestDto {
    private String title;
    private String tutor;

    public CourseRequestDto(String title, String tutor) {
        this.title = title;
        this.tutor = tutor;
    }
}

2. CourseService, Course, Week02Application 클래스에서 update 부분에 데이터를 넘겨줄 때 CourseRequestDto를 이용하도록 코드를 수정한다. 

- CourseSercvie.java 예시

@RequiredArgsConstructor
@Service
public class CourseService {
    private final CourseRepository courseRepository;

    @Transactional
    public Long update(Long id, CourseRequestDto requestDto) {
        Course course1 = courseRepository.findById(id).orElseThrow(
                () -> new IllegalArgumentException("해당 아이디가 존재하지 않습니다.")
        );
        course1.update(requestDto);
        return course1.getId();
    }
}

 

 

 

 

Controller

💡 API

API는 클라이언트-서버 간의 약속이다. 클라이언트가 정한대로 서버에게 요청(Request)을 보내면, 서버가 요구사항을 처리하여 응답(Response)을 반환하는 것이다. 

 

REST란 주소에 명사, 요청 방식에 동사를 사용함으로써 의도를 명확히 드러냄을 의미한다. 여기서 동사는 전에 말했던 CRUD를 지칭한다. 예를 들자면 courses에 대해 생성(POST)/조회(GET)/수정(PUT)/삭제(DELETE) 요청하는 것이다. 

 

참고로, 주소에 들어가는 명사들은 복수형을 사용한다. 그리고 주소에 동사는 가급적 사용하지 않는다고 한다. 

 

 

💡 Controller에 API 작성하기

controller 패키지를 만들고 그 안에 CourseController 클래스를 생성한다. 

@RequiredArgsConstructor
@RestController
public class CourseController {

    private final CourseRepository courseRepository;
	
    // 여기에 API 작성할 예정
    
}

 

- GET

@GetMapping("/api/courses")
public List<Course> getCourses() {
	return courseRepository.findAll();
}

 

- POST

@PostMapping("/api/courses") 
public Course createCourse(@RequestBody CourseRequestDto requestDto) {
	Course course = new Course(requestDto);
	return courseRepository.save(course);
}

 

- PUT

@PutMapping("/api/courses/{id}")
public Long updateCourse(@PathVariable Long id, @RequestBody CourseRequestDto requestDto) {
    return courseService.update(id, requestDto);
}

 

- DELETE

@DeleteMapping("/api/courses/{id}")
public Long deleteCourse(@PathVariable Long id) {
    courseRepository.deleteById(id);
    return id;
}

 

 

참고) 강의에선 ARC(Advanced REST Client)를 이용해서 API 기능 확인을 했다. 주의할 점은 POST, PUT 요청에 대해서는 header에 Content-Type을 application/json으로 추가한 뒤, body에 json 형식으로 course 정보를 넘겨줘야 한다. 

 

 

 

 

 

 

참고 자료: 스파르타코딩클럽 웹개발의 봄, Spring 2주차 강의자료