[Spring Boot - 🐱PetClinic🐶] 10. Controller 분석(2)🔍

⚓️ 들어가기 앞서..

이전 글에서 파악한 내용을 간략하게 설명하자면 @Controller 클래스의 각 메서드는 (필요할 경우 파라미터로 받은 Model에 View 렌더링을 위한 정보를 넣어주고) 렌더링에 사용할 View name을 반환한다. (때에 따라 다른 View 요청을 위한 리다이렉트 주소를 반환하기도 한다.) Dispatcher Servlet은 @Controller에서 반환받은 View name을 바탕으로 렌더링할 View를 찾고 Model 정보를 이용해 View를 렌더링한 뒤 Client에게 렌더링한 View를 보내준다.

👾 WelcomeController

@GetMapping("/") - index 페이지 요청

Index View 요청을 처리하는 컨트롤러. Index 페이지에 해당하는 View name을 리턴하는 메서드 하나만 존재한다.

👼🏻 OwnerController

Pet Clinic의 컨트롤러 중 가장 많은 요청을 처리한다. owner 관련 요청을 처리한다. 이 컨트롤러가 처리하는 요청은 다음과 같다.

Method	URI	설명
GET	/owners/new	owner 추가 페이지 요청
POST	/owners/new	owner 추가 요청
GET	/owners/find	owner 찾기 페이지 요청
GET	/owners/	owner 리스트 페이지 요청
GET	/owners/{ownerId}/edit	owner 수정 페이지 요청
POST	/owners/{ownerId}/edit	owner 수정 요청
GET	/owners/{ownerId}	owner 상세정보 페이지 요청

@GetMapping("/owners/new") - owner를 추가하기 위한 페이지 요청(initCreationForm)

public String initCreationForm(Map<String, Object> model)

owner 추가 View name을 리턴하는 메서드. Model에 왜 굳이 Owner 객체를 새로 만들어서 넣어주나 했더니 여기서 리턴하는 View가 owner 추가, 수정 모두에 사용하기 때문이었다. 새로 생성한 객체를 넣어주면 View에서 렌더링할 때 input 항목에 default로 들어갈 정보들이 null이기 때문에 각 input 항목을 비우고 렌더링한다.

@PostMapping("/owners/new") - owner 추가 요청(processCreationForm)

public String processCreationForm(@Valid Owner owner, BindingResult result) 

Request Body로 들어온 owner 정보를 이용해 데이터베이스에 저장하기 위한 메서드. owner 정보를 검증한 후 오류가 있다면 입력한 정보에 문제가 있다는 뜻이므로 owner 정보 입력 View로 되돌아가고, 오류가 없다면 새 owner 정보를 Database에 저장한다. 새 owner 저장 후 저장한 owner 상세 정보 조회를 위한 주소로 리다이렉트 한다.

@GetMapping("/owners/find") - 특정 owner 찾기 페이지 요청(initFindForm)

public String initFindForm()

owner 찾기를 위한 View name을 리턴하는 메서드.

@GetMapping("/owners") - owner 찾기 요청(processFindForm)

public String processFindForm(@RequestParam(defaultValue = "1") int page,
									Owner owner, BindingResult result, Model model)

owner 찾기 페이지에서 입력한 last name으로 해당하는 owner를 찾기 위한 메서드. last name으로 아무것도 입력하지 않을 경우 모든 owner를 찾는다. owner 검색 결과 last name이 일치하는 owner가 1명일 경우 해당 owner 상세 정보 조회를 위한 주소로 리다이렉트 하고, 여러 건일 경우 페이지 처리를 한 후 owner 리스트를 보여주는 View로 이동한다.

@GetMapping("/owners/{ownerId}/edit") - 특정 owner 정보 수정 페이지 요청(initUpdateOwnerForm)

public String initUpdateOwnerForm(@PathVariable("ownerId") int ownerId, Model model)

특정 owner의 상세 정보 수정 View name을 리턴하는 메서드. View는 owner 추가에 사용하는 View와 같다. {ownerID}에 맞는 사용자를 찾아 사용자 정보를 Model에 넣어준다. Dispatcher Servlet에서 Model에 담겨있는 owner 정보를 이용해 수정할 owner 정보를 View에 렌더링한다.

@PostMapping("/owners/{ownerId}/edit") - 특정 owner 정보 수정 요청(processUpdateOwnerForm)

public String processUpdateOwnerForm(@Valid Owner owner, BindingResult result,
											@PathVariable("ownerId") int ownerId)

