[Spring Boot/RESTful] User Service API 구현

1) domain 클래스 생성

도메인

특정 전문 분야에서 사용되는 전문 지식

스테레오타입

해당 클래스가 어느 용도로 사용될 것인지 나타내는 것 → 의존성 주입할 때 도움이 된다.

ex) @RestController, @Service

User domain

여기에서는 @Data annotation을 사용했지만 @Data 사용은 되도록 자제하고 @Getter @Setter 등을 따로 지정해주는 것이 좋다. 

(@Data 같은 경우는 한꺼번에 많은 기능을 불러오기도 하고, @ToString은 잘못 쓰면 JPA에서 문제가 생길 수 있기 때문)

@Data @AllArgsConstructor 
public class User { 
    private Integer id; 
    private String name; 
    private Date joinDate; 
}

2) DAO + Service 클래스 생성

하지만 db 연결을 하지 않기 때문에 DAO 클래스는 필요없다. 그러니 Service 클래스만 만들어보겠다. 

@Service
public class UserDaoService {
	private static List<User> users = new ArrayList<>();

	private static int usersCount = 3;

	static {
		users.add(new User(1, "minji", true, new Date()));
		users.add(new User(2, "nitro", false, new Date()));
		users.add(new User(3, "ewha", false, new Date()));
	}

	// 전체 조회
	public List<User> findAll(){
		return users;
	}

	// 저장
	public User save(User user){
		if (user.getId() == null){
			user.setId(++usersCount);
		}
		users.add(user);
		return user;
	}

	// 일부 조회
	public User findOne(int id){
		for (User user : users){
			if (user.getId() == id) return user;
		}
		return null;
	}

	public User deleteById(int id){
		Iterator<User> iterator = users.iterator();

		while(iterator.hasNext()){
			User user = iterator.next();
			if (user.getId() == id){
				iterator.remove();
				return user;
			}
		}
		return null;
	}

	public User updateById(int id){
		Iterator<User> iterator = users.iterator();
		while(iterator.hasNext()){
			User user = iterator.next();
			if (user.getId() == id){
				return user;
			}
		}
		return null;
	}
}

3) Controller 클래스 생성

의존성 주입

- setter 메소드 / 생성자의 매개변수 / @Autowired를 사용하는 방법이 있다.

- userController에서 service를 매개변수로 받아 의존성 주입한다.(생성자를 통한 의존성 주입)

=> DEBUG 레벨의 log에서 userController를 검색하면 의존성 주입이 완료되어 아래와 같은 메시지가 뜬다.

'userController' via constructor to bean named 'userDaoService'

@RestController
public class UserController {

	private UserDaoService service;

	// 생성자를 통한 의존성 주입
	public UserController(UserDaoService service) {
		this.service = service;
	}

	// GET users/10 -> String
	// 기본은 String이지만 매개변수로 int 받으면 자동 변경
	@GetMapping("/users/{id}")
	public User retrieveUser(@PathVariable int id) {
		User user = service.findOne(id);
		if (user == null){
			// 직접 상황에 맞는 예외 클래스 작성
			throw new UserNotFoundException(
            	String.format("ID[%s] is not found", id));
		}
		return user;
	}

	@PostMapping("/users")
    	// @RequestBody : 현재 variable이 requestBody 형식으로 들어옴을 알림
	public ResponseEntity<User> createUser(@RequestBody User user) { 
		User savedUser = service.save(user);

		// ServletUriComponentBuilder -> 현재 요청의 URI를 얻을 수 있다.
		URI location = ServletUriComponentsBuilder.fromCurrentRequest()
			.path("/{id}")
			.buildAndExpand(savedUser.getId())
			.toUri();

		// ResponseEntity -> HTTP 상태 코드와 전송하고 싶은 데이터를 전송
		// HTTP 201 Created : 요청이 성공적이었으며 그 결과로 새로운 리소스가 생성됨
		return ResponseEntity.created(location).build();
	}

 

HTTP Status Code

• 2XX → OK
• 4XX → Client
• 5XX → Server

@ServletUriComponentsBuilder를 이용해 호출 방법에 따라 적절한 status code를 반환함

@PostMapping("/users")
public ResponseEntity<User> createUser(@RequestBody User user){
	User savedUser = service.save(user);

	URI location = ServletUriComponentsBuilder.fromCurrentRequest()
		.path("/{id}")
		.buildAndExpand(savedUser.getId())
		.toUri();

	return ResponseEntity.created(location).build();
}

 

HTTP Status Code를 이용한 Exception Handling

customizedException을 사용하면 상황에 따라 알맞은 HTTP 상태 코드와 메시지를 반환할 수 있다.

보통은 customizedExceptionHandler를 사용하여 다양한 customizedException을 사용한다.

 

아래 코드에서는 @ResponseStatus를 사용했지만 CustomizedResponseEntityExceptionHandler.class에서 UserNotFoundException이 발생했을 때, Exception Response를 반환(Http status code도 반환)한다.
=> ResponseStatus 생략 가능

[Controller]
@GetMapping("/users/{id}")
public User retrieveUser(@PathVariable int id) {
	User user = service.findOne(id);
	if (user == null){
		throw new UserNotFoundException(String.format("ID[%s] is not found", id));
	}
	return user;
}

[Exception]
@ResponseStatus(HttpStatus.NOT_FOUND) // 응답 상태 코드 값 지정
public class UserNotFoundException extends RuntimeException {
	public UserNotFoundException(String message) {
		super(message); // ex.getMessage()
	}
}

 

Spring AOP(Aspect Oriented Programming)를 이용한 Error Handling

스프링 부트 어플리케이션 내에서 공통적으로 처리되어야 하는 로직이나 메소드 추가

Aspect로 모듈화하고 핵심적인 비즈니스 로직에서 분리하여 재사용

1) 기본 Response 서식 지정

@Data
@AllArgsConstructor
@NoArgsConstructor
public class ExceptionResponse {
	private Date timestamp;
	private String message;
	private String details;
}

2) 예외 처리 handler 생성

• @ControllerAdvice
• 모든 Controller가 실행될 때 annotation을 가지고 있는 bean이 항상 먼저 실행됨

[CustomizedResponseEntityExceptionHandler]
@RestController
@ControllerAdvice // 모든 @Controller가 실행되기 전에 실행됨 -> 전역 발생 예외 처리 가능
public class CustomizedResponseEntityExceptionHandler extends ResponseEntityExceptionHandler {
	@ExceptionHandler(Exception.class)
	public final ResponseEntity<Object> handleAllExceptions(Exception ex, WebRequest request) {
		ExceptionResponse exceptionResponse =new ExceptionResponse(
        new Date(), ex.getMessage(), request.getDescription(false));
		// ResponseEntity : http status code와 전송하고자 하는 데이터를 함께 전송
		return new ResponseEntity(exceptionResponse,
        	HttpStatus.INTERNAL_SERVER_ERROR);
	}

3) 상황별 custome Exception 생성

custom exception 생성 후에는 customizedExceptionHandler에 넣어주어야 한다.

@ExceptionHandler(UserNotFoundException.class)
public final ResponseEntity<Object> handleUserNotFoundException(Exception ex, WebRequest request) {
	ExceptionResponse exceptionResponse = new ExceptionResponse(
    	new Date(), ex.getMessage(), request.getDescription(false));
	return new ResponseEntity(exceptionResponse, HttpStatus.NOT_FOUND);
}