Request Body로 들어온 owner 정보를 이용해 데이터베이스를 수정하기 위한 메서드. owner 정보를 검증한 후 오류가 있다면 입력한 정보에 문제가 있다는 뜻이므로 owner 정보 입력 View로 되돌아가고, 오류가 없다면 {ownerId}에 해당하는 owner를 요청과 함께 들어온 정보로 수정한다. owner 갱신 후 해당 owner 상세 페이지 조회를 위한 주소로 리다이렉트 한다.

@GetMapping("/owners/{ownerId}")

public ModelAndView showOwner(@PathVariable("ownerId") int ownerId)

owner 상세 정보 조회 View name을 리턴하는 메서드. {ownerId}에 해당하는 owner를 찾아 Model에 넣어준다. Dispatcher Servlet은 Model에 담긴 owner 정보를 통해 View를 렌더링한다.

🐶 PetController

pet 관련 요청을 처리한다. @Controller 어노테이션 밑의 @RequestMapping("/owners/{ownerId}") 어노테이션을 통해 기본적으로 이 컨트롤러에서 처리할 경로를 설정한다. 기본 경로에 메서드별 처리할 경로를 추가해서 사용한다. 이 컨트롤러가 처리하는 요청은 다음과 같다.

Method	URI(/owners/{ownerId} + )	설명
GET	/pets/new	pet 추가 페이지 요청
POST	/pets/new	pet 추가 요청
GET	/pets/{petId}/edit	pet 수정 페이지 요청
POST	/pets/{petId}/edit	pet 수정 요청

@GetMapping("/pets/new") - 특정 owner에 pet을 추가하기 위한 페이지 요청(initCreationForm)

public String initCreationForm(Owner owner, ModelMap model)

owner id가 {ownerId}인 owner에 pet을 추가하기 위한 정보 입력 View name을 리턴하는 메서드. GET /owners/{ownerId}/pets/new 요청을 처리한다. 이 View 역시 추가, 수정 모두에 사용되므로 owner에 pet 객체를 새로 만들어 owner에 추가한 후 Model에 넣어준다.

@PostMapping("/pets/new") - 특정 owner에 pet 추가 요청(processCreationForm)

public String processCreationForm(Owner owner, @Valid Pet pet,
										BindingResult result, ModelMap model)

Request Body로 들어온 pet 정보를 이용해 데이터베이스를 수정하기 위한 메서드. POST /owners/{ownerId}/pets/new 요청을 처리한다. owner id가 {ownerId}에 해당하는 owner에 새 pet을 추가한다. 이름의 길이, 이름 중복 여부 등을 검사하여 이상이 있으면 다시 pet 추가 View로 되돌아가고, 이상이 없으면 데이터베이스에 추가한 뒤 해당 owner 상세 정보 조회를 위한 주소로 리다이렉트 한다.

@GetMapping("/pets/{petId}/edit") - 특정 owner의 특정 pet 정보 수정 페이지 요청(intiUpdateForm)

public String initUpdateForm(Owner owner, @PathVariable("petId") int petId, ModelMap model)

특정 owner의 특정 pet의 정보 수정을 위한 View name을 리턴하는 메서드. GET /owners/{ownerId}/pets/{petId}/edit 요청을 처리한다. owner id가 {ownerId}인 owner의 pet id가 {petId}인 pet의 정보를 찾아 Model에 담는다. Dispatcher Servlet은 이 메서드를 통해 찾은 수정할 pet의 정보를 View에 렌더링한다.

@PostMapping("/pets/{petId}/edit") - 특정 owner의 특정 pet 정보 수정 요청(processUpdateForm)

public String processUpdateForm(@Valid Pet pet, BindingResult result, 
												Owner owner, ModelMap model)

특정 owner의 특정 pet의 정보를 수정하기 위한 메서드. POST /owners/{ownerId}/pets/{petId}/edit 요청을 처리한다. Request Body로 넘어온 pet의 정보를 이용해 owner id가 {ownerId}에 해당하는 pet id가 {petId}인 pet의 정보를 수정한다. 받아온 pet 정보에 오류가 있으면 pet 정보 수정 View로 되돌아가고, 없으면 해당 owner 상세 정보 View로 리다이렉트 한다.

🏥 VisitController

visit 관련 요청을 처리한다. 이 컨트롤러가 처리하는 요청은 다음과 같다.

Method	URI	설명
GET	/owners/{ownerId}/pets/{petId}/visits/new	visit 추가 페이지 요청
POST	/owners/{ownerId}/pets/{petId}/visits/new	visit 추가 요청

@GetMapping("/owners/{ownerId}/pets/{petId}/visits/new") - 특정 owner의 특정 pet에 방문기록 추가를 위한 페이지 요청(initNewVisitForm)

public String initNewVisitForm()

방문 정보 입력 View name을 리턴하는 메서드. 이 View도 visit 추가, 수정에 모두 사용될 수 있으나 추가 기능만 구현되어 있다. 수정에 사용하기 위해서는 이 메서드 내용과 html 파일 모두 수정해야 한다.

@PostMapping("/owners/{ownerId}/pets/{petId}/visits/new") - 특정 owner의 특정 pet에 방문기록 추가 요청(processNewVisitForm)

public String processNewVisitForm(@ModelAttribute Owner owner, @PathVariable int petId, 
												@Valid Visit visit, BindingResult result)

Request Body를 통해 들어온 방문 정보를 이용해 해당 pet에 방문 정보를 데이터베이스에 추가하기 위한 메서드. owner id가 {ownerId}인 owner의 pet id가 {petId}인 pet에 방문 정보를 저장한다. 받아온 정보에 오류가 있으면 방문 정보 입력 View로 되돌아가고, 오류가 없으면 데이터베이스에 저장 후 해당 owner 상세 정보 페이지로 리다이렉트 한다.

🧑🏻‍⚕️ VetController

vet 관련 요청을 처리한다. 이 컨트롤러가 처리하는 요청은 다음과 같다.

Method	URI	설명
GET	/vets.html	vet 목록 조회 페이지 요청
GET	/vets	vet 목록 요청

두 요청 모두 Veterinarian의 목록 조회를 위한 요청이지만, 서버에서 클라이언트로 보내는 방식이 다르다.

@GetMapping("/vets.html") - Veterinarian 목록 조회 페이지 요청(showVetList)

public String showVetList(@RequestParam(defaultValue = "1") int page, Model model)

Veterinarian의 목록을 출력해 주는 View name을 리턴하는 메서드. ModelAndView 방식으로 클라이언트에게 Veterinarian의 목록을 출력하는 View를 보내준다. Dispatcher Servlet은 이 메서드를 통해 Veterinarian의 목록을 읽어와 페이지 처리를 한 뒤 View를 렌더링한 다음 클라이언트에게 보내준다.

@GetMapping("/vets") - Veterinarian 리스트를 받기 위한 요청(showResourcesVetList)

public @ResponseBody Vets showResourcesVetList()

Veterinarian의 목록을 리턴해주는 메서드. 따로 View를 렌더링해서 보내주는 것이 아닌 목록을 보내주는 역할을 한다. 데이터를 parsing 해서 사용하는 경우 사용하는 요청이다. 이 메서드의 리턴값은 Veterinarian의 목록이 담긴 객체를 XML 파일 형태로 넘긴다.

🎇 CrashController

오류 페이지 요청을 처리한다. 이 컨트롤러가 처리하는 요청은 다음과 같다.

Method	URI	설명
GET	/oups	오류 페이지 요청

@GetMapping("/oups") - 오류 페이지 요청

public String triggerException()

오류 페이지 요청을 처리하는 메서드. Runtime Exception을 발생시킨다. Runtime Exception이 발생하면 Dispatcher Servlet은 내부적으로 '/error' 요청을 발생시켜 클라이언트에게 error.html을 전해준다. Runtime Exception이 발생할 때 error message를 설정해 주면 error.html에 해당 error message를 렌더링하고 보내준다.

🗒 Naming Convention

Pet Clinic에서는 @Controller의 메서드 이름을 작성할 때의 naming convention은 다음과 같다.

Method name	설명
init{행위}Form(Creation, Find 등)	추가를 위한 View 요청 처리 메서드
process{행위}Form(Creation, Find 등)	요청 처리 메서드(저장, 찾기 등)
initUpdate{대상}Form	대상 수정을 위한 View 요청 처리 메서드
processUpdate{대상}Form	대상 수정을 위한 요청 처리 메서드
show{대상}	대상 조회를 위한 View 요청 처리 메서드

🧩 마무리

@Controller 메서드를 분석하며 한 가지 View를 이용해 추가, 수정에 모두 사용하는 방법을 배웠다. xml파일로 목록을 보내는 방법도 배울 수 있었다. 또한, Controller 단의 naming convention과 어디까지를 Controller에서 처리하는지에 대한 전반적인 내용을 파악할 수 있었다.(Request Mapping, 페이지 처리, Request Body로 들어오는 Model Attribute를 객체에 바인딩, View 렌더링을 위한 Model에 객체 추가 등등..) 다음 글에서는 Pet Clinic의 Repository 분석에 대해 다룰 예정이다. 지금은 직접 코드를 작성하면서 활용하는 능력을 기르는 것이 더 필요한 것 같지만.. 이왕 시작했으니까.. 끝을 보고 다음 단계로 넘어가는 것이 더 좋을 것 같다. 얼른 하고 프로젝트 들어가야지...!

[참고]

@XmlElement 설명 -
https://fordeveloper2.tistory.com/7584?category=360